Edit in GitHubLog an issue

TOCStyle

A TOC style definition.

Instance

Read Only

Number id

The unique ID of the TOCStyle.


Read Only

Boolean isValid

Returns true if the object specifier resolves to valid objects.


Read Only

Document parent

The parent of the TOCStyle (a Document).


Read Only

Number index

The index of the TOCStyle within its containing object.


Read Only

TOCStyleEntries tocStyleEntries

A collection TOC style entries.


Read Only

Events events

A collection of events.


Read Only

EventListeners eventListeners

A collection of event listeners.


ParagraphStyle titleStyle

The paragraph style applied to the TOC title.


String title

The TOC title.


String name

The name of the TOCStyle.


Boolean runIn

If true, the lowest-level TOC entries are placed on the same line as the previous entry.


Boolean includeHidden

If true, the TOC includes entries from text on hidden layers.


Boolean includeBookDocuments

If true, includes the entire book in the TOC. If false, includes only the TOC entries in the current document. Note: Valid when the current document is part of a book.


Boolean createBookmarks

If true, creates bookmarks for TOC entries.


HorizontalOrVertical setStoryDirection

The table of contents story direction.


NumberedParagraphsOptions numberedParagraphs

The format for importing numbered paragraphs into the TOC.


Boolean removeForcedLineBreak

If true, remove forced line breaks.


Boolean makeAnchor

If true, make text anchor in source paragraph.


String label

A property that can be set to any string.


Object properties

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

Methods

TOCStyle duplicate()

Duplicates the TOCStyle.


remove()

Deletes the TOCStyle.


insertLabel( String key, String value )

Sets the label to the value associated with the specified key.

Parameters

TypeNameDescription
String
key
The key.
String
value
The value.

String extractLabel( String key )

Gets the label value associated with the specified key.

Parameters

TypeNameDescription
String
key
The key.

String toSource()

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


TOCStyle getElements()

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


String toSpecifier()

Retrieves the object specifier.


EventListener addEventListener( String eventType, Mixed handler, Boolean captures )

Adds an event listener.

Parameters

TypeNameDescription
String
eventType
The event type.
Mixed
handler
The event handler. Can accept: File or JavaScript Function.
Boolean
captures
This parameter is obsolete. (Optional)

Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )

Removes the event listener.

Parameters

TypeNameDescription
String
eventType
The registered event type.
Mixed
handler
The registered event handler. Can accept: File or JavaScript Function.
Boolean
captures
This parameter is obsolete. (Optional)
Was this helpful?
  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2023 Adobe. All rights reserved.