new RubberStampAnnot()
A RubberStamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp.
Methods
-
<static> create(doc, pos)
-
Constructor
Parameters:
Name Type Description doc
PDFNet.SDFDoc pos
PDFNet.Rect Returns:
A promise that resolves to an object of type: "RubberStampAnnot"
-
<static> createFromAnnot(ann)
-
creates a RubberStamp annotation and initializes it using given annotation object.
Parameters:
Name Type Description ann
PDFNet.Annot Annot object used to initialize the RubberStamp annotation.
Returns:
A promise that resolves to an object of type: "RubberStampAnnot"
-
<static> createFromObj(d)
-
creates a RubberStamp annotation and initializes it using given Cos/SDF object.
Parameters:
Name Type Description d
PDFNet.Obj The Cos/SDF object to initialze the annotation with.
Returns:
A promise that resolves to an object of type: "RubberStampAnnot"
-
getIcon()
-
Returns the type of the icon associated with the RubberStamp annotation.
Returns:
A promise that resolves to a value of enum "Icon" that represents the type of icon associated with the annotation. Default value: e_Draft.
- Type
- number
Example
Return value enum: <pre> 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 } </pre>
-
getIconName()
-
Returns the name of the icon associated with the RubberStamp annotation.
Returns:
A promise that resolves to a string that is the name of the icon associated with the RubberStamp annotation.
- Type
- string
-
setIcon(type)
-
sets the type of the icon associated with the RubberStamp annotation.
Parameters:
Name Type Description type
number A value of enum "Icon" type that represents the type of icon associated with the annotation. Default value: e_Draft.
-
setIconDefault()
-
-
setIconName(iconstring)
-
sets the name of the icon associated with the RubberStamp annotation.
Parameters:
Name Type Description iconstring
string the name of the icon associated with the RubberStamp annotation.