Class PDFNet.FreeTextAnnot
PDFNet.FreeTextAnnot
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
A FreeText annotation (PDF 1.3) displays text directly on the page.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.FreeTextAnnot.create(doc, pos)
Creates a new FreeText annotation in the specified document.
|
| <static> |
PDFNet.FreeTextAnnot.createFromAnnot(ann)
creates a FreeText annotation and initializes it using given annotation object.
|
| <static> |
PDFNet.FreeTextAnnot.createFromObj(d)
creates a FreeText annotation and initializes it using given Cos/SDF object.
|
|
getCalloutLinePoints(p1, p2, p3)
[Documentation Not Yet Added]
|
|
|
Returns the default appearance of the FreeText annotation.
|
|
|
Returns the ending style of the callout line of the FreeText Annotation.
|
|
|
Get the default appearance font size.
|
|
|
Returns Intent name of the FreeText annotation.
|
|
|
getLineColor(col_comp)
[Documentation Not Yet Added]
|
|
|
Returns the quading format of the FreeText annotation.
|
|
|
getTextColor(col_comp)
[Documentation Not Yet Added]
|
|
|
setCalloutLinePoints(p1, p2, p3)
sets the callout line points of the FreeText annotation.
|
|
|
setCalloutLinePointsTwo(p1, p2)
sets the callout line points of the FreeText annotation.
|
|
|
setDefaultAppearance(app_str)
sets the default appearance of the FreeText annotation.
|
|
|
setEndingStyle(style)
Sets the ending style of the callout line of the FreeText Annotation.
|
|
|
setEndingStyleName(est)
sets the ending style of the callout line of the FreeText Annotation.
|
|
|
setFontSize(font_size)
Sets the default appearance font size.
|
|
|
setIntentName(mode)
Sets the Intent name of the FreeText annotation.
|
|
|
[Documentation Not Yet Added]
|
|
|
setLineColor(color, col_comp)
sets the line and border color of the FreeText Annotation.
|
|
|
setQuaddingFormat(format)
Sets the quading format of the FreeText annotation.
|
|
|
setTextColor(color, col_comp)
sets the text color of the FreeText Annotation.
|
Class Detail
PDFNet.FreeTextAnnot(id)
A FreeText annotation (PDF 1.3) displays text directly on the page.
Unlike an ordinary Text annotation, a FreeText annotation has no
open or closed state; The content of the FreeText annotation is always
visible instead of being displayed in a popup window.
- Parameters:
- id
Method Detail
<static>
{FreeTextAnnot}
PDFNet.FreeTextAnnot.create(doc, pos)
Creates a new FreeText annotation in the specified document.
- Parameters:
- {SDFDoc} doc
- A document to which the FreeText annotation is added.
- {rect} pos
- A rectangle specifying the FreeText annotation's bounds in default user space units.
- Returns:
- {FreeTextAnnot} A promise that resolves to a newly created blank FreeText annotation.
<static>
{FreeTextAnnot}
PDFNet.FreeTextAnnot.createFromAnnot(ann)
creates a FreeText annotation and initializes it using given annotation object.
- Parameters:
- {Annot} ann
- Annot object used to initialize the FreeText annotation.
- Returns:
- {FreeTextAnnot} A promise that resolves to an object of type: "FreeTextAnnot" (generated documentation)
<static>
{FreeTextAnnot}
PDFNet.FreeTextAnnot.createFromObj(d)
creates a FreeText annotation and initializes it using given Cos/SDF object.
- Parameters:
- {Obj} d
- The Cos/SDF object to initialze the annotation with.
- Returns:
- {FreeTextAnnot} A promise that resolves to an object of type: "FreeTextAnnot" (generated documentation)
getCalloutLinePoints(p1, p2, p3)
[Documentation Not Yet Added]
- Parameters:
- {point} p1
- (generated documentation)
- {point} p2
- (generated documentation)
- {point} p3
- (generated documentation)
{string}
getDefaultAppearance()
Returns the default appearance of the FreeText annotation.
- Returns:
- {string} A promise that resolves to a string representing the default appearance of the annotation.
{number}
getEndingStyle()
Returns the ending style of the callout line of the FreeText Annotation.
Return value enum:
PDFNet.LineAnnot.EndingStyle = {
e_Square : 0
e_Circle : 1
e_Diamond : 2
e_OpenArrow : 3
e_ClosedArrow : 4
e_Butt : 5
e_ROpenArrow : 6
e_RClosedArrow : 7
e_Slash : 8
e_None : 9
e_Unknown : 10
}
- Returns:
- {number} A promise that resolves to the ending style represented as one of the entries of the enum "EndingStyle"
{number}
getFontSize()
Get the default appearance font size. To get the actual font
size used, call RefreshAppearance and then use ElementReader
on the content stream of this annotation.
- Returns:
- {number} A promise that resolves tos the default font size, where a value of zero indicates auto sizing.
{number}
getIntentName()
Returns Intent name of the FreeText annotation.
(PDF 1.4)
Return value enum:
PDFNet.FreeTextAnnot.IntentName = {
e_FreeText : 0
e_FreeTextCallout : 1
e_FreeTextTypeWriter : 2
e_Unknown : 3
}
- Returns:
- {number} A promise that resolves tos The intent name of the annotation as an entry from the enum "IntentName".
getLineColor(col_comp)
[Documentation Not Yet Added]
- Parameters:
- {colorpt} col_comp
- (generated documentation)
{number}
getQuaddingFormat()
Returns the quading format of the FreeText annotation.
(PDF 1.4)
- Returns:
- {number} A promise that resolves to a int (code) indicating the quading format of the FreeText annotation.
getTextColor(col_comp)
[Documentation Not Yet Added]
- Parameters:
- {colorpt} col_comp
- (generated documentation)
setCalloutLinePoints(p1, p2, p3)
sets the callout line points of the FreeText annotation.
(Optional; meaningful only if IT is FreeTextCallout; PDF 1.6)
- Parameters:
- {point} p1
- The starting point.
- {point} p2
- The ending point.
- {point} p3
- The knee point.
setCalloutLinePointsTwo(p1, p2)
sets the callout line points of the FreeText annotation.
(Optional; meaningful only if IT is FreeTextCallout; PDF 1.6)
- Parameters:
- {point} p1
- The staring point.
- {point} p2
- The ending point.
setDefaultAppearance(app_str)
sets the default appearance of the FreeText annotation.
- Parameters:
- {string} app_str
- A string representing the default appearance of the annotation.
setEndingStyle(style)
Sets the ending style of the callout line of the FreeText Annotation.
(Optional; meaningful only if CL is present; PDF 1.6)
- Parameters:
- {number} style
- The ending style represented using one of the entries of the enum "EndingStyle"
setEndingStyleName(est)
sets the ending style of the callout line of the FreeText Annotation.
(Optional; meaningful only if CL is present; PDF 1.6)
- Parameters:
- {string} est
- The ending style represented using a string.
setFontSize(font_size)
Sets the default appearance font size. A value of zero specifies
that the font size should should adjust so that the text uses
as much of the FreeText bounding box as possible.
- Parameters:
- {number} font_size
- Set the default font size. A value of zero means auto resize font.
setIntentName(mode)
Sets the Intent name of the FreeText annotation.
(Optional; PDF 1.4)
- Parameters:
- {number} mode
- The intent name of the annotation as an entry from the enum "IntentName".
setIntentNameDefault()
[Documentation Not Yet Added]
setLineColor(color, col_comp)
sets the line and border color of the FreeText Annotation.
- Parameters:
- {colorpt} color
- ColorPt object representing the color.
- {number} col_comp
- number of colorant components in ColorPt object.
setQuaddingFormat(format)
Sets the quading format of the FreeText annotation.
(Optional; PDF 1.4)
- Parameters:
- {number} format
- A int code indicating the quading format of the FreeText annotation. Default value: 0 (left-justified).
setTextColor(color, col_comp)
sets the text color of the FreeText Annotation.
- Parameters:
- {colorpt} color
- ColorPt object representing the color.
- {number} col_comp
- number of colorant components in ColorPt object.