Inheritance diagram for originpro.notes.Notes:

Public Member Functions
	__repr__ (self)

	text (self)

	text (self, value)

	syntax (self)

	syntax (self, value)

	view (self)

	view (self, value)

	append (self, text, newline=True)

	load (self, fname, askreplace=False)

	exp_html (self, fname)

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

Public Attributes
	text = text

Public Attributes inherited from originpro.base.BaseObject
	obj = obj

Detailed Description

 Origin Notes Window

Member Function Documentation

◆ append()

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

originpro.notes.Notes.destroy ( self )

Destroy Notes window.

Parameters:

Returns:
    None

Examples:
    nt.destroy()

◆ exp_html()

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

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]

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]

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]

originpro.notes.Notes.text ( self )

Get Notes window text

Parameters:

Returns:
    (str) Notes window text

Examples:
    text = nt.text

◆ text() [2/2]

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]

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]

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:

src/originpro/notes.py

Public Member Functions

Public Attributes