Selection API in Angular DocumentEditor API component

Selection

Properties

bookmarks string[]

Gets bookmark name collection.

cellFormat SelectionCellFormat

Gets the instance of selection cell format.

characterFormat SelectionCharacterFormat

Gets the instance of selection character format.

contextType string

Gets the context type of the selection.

endOffset string

Returns end hierarchical index.

endPage number

Gets the page number where the selection ends.

imageFormat SelectionImageFormat

Gets the instance of selection image format.

isInField boolean

Returns true if selection is in field

paragraphFormat SelectionParagraphFormat

Gets the instance of selection paragraph format.

rowFormat SelectionRowFormat

Gets the instance of selection row format.

sectionFormat SelectionSectionFormat

Gets the instance of selection section format.

startOffset string

Returns start hierarchical index.

startPage number

Gets the page number where the selection ends.

tableFormat SelectionTableFormat

Gets the instance of selection table format.

text string

Gets the text within selection.

Methods

closeHeaderFooter

Closes the header and footer region.

Returns void

copy

Copies the selected content to clipboard.

Returns void

copyHyperlink

Copies the hyperlink URL if the context is within hyperlink.

Returns void

extendBackward

Extends selection backward.

Returns void

extendForward

Extends selection forward.

Returns void

extendToLineEnd

Extend selection to line end

Returns void

extendToLineStart

Extends selection to line start.

Returns void

extendToNextLine

Extend selection to next line.

Returns void

extendToParagraphEnd

Extend selection to paragraph end.

Returns void

extendToParagraphStart

Extends selection to paragraph start.

Returns void

extendToPreviousLine

Extends selection to previous line.

Returns void

extendToWordEnd

Extends selection to word end.

Returns void

extendToWordEndInternal

Extends selection to word end.

Returns void

extendToWordStart

Extends selection to word start.

Returns void

getBookmarks

Gets the bookmark name collection in current selection

Parameter	Type	Description
includeHidden (optional)	boolean	Decide whether to include hidden bookmark name in current selection or not.

Returns string[]

getNextContextType

Returns the context type of next character or element.

Parameter	Type	Description
isElement (optional)	boolean	Decides whether to get next context type from element or character. By default, character.

Returns string

getPreviousContextType

Returns the context type of previous character or element.

Parameter	Type	Description
isElement (optional)	boolean	Decides whether to get previous context type from element or character. By default, character.

Returns string

goToFooter

Moves the selection to the footer of current page.

Returns void

goToHeader

Moves the selection to the header of current page.

Returns void

goToPage

Moves the selection to the start of specified page number.

Returns void

isSelectionInEditRegion

Returns true if selection is inside the edit region

Returns boolean

moveToDocumentEnd

Moves selection to end of the document.

Returns void

moveToDocumentStart

Moves selection to start of the document.

Returns void

moveToLineEnd

Moves selection to end of the current line.

Returns void

moveToLineStart

Moves selection to start of the current line.

Returns void

moveToNextCharacter

Moves selection to next character.

Returns void

moveToNextLine

Moves selection to next line.

Returns void

moveToParagraphEnd

Moves selection to current paragraph end.

Returns void

moveToParagraphStart

Moves selection to current paragraph start.

Returns void

moveToPreviousCharacter

Moves selection to previous character.

Returns void

moveToPreviousLine

Moves selection to previous line.

Returns void

navigateHyperlink

Fires the requestNavigate event if current selection context is in hyperlink.

Returns void

navigateNextComment

Navigate to next comment in the document.

Returns void

navigateNextRevision

Navigate to next revision in the document.

Returns void

navigatePreviousComment

Navigate to previous comment in the document.

Returns void

navigatePreviousRevision

Navigate to previous revision in the document.

Returns void

navigateToNextEditingRegion

Navigate to next editing region, where current user can edit.

Returns void

nextEndnote

To navigate to next Endnote from current selection

Returns void

nextFootnote

To navigate to next footnote from current selection

Returns void

previousEndnote

To navigate to previous Endnote from current selection

Returns void

previousFootnote

To navigate to previous footnote from current selection

Returns void

select

Selects content based on selection settings

Returns void

select

Selects content based on start and end hierarchical index.

Parameter	Type	Description
start	string	start hierarchical index.
end	string	end hierarchical index.

Returns void

selectAll

Selects the entire document.

Returns void

selectBookmark

Selects the specified bookmark.

Parameter	Type	Description
name	string

Returns void

selectByHierarchicalIndex

Selects based on start and end hierarchical index.

Returns void

selectCell

Selects the entire cell if the context is within table.

Returns void

selectColumn

Selects the entire column if the context is within table.

Returns void

selectCurrentWord

Selects Current word

Returns void

selectField

Select the current field if selection is in field

Returns void

selectLine

Selects current line.

Returns void

selectParagraph

Selects current paragraph

Returns void

selectRow

Selects the entire row if the context is within table.

Returns void

selectTable

Selects the entire table if the context is within table.

Returns void

showAllEditingRegion

Shows all the editing region, where current user can edit.

Returns void

toggleEditingRegionHighlight

Highlight all the editing region, where current user can edit.

Returns void