MatchCharacterStylePreference

The preferences for a running header/footer (match character style) variable.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, ChangeCaseOptions, CharacterStyle, EventListeners, Events, Object, SearchStrategies, String,

Hierarchy:

Superclass: Preference

Class: MatchCharacterStylePreference

Property Listing

Property

Type

Access

Description

appliedCharacterStyle

CharacterStyle

String

read/write

The character style applied to the text. Can also accept: String.

changeCase

ChangeCaseOptions

ChangeCaseOptions.LOWERCASE

ChangeCaseOptions.NONE

ChangeCaseOptions.SENTENCECASE

ChangeCaseOptions.TITLECASE

ChangeCaseOptions.UPPERCASE

read/write

The case of the matched text.

deleteEndPunctuation

Boolean

read/write

If true, deletes end punctuation from the matched text.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

TextVariable

readonly

The parent of the MatchCharacterStylePreference (a TextVariable).

properties

Object

read/write

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

searchStrategy

SearchStrategies

SearchStrategies.FIRST_ON_PAGE

SearchStrategies.LAST_ON_PAGE

read/write

The starting point and direction in which the search will be conducted.

textAfter

String

read/write

The text that follows the value of the variable. (Limit: 128 characters)

textBefore

String

read/write

The text that precedes the value of the variable. (Limit: 128 characters)

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)

MatchCharacterStylePreference getElements ()

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

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Event.parent

EventListener.parent

MutationEvent.parent

TextVariable.variableOptions

Return

MatchCharacterStylePreference.getElements()