OriginPro
 
Loading...
Searching...
No Matches
originpro.base.BasePage Class Reference
Inheritance diagram for originpro.base.BasePage:
originpro.base.BaseObject originpro.base.DBook originpro.graph.GPage originpro.image.IPage originpro.matrix.MBook originpro.worksheet.WBook

Public Member Functions

def __len__ (self)
 
def is_open (self)
 
def is_active (self)
 
def lt_range (self)
 
def activate (self)
 
def destroy (self)
 
def duplicate (self)
 
- Public Member Functions inherited from originpro.base.BaseObject
def __init__ (self, obj)
 
def __del__ (self)
 
def __str__ (self)
 
def __bool__ (self)
 
def index (self)
 
def get_str (self, prop)
 
def get_int (self, prop)
 
def get_float (self, prop)
 
def set_str (self, prop, value)
 
def set_int (self, prop, value)
 
def set_float (self, prop, value)
 
def method_int (self, name, arg='')
 
def method_float (self, name, arg='')
 
def method_str (self, name, arg='')
 
def lt_exec (self, labtalk)
 
def name (self)
 
def name (self, value)
 
def lname (self)
 
def lname (self, value)
 
def comments (self)
 
def comments (self, value)
 
def show (self)
 
def show (self, value)
 
def usertree (self)
 
def usertree (self, tr)
 
def userprops (self)
 

Additional Inherited Members

- Public Attributes inherited from originpro.base.BaseObject
 obj
 

Detailed Description

base class for all Origin books and graph, it holds a PyOrigin Page

Member Function Documentation

◆ activate()

def originpro.base.BasePage.activate (   self)
make page active
Parameters:
    none
Returns:
    none
Examples:
    wb = op.find_book('w', 'Book2')
    wb.activate()

◆ destroy()

def originpro.base.BasePage.destroy (   self)
Destroy the window
Parameters:
    none
Returns:
    none
Examples:
    wb=op.new_book()
    wb.destroy()

◆ duplicate()

def originpro.base.BasePage.duplicate (   self)
duplicate the window
Parameters:
    none
Returns:
    the newly created window object
Examples:
    wb=op.new_book()
    wbDuplicate=wb.duplicate()

◆ is_active()

def originpro.base.BasePage.is_active (   self)
Returns whether book is currently active
Parameters:
    none
Returns:
    bool that indicate if the book is active
Examples:
    wb=op.new_book()
    print(wb.is_active())

◆ is_open()

def originpro.base.BasePage.is_open (   self)
Returns whether book is neither hidden, nor minimized.

Parameters:

Returns:
    (bool)

Examples:
    b = wb.is_open()

◆ lt_range()

def originpro.base.BasePage.lt_range (   self)
Parameters:
    none
Returns:
    return the Origin Range String that iddentify page object
Examples:
    wb=op.new_book()
    print(wb.lt_range())

The documentation for this class was generated from the following file: