Text Object - Nested Content

The following Text object commands and properties provide access to various kinds of content nested inside the text.

.tables v1.1

Returns an array of all Table objects that are contained in the text object. The tables are sorted by their order in the text. Read-only.

.imageAtIndex charIndex, [effectiveRange] v2.0

Returns an Image object for the inline image at the given character index. If the character is not an image, returns the @undefined value.

If provided, the given Range object will be modified so that upon returning it will specify the effective range of the returned image.

.listItemAtIndex charIndex, [effectiveRange] v2.1.2

This is a convenience command that operates just as ListItem.itemInTextAtIndex.

.listItemInParagraphAtIndex charIndex, [effectiveRange] v2.1.2

This is a convenience command that operates just as ListItem.itemInTextInParagraphAtIndex.

.noteAtIndex charIndex, [effectiveRange] v1.1

If a note (eg: footnote) exists at the given character index, this command returns a Note object representing that note. If the character index does not fall on a note reference (as found in the main document body) or note text (held in the note area), this command returns the @undefined value.

If provided, the given Range object will be modified so that upon returning it will specify the effective range of the returned note.

.linkAtIndex charIndex, [effectiveRange] v2.0.5

If a link exists at the given character index, this command returns a Link object representing that hyperlink. If the character index does not fall on a link, this command returns the @undefined value.

If provided, the given Range object will be modified so that upon returning it will specify the effective range of the returned link.

.bookmarksAtIndex charIndex v2.0.5

This command returns an array of all Bookmark objects applied to the character at the given character index. If no bookmarks are applied, the @undefined value is returned.

.crossReferenceAtIndex charIndex v2.0.5

This command the CrossReference objects applied at the given character index. If no cross-reference exists there, the @undefined value is returned.

.commentsAtIndex charIndex v2.0

This command returns an array of all Comment objects applied to the character at the given character index. If no comments are applied, the @undefined value is returned.

.trackedChangesAtIndex charIndex v2.0

This command returns an array of all TrackedChange objects applied to the character at the given character index. If no changes are applied, the @undefined value is returned.

.floatingContentsAtIndex charIndex v2.0

This command returns an array of all FloatingContent objects anchored to the character at the given character index. Each floating content is considered to be anchored to the entire paragraph, so inspecting any character within the same paragraph will yield the same array. If no floating contents are anchored, the @undefined value is returned.