Adobe InCopy CS5 (7.0) Object Model JS: DialogColumn

InCopy CS5

Class

DialogColumn

 A borderless column for containing controls in a dialog.

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

BorderPanel | Dialog | DialogRow | EnablingGroup
DialogColumn
AngleCombobox | AngleEditbox | BorderPanel | CheckboxControl | DialogRow | 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.
dialogRowsDialogRows readonlyA collection of dialog rows.
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 DialogColumn.
indexnumber readonlyThe index of the DialogColumn 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.
parentBorderPanelDialog
DialogRow
EnablingGroup
readonlyThe parent of the DialogColumn (a Dialog, DialogRow, EnablingGroup or BorderPanel).
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 DialogColumn 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 DialogColumn.

string toSpecifier ()
Retrieves the object specifier.

Element of

DialogRow.parent

Used in:

DialogColumn DialogColumns.nextItem (obj: DialogColumn)

DialogColumn DialogColumns.previousItem (obj: DialogColumn)

Return

Array of DialogColumn DialogColumn.getElements ()

DialogColumn DialogColumns.[] (index: number)

DialogColumn DialogColumns.add ([withProperties: Object])

DialogColumn DialogColumns.anyItem ()

Array of DialogColumn DialogColumns.everyItem ()

DialogColumn DialogColumns.firstItem ()

DialogColumn DialogColumns.item (index: varies)

DialogColumn DialogColumns.itemByID (id: number)

Array of DialogColumn DialogColumns.itemByRange (from: varies, to: varies)

DialogColumn DialogColumns.lastItem ()

DialogColumn DialogColumns.middleItem ()

DialogColumn DialogColumns.nextItem (obj: DialogColumn)

DialogColumn DialogColumns.previousItem (obj: DialogColumn)

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