originpro.base.BasePage Class Reference

Inheritance diagram for originpro.base.BasePage:

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

Additional Inherited Members
Public Attributes inherited from originpro.base.BaseObject
	obj = obj

Detailed Description

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

Member Function Documentation

activate()

originpro.base.BasePage.activate

(

self

)

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

destroy()

originpro.base.BasePage.destroy

(

self

)

Destroy the window
Parameters:
    none
Returns:
    none
Examples:
    wb=op.new_book()
    wb.destroy()

duplicate()

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()

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()

originpro.base.BasePage.is_open

(

self

)

Returns whether book is neither hidden, nor minimized.

Parameters:

Returns:
    (bool)

Examples:
    b = wb.is_open()

lt_range()

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:

• src/originpro/base.py