Adobe InCopy CS5 (7.0) Object Model JS: DialogRow

InCopy CS5

Class

DialogRow

 A borderless row for containing controls in a dialog.

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

DialogColumn
DialogRow
AngleCombobox | AngleEditbox | BorderPanel | CheckboxControl | DialogColumn | Dropdown | EnablingGroup | Event | EventListener | IntegerCombobox | IntegerEditbox | MeasurementCombobox | MeasurementEditbox | MutationEvent | PercentCombobox | PercentEditbox | RadiobuttonGroup | RealCombobox | RealEditbox | StaticText | TextEditbox | Widget

Properties

PropertyTypeAccessDescription
angleComboboxesAngleComboboxes readonlyA collection of angle comboboxes.
angleEditboxesAngleEditboxes readonlyA collection of angle editboxes.
borderPanelsBorderPanels readonlyA collection of border panels.
checkboxControlsCheckboxControls readonlyA collection of checkbox controls.
dialogColumnsDialogColumns readonlyA collection of dialog columns.
dropdownsDropdowns readonlyA collection of dropdowns.
enablingGroupsEnablingGroups readonlyA collection of enabling groups.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the DialogRow.
indexnumber readonlyThe index of the DialogRow within its containing object.
integerComboboxesIntegerComboboxes readonlyA collection of integer comboboxes.
integerEditboxesIntegerEditboxes readonlyA collection of integer editboxes.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
measurementComboboxesMeasurementComboboxes readonlyA collection of measurement comboboxes.
measurementEditboxesMeasurementEditboxes readonlyA collection of measurement editboxes.
parentDialogColumn readonlyThe parent of the DialogRow (a DialogColumn).
percentComboboxesPercentComboboxes readonlyA collection of percent comboboxes.
percentEditboxesPercentEditboxes readonlyA collection of percent editboxes.
propertiesObject r/wA property that allows setting of several properties at the same time.
radiobuttonGroupsRadiobuttonGroups readonlyA collection of radiobutton groups.
realComboboxesRealComboboxes readonlyA collection of real number comboboxes.
realEditboxesRealEditboxes readonlyA collection of real number editboxes.
staticTextsStaticTexts readonlyA collection of static text objects.
textEditboxesTextEditboxes readonlyA collection of text editboxes.
widgetsWidgets readonlyA collection of widgets.

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 DialogRow 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 DialogRow.

string toSpecifier ()
Retrieves the object specifier.

Used in:

DialogRow DialogRows.nextItem (obj: DialogRow)

DialogRow DialogRows.previousItem (obj: DialogRow)

Return

Array of DialogRow DialogRow.getElements ()

DialogRow DialogRows.[] (index: number)

DialogRow DialogRows.add ([withProperties: Object])

DialogRow DialogRows.anyItem ()

Array of DialogRow DialogRows.everyItem ()

DialogRow DialogRows.firstItem ()

DialogRow DialogRows.item (index: varies)

DialogRow DialogRows.itemByID (id: number)

Array of DialogRow DialogRows.itemByRange (from: varies, to: varies)

DialogRow DialogRows.lastItem ()

DialogRow DialogRows.middleItem ()

DialogRow DialogRows.nextItem (obj: DialogRow)

DialogRow DialogRows.previousItem (obj: DialogRow)

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