Class PDFNet.RubberStampAnnot
PDFNet.RubberStampAnnot
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
A RubberStamp annotation displays text or graphics intended
to look as if they were stamped on the page with a rubber stamp.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
PDFNet.RubberStampAnnot.create(doc, pos)
Constructor
|
| <static> |
PDFNet.RubberStampAnnot.createFromAnnot(ann)
creates a RubberStamp annotation and initializes it using given annotation object.
|
| <static> |
PDFNet.RubberStampAnnot.createFromObj(d)
creates a RubberStamp annotation and initializes it using given Cos/SDF object.
|
|
getIcon()
Returns the type of the icon associated with the RubberStamp annotation.
|
|
|
Returns the name of the icon associated with the RubberStamp annotation.
|
|
|
setIcon(type)
sets the type of the icon associated with the RubberStamp annotation.
|
|
|
[Documentation Not Yet Added]
|
|
|
setIconName(iconstring)
sets the name of the icon associated with the RubberStamp annotation.
|
Class Detail
PDFNet.RubberStampAnnot(id)
A RubberStamp annotation displays text or graphics intended
to look as if they were stamped on the page with a rubber stamp.
- Parameters:
- id
Method Detail
<static>
{RubberStampAnnot}
PDFNet.RubberStampAnnot.create(doc, pos)
Constructor
- Parameters:
- {SDFDoc} doc
- (generated documentation)
- {rect} pos
- (generated documentation)
- Returns:
- {RubberStampAnnot} A promise that resolves to an object of type: "RubberStampAnnot" (generated documentation)
<static>
{RubberStampAnnot}
PDFNet.RubberStampAnnot.createFromAnnot(ann)
creates a RubberStamp annotation and initializes it using given annotation object.
- Parameters:
- {Annot} ann
- Annot object used to initialize the RubberStamp annotation.
- Returns:
- {RubberStampAnnot} A promise that resolves to an object of type: "RubberStampAnnot" (generated documentation)
<static>
{RubberStampAnnot}
PDFNet.RubberStampAnnot.createFromObj(d)
creates a RubberStamp annotation and initializes it using given Cos/SDF object.
- Parameters:
- {Obj} d
- The Cos/SDF object to initialze the annotation with.
- Returns:
- {RubberStampAnnot} A promise that resolves to an object of type: "RubberStampAnnot" (generated documentation)
{number}
getIcon()
Returns the type of the icon associated with the RubberStamp annotation.
Return value enum:
PDFNet.RubberStampAnnot.Icon = {
e_Approved : 0
e_Experimental : 1
e_NotApproved : 2
e_AsIs : 3
e_Expired : 4
e_NotForPublicRelease : 5
e_Confidential : 6
e_Final : 7
e_Sold : 8
e_Departmental : 9
e_ForComment : 10
e_TopSecret : 11
e_ForPublicRelease : 12
e_Draft : 13
e_Unknown : 14
}
- Returns:
- {number} A promise that resolves to a value of enum "Icon" that represents the type of icon associated with the annotation. Default value: e_Draft.
{string}
getIconName()
Returns the name of the icon associated with the RubberStamp annotation.
- Returns:
- {string} A promise that resolves to a string that is the name of the icon associated with the RubberStamp annotation.
setIcon(type)
sets the type of the icon associated with the RubberStamp annotation.
- Parameters:
- {number} type
- A value of enum "Icon" type that represents the type of icon associated with the annotation. Default value: e_Draft.
setIconDefault()
[Documentation Not Yet Added]
setIconName(iconstring)
sets the name of the icon associated with the RubberStamp annotation.
- Parameters:
- {string} iconstring
- the name of the icon associated with the RubberStamp annotation.