Apryse WebViewer

Class: TaggingOptions

Core.PDFNet.Page. TaggingOptions

new TaggingOptions()

Options for functions that help create tags (e.g. Page.AnnotInsertWithTagging).

Methods

getDescription()

Gets the value Description from the options object. Alternate description required by some standards. Default is empty, which will automatically attempt to fill it using contextual information (such as TU for Widgets), but explicitly setting this is recommended for better semantics.
Returns:
The current value for Description.
Type
string

getInsertIndex()

Gets the value InsertIndex from the options object. The index, in the parent SElement's kids array, at which to insert the new tag. The new element will be inserted before the element at the insert index, where the first element is at index 0. If insert index >= number of elements, it will be inserted at the end. Default inserts at the end.
Returns:
The current value for InsertIndex.
Type
number

setDescription(value)

Sets the value for Description in the options object. Alternate description required by some standards. Default is empty, which will automatically attempt to fill it using contextual information (such as TU for Widgets), but explicitly setting this is recommended for better semantics.
Parameters:
Name Type Description
value string The new value for Description
Returns:
This object, for call chaining.
Type
PDFNet.Page.TaggingOptions

setInsertIndex(value)

Sets the value for InsertIndex in the options object. The index, in the parent SElement's kids array, at which to insert the new tag. The new element will be inserted before the element at the insert index, where the first element is at index 0. If insert index >= number of elements, it will be inserted at the end. Default inserts at the end.
Parameters:
Name Type Description
value number The new value for InsertIndex
Returns:
This object, for call chaining.
Type
PDFNet.Page.TaggingOptions