Adobe InDesign CS5.5 Server (7.5) Object Model JS: StrokeStyle

InDesign Server CS5.5

Class

StrokeStyle

 

A stroke style.

Superclass of DashedStrokeStyle, DottedStrokeStyle, and StripedStrokeStyle

QuickLinks

addEventListener, duplicate, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
StrokeStyle
DashedStrokeStyle | DottedStrokeStyle | StripedStrokeStyle
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the StrokeStyle.
indexnumber readonlyThe index of the StrokeStyle within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring r/wThe name of the StrokeStyle.
parentApplicationDocument readonlyThe parent of the StrokeStyle (a Document or Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
strokeStyleTypestring readonlyThe stroke style type.

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)

StrokeStyle duplicate ()
Duplicates the StrokeStyle.

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

void remove ([replacingWith: varies])
Deletes the stroke style.

ParameterTypeDescription
replacingWithString
StrokeStyle
The stroke style to apply in place of the deleted style. . Can accept: StrokeStyle or String. (Optional)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Button.strokeType

Cell.bottomEdgeStrokeType

Cell.diagonalLineStrokeType

Cell.innerColumnStrokeType

Cell.innerRowStrokeType

Cell.leftEdgeStrokeType

Cell.rightEdgeStrokeType

Cell.topEdgeStrokeType

CellStyle.bottomEdgeStrokeType

CellStyle.diagonalLineStrokeType

CellStyle.leftEdgeStrokeType

CellStyle.rightEdgeStrokeType

CellStyle.topEdgeStrokeType

ChangeGrepPreference.strikeThroughType

ChangeGrepPreference.underlineType

ChangeObjectPreference.strokeType

ChangeTextPreference.strikeThroughType

ChangeTextPreference.underlineType

ChangeTransliteratePreference.strikeThroughType

ChangeTransliteratePreference.underlineType

Character.ruleAboveType

Character.ruleBelowType

Character.strikeThroughType

Character.underlineType

CharacterStyle.strikeThroughType

CharacterStyle.underlineType

Column.bottomEdgeStrokeType

Column.diagonalLineStrokeType

Column.innerColumnStrokeType

Column.innerRowStrokeType

Column.leftEdgeStrokeType

Column.rightEdgeStrokeType

Column.topEdgeStrokeType

EPS.strokeType

EPSText.strokeType

FindGrepPreference.strikeThroughType

FindGrepPreference.underlineType

FindObjectPreference.strokeType

FindTextPreference.strikeThroughType

FindTextPreference.underlineType

FindTransliteratePreference.strikeThroughType

FindTransliteratePreference.underlineType

FootnoteOption.continuingRuleType

FootnoteOption.ruleType

FormField.strokeType

Graphic.strokeType

GraphicLine.strokeType

Group.strokeType

Image.strokeType

ImportedPage.strokeType

InsertionPoint.ruleAboveType

InsertionPoint.ruleBelowType

InsertionPoint.strikeThroughType

InsertionPoint.underlineType

Line.ruleAboveType

Line.ruleBelowType

Line.strikeThroughType

Line.underlineType

MediaItem.strokeType

Movie.strokeType

MultiStateObject.strokeType

ObjectStyle.strokeType

Oval.strokeType

PDF.strokeType

PICT.strokeType

PageItem.strokeType

PageItemDefault.strokeType

Paragraph.ruleAboveType

Paragraph.ruleBelowType

Paragraph.strikeThroughType

Paragraph.underlineType

ParagraphStyle.ruleAboveType

ParagraphStyle.ruleBelowType

ParagraphStyle.strikeThroughType

ParagraphStyle.underlineType

Polygon.strokeType

Rectangle.strokeType

Row.bottomEdgeStrokeType

Row.diagonalLineStrokeType

Row.innerColumnStrokeType

Row.innerRowStrokeType

Row.leftEdgeStrokeType

Row.rightEdgeStrokeType

Row.topEdgeStrokeType

Sound.strokeType

SplineItem.strokeType

Story.ruleAboveType

Story.ruleBelowType

Story.strikeThroughType

Story.underlineType

Table.bottomBorderStrokeType

Table.endColumnLineStyle

Table.endRowStrokeType

Table.leftBorderStrokeType

Table.rightBorderStrokeType

Table.startColumnStrokeType

Table.startRowStrokeType

Table.topBorderStrokeType

TableStyle.bottomBorderStrokeType

TableStyle.endColumnLineStyle

TableStyle.endRowStrokeType

TableStyle.leftBorderStrokeType

TableStyle.rightBorderStrokeType

TableStyle.startColumnStrokeType

TableStyle.startRowStrokeType

TableStyle.topBorderStrokeType

Text.ruleAboveType

Text.ruleBelowType

Text.strikeThroughType

Text.underlineType

TextColumn.ruleAboveType

TextColumn.ruleBelowType

TextColumn.strikeThroughType

TextColumn.underlineType

TextDefault.ruleAboveType

TextDefault.ruleBelowType

TextDefault.strikeThroughType

TextDefault.underlineType

TextFrame.strokeType

TextStyleRange.ruleAboveType

TextStyleRange.ruleBelowType

TextStyleRange.strikeThroughType

TextStyleRange.underlineType

WMF.strokeType

Word.ruleAboveType

Word.ruleBelowType

Word.strikeThroughType

Word.underlineType

XmlStory.ruleAboveType

XmlStory.ruleBelowType

XmlStory.strikeThroughType

XmlStory.underlineType

Used in:

void Application.exportStrokeStyles (to: File, strokeStyleList: Array of StrokeStyle[, versionComments: string][, forceSave: bool=false])

void Document.exportStrokeStyles (to: File, strokeStyleList: Array of StrokeStyle[, versionComments: string][, forceSave: bool=false])

StrokeStyle StrokeStyles.nextItem (obj: StrokeStyle)

StrokeStyle StrokeStyles.previousItem (obj: StrokeStyle)

Return

StrokeStyle StrokeStyle.duplicate ()

Array of StrokeStyle StrokeStyle.getElements ()

StrokeStyle StrokeStyles.[] (index: number)

StrokeStyle StrokeStyles.anyItem ()

Array of StrokeStyle StrokeStyles.everyItem ()

StrokeStyle StrokeStyles.firstItem ()

StrokeStyle StrokeStyles.item (index: varies)

StrokeStyle StrokeStyles.itemByID (id: number)

StrokeStyle StrokeStyles.itemByName (name: string)

Array of StrokeStyle StrokeStyles.itemByRange (from: varies, to: varies)

StrokeStyle StrokeStyles.lastItem ()

StrokeStyle StrokeStyles.middleItem ()

StrokeStyle StrokeStyles.nextItem (obj: StrokeStyle)

StrokeStyle StrokeStyles.previousItem (obj: StrokeStyle)

Jongware, 28-Apr-2012 v3.0.3iContents :: Index