Packagecom.adobe.indesign
Classpublic class Note
InheritanceNote Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  characters : Characters
[read-only] A collection of characters.
Note
  collapsed : Boolean
If true, the note is collapsed in galley view.
Note
  creationDate : Date
[read-only] The date and time the note was created.
Note
  eventListeners : EventListeners
[read-only] A collection of event listeners.
Note
  events : Events
[read-only] A collection of events.
Note
  hiddenTexts : HiddenTexts
[read-only] A collection of hidden text objects.
Note
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the Note.
Note
  index : Number
[read-only] The index of the Note within its containing object.
Note
  insertionPoints : InsertionPoints
[read-only] A collection of insertion points.
Note
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
Note
  label : String
A property that can be set to any string.
Note
  lines : Lines
[read-only] A collection of lines.
Note
  modificationDate : Date
[read-only] The date and time the note was last modified.
Note
  name : String
The name of the Note; this is an alias to the Note's label property.
Note
  paragraphs : Paragraphs
[read-only] A collection of paragraphs.
Note
  parent : Object
[read-only] The parent of the Note (a XmlStory, Story, TextFrame, InsertionPoint or Cell).
Note
  properties : Object
A property that allows setting of several properties at the same time.
Note
  storyOffset : InsertionPoint
[read-only] The insertion point before the table in the story containing the table.
Note
  textColumns : TextColumns
[read-only] A collection of text columns.
Note
  texts : Texts
[read-only] A collection of text objects.
Note
  textStyleRanges : TextStyleRanges
[read-only] A collection of text style ranges.
Note
  textVariableInstances : TextVariableInstances
[read-only] A collection of text variable instances.
Note
  userName : String
[read-only] The user who made the note.
Note
  words : Words
[read-only] A collection of words.
Note
Public Methods
 MethodDefined By
  
addEventListenerNote(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Note
  
Converts the note to story text.
Note
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
Note
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
Resolves the object specifier, creating an array of object references.
Note
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
Note
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
move(toParam:LocationOptions = null, referenceParam:Object = null):Note
Moves the note to the specified location.
Note
  
remove():void
Deletes the Note.
Note
  
removeEventListenerNote(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Note
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
Note
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
charactersproperty
characters:Characters  [read-only]

A collection of characters.


Implementation
    public function get characters():Characters
collapsedproperty 
collapsed:Boolean

If true, the note is collapsed in galley view.


Implementation
    public function get collapsed():Boolean
    public function set collapsed(value:Boolean):void
creationDateproperty 
creationDate:Date  [read-only]

The date and time the note was created.


Implementation
    public function get creationDate():Date
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
hiddenTextsproperty 
hiddenTexts:HiddenTexts  [read-only]

A collection of hidden text objects.


Implementation
    public function get hiddenTexts():HiddenTexts
idproperty 
id:Number  [read-only]

The unique ID of the Note.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only]

The index of the Note within its containing object.


Implementation
    public function get index():Number
insertionPointsproperty 
insertionPoints:InsertionPoints  [read-only]

A collection of insertion points.


Implementation
    public function get insertionPoints():InsertionPoints
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
linesproperty 
lines:Lines  [read-only]

A collection of lines.


Implementation
    public function get lines():Lines
modificationDateproperty 
modificationDate:Date  [read-only]

The date and time the note was last modified.


Implementation
    public function get modificationDate():Date
nameproperty 
name:String

The name of the Note; this is an alias to the Note's label property.


Implementation
    public function get name():String
    public function set name(value:String):void
paragraphsproperty 
paragraphs:Paragraphs  [read-only]

A collection of paragraphs.


Implementation
    public function get paragraphs():Paragraphs
parentproperty 
parent:Object  [read-only]

The parent of the Note (a XmlStory, Story, TextFrame, InsertionPoint or Cell).


Implementation
    public function get parent():Object
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
storyOffsetproperty 
storyOffset:InsertionPoint  [read-only]

The insertion point before the table in the story containing the table.


Implementation
    public function get storyOffset():InsertionPoint
textColumnsproperty 
textColumns:TextColumns  [read-only]

A collection of text columns.


Implementation
    public function get textColumns():TextColumns
textsproperty 
texts:Texts  [read-only]

A collection of text objects.


Implementation
    public function get texts():Texts
textStyleRangesproperty 
textStyleRanges:TextStyleRanges  [read-only]

A collection of text style ranges.


Implementation
    public function get textStyleRanges():TextStyleRanges
textVariableInstancesproperty 
textVariableInstances:TextVariableInstances  [read-only]

A collection of text variable instances.


Implementation
    public function get textVariableInstances():TextVariableInstances
userNameproperty 
userName:String  [read-only]

The user who made the note.


Implementation
    public function get userName():String
wordsproperty 
words:Words  [read-only]

A collection of words.


Implementation
    public function get words():Words
Method Detail
addEventListenerNote()method
public function addEventListenerNote(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
convertToText()method 
public function convertToText():void

Converts the note to story text.

extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

move()method 
public function move(toParam:LocationOptions = null, referenceParam:Object = null):Note

Moves the note to the specified location.

Parameters

toParam:LocationOptions (default = null) — (LocationOptions) The new location relative to the reference object or within the containing object.
 
referenceParam:Object (default = null) — (Object) The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text or Story. (Optional)

Returns
Note
remove()method 
public function remove():void

Deletes the Note.

removeEventListenerNote()method 
public function removeEventListenerNote(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String