Class PDFNet.CaretAnnot
PDFNet.CaretAnnot
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
A Caret annotation (PDF 1.5) is a visual symbol that indicates
the presence of text edits.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.CaretAnnot.create(doc, pos)
Creates a new Caret annotation in the specified document.
|
| <static> |
PDFNet.CaretAnnot.createFromAnnot(ann)
creates an Caret annotation and initializes it using given annotation object.
|
| <static> |
PDFNet.CaretAnnot.createFromObj(d)
creates an Caret annotation and initializes it using given Cos/SDF object.
|
|
Returns the paragraph symbol associated with the caret.
|
|
|
setSymbol(symbol)
sets the caret symbol.
|
Class Detail
PDFNet.CaretAnnot(id)
A Caret annotation (PDF 1.5) is a visual symbol that indicates
the presence of text edits.
- Parameters:
- id
Method Detail
<static>
{CaretAnnot}
PDFNet.CaretAnnot.create(doc, pos)
Creates a new Caret annotation in the specified document.
- Parameters:
- {SDFDoc} doc
- A document to which the Caret annotation is added.
- {rect} pos
- A rectangle specifying the Caret annotation's bounds in default user space units.
- Returns:
- {CaretAnnot} A promise that resolves to a newly created blank Caret annotation.
<static>
{CaretAnnot}
PDFNet.CaretAnnot.createFromAnnot(ann)
creates an Caret annotation and initializes it using given annotation object.
- Parameters:
- {Annot} ann
- Annot object used to initialize the Caret annotation.
- Returns:
- {CaretAnnot} A promise that resolves to an object of type: "CaretAnnot" (generated documentation)
<static>
{CaretAnnot}
PDFNet.CaretAnnot.createFromObj(d)
creates an Caret annotation and initializes it using given Cos/SDF object.
- Parameters:
- {Obj} d
- The Cos/SDF object to initialze the annotation with.
- Returns:
- {CaretAnnot} A promise that resolves to an object of type: "CaretAnnot" (generated documentation)
{string}
getSymbol()
Returns the paragraph symbol associated with the caret.
- Returns:
- {string} A promise that resolves to the name of the symbol. This can be either "P" (Use a new paragraph symbol) or "None" (Don't use any symbol). Default value: None.
setSymbol(symbol)
sets the caret symbol.
- Parameters:
- {string} symbol
- The name of the symbol. This can be either "P" (Use a new paragraph symbol) or "None" (Don't use any symbol). Default value: None.