ListBox
QuickLinks
Hierarchy
Properties
Property | Type | Access | Description |
---|---|---|---|
absoluteFlip | Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH |
r/w | Indicates whether the ListBox has been flipped independently of its parent object and, if yes, the direction in which the ListBox was flipped. |
absoluteHorizontalScale | number | readonly | The horizontal scale of the ListBox relative to its containing object. |
absoluteRotationAngle | number | readonly | The rotation angle of the ListBox relative to its containing object. (Range: -360 to 360) |
absoluteShearAngle | number | readonly | The skewing angle of the ListBox relative to its containing object. (Range: -360 to 360) |
absoluteVerticalScale | number | readonly | The vertical scale of the ListBox relative to its containing object. |
activeStateIndex | number | readonly | The index of the active state in the object's states collection. |
allGraphics | Array of Graphic | readonly | Lists all graphics contained by the ListBox. |
allPageItems | Array of PageItem | readonly | Lists all page items contained by the ListBox. |
allowOverrides | bool | r/w | If true, the master page item can be overridden. |
anchoredObjectSettings | AnchoredObjectSetting | readonly | Anchored object settings. |
associatedXMLElement | XMLItem | readonly | The XML element associated with the ListBox. |
behaviors | Behaviors Behavior | readonly | A collection of behavior objects. |
bottomLeftCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
readonly | The shape to apply to the bottom left corner of rectangular shapes. |
bottomLeftCornerRadius | Measurement Unit (Number or String) | readonly | The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes |
bottomRightCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
readonly | The shape to apply to the bottom right corner of rectangular shapes. |
bottomRightCornerRadius | Measurement Unit (Number or String) | readonly | The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes |
choiceList | Array of string | readonly | The list of choices for combo and list boxes in the exported PDF. |
clearFormBehaviors | ClearFormBehaviors ClearFormBehavior | readonly | A collection of clear form behavior objects. |
description | string | readonly | The description of the ListBox. |
endCap | EndCap: EndCap.BUTT_END_CAP EndCap.ROUND_END_CAP EndCap.PROJECTING_END_CAP |
readonly | The end shape of an open path. |
endJoin | EndJoin: EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN EndJoin.BEVEL_END_JOIN |
readonly | The corner join applied to the ListBox. |
epss | EPSs EPS | readonly | A collection of EPS files. |
epstexts | EPSTexts EPSText | readonly | EPSTexts |
eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
events | Events Event | readonly | A collection of events. |
fillColor | String Swatch |
readonly | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the ListBox. . Can also accept: String. |
fillTint | number | readonly | The percent of tint to use in the ListBox's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) |
flip | Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH |
r/w | The direction in which to flip the printed image. |
fontSize | number | readonly | The font size for the form field in the exported PDF. |
gapColor | Swatch | readonly | The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type. |
gapTint | number | readonly | The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) |
geometricBounds | Array of Measurement Unit (Number or String) | readonly | The bounds of the ListBox excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. |
gotoAnchorBehaviors | GotoAnchorBehaviors GotoAnchorBehavior | readonly | A collection of goto anchor behavior objects. |
gotoFirstPageBehaviors | GotoFirstPageBehaviors GotoFirstPageBehavior | readonly | A collection of goto first page behavior objects. |
gotoLastPageBehaviors | GotoLastPageBehaviors GotoLastPageBehavior | readonly | A collection of goto last page behavior objects. |
gotoNextPageBehaviors | GotoNextPageBehaviors GotoNextPageBehavior | readonly | A collection of goto next page behavior objects. |
gotoNextViewBehaviors | GotoNextViewBehaviors GotoNextViewBehavior | readonly | A collection of goto next view behavior objects. |
gotoPreviousPageBehaviors | GotoPreviousPageBehaviors GotoPreviousPageBehavior | readonly | A collection of goto previous page behavior objects. |
gotoPreviousViewBehaviors | GotoPreviousViewBehaviors GotoPreviousViewBehavior | readonly | A collection of goto previous view behavior objects. |
gotoURLBehaviors | GotoURLBehaviors GotoURLBehavior | readonly | A collection of goto URL behavior objects. |
gradientFillAngle | number | readonly | The angle of a linear gradient applied to the fill of the ListBox. (Range: -180 to 180) |
gradientFillLength | Measurement Unit (Number or String) | readonly | The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the ListBox. |
gradientFillStart | Array of Measurement Unit (Number or String) | readonly | The starting point (in page coordinates) of a gradient applied to the fill of the ListBox, in the format [x, y]. |
gradientStrokeAngle | number | readonly | The angle of a linear gradient applied to the stroke of the ListBox. (Range: -180 to 180) |
gradientStrokeLength | Measurement Unit (Number or String) | readonly | The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the ListBox. |
gradientStrokeStart | Array of Measurement Unit (Number or String) | readonly | The starting point (in page coordinates) of a gradient applied to the stroke of the ListBox, in the format [x, y]. |
graphicLines | GraphicLines GraphicLine | readonly | A collection of graphic lines. |
graphics | Graphics Graphic | readonly | A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). |
groups | Groups Group | readonly | A collection of groups. |
hiddenUntilTriggered | bool | readonly | If true, the form field/push button is hidden until triggered in the exported PDF. |
horizontalLayoutConstraints |
Array
of DimensionsConstraints: DimensionsConstraints.FIXED_DIMENSION DimensionsConstraints.FLEXIBLE_DIMENSION |
readonly | The left margin, width, and right margin constraints this item is subject to when using the object-based layout rule. |
horizontalScale | number | readonly | The horizontal scaling applied to the ListBox. |
id | number | readonly | The unique ID of the ListBox. |
images | Images Image | readonly | A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF). |
index | number | readonly | The index of the ListBox within its containing object. |
isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
itemLayer | Layer | readonly | The layer that the ListBox is on. |
label | string | r/w | A property that can be set to any string. |
leftLineEnd | ArrowHead: ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD |
readonly | The arrowhead applied to the start of the path. |
localDisplaySetting | DisplaySettingOptions: DisplaySettingOptions.HIGH_QUALITY DisplaySettingOptions.TYPICAL DisplaySettingOptions.OPTIMIZED DisplaySettingOptions.DEFAULT_VALUE |
readonly | Display performance options for the ListBox. |
locked | bool | readonly | If true, the ListBox is locked. |
miterLimit | number (range: 1 - 500) | readonly | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (default: 4) |
movieBehaviors | MovieBehaviors MovieBehavior | readonly | A collection of movie behavior objects. |
multipleSelection | bool | readonly | If true, the list box can have multiple items selected simultaneously in the exported PDF. |
name | string | readonly | The name of the ListBox. |
nonprinting | bool | readonly | If true, the ListBox does not print. |
openFileBehaviors | OpenFileBehaviors OpenFileBehavior | readonly | A collection of open file behavior objects. |
ovals | Ovals Oval | readonly | A collection of ellipses. |
overprintFill | bool | readonly | If true, the ListBox's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. |
overprintGap | bool | readonly | If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. |
overprintStroke | bool | readonly | If true, the ListBox's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. |
overridden | bool | readonly | If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page. |
overriddenMasterPageItem | Graphic Guide Movie PageItem Sound |
readonly | An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound. |
pageItems | PageItems PageItem | readonly | The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. |
parent | Character GraphicLine Group MasterSpread Oval PlaceGun Polygon Rectangle SplineItem Spread |
readonly | The parent of the ListBox (a PlaceGun, Character, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval or Group). |
parentPage | Page | readonly | The page on which this page item appears. |
pdfs | PDFs PDF | readonly | A collection of PDF files. |
picts | PICTs PICT | readonly | A collection of PICT graphics. |
polygons | Polygons Polygon | readonly | A collection of polygons. |
preferences | Preferences Preference | readonly | A collection of preferences objects. |
printFormBehaviors | PrintFormBehaviors PrintFormBehavior | readonly | A collection of print form behavior objects. |
printableInPdf | bool | readonly | If true, the form field/push button is printable in the exported PDF. |
properties | Object | r/w | A property that allows setting of several properties at the same time. |
readOnly | bool | readonly | If true, the form field is read only in the exported PDF. |
rectangles | Rectangles Rectangle | readonly | A collection of rectangles. |
required | bool | readonly | If true, the form field is required in the exported PDF. |
rightLineEnd | ArrowHead: ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD |
readonly | The arrowhead applied to the end of the path. |
rightToLeftField | bool | readonly | If true, the form field has right to left text enabled in the exported PDF. |
rotationAngle | number | readonly | The rotatation angle of the ListBox. (Range: -360 to 360) |
shearAngle | number | readonly | The skewing angle applied to the ListBox. (Range: -360 to 360) |
showHideFieldsBehaviors | ShowHideFieldsBehaviors ShowHideFieldsBehavior | readonly | A collection of show/hide fields behavior objects. |
sortChoices | bool | readonly | If true, the choices would be sorted in the exported PDF. |
soundBehaviors | SoundBehaviors SoundBehavior | readonly | A collection of sound behavior objects. |
splineItems | SplineItems SplineItem | readonly | The spline items collection. |
strokeAlignment | StrokeAlignment: StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT |
readonly | The stroke alignment applied to the ListBox. |
strokeColor | String Swatch |
readonly | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the ListBox. Can also accept: String. |
strokeCornerAdjustment | StrokeCornerAdjustment: StrokeCornerAdjustment.NONE StrokeCornerAdjustment.DASHES StrokeCornerAdjustment.GAPS StrokeCornerAdjustment.DASHES_AND_GAPS |
readonly | The corner adjustment applied to the ListBox. |
strokeDashAndGap | Array of Measurement Unit (Number or String) | readonly | The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3]. |
strokeTint | number | readonly | The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.) |
strokeType | String StrokeStyle |
readonly | The name of the stroke style to apply. Can also accept: String. |
strokeWeight | Measurement Unit (Number or String) | readonly | The weight (in points) to apply to the ListBox's stroke. |
submitFormBehaviors | SubmitFormBehaviors SubmitFormBehavior | readonly | A collection of submit form behavior objects. |
textFrames | TextFrames TextFrame | readonly | A collection of text frames. |
textWrapPreferences | TextWrapPreference | readonly | The text wrap preference properties that define the default formatting for wrapping text around objects. |
topLeftCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
readonly | The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight. |
topLeftCornerRadius | Measurement Unit (Number or String) | readonly | The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes |
topRightCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
readonly | The shape to apply to the top right corner of rectangular shapes |
topRightCornerRadius | Measurement Unit (Number or String) | readonly | The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes |
verticalLayoutConstraints |
Array
of DimensionsConstraints: DimensionsConstraints.FIXED_DIMENSION DimensionsConstraints.FLEXIBLE_DIMENSION |
readonly | The top margin, height, and bottom margin constraints this item is subject to when using the object-based layout rule. |
verticalScale | number | readonly | The vertical scaling applied to the ListBox. |
viewZoomBehaviors | ViewZoomBehaviors ViewZoomBehavior | readonly | A collection of view zoom behavior objects. |
visible | bool | r/w | If true, the ListBox is visible. |
visibleBounds | Array of Measurement Unit (Number or String) | readonly | The bounds of the ListBox including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box. |
wmfs | WMFs WMF | readonly | A collection of WMF graphics. |
Class
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
Parameter | Type | Description |
---|---|---|
eventType | string | The event type. |
handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
captures | bool | This parameter is obsolete. (Optional) (default: false) |
void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.
Array
of PageItem changeObject ([reverseOrder:
bool])
Finds objects that match the find what value and replace the objects with the change to value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
void clearTransformations ()
Clears transformations from the ListBox. Transformations include rotation, scaling, flipping, fitting, and shearing.
void convertShape (given:
ConvertShapeOptions[, numberOfSides:
number][, insetPercentage:
number][, cornerRadius:
Measurement Unit (Number or String)])
Converts the ListBox to a different shape.
Parameter | Type | Description |
---|---|---|
given | ConvertShapeOptions: ConvertShapeOptions.CONVERT_TO_RECTANGLE ConvertShapeOptions.CONVERT_TO_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_BEVELED_RECTANGLE ConvertShapeOptions.CONVERT_TO_INVERSE_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_OVAL ConvertShapeOptions.CONVERT_TO_TRIANGLE ConvertShapeOptions.CONVERT_TO_POLYGON ConvertShapeOptions.CONVERT_TO_LINE ConvertShapeOptions.CONVERT_TO_STRAIGHT_LINE ConvertShapeOptions.CONVERT_TO_OPEN_PATH ConvertShapeOptions.CONVERT_TO_CLOSED_PATH | The ListBox's new shape. |
numberOfSides | number (range: 3 - 100) | The number of sides for the resulting polygon. (Range: 3 to 100) (Optional) |
insetPercentage | number (range: 0 - 100) | The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional) |
cornerRadius | Measurement Unit (Number or String) (range: 0 - 800) | The corner radius of the resulting rectangle. (Optional) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
Parameter | Type | Description |
---|---|---|
key | string | The key. |
Array
of PageItem findObject ([reverseOrder:
bool])
Finds objects that match the find what value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
void fit (given:
FitOptions)
Applies the specified fit option to content in a frame.
Parameter | Type | Description |
---|---|---|
given | FitOptions: FitOptions.CONTENT_TO_FRAME FitOptions.CENTER_CONTENT FitOptions.PROPORTIONALLY FitOptions.FILL_PROPORTIONALLY FitOptions.APPLY_FRAME_FITTING_OPTIONS | The fit option to use. |
Array
of ListBox getElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
Parameter | Type | Description |
---|---|---|
key | string | The key. |
value | string | The value. |
void placeXML (using:
XMLElement)
Places XML content into the specified object. Note: Replaces any existing content.
Parameter | Type | Description |
---|---|---|
using | XMLElement | The XML element whose content you want to place. |
void redefineScaling ([to:
Array
of number])
Apply an item's scaling to its content if possible.
Parameter | Type | Description |
---|---|---|
to | Array of number | The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional) |
void reframe (in:
varies, opposingCorners:
Array
of varies)
Move the bounding box of the page item
Parameter | Type | Description |
---|---|---|
in | boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace:CoordinateSpaces | The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. |
opposingCorners | Array of any | Opposing corners of new bounding box in the given coordinate space |
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
Parameter | Type | Description |
---|---|---|
eventType | string | The registered event type. |
handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
captures | bool | This parameter is obsolete. (Optional) (default: false) |
void resize (in:
varies, from:
varies, by:
ResizeMethods, values:
Array
of varies[, resizeIndividually:
bool=true][, consideringRulerUnits:
bool=false])
Resize the page item.
Parameter | Type | Description |
---|---|---|
in | BoundingBoxLimits boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace:CoordinateSpaces | The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. |
from | AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers | The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. |
by | ResizeMethods: ResizeMethods.ADDING_CURRENT_DIMENSIONS_TO ResizeMethods.MULTIPLYING_CURRENT_DIMENSIONS_BY ResizeMethods.REPLACING_CURRENT_DIMENSIONS_WITH | How the current dimensions are affected by the given values |
values |
Array
of : Array of Reals CoordinateSpaces ResizeConstraints | The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators. |
resizeIndividually | bool | If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them. (Optional) (default: true) |
consideringRulerUnits | bool | If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false) |
any resolve (location:
varies, in:
CoordinateSpaces[, consideringRulerUnits:
bool=false])
Get the coordinates of the given location in the specified coordinate system.
Parameter | Type | Description |
---|---|---|
location | AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers | The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. |
in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES | The coordinate space to use. |
consideringRulerUnits | bool | If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the ListBox.
string toSpecifier ()
Retrieves the object specifier.
void transform (in:
CoordinateSpaces, from:
varies, withMatrix:
varies[, replacingCurrent:
varies][, consideringRulerUnits:
bool=false])
Transform the page item.
Parameter | Type | Description |
---|---|---|
in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES | The coordinate space to use |
from | AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers | The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers. |
withMatrix |
Array
of 6 Reals TransformationMatrix | Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix. |
replacingCurrent |
Array
of MatrixContent Long Integer MatrixContent | Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer. (Optional) |
consideringRulerUnits | bool | If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page. (Optional) (default: false) |
Array
of TransformationMatrix transformValuesOf (in:
CoordinateSpaces)
Get the transformation values of the page item.
Parameter | Type | Description |
---|---|---|
in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES | The coordinate space to use |
Used in:
ListBox ListBoxes.nextItem (obj: ListBox)
ListBox ListBoxes.previousItem (obj: ListBox)
Return
Array of ListBox ListBox.getElements ()
ListBox ListBoxes.[] (index: number)
ListBox ListBoxes.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
ListBox ListBoxes.anyItem ()
Array of ListBox ListBoxes.everyItem ()
ListBox ListBoxes.firstItem ()
ListBox ListBoxes.item (index: varies)
ListBox ListBoxes.itemByID (id: number)
ListBox ListBoxes.itemByName (name: string)
Array of ListBox ListBoxes.itemByRange (from: varies, to: varies)
ListBox ListBoxes.lastItem ()
ListBox ListBoxes.middleItem ()
ListBox ListBoxes.nextItem (obj: ListBox)
ListBox ListBoxes.previousItem (obj: ListBox)
Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |