OriginPro
 
Loading...
Searching...
No Matches
originpro.notes.Notes Class Reference
Inheritance diagram for originpro.notes.Notes:
originpro.base.BaseObject

Public Member Functions

def __repr__ (self)
 
def text (self)
 
def text (self, value)
 
def syntax (self)
 
def syntax (self, value)
 
def view (self)
 
def view (self, value)
 
def append (self, text, newline=True)
 
def load (self, fname, askreplace=False)
 
def exp_html (self, fname)
 
def destroy (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)
 

Public Attributes

 text
 
- Public Attributes inherited from originpro.base.BaseObject
 obj
 

Detailed Description

 Origin Notes Window

Member Function Documentation

◆ append()

def originpro.notes.Notes.append (   self,
  text,
  newline = True 
)
Append text to Notes window.

Parameters:
    text (str): Text to append.
    newline (bool): Add new line character if true.
Returns:
    None

Examples:
    nt.append('hello world')

◆ destroy()

def originpro.notes.Notes.destroy (   self)
Destroy Notes window.

Parameters:

Returns:
    None

Examples:
    nt.destroy()

◆ exp_html()

def originpro.notes.Notes.exp_html (   self,
  fname 
)
Export Notes window as HTML files.

Parameters:
    fname (str): Output HTML file name.
Returns:
    Error code, 0 for success.

Examples:
    nt.exp_html('D:/hello.html')

◆ load()

def originpro.notes.Notes.load (   self,
  fname,
  askreplace = False 
)
Load file into Notes window.

Parameters:
    fname (str): Input file full path.
    askreplace (bool): Ask if replace current content if True
Returns:
    Error code, 0 for success.

Examples:
    nt.load('D:/hello.html')

◆ syntax() [1/2]

def originpro.notes.Notes.syntax (   self)
Get Notes syntax

Parameters:

Returns:
    (int) Notes syntax, can be 0(Normal Text), 1(HTML), 2(Markdown), 3(Origin Rich Text)

Examples:
    syntax = nt.syntax

◆ syntax() [2/2]

def originpro.notes.Notes.syntax (   self,
  value 
)
Set Notes syntax

Parameters:
    value (int): Syntax to set, can be 0(Normal Text), 1(HTML), 2(Markdown), 3(Origin Rich Text)

Returns:
    None

Examples:
    nt.syntax = 2

◆ text() [1/2]

def originpro.notes.Notes.text (   self)
Get Notes window text

Parameters:

Returns:
    (str) Notes window text

Examples:
    text = nt.text

◆ text() [2/2]

def originpro.notes.Notes.text (   self,
  value 
)
Set Notes window text

Parameters:
    value (str): Text to set

Returns:
    None

Examples:
    nt.text = 'hello world'

◆ view() [1/2]

def originpro.notes.Notes.view (   self)
Get Notes view mode

Parameters:

Returns:
    (int) Notes view mode, can be 0(Text Mode), 1(Render Mode)

Examples:
    syntax = nt.syntax

◆ view() [2/2]

def originpro.notes.Notes.view (   self,
  value 
)
Set Notes view mode

Parameters:
    value (int): View mode to set, can be 0(Text Mode), 1(Render Mode)

Returns:
    None

Examples:
    nt.view = 1

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