Class PDFNet.TextAnnot
PDFNet.TextAnnot
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
PDFNet.TextAnnot(id)
A text annotation represents a "sticky note" attached to a point in
the PDF document.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.TextAnnot.create(doc, pos)
Constructor
|
| <static> |
PDFNet.TextAnnot.createAtPoint(doc, pos)
[Documentation Not Yet Added]
|
| <static> |
PDFNet.TextAnnot.createFromAnnot(ann)
creates a Text annotation and initializes it using given annotation object.
|
| <static> |
PDFNet.TextAnnot.createFromObj(d)
creates a Text annotation and initializes it using given Cos/SDF object.
|
|
getIcon()
Returns the type of the icon associated with the Text annotation.
|
|
|
Returns the name of the icon associated with the Text annotation.
|
|
|
getState()
Returns the string indicating the state of the Text annotation.
|
|
|
Returns the string indicating the state model of the Text annotation.
|
|
|
isOpen()
Returns the initial status of the Text annotation.
|
|
|
setIcon(icon)
sets the type of the icon associated with the Text annotation.
|
|
|
[Documentation Not Yet Added]
|
|
|
setIconName(icon)
sets the name of the icon associated with the Text annotation.
|
|
|
setOpen(isopen)
sets the initial status of the Text annotation.
|
|
|
setState(state)
Sets the string indicating the state of the Text annotation.
|
|
|
setStateModel(sm)
Sets the string indicating the state model of the Text annotation.
|
Class Detail
PDFNet.TextAnnot(id)
A text annotation represents a "sticky note" attached to a point in
the PDF document. When closed, the annotation shall appear as an icon;
when open, it shall display a pop-up window containing the text of
the note in a font and size chosen by the conforming reader.
Text annotations do not scale and rotate with the page (i.e. they should
behave as if the NoZoom and NoRotate annotation flags).
- Parameters:
- id
Method Detail
<static>
{TextAnnot}
PDFNet.TextAnnot.create(doc, pos)
Constructor
- Parameters:
- {SDFDoc} doc
- (generated documentation)
- {rect} pos
- (generated documentation)
- Returns:
- {TextAnnot} A promise that resolves to an object of type: "TextAnnot" (generated documentation)
<static>
{TextAnnot}
PDFNet.TextAnnot.createAtPoint(doc, pos)
[Documentation Not Yet Added]
- Parameters:
- {SDFDoc} doc
- (generated documentation)
- {point} pos
- (generated documentation)
- Returns:
- {TextAnnot} A promise that resolves to an object of type: "TextAnnot" (generated documentation)
<static>
{TextAnnot}
PDFNet.TextAnnot.createFromAnnot(ann)
creates a Text annotation and initializes it using given annotation object.
- Parameters:
- {Annot} ann
- Annot object used to initialize the Text annotation.
- Returns:
- {TextAnnot} A promise that resolves to an object of type: "TextAnnot" (generated documentation)
<static>
{TextAnnot}
PDFNet.TextAnnot.createFromObj(d)
creates a Text annotation and initializes it using given Cos/SDF object.
- Parameters:
- {Obj} d
- The Cos/SDF object to initialze the annotation with.
- Returns:
- {TextAnnot} A promise that resolves to an object of type: "TextAnnot" (generated documentation)
{number}
getIcon()
Returns the type of the icon associated with the Text annotation.
Return value enum:
PDFNet.TextAnnot.Icon = {
e_Comment : 0
e_Key : 1
e_Help : 2
e_NewParagraph : 3
e_Paragraph : 4
e_Insert : 5
e_Note : 6
e_Unknown : 7
}
- Returns:
- {number} A promise that resolves to a value of the enumeration type "Icon". Default value: e_Note.
{string}
getIconName()
Returns the name of the icon associated with the Text annotation.
- Returns:
- {string} A promise that resolves to a string denoting the name of the icon.
{string}
getState()
Returns the string indicating the state of the Text annotation.
(PDF 1.5)
- Returns:
- {string} A promise that resolves to a string that indicates the state of the Text annotation when first loaded. Default: "Unmarked" if StateModel is "Marked"; "None" if StateModel is "Review".
{string}
getStateModel()
Returns the string indicating the state model of the Text annotation.
(PDF 1.5)
- Returns:
- {string} A promise that resolves to a string containing the state model name either "Marked" or "Review".
{boolean}
isOpen()
Returns the initial status of the Text annotation.
- Returns:
- {boolean} A promise that resolves to a boolean value that specifies whether the annotation shall initially be displayed as opened. Default value: false.
setIcon(icon)
sets the type of the icon associated with the Text annotation.
(Optional)
- Parameters:
- {number} icon
- A value of the enum "Icon" type. Default value: e_Note.
setIconDefault()
[Documentation Not Yet Added]
setIconName(icon)
sets the name of the icon associated with the Text annotation.
(Optional)
- Parameters:
- {string} icon
- A string denoting the name of the icon.
setOpen(isopen)
sets the initial status of the Text annotation.
(Optional)
- Parameters:
- {boolean} isopen
- A boolean value that specifies whether the annotation shall initially be displayed as opened. Default value: false.
setState(state)
Sets the string indicating the state of the Text annotation.
(Optional; PDF 1.5 )
- Parameters:
- {string} state
- A string that indicates the state of the Text annotation when first loaded. Default: "Unmarked" if StateModel is "Marked"; "None" if StateModel is "Review".
setStateModel(sm)
Sets the string indicating the state model of the Text annotation.
(Required if State is present, otherwise optional; PDF 1.5 )
- Parameters:
- {string} sm
- A string containing the state model name either "Marked" or "Review".