@grapecity/gcpdfviewer

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TextWidget | Document Solutions PDF Viewer - v7.2.3</title><meta name="description" content="Documentation for Document Solutions PDF Viewer - v7.2.3"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> <div class="tsd-toolbar-contents container"> <div class="table-cell" id="tsd-search" data-base=".."> <div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Document Solutions PDF Viewer - v7.2.3</a></div> <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header> <div class="container container-main"> <div class="col-8 col-content"> <div class="tsd-page-title"> <ul class="tsd-breadcrumb"> <li><a href="../index.html">Document Solutions PDF Viewer - v7.2.3</a></li> <li><a href="TextWidget.html">TextWidget</a></li></ul> <h1>Class TextWidget</h1></div> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"><p>Text field widget.</p> </div></section> <section class="tsd-panel tsd-hierarchy"> <h4>Hierarchy</h4> <ul class="tsd-hierarchy"> <li><a href="WidgetAnnotation.html" class="tsd-signature-type" data-tsd-kind="Class">WidgetAnnotation</a> <ul class="tsd-hierarchy"> <li><span class="target">TextWidget</span></li></ul></li></ul></section> <section class="tsd-panel-group tsd-index-group"> <section class="tsd-panel tsd-index-panel"> <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"> <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary> <div class="tsd-accordion-details"> <section class="tsd-index-section"> <h3 class="tsd-index-heading">Properties</h3> <div class="tsd-index-list"><a href="TextWidget.html#alternativeText" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>alternative<wbr/>Text</span></a> <a href="TextWidget.html#annotationName" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>annotation<wbr/>Name</span></a> <a href="TextWidget.html#annotationType" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>annotation<wbr/>Type</span></a> <a href="TextWidget.html#appearanceColor" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>appearance<wbr/>Color</span></a> <a href="TextWidget.html#autoSizeFont" class="tsd-index-link tsd-kind-property tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>auto<wbr/>Size<wbr/>Font</span></a> <a href="TextWidget.html#borderStyle" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>border<wbr/>Style</span></a> <a href="TextWidget.html#color" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>color</span></a> <a href="TextWidget.html#contents" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>contents</span></a> <a href="TextWidget.html#convertToContent" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>convert<wbr/>To<wbr/>Content</span></a> <a href="TextWidget.html#creationDate" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>creation<wbr/>Date</span></a> <a href="TextWidget.html#display" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>display</span></a> <a href="TextWidget.html#fieldName" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>field<wbr/>Name</span></a> <a href="TextWidget.html#fieldType" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>field<wbr/>Type</span></a> <a href="TextWidget.html#fieldValue" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>field<wbr/>Value</span></a> <a href="TextWidget.html#fontName" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>font<wbr/>Name</span></a> <a href="TextWidget.html#fontSize" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>font<wbr/>Size</span></a> <a href="TextWidget.html#gcProps" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>gc<wbr/>Props</span></a> <a href="TextWidget.html#id" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>id</span></a> <a href="TextWidget.html#invisibleFlag" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>invisible<wbr/>Flag</span></a> <a href="TextWidget.html#irtAnnotations" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>irt<wbr/>Annotations</span></a> <a href="TextWidget.html#isRichContents" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>is<wbr/>Rich<wbr/>Contents</span></a> <a href="TextWidget.html#locked" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>locked</span></a> <a href="TextWidget.html#modificationDate" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>modification<wbr/>Date</span></a> <a href="TextWidget.html#opacity" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>opacity</span></a> <a href="TextWidget.html#orderIndex" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>order<wbr/>Index</span></a> <a href="TextWidget.html#orientation" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>orientation</span></a> <a href="TextWidget.html#parentAnnotation" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>parent<wbr/>Annotation</span></a> <a href="TextWidget.html#parentId" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>parent<wbr/>Id</span></a> <a href="TextWidget.html#popupId" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>popup<wbr/>Id</span></a> <a href="TextWidget.html#printableFlag" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>printable<wbr/>Flag</span></a> <a href="TextWidget.html#readOnly" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>read<wbr/>Only</span></a> <a href="TextWidget.html#rect" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>rect</span></a> <a href="TextWidget.html#redacted" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>redacted</span></a> <a href="TextWidget.html#redactedBy" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>redacted<wbr/>By</span></a> <a href="TextWidget.html#referenceAnnotationId" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>reference<wbr/>Annotation<wbr/>Id</span></a> <a href="TextWidget.html#referenceType" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>reference<wbr/>Type</span></a> <a href="TextWidget.html#rotate" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>rotate</span></a> <a href="TextWidget.html#sharedChanges" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>shared<wbr/>Changes</span></a> <a href="TextWidget.html#state" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>state</span></a> <a href="TextWidget.html#stateModel" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>state<wbr/>Model</span></a> <a href="TextWidget.html#subject" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>subject</span></a> <a href="TextWidget.html#subtype" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>subtype</span></a> <a href="TextWidget.html#textAlignment" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>text<wbr/>Alignment</span></a> <a href="TextWidget.html#title" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>title</span></a> </div></section></div></details></section></section> <section class="tsd-panel-group tsd-member-group"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="alternativeText" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>alternative<wbr/>Text</span><a href="#alternativeText" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3> <div class="tsd-signature">alternative<wbr/>Text<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div> <div class="tsd-comment tsd-typography"><p>An alternate field text to be used as tooltip. This text is also useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#alternativeText">alternativeText</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="annotationName" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>annotation<wbr/>Name</span><a href="#annotationName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">annotation<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <div class="tsd-comment tsd-typography"><p>Annotation name (NM entry).</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#annotationName">annotationName</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="annotationType" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>annotation<wbr/>Type</span><a href="#annotationType" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">annotation<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../enums/AnnotationTypeCode.html" class="tsd-signature-type" data-tsd-kind="Enumeration">AnnotationTypeCode</a></div> <div class="tsd-comment tsd-typography"><p>Annotation type.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#annotationType">annotationType</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="appearanceColor" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>appearance<wbr/>Color</span><a href="#appearanceColor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">appearance<wbr/>Color<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div> <div class="tsd-comment tsd-typography"><p>Appearance color.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#appearanceColor">appearanceColor</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="autoSizeFont" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>auto<wbr/>Size<wbr/>Font</span><a href="#autoSizeFont" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">auto<wbr/>Size<wbr/>Font<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div> <div class="tsd-comment tsd-typography"><p>When the autoSizeFont flag is set, the text widget will resize the text to fit within the widget's bounds.</p> </div></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="borderStyle" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>border<wbr/>Style</span><a href="#borderStyle" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">border<wbr/>Style<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>dashArray<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>horizontalCornerRadius<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>verticalCornerRadius<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div> <div class="tsd-comment tsd-typography"><p>Annotation's border style.</p> </div> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><code class="tsd-tag ts-flagOptional">Optional</code> dash<wbr/>Array<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"><p>Border dash pattern. Used when the border style is dashed.</p> </div></li> <li class="tsd-parameter"> <h5>horizontal<wbr/>Corner<wbr/>Radius<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li> <li class="tsd-parameter"> <h5>style<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"><p>Border style. Possible values: 1 - solid style (default), 2 - dashed style.</p> </div></li> <li class="tsd-parameter"> <h5>vertical<wbr/>Corner<wbr/>Radius<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li> <li class="tsd-parameter"> <h5>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"><p>Border width.</p> </div></li></ul></div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#borderStyle">borderStyle</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="color" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>color</span><a href="#color" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">color<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div> <div class="tsd-comment tsd-typography"><p>Annotation color.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#color">color</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="contents" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>contents</span><a href="#contents" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">contents<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div> <div class="tsd-comment tsd-typography"><p>The text (or rich text) string that shall be displayed in the pop-up when the annotation is opened.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#contents">contents</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="convertToContent" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>convert<wbr/>To<wbr/>Content</span><a href="#convertToContent" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">convert<wbr/>To<wbr/>Content<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div> <div class="tsd-comment tsd-typography"><p>Indicates whether the annotation will be converted to content when the document is saved.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#convertToContent">convertToContent</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="creationDate" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>creation<wbr/>Date</span><a href="#creationDate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">creation<wbr/>Date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <div class="tsd-comment tsd-typography"><p>Creation date.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#creationDate">creationDate</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="display" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>display</span><a href="#display" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">display<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"visible"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hidden"</span></div> <div class="tsd-comment tsd-typography"><p>The field is used for compatibility with Adobe Acrobat Reader.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#display">display</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="fieldName" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>field<wbr/>Name</span><a href="#fieldName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">field<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <div class="tsd-comment tsd-typography"><p>Field name.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#fieldName">fieldName</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="fieldType" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>field<wbr/>Type</span><a href="#fieldType" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">field<wbr/>Type<span class="tsd-signature-symbol">:</span> <a href="../types/WidgetFieldTypeName.html" class="tsd-signature-type" data-tsd-kind="Type alias">WidgetFieldTypeName</a></div> <div class="tsd-comment tsd-typography"><p>Field type.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#fieldType">fieldType</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="fieldValue" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>field<wbr/>Value</span><a href="#fieldValue" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">field<wbr/>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div> <div class="tsd-comment tsd-typography"><p>Field widget value.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#fieldValue">fieldValue</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="fontName" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>font<wbr/>Name</span><a href="#fontName" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">font<wbr/>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <div class="tsd-comment tsd-typography"><p>Font name. Available standard font names: 'Helv' (Helvetica), 'HelveticaItalic' (Helvetica Italic), 'HelveticaBold' (Helvetica Bold), 'HelveticaBoldItalic' (Helvetica Bold Italic), 'TimesRegular' (Times Roman), 'TimesItalic' (Times Roman Italic), 'TimesBold' (Times Roman Bold), 'TimesBoldItalic' (Times Roman Bold Italic), 'CourierRegular' (Courier), 'CourierItalic' (Courier Italic), 'CourierBold' (Courier Bold), 'CourierBoldItalic' (Courier Bold Italic), 'Symbol' (Text symbol letters)</p> <h3>Default</h3><p>"Helv"</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#fontName">fontName</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="fontSize" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>font<wbr/>Size</span><a href="#fontSize" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">font<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <div class="tsd-comment tsd-typography"><p>Font size.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#fontSize">fontSize</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="gcProps" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>gc<wbr/>Props</span><a href="#gcProps" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">gc<wbr/>Props<span class="tsd-signature-symbol">?:</span> <a href="../types/GcProps.html" class="tsd-signature-type" data-tsd-kind="Type alias">GcProps</a></div> <div class="tsd-comment tsd-typography"><p>Additional custom properties. Only available for use with DsPdf.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#gcProps">gcProps</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="id" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <div class="tsd-comment tsd-typography"><p>Annotation id.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#id">id</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="invisibleFlag" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>invisible<wbr/>Flag</span><a href="#invisibleFlag" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">invisible<wbr/>Flag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <div class="tsd-comment tsd-typography"><p>true if the annotation is hidden.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#invisibleFlag">invisibleFlag</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="irtAnnotations" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>irt<wbr/>Annotations</span><a href="#irtAnnotations" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">irt<wbr/>Annotations<span class="tsd-signature-symbol">?:</span> <a href="AnnotationBase.html" class="tsd-signature-type" data-tsd-kind="Class">AnnotationBase</a><span class="tsd-signature-symbol">[]</span></div> <div class="tsd-comment tsd-typography"><p>Internal helper property. Primary annotation's children annotations. Note, the array contains all children annotations, including annotations what is not direct descendant of the primary annotation.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#irtAnnotations">irtAnnotations</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="isRichContents" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>is<wbr/>Rich<wbr/>Contents</span><a href="#isRichContents" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">is<wbr/>Rich<wbr/>Contents<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <div class="tsd-comment tsd-typography"><p>Specifies whether or not the RichContent mode is used for the contents property.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#isRichContents">isRichContents</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="locked" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>locked</span><a href="#locked" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">locked<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div> <div class="tsd-comment tsd-typography"><p>Specifies whether the annotation can be deleted or its properties (including position and size) can be modified by the user.</p> <h3>Example</h3><pre><code class="language-javascript"><span class="hl-0">var</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">DsPdfViewer</span><span class="hl-1">(</span><span class="hl-4">'#root'</span><span class="hl-1">, { </span><span class="hl-2">renderInteractiveForms:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> , </span><span class="hl-2">supportApi:</span><span class="hl-1"> { </span><span class="hl-2">apiUrl:</span><span class="hl-1"> </span><span class="hl-4">'api/pdf-viewer'</span><span class="hl-1">, </span><span class="hl-2">webSocketUrl:</span><span class="hl-1"> </span><span class="hl-0">false</span><span class="hl-1"> } });</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addDefaultPanels</span><span class="hl-1">();</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addAnnotationEditorPanel</span><span class="hl-1">();</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addFormEditorPanel</span><span class="hl-1">();</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">addReplyTool</span><span class="hl-1">();</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-2">onAfterOpen</span><span class="hl-1">.</span><span class="hl-3">register</span><span class="hl-1">(()</span><span class="hl-0">=></span><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-5">// Lock all text annotations after document open:</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-6">resultArr</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">findAnnotation</span><span class="hl-1">(</span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-5">// 1 - AnnotationTypeCode.TEXT</span><br/><span class="hl-1"> { </span><span class="hl-2">findField:</span><span class="hl-1"> </span><span class="hl-4">'annotationType'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">pageNumberConstraint:</span><span class="hl-1"> </span><span class="hl-8">1</span><span class="hl-1">, </span><span class="hl-2">findAll:</span><span class="hl-1"> </span><span class="hl-0">true</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">updateAnnotations</span><span class="hl-1">(</span><span class="hl-8">0</span><span class="hl-1">, </span><span class="hl-2">resultArr</span><span class="hl-1">.</span><span class="hl-3">map</span><span class="hl-1">((</span><span class="hl-2">data</span><span class="hl-1">)</span><span class="hl-0">=></span><span class="hl-1"> { </span><span class="hl-2">data</span><span class="hl-1">.</span><span class="hl-2">annotation</span><span class="hl-1">.</span><span class="hl-2">locked</span><span class="hl-1"> = </span><span class="hl-0">true</span><span class="hl-1">; </span><span class="hl-7">return</span><span class="hl-1"> </span><span class="hl-2">data</span><span class="hl-1">.</span><span class="hl-2">annotation</span><span class="hl-1">; }));</span><br/><span class="hl-1">});</span><br/><span class="hl-5">// Open Annotations.pdf</span><br/><span class="hl-2">viewer</span><span class="hl-1">.</span><span class="hl-3">open</span><span class="hl-1">(</span><span class="hl-4">'Annotations.pdf'</span><span class="hl-1">);</span> </code></pre> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#locked">locked</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="modificationDate" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>modification<wbr/>Date</span><a href="#modificationDate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">modification<wbr/>Date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div> <div class="tsd-comment tsd-typography"><p>Modification date.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#modificationDate">modificationDate</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="opacity" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>opacity</span><a href="#opacity" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">opacity<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div> <div class="tsd-comment tsd-typography"><p>Annotation opacity.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#opacity">opacity</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="orderIndex" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><span>order<wbr/>Index</span><a href="#orderIndex" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">order<wbr/>Index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div> <div class="tsd-comment tsd-typography"><p>The field order index.</p> </div><aside class="tsd-sources"> <p>Inherited from <a href="WidgetAnnotation.html">WidgetAnnotation</a>.<a href="WidgetAnnotation.html#orderIndex">orderIndex</a></p></aside></section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a id="orientation" class="tsd-anchor"></a> <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>orientation</span><a href="#orientation" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3> <div class="tsd-signature">orientation<span class="tsd-signature-symbol">?:</span> <spa