LegacyTextItem
LegacyTextItem
Section titled “LegacyTextItem”legacyTextItems[index]
Description
Section titled “Description”A text object created in Illustrator CS (version 10) or earlier, which is uneditable until converted. To convert legacy text, see LegacyTextItems.convertToNative().
You can view, move, and print legacy text, but you cant edit it. Legacy text has an “x” through its bounding box when selected.
Properties
Section titled “Properties”LegacyTextItem.artworkKnockout
Section titled “LegacyTextItem.artworkKnockout”legacyTextItems[index].artworkKnockout
Description
Section titled “Description”Is this object used to create a knockout, and if so, what kind of knockout.
LegacyTextItem.blendingMode
Section titled “LegacyTextItem.blendingMode”legacyTextItems[index].blendingMode
Description
Section titled “Description”The blend mode used when compositing an object.
LegacyTextItem.controlBounds
Section titled “LegacyTextItem.controlBounds”legacyTextItems[index].controlBounds
Description
Section titled “Description”The bounds of the object including stroke width and controls.
Array of 4 numbers; read-only.
LegacyTextItem.converted
Section titled “LegacyTextItem.converted”legacyTextItems[index].converted
Description
Section titled “Description”If true, the legacy text item has been updated to a native text frame item.
Boolean; read-only.
LegacyTextItem.editable
Section titled “LegacyTextItem.editable”legacyTextItems[index].editable
Description
Section titled “Description”If true, this item is editable.
Boolean; read-only.
LegacyTextItem.geometricBounds
Section titled “LegacyTextItem.geometricBounds”legacyTextItems[index].geometricBounds
Description
Section titled “Description”The bounds of the object excluding stroke width.
Array of 4 numbers; read-only.
LegacyTextItem.height
Section titled “LegacyTextItem.height”legacyTextItems[index].height
Description
Section titled “Description”The height of the group item.
Number (double).
LegacyTextItem.hidden
Section titled “LegacyTextItem.hidden”legacyTextItems[index].hidden
Description
Section titled “Description”If true, this item is hidden.
Boolean.
LegacyTextItem.isIsolated
Section titled “LegacyTextItem.isIsolated”legacyTextItems[index].isIsolated
Description
Section titled “Description”If true, this object is isolated.
Boolean.
LegacyTextItem.layer
Section titled “LegacyTextItem.layer”legacyTextItems[index].layer
Description
Section titled “Description”The layer to which this item belongs.
Layer; read-only.
LegacyTextItem.left
Section titled “LegacyTextItem.left”legacyTextItems[index].left
Description
Section titled “Description”The position of the left side of the item (in points, measured from the left side of the page).
Number (double).
LegacyTextItem.locked
Section titled “LegacyTextItem.locked”legacyTextItems[index].locked
Description
Section titled “Description”If true, this item is locked.
Boolean.
LegacyTextItem.name
Section titled “LegacyTextItem.name”legacyTextItems[index].name
Description
Section titled “Description”The name of this item.
String.
LegacyTextItem.note
Section titled “LegacyTextItem.note”legacyTextItems[index].note
Description
Section titled “Description”The note assigned to this item.
String.
LegacyTextItem.opacity
Section titled “LegacyTextItem.opacity”legacyTextItems[index].opacity
Description
Section titled “Description”The opacity of the object.
Range: 0.0 to 100.0.
Number (double).
LegacyTextItem.parent
Section titled “LegacyTextItem.parent”legacyTextItems[index].parent
Description
Section titled “Description”The parent of this object.
Layer or GroupItem; read-only.
LegacyTextItem.position
Section titled “LegacyTextItem.position”legacyTextItems[index].position
Description
Section titled “Description”The position (in points) of the top left corner of the legacyTextItems[index] object in the format [x, y]. Does not include stroke weight.
Array of 2 numbers.
LegacyTextItem.selected
Section titled “LegacyTextItem.selected”legacyTextItems[index].selected
Description
Section titled “Description”If true, this item is selected.
Boolean.
LegacyTextItem.sliced
Section titled “LegacyTextItem.sliced”legacyTextItems[index].sliced
Description
Section titled “Description”If true, the item sliced.
Default: false.
Boolean.
LegacyTextItem.tags
Section titled “LegacyTextItem.tags”legacyTextItems[index].tags
Description
Section titled “Description”The tags contained in this item.
Tags; read-only.
LegacyTextItem.top
Section titled “LegacyTextItem.top”legacyTextItems[index].top
Description
Section titled “Description”The position of the top of the item (in points, measured from the bottom of the page).
Number (double).
LegacyTextItem.typename
Section titled “LegacyTextItem.typename”legacyTextItems[index].typename
Description
Section titled “Description”The class name of the referenced object.
String; read-only.
LegacyTextItem.uRL
Section titled “LegacyTextItem.uRL”legacyTextItems[index].uRL
Description
Section titled “Description”The value of the Adobe URL tag assigned to this item.
String.
LegacyTextItem.visibilityVariable
Section titled “LegacyTextItem.visibilityVariable”legacyTextItems[index].visibilityVariable
Description
Section titled “Description”The visibility variable bound to the item.
LegacyTextItem.visibleBounds
Section titled “LegacyTextItem.visibleBounds”legacyTextItems[index].visibleBounds
Description
Section titled “Description”The visible bounds of the item including stroke width.
Array of 4 numbers; read-only.
LegacyTextItem.width
Section titled “LegacyTextItem.width”legacyTextItems[index].width
Description
Section titled “Description”The width of the item.
Number (double).
LegacyTextItem.wrapInside
Section titled “LegacyTextItem.wrapInside”legacyTextItems[index].wrapInside
Description
Section titled “Description”If true, the text frame object should be wrapped inside this object.
Boolean.
LegacyTextItem.wrapOffset
Section titled “LegacyTextItem.wrapOffset”legacyTextItems[index].wrapOffset
Description
Section titled “Description”The offset to use when wrapping text around this object.
Number (double).
LegacyTextItem.wrapped
Section titled “LegacyTextItem.wrapped”legacyTextItems[index].wrapped
Description
Section titled “Description”If true, wrap text frame objects around this object (text frame must be above the object).
Boolean.
LegacyTextItem.zOrderPosition
Section titled “LegacyTextItem.zOrderPosition”legacyTextItems[index].zOrderPosition
Description
Section titled “Description”The position of this item within the stacking order of the group or layer (parent) that contains the item.
Number (long); read-only.
Methods
Section titled “Methods”LegacyTextItem.convertToNative()
Section titled “LegacyTextItem.convertToNative()”legacyTextItems[index].convertToNative()
Description
Section titled “Description”Converts the legacy text item to a text frame and deletes the original legacy text.
Returns
Section titled “Returns”LegacyTextItem.duplicate()
Section titled “LegacyTextItem.duplicate()”legacyTextItems[index].duplicate( [relativeObject] [,insertionLocation])Description
Section titled “Description”Creates a duplicate of the selected object.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
relativeObject | Object, optional | Object to duplicate to |
insertionLocation | ElementPlacement, optional | Location to insert element |
Returns
Section titled “Returns”LegacyTextItem.move()
Section titled “LegacyTextItem.move()”legacyTextItems[index].move(relativeObject, insertionLocation)
Description
Section titled “Description”Moves the object.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
relativeObject | Object | Object to move element within |
insertionLocation | ElementPlacement, optional | Location to move element to |
Returns
Section titled “Returns”LegacyTextItem.remove()
Section titled “LegacyTextItem.remove()”legacyTextItems[index].remove()
Description
Section titled “Description”Deletes this object.
Returns
Section titled “Returns”Nothing.
LegacyTextItem.resize()
Section titled “LegacyTextItem.resize()”legacyTextItem.resize( scaleX, scaleY [,changePositions] [,changeFillPatterns] [,changeFillGradients] [,changeStrokePattern] [,changeLineWidths] [,scaleAbout])Description
Section titled “Description”Scales the art item where scaleX is the horizontal scaling factor and scaleY is the vertical scaling factor. 100.0 = 100%.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
scaleX | Number (double) | Horizontal scaling factor |
scaleY | Number (double) | Vertical scaling factor |
changePositions | Boolean, optional | Whether to effect art object positions and orientations |
changeFillPatterns | Boolean, optional | Whether to transform fill patterns |
changeFillGradients | Boolean, optional | Whether to transform fill gradients |
changeStrokePattern | Boolean, optional | Whether to transform stroke patterns |
changeLineWidths | Number (double), optional | The amount to scale line widths |
scaleAbout | Transformation, optional | The point to use as anchor, to transform about |
Returns
Section titled “Returns”Nothing.
LegacyTextItem.rotate()
Section titled “LegacyTextItem.rotate()”legacyTextItem.rotate( angle [,changePositions] [,changeFillPatterns] [,changeFillGradients] [,changeStrokePattern] [,rotateAbout])Description
Section titled “Description”Rotates the art item relative to the current rotation. The object is rotated counter-clockwise if the angle value is positive, clockwise if the value is negative.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
angle | Number (double) | The angle amount to rotate the element |
changePositions | Boolean, optional | Whether to effect art object positions and orientations |
changeFillPatterns | Boolean, optional | Whether to transform fill patterns |
changeFillGradients | Boolean, optional | Whether to transform fill gradients |
changeStrokePattern | Boolean, optional | Whether to transform stroke patterns |
rotateAbout | Transformation, optional | The point to use as anchor, to transform about |
Returns
Section titled “Returns”Nothing.
LegacyTextItem.transform()
Section titled “LegacyTextItem.transform()”legacyTextItem.transform( transformationMatrix [,changePositions] [,changeFillPatterns] [,changeFillGradients] [,changeStrokePattern] [,changeLineWidths] [,transformAbout])Description
Section titled “Description”Transforms the art item by applying a transformation matrix.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
transformationMatrix | Matrix | Transformation matrix to apply |
changePositions | Boolean, optional | Whether to change Positions |
changeFillPatterns | Boolean, optional | Whether to change Fill Patterns |
changeFillGradients | Boolean, optional | Whether to change Fill Gradients |
changeStrokePattern | Boolean, optional | Whether to change Stroke Pattern |
changeLineWidths | Number (double), optional | The amount to scale line widths |
transformAbout | Transformation, optional | The point to use as anchor, to transform about |
Returns
Section titled “Returns”Nothing.
LegacyTextItem.translate()
Section titled “LegacyTextItem.translate()”legacyTextItem.translate( [deltaX] [,deltaY] [,transformObjects] [,transformFillPatterns] [,transformFillGradients] [,transformStrokePatterns])Description
Section titled “Description”Repositions the art item relative to the current position, where deltaX is the horizontal offset and deltaY is the vertical offset.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
deltaX | Number (double), optional | Horizontal offset |
deltaY | Number (double), optional | Vertical offset |
transformObjects | Boolean, optional | Whether to transform Objects |
transformFillPatterns | Boolean, optional | Whether to transform Fill Patterns |
transformFillGradients | Boolean, optional | Whether to transform Fill Gradients |
transformStrokePatterns | Boolean, optional | Whether to transform Stroke Patterns |
Returns
Section titled “Returns”Nothing.
LegacyTextItem.zOrder()
Section titled “LegacyTextItem.zOrder()”legacyTextItems[index].zOrder(zOrderCmd)
Description
Section titled “Description”Arranges the art item’s position in the stacking order of the group or layer (parent) of this object.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
zOrderCmd | ZOrderMethod | Stacking order arrangement method |
Returns
Section titled “Returns”Nothing.