MatchCharacterStylePreference

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

Methods:

getElements, toSource, toSpecifier

Objects:

Boolean, ChangeCaseOptions, CharacterStyle, 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.

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

MatchCharacterStylePreference getElements ()

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

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

TextVariable.variableOptions

Return

MatchCharacterStylePreference.getElements()