Adobe InCopy CS5 (7.0) Object Model JS: StaticText

InCopy CS5

Class

StaticText

 A static text control (typically a label for another control or a set of controls). Base Class: Widget

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

BorderPanel | DialogColumn | DialogRow | EnablingGroup
Widget
StaticText
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the StaticText.
indexnumber readonlyThe index of the StaticText within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
minWidthnumber r/wThe width of the control. For an editbox or combobox, specifies the minimum width of the box.
parentBorderPanelDialogColumn
DialogRow
EnablingGroup
readonlyThe parent of the StaticText (a DialogColumn, DialogRow, EnablingGroup or BorderPanel).
propertiesObject r/wA property that allows setting of several properties at the same time.
staticLabelstring r/wText that appears in the StaticText.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of StaticText getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the StaticText.

string toSpecifier ()
Retrieves the object specifier.

Used in:

StaticText StaticTexts.nextItem (obj: StaticText)

StaticText StaticTexts.previousItem (obj: StaticText)

Return

Array of StaticText StaticText.getElements ()

StaticText StaticTexts.[] (index: number)

StaticText StaticTexts.add ([withProperties: Object])

StaticText StaticTexts.anyItem ()

Array of StaticText StaticTexts.everyItem ()

StaticText StaticTexts.firstItem ()

StaticText StaticTexts.item (index: varies)

StaticText StaticTexts.itemByID (id: number)

Array of StaticText StaticTexts.itemByRange (from: varies, to: varies)

StaticText StaticTexts.lastItem ()

StaticText StaticTexts.middleItem ()

StaticText StaticTexts.nextItem (obj: StaticText)

StaticText StaticTexts.previousItem (obj: StaticText)

Jongware, 23-Mar-2011 v3.0.3dContents :: Index