8.1.21.18 OriginObject::SetComments

It is recommended that you switch to the originpro package. PyOrigin is primarily for users who need to work with Origin version prior to 2021.

Description

Sets the comments with a text string to an object that supports Comments.

Syntax

SetComments(comments, bUndo = FALSE)

Parameters

comments

String for the comments to be set

bUndo

Set to TRUE if you wish to support Undo, otherwise FALSE

Return

Returns true if the object's comments was set, false if not.

Examples

EX1

import PyOrigin
PyOrigin.Pages('Book1').SetComments('test')
print('%s' % PyOrigin.Pages('Book1').GetComments())

See Also

GetComments