Adobe InCopy CS5 (7.0) Object Model JS: MatchCharacterStylePreference

InCopy CS5

Class

MatchCharacterStylePreference

 The preferences for a running header/footer (match character style) variable. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

TextVariable
Preference
MatchCharacterStylePreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
appliedCharacterStyleCharacterStyleString r/wThe character style applied to the text. Can also accept: String.
changeCaseChangeCaseOptions:
ChangeCaseOptions.NONE
ChangeCaseOptions.UPPERCASE
ChangeCaseOptions.LOWERCASE
ChangeCaseOptions.TITLECASE
ChangeCaseOptions.SENTENCECASE
r/wThe case of the matched text.
deleteEndPunctuationbool r/wIf true, deletes end punctuation from the matched text.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentTextVariable readonlyThe parent of the MatchCharacterStylePreference (a TextVariable).
propertiesObject r/wA property that allows setting of several properties at the same time.
searchStrategySearchStrategies:
SearchStrategies.FIRST_ON_PAGE
SearchStrategies.LAST_ON_PAGE
r/wThe starting point and direction in which the search will be conducted.
textAfterstring r/wThe text that follows the value of the variable. (Limit: 128 characters)
textBeforestring r/wThe text that precedes the value of the variable. (Limit: 128 characters)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

TextVariable.variableOptions

Return

Array of MatchCharacterStylePreference MatchCharacterStylePreference.getElements ()

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