EndnoteRange

An endnote text range.

Methods:

addEventListener, deleteEndnoteRange, extractLabel, getElements, insertLabel, removeEventListener, toSource, toSpecifier

Objects:

Boolean, Endnote, EventListeners, Events, Number, Object, SpecialCharacters, String,

Property Listing

Property

Type

Access

Description

endnoteRangeContent

SpecialCharacters

SpecialCharacters.ARABIC_COMMA

SpecialCharacters.ARABIC_KASHIDA

SpecialCharacters.ARABIC_QUESTION_MARK

SpecialCharacters.ARABIC_SEMICOLON

SpecialCharacters.AUTO_PAGE_NUMBER

SpecialCharacters.BULLET_CHARACTER

SpecialCharacters.COLUMN_BREAK

SpecialCharacters.COPYRIGHT_SYMBOL

SpecialCharacters.DEGREE_SYMBOL

SpecialCharacters.DISCRETIONARY_HYPHEN

SpecialCharacters.DISCRETIONARY_LINE_BREAK

SpecialCharacters.DOTTED_CIRCLE

SpecialCharacters.DOUBLE_LEFT_QUOTE

SpecialCharacters.DOUBLE_RIGHT_QUOTE

SpecialCharacters.DOUBLE_STRAIGHT_QUOTE

SpecialCharacters.ELLIPSIS_CHARACTER

SpecialCharacters.EM_DASH

SpecialCharacters.EM_SPACE

SpecialCharacters.END_NESTED_STYLE

SpecialCharacters.EN_DASH

SpecialCharacters.EN_SPACE

SpecialCharacters.EVEN_PAGE_BREAK

SpecialCharacters.FIGURE_SPACE

SpecialCharacters.FIXED_WIDTH_NONBREAKING_SPACE

SpecialCharacters.FLUSH_SPACE

SpecialCharacters.FOOTNOTE_SYMBOL

SpecialCharacters.FORCED_LINE_BREAK

SpecialCharacters.FRAME_BREAK

SpecialCharacters.HAIR_SPACE

SpecialCharacters.HEBREW_GERESH

SpecialCharacters.HEBREW_GERSHAYIM

SpecialCharacters.HEBREW_MAQAF

SpecialCharacters.HEBREW_SOF_PASUK

SpecialCharacters.INDENT_HERE_TAB

SpecialCharacters.LEFT_TO_RIGHT_EMBEDDING

SpecialCharacters.LEFT_TO_RIGHT_MARK

SpecialCharacters.LEFT_TO_RIGHT_OVERRIDE

SpecialCharacters.NEXT_PAGE_NUMBER

SpecialCharacters.NONBREAKING_HYPHEN

SpecialCharacters.NONBREAKING_SPACE

SpecialCharacters.ODD_PAGE_BREAK

SpecialCharacters.PAGE_BREAK

SpecialCharacters.PARAGRAPH_SYMBOL

SpecialCharacters.POP_DIRECTIONAL_FORMATTING

SpecialCharacters.PREVIOUS_PAGE_NUMBER

SpecialCharacters.PUNCTUATION_SPACE

SpecialCharacters.QUARTER_SPACE

SpecialCharacters.REGISTERED_TRADEMARK

SpecialCharacters.RIGHT_INDENT_TAB

SpecialCharacters.RIGHT_TO_LEFT_EMBEDDING

SpecialCharacters.RIGHT_TO_LEFT_MARK

SpecialCharacters.RIGHT_TO_LEFT_OVERRIDE

SpecialCharacters.SECTION_MARKER

SpecialCharacters.SECTION_SYMBOL

SpecialCharacters.SINGLE_LEFT_QUOTE

SpecialCharacters.SINGLE_RIGHT_QUOTE

SpecialCharacters.SINGLE_STRAIGHT_QUOTE

SpecialCharacters.SIXTH_SPACE

SpecialCharacters.TEXT_VARIABLE

SpecialCharacters.THIN_SPACE

SpecialCharacters.THIRD_SPACE

SpecialCharacters.TRADEMARK_SYMBOL

SpecialCharacters.ZERO_WIDTH_JOINER

SpecialCharacters.ZERO_WIDTH_NONJOINER

String

Array of Strings String

NothingEnums NothingEnum

SpecialCharactersCanalsoaccept:NothingEnum

read/write

EndnoteRange Contents, It will skip the endnote number while setting/replacing the content into endnote range. Can return: String, SpecialCharacters enumerator or Array of Strings or SpecialCharacters enumerators. Can also accept: NothingEnum enumerator or Array of Strings, SpecialCharacters enumerators or NothingEnum enumerators.

endnoteRangeEndIndex

Number

readonly

Ending Index of the endnote range object.

endnoteRangeStartIndex

Number

readonly

Starting Index of the endnote range object.

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

index

Number

readonly

The index of the EndnoteRange within its containing object.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

name

String

read/write

The name of the EndnoteRange; this is an alias to the EndnoteRange's label property.

parent

Character

InsertionPoint

Line

Paragraph

Story

TextColumn

TextStyleRange

Word

Text

XmlStory

readonly

The parent of the EndnoteRange (a Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story or XmlStory).

properties

Object

read/write

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

sourceEndnote

Endnote

read/write

The endnote reference corresponding to the endnote text range.

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)

undefined deleteEndnoteRange ()

Deletes the endnote range and the associated endnote anchor.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

EndnoteRange getElements ()

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

undefined insertLabel (key:String, value:String)

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

Parameter

Type

Description

key

String

The key.

value

String

The value.

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Endnote.endnoteTextRange

Event.parent

EventListener.parent

MutationEvent.parent

Return

EndnoteRange.getElements()

EndnoteRanges.anyItem()

EndnoteRanges.everyItem()

EndnoteRanges.nextItem()

EndnoteRanges.previousItem()

EndnoteRanges.itemByID()

EndnoteRanges.item()

EndnoteRanges.[]()

EndnoteRanges.itemByName()

EndnoteRanges.itemByRange()

EndnoteRanges.firstItem()

EndnoteRanges.lastItem()

EndnoteRanges.middleItem()