StrokeStyle

A stroke style.

Methods:

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

Objects:

Boolean, EventListeners, Events, Number, Object, String

Hierarchy:

Class: StrokeStyle

Subclasses: DashedStrokeStyle | DottedStrokeStyle | StripedStrokeStyle

Property Listing

Property

Type

Access

Description

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

id

Number

readonly

The unique ID of the StrokeStyle.

index

Number

readonly

The index of the StrokeStyle within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

name

String

read/write

The name of the StrokeStyle.

parent

Application

Document

readonly

The parent of the StrokeStyle (a Document or Application).

properties

Object

read/write

A property that allows setting of several properties at the same time.

strokeStyleType

String

readonly

The stroke style type.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

StrokeStyle duplicate ()

Duplicates the StrokeStyle.

StrokeStyle getElements ()

Resolves the object specifier, creating an array of object references.

undefined remove (replacingWith:Varies StrokeStyle String)

Deletes the stroke style.

Parameter

Type

Description

replacingWith

StrokeStyle

String

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

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the StrokeStyle.

String toSpecifier ()

Retrieves the object specifier.

Object of

TextFramePreference.columnRuleStrokeType

FormField.strokeType

Button.strokeType

MultiStateObject.strokeType

CheckBox.strokeType

ComboBox.strokeType

ListBox.strokeType

RadioButton.strokeType

TextBox.strokeType

SignatureField.strokeType

Movie.strokeType

Sound.strokeType

PageItem.strokeType

Oval.strokeType

Rectangle.strokeType

GraphicLine.strokeType

Polygon.strokeType

Group.strokeType

Image.strokeType

EPS.strokeType

PDF.strokeType

WMF.strokeType

PICT.strokeType

Graphic.strokeType

SplineItem.strokeType

EPSText.strokeType

ImportedPage.strokeType

SVG.strokeType

MediaItem.strokeType

HtmlItem.strokeType

ObjectStyle.strokeType

PageItemDefault.strokeType

TextFrame.strokeType

EndnoteTextFrame.strokeType

FindObjectPreference.strokeType

ChangeObjectPreference.strokeType

Event.parent

EventListener.parent

MutationEvent.parent

Table.startColumnStrokeType

TableStyle.startColumnStrokeType

Table.endColumnLineStyle

TableStyle.endColumnLineStyle

Table.startRowStrokeType

TableStyle.startRowStrokeType

Table.endRowStrokeType

TableStyle.endRowStrokeType

Table.bottomBorderStrokeType

TableStyle.bottomBorderStrokeType

Cell.bottomEdgeStrokeType

Column.bottomEdgeStrokeType

Row.bottomEdgeStrokeType

CellStyle.bottomEdgeStrokeType

Cell.diagonalLineStrokeType

Column.diagonalLineStrokeType

Row.diagonalLineStrokeType

CellStyle.diagonalLineStrokeType

Cell.innerColumnStrokeType

Column.innerColumnStrokeType

Row.innerColumnStrokeType

Cell.innerRowStrokeType

Column.innerRowStrokeType

Row.innerRowStrokeType

Table.leftBorderStrokeType

TableStyle.leftBorderStrokeType

Cell.leftEdgeStrokeType

Column.leftEdgeStrokeType

Row.leftEdgeStrokeType

CellStyle.leftEdgeStrokeType

Table.rightBorderStrokeType

TableStyle.rightBorderStrokeType

Cell.rightEdgeStrokeType

Column.rightEdgeStrokeType

Row.rightEdgeStrokeType

CellStyle.rightEdgeStrokeType

FootnoteOption.continuingRuleType

FootnoteOption.ruleType

TextDefault.ruleAboveType

Text.ruleAboveType

Character.ruleAboveType

Word.ruleAboveType

Line.ruleAboveType

TextColumn.ruleAboveType

Paragraph.ruleAboveType

TextStyleRange.ruleAboveType

InsertionPoint.ruleAboveType

Story.ruleAboveType

ParagraphStyle.ruleAboveType

XmlStory.ruleAboveType

TextDefault.ruleBelowType

Text.ruleBelowType

Character.ruleBelowType

Word.ruleBelowType

Line.ruleBelowType

TextColumn.ruleBelowType

Paragraph.ruleBelowType

TextStyleRange.ruleBelowType

InsertionPoint.ruleBelowType

Story.ruleBelowType

ParagraphStyle.ruleBelowType

XmlStory.ruleBelowType

TextDefault.strikeThroughType

Text.strikeThroughType

Character.strikeThroughType

Word.strikeThroughType

Line.strikeThroughType

TextColumn.strikeThroughType

Paragraph.strikeThroughType

TextStyleRange.strikeThroughType

InsertionPoint.strikeThroughType

Story.strikeThroughType

ParagraphStyle.strikeThroughType

XmlStory.strikeThroughType

FindTextPreference.strikeThroughType

FindGrepPreference.strikeThroughType

FindTransliteratePreference.strikeThroughType

ChangeTextPreference.strikeThroughType

ChangeGrepPreference.strikeThroughType

ChangeTransliteratePreference.strikeThroughType

CharacterStyle.strikeThroughType

Table.topBorderStrokeType

TableStyle.topBorderStrokeType

Cell.topEdgeStrokeType

Column.topEdgeStrokeType

Row.topEdgeStrokeType

CellStyle.topEdgeStrokeType

TextDefault.underlineType

Text.underlineType

Character.underlineType

Word.underlineType

Line.underlineType

TextColumn.underlineType

Paragraph.underlineType

TextStyleRange.underlineType

InsertionPoint.underlineType

Story.underlineType

ParagraphStyle.underlineType

XmlStory.underlineType

FindTextPreference.underlineType

FindGrepPreference.underlineType

FindTransliteratePreference.underlineType

ChangeTextPreference.underlineType

ChangeGrepPreference.underlineType

ChangeTransliteratePreference.underlineType

CharacterStyle.underlineType

TextDefault.paragraphBorderType

Text.paragraphBorderType

Character.paragraphBorderType

Word.paragraphBorderType

Line.paragraphBorderType

TextColumn.paragraphBorderType

Paragraph.paragraphBorderType

TextStyleRange.paragraphBorderType

InsertionPoint.paragraphBorderType

Story.paragraphBorderType

ParagraphStyle.paragraphBorderType

XmlStory.paragraphBorderType

Return

StrokeStyle.duplicate()

StrokeStyle.getElements()

StrokeStyles.anyItem()

StrokeStyles.everyItem()

StrokeStyles.nextItem()

StrokeStyles.previousItem()

StrokeStyles.itemByID()

StrokeStyles.item()

StrokeStyles.[]()

StrokeStyles.itemByName()

StrokeStyles.itemByRange()

StrokeStyles.firstItem()

StrokeStyles.lastItem()

StrokeStyles.middleItem()