TX Text Control .NET Server

Annotations Class

Class

Description

Controls annotation import/export, stamp definitions, and annotation UI.

Syntax

Annotations

Examples

The following example demonstrates Annotations in a practical Document Viewer workflow. This object provides functionalities for working with annotations.

const annotationJson = TXDocumentViewer.annotations.export();
console.log("Current annotations:", JSON.parse(annotationJson));

Members

Methods

MethodDescription
exportSerializes the page-indexed annotation collection as JSON.
getStampListReturns the current stamp definitions.
loadReplaces the collection with annotations from viewer JSON.
setStampListReplaces the toolbar's stamp definitions.
showSidebarShows or hides the comments sidebar.
showToolbarShows, hides, or toggles the annotation toolbar. Showing the toolbar also activates annotation editing.