note

A note in a story.

note properties

Property Type Access Description
class integer read The class descriptor type.
collapsed boolean r/w Is the note collapsed in the galley window.
creation date date read When the note was created.
id integer read The object’s unique id.
index integer read Index of the object within its parent object.
label string r/w A label that can be set to any string.
modification date date read When the note was last modified.
object reference object read An object reference for this object.
parent object read The object’s parent.
parent text frame text frame read The text frame this note appears in.
properties record r/w Property that allows setting of several properties at the same time.
story offset integer read The location of this note from the beginning of the story.
user name string read The user who made the note.

note methods

Method Returns Description
convert to text Nothing Convert to text.
delete Nothing Delete the object.
extract label string Get the label value associated with the given key.
insert label Nothing Set the label associated with the given key.
move note Move before/after another text object, or to beginning/end.

Leave a Comment

Previous post:

Next post: