Foxit PDF SDK
foxit.pdf.annots.Stamp Class Reference
Inheritance diagram for foxit.pdf.annots.Stamp:
foxit.pdf.annots.Markup foxit.pdf.annots.Annot foxit.common.Base

Public Member Functions

 Stamp ()
 Constructor.

 
 Stamp (Annot annot)
 Constructor, with parent class object.
More...
 
string GetIconName ()
 Get icon name.
More...
 
int GetRotation ()
 Get current rotation angle (in clockwise).
More...
 
void Rotate (int angle)
 Rotate current annotation from current state with specified angle degree in clockwise.
More...
 
void SetBitmap (Bitmap bitmap)
 Set bitmap to current stamp annotation.
More...
 
void SetIconName (string icon_name)
 Set icon name.
More...
 
void SetImage (Image image, int frame_index, int compress)
 Set image to current stamp annotation, with a specified frame index.
More...
 
void SetRotation (int angle)
 Set rotation angle (in clockwise).
More...
 
- Public Member Functions inherited from foxit.pdf.annots.Markup
 Markup (Annot annot)
 Constructor, with parent class object.
More...
 
 Markup ()
 Constructor.

 
Note AddReply ()
 Add a new reply to the end of reply list.
More...
 
void AddRichText (string content, RichTextStyle style)
 Add a new rich text string to the end.
More...
 
Note AddStateAnnot (string title, Markup.StateModel model, Markup.State state)
 Add a new state annotation.
More...
 
DateTime GetCreationDateTime ()
 Get creation date time.
More...
 
MarkupArray GetGroupElements ()
 Get an element (as markup annotation) from the group that current markup annotation belongs to.
More...
 
Markup GetGroupHeader ()
 Get the header annotation (as primary annotation) of the group that current markup annotation belongs to.
More...
 
string GetIntent ()
 Get intent name.
More...
 
float GetOpacity ()
 Get opacity value.
More...
 
Popup GetPopup ()
 Get related pop-up annotation.
More...
 
Note GetReply (int index)
 Get a reply by index.
More...
 
int GetReplyCount ()
 Count all replies.
More...
 
string GetRichTextContent (int index)
 Get text string of a rich text string specified by index.
More...
 
int GetRichTextCount ()
 Get the count of rich text string.
More...
 
RichTextStyle GetRichTextStyle (int index)
 Get style data of a rich text string specified by index.
More...
 
NoteArray GetStateAnnots (Markup.StateModel model)
 Get all state annotations in a specified state model.
More...
 
string GetSubject ()
 Get subject string.
More...
 
string GetTitle ()
 Get title string.
More...
 
void InsertRichText (int index, string content, RichTextStyle style)
 Insert a new rich text string to the place which is specified by index.
More...
 
bool IsGrouped ()
 Check whether current markup annotation is in a group or not.
More...
 
bool RemoveAllReplies ()
 Remove all the replies.
More...
 
bool RemoveAllStateAnnots ()
 Remove all the state annotations.
More...
 
bool RemoveReply (int index)
 Remove a reply by index.
More...
 
void RemoveRichText (int index)
 Remove a rich text string specified by index.
More...
 
void SetCreationDateTime (DateTime date_time)
 Set creation date time.
More...
 
void SetIntent (string intent)
 Set intent name.
More...
 
void SetOpacity (float opacity)
 Set opacity value.
More...
 
void SetPopup (Popup popup)
 Set related pop-up annotation.
More...
 
void SetRichTextContent (int index, string content)
 Set text string of a rich text string specified by index.
More...
 
void SetRichTextStyle (int index, RichTextStyle style)
 Set style data of a rich text string specified by index.
More...
 
void SetSubject (string subject)
 Set subject string.
More...
 
void SetTitle (string title)
 Set title string.
More...
 
bool Ungroup ()
 Ungroup current markup annotation from the group it belongs to.
More...
 
- Public Member Functions inherited from foxit.pdf.annots.Annot
 Annot (PDFPage page, PDFDictionary annot_dict)
 Constructor, with PDF page and annotation's PDF dictionary.
More...
 
 Annot (Annot annot)
 Constructor, with another annotation object.
More...
 
 Annot ()
 Constructor.

 
PDFStream GetAppearanceStream (Annot.AppearanceType type, string appearance_state)
 Get annotation's appearance stream with specified type and state.
More...
 
int GetBorderColor ()
 Get border color.
More...
 
BorderInfo GetBorderInfo ()
 Get border information.
More...
 
string GetContent ()
 Get content.
More...
 
RectI GetDeviceRect (Matrix2D matrix)
 Get annotation rectangle in device coordinate system.
More...
 
PDFDictionary GetDict ()
 Get annotation's dictionary object.
More...
 
Matrix2D GetDisplayMatrix (Matrix2D page_display_matrix)
 Get the display matrix, from PDF coordinate system to targeted device coordinate system.
More...
 
int GetFlags ()
 Get annotation flags.
More...
 
int GetIndex ()
 Get the index of current annotation in the page which current annotation belongs to.
More...
 
DateTime GetModifiedDateTime ()
 Get last modified date time.
More...
 
PDFDictionary GetOptionalContent ()
 Get the PDF dictionary of annotation's optional content.
More...
 
PDFPage GetPage ()
 Get the related PDF page.
More...
 
RectF GetRect ()
 Get rectangle, in PDF coordinate system.
More...
 
Annot.Type GetType ()
 Get actual annotation type of current annotation.
More...
 
string GetUniqueID ()
 Get unique ID.
More...
 
bool HasProperty (Annot.Property property)
 Whether current annotation has the specified annotation's property.
More...
 
bool IsEmpty ()
 Check whether current object is empty or not.
More...
 
bool IsMarkup ()
 Check if current annotation is a markup annotation.
More...
 
bool Move (RectF rect)
 Move current annotation to a new position, specified by a new rectangle in [PDF coordinate system] (foxit.pdf.PDFPage).
More...
 
bool RemoveProperty (Annot.Property property)
 Remove a specified annotation's property.
More...
 
bool ResetAppearanceStream ()
 Reset appearance stream.
More...
 
void SetBorderColor (int color)
 Set border color.
More...
 
void SetBorderInfo (BorderInfo border)
 Set border information.
More...
 
void SetContent (string content)
 Set content.
More...
 
void SetFlags (int flags)
 Set annotation flags.
More...
 
void SetModifiedDateTime (DateTime date_time)
 Set last modified date time.
More...
 
void SetUniqueID (string unique_id)
 Set unique ID.
More...
 

Additional Inherited Members

- Public Types inherited from foxit.pdf.annots.Markup
enum  EndingStyle {
  EndingStyle.e_EndingStyleNone = 0, EndingStyle.e_EndingStyleSquare = 1, EndingStyle.e_EndingStyleCircle = 2, EndingStyle.e_EndingStyleDiamond = 3,
  EndingStyle.e_EndingStyleOpenArrow = 4, EndingStyle.e_EndingStyleClosedArrow = 5, EndingStyle.e_EndingStyleButt = 6, EndingStyle.e_EndingStyleROpenArrow = 7,
  EndingStyle.e_EndingStyleRClosedArrow = 8, EndingStyle.e_EndingStyleSlash = 9
}
 Enumeration for line ending style.
More...
 
enum  MeasureType {
  MeasureType.e_MeasureTypeX = 0, MeasureType.e_MeasureTypeY = 1, MeasureType.e_MeasureTypeD = 2, MeasureType.e_MeasureTypeA = 3,
  MeasureType.e_MeasureTypeT = 4, MeasureType.e_MeasureTypeS = 5
}
 Enumeration for annotation's measure type.
More...
 
enum  State {
  State.e_StateMarked = 1, State.e_StateUnmarked = 2, State.e_StateAccepted = 3, State.e_StateRejected = 4,
  State.e_StateCancelled = 5, State.e_StateCompleted = 6, State.e_StateNone = 7
}
 Enumeration for markup annotation's state.
More...
 
enum  StateModel { StateModel.e_StateModelMarked = 1, StateModel.e_StateModelReview = 2 }
 Enumeration for markup annotation's state model.
More...
 
- Public Types inherited from foxit.pdf.annots.Annot
enum  AppearanceType { AppearanceType.e_AppearanceTypeNormal = 0, AppearanceType.e_AppearanceTypeRollover = 1, AppearanceType.e_AppearanceTypeDown = 2 }
 Enumeration for the type of annotation's appearance.
More...
 
enum  Flags {
  Flags.e_FlagInvisible = 0x0001, Flags.e_FlagHidden = 0x0002, Flags.e_FlagPrint = 0x0004, Flags.e_FlagNoZoom = 0x0008,
  Flags.e_FlagNoRotate = 0x0010, Flags.e_FlagNoView = 0x0020, Flags.e_FlagReadOnly = 0x0040, Flags.e_FlagLocked = 0x0080,
  Flags.e_FlagToggleNoView = 0x0100, Flags.e_FlagLockedContents = 0x0200
}
 Enumeration for PDF annotation flags.
More...
 
enum  HighlightingMode {
  HighlightingMode.e_HighlightingNone = 0, HighlightingMode.e_HighlightingInvert = 1, HighlightingMode.e_HighlightingOutline = 2, HighlightingMode.e_HighlightingPush = 3,
  HighlightingMode.e_HighlightingToggle = 4
}
 Enumeration for PDF annotation highlighting mode.
More...
 
enum  MKEntry {
  MKEntry.e_MKEntryRotation = 0, MKEntry.e_MKEntryBorderColor = 1, MKEntry.e_MKEntryBackgroundColor = 2, MKEntry.e_MKEntryNormalCaption = 3,
  MKEntry.e_MKEntryRolloverCaption = 4, MKEntry.e_MKEntryDownCaption = 5, MKEntry.e_MKEntryNormalIcon = 6, MKEntry.e_MKEntryRolloverIcon = 7,
  MKEntry.e_MKEntryDownIcon = 8, MKEntry.e_MKEntryIconFit = 9, MKEntry.e_MKEntryIconCaptionRelation = 10
}
 Enumeration for annotation's MK dictionary (an appearance characteristics) entry.
More...
 
enum  MKIconCaptionRelation {
  MKIconCaptionRelation.e_MKRelationNoIcon = 0, MKIconCaptionRelation.e_MKRelationNoCaption = 1, MKIconCaptionRelation.e_MKRelationCaptionBelowIcon = 2, MKIconCaptionRelation.e_MKRelationCaptionAboveIcon = 3,
  MKIconCaptionRelation.e_MKRelationCaptionRight = 4, MKIconCaptionRelation.e_MKRelationCaptionLeft = 5, MKIconCaptionRelation.e_MKRelationCaptionOvrlayOnIcon = 6
}
 Enumeration for icon and caption relative position in annotation's MK dictionary.
More...
 
enum  Property { Property.e_PropertyModifiedDate = 0, Property.e_PropertyCreationDate = 1, Property.e_PropertyBorderColor = 2, Property.e_PropertyFillColor = 3 }
 Enumeration for some PDF annotation property.
More...
 
enum  Type {
  Type.e_UnknownType = 0, Type.e_Note = 1, Type.e_Link = 2, Type.e_FreeText = 3,
  Type.e_Line = 4, Type.e_Square = 5, Type.e_Circle = 6, Type.e_Polygon = 7,
  Type.e_PolyLine = 8, Type.e_Highlight = 9, Type.e_Underline = 10, Type.e_Squiggly = 11,
  Type.e_StrikeOut = 12, Type.e_Stamp = 13, Type.e_Caret = 14, Type.e_Ink = 15,
  Type.e_PSInk = 16, Type.e_FileAttachment = 17, Type.e_Sound = 18, Type.e_Movie = 19,
  Type.e_Widget = 20, Type.e_Screen = 21, Type.e_PrinterMark = 22, Type.e_TrapNet = 23,
  Type.e_Watermark = 24, Type.e_3D = 25, Type.e_Popup = 26, Type.e_Redact = 27
}
 Enumeration for PDF annotation type.
More...
 

Detailed Description

A stamp annotation displays text or graphics intended to look as if they were stamped on the page with a rubber stamp.
A stamp annotation's appearance can be with an icon or a bitmap. Currently, Foxit PDF SDK does not have any default appearance for predefined standard stamp icons, so user should set a customized annotation icon provider to Foxit PDF SDK by function common.Library.SetAnnotIconProviderCallback if the stamp is represented by icon.
Stamp annotation is a kind of markup annotation, so class Stamp is derived from class Markup , and also offers functions to get/set stamp annotation's properties and reset appearance stream of a stamp annotation.
Before resetting appearance stream of a stamp annotation, please ensure a stamp annotation has been set valid bitmap or image, or it has an icon name with the supported customized annotation icon provider being set to Foxit PDF SDK; otherwise the stamp annotation cannot be reset appearance stream.

Note
For a newly created stamp annotation, some properties will be set with default values:
opacity = 1.0, icon name = "Draft".
Before calling Annot.ResetAppearanceStream (inherited from Stamp 's parent class), user should ensure to set a bitmap to the stamp by function Stamp.SetBitmap or Stamp.SetImage , or set a useful customized annotation icon provider to Foxit PDF SDK by function common.Library.SetAnnotIconProviderCallback .
See also
Markup
foxit.common.Library

Constructor & Destructor Documentation

◆ Stamp()

foxit.pdf.annots.Stamp.Stamp ( Annot  annot)
inline

Constructor, with parent class object.

Parameters
[in]annotParent class object.

Member Function Documentation

◆ GetIconName()

string foxit.pdf.annots.Stamp.GetIconName ( )
inline

Get icon name.

This property may has effect on stamp annotation's appearance when a supported customized annotation icon provider being set to Foxit PDF SDK. Stamp annotation has predefined standard icon names:
"Approved", "AsIs", "Confidential", "Departmental", "Draft", "Experimental", "Expired", "Final", "ForComment", "ForPublicRelease", "NotApproved", "NotForPublicRelease", "Sold", "TopSecret".

Returns
Icon name string.

◆ GetRotation()

int foxit.pdf.annots.Stamp.GetRotation ( )
inline

Get current rotation angle (in clockwise).

Returns
Current rotation angle (in clockwise). Value range: from 0 to 360.

◆ Rotate()

void foxit.pdf.annots.Stamp.Rotate ( int  angle)
inline

Rotate current annotation from current state with specified angle degree in clockwise.

Parameters
[in]angleAngle degree value, which is used to rotate current annotation from current state in clockwise. Value range: from 0 to 360. Specially, if the input value is 0 or 360 (which means not to rotate current annotation), current function will do nothing.
Returns
None.

◆ SetBitmap()

void foxit.pdf.annots.Stamp.SetBitmap ( Bitmap  bitmap)
inline

Set bitmap to current stamp annotation.

If user wants the new bitmap has effect on annotation's appearance, please call function Annot.ResetAppearanceStream after setting the new bitmap.

Parameters
[in]bitmapA bitmap to be set to current stamp.
Returns
None.

◆ SetIconName()

void foxit.pdf.annots.Stamp.SetIconName ( string  icon_name)
inline

Set icon name.

This property may has effect on stamp annotation's appearance when a supported customized annotation icon provider being set to Foxit PDF SDK. Stamp annotation has predefined standard icon names:
"Approved", "AsIs", "Confidential", "Departmental", "Draft", "Experimental", "Expired", "Final", "ForComment", "ForPublicRelease", "NotApproved", "NotForPublicRelease", "Sold", "TopSecret".
Once user set a new icon name to current stamp annotation, please ensure the customized icon provider has been set to Foxit PDF SDK by function common.Library.SetAnnotIconProviderCallback before function Annot.ResetAppearanceStream (inherited from Stamp's parent class) is called. For a newly created stamp annotation, if current function is not called, icon name will be "Draft" by default.
If user wants the new icon name has effect on annotation's appearance, please ensure a supported customized annotation icon provider has been set to Foxit PDF SDK and then call function Annot.ResetAppearanceStream after setting the new icon name.

Parameters
[in]icon_nameNew icon name string to be set. An empty icon name string means icon of current stamp annotation would be treated as "Draft".
Returns
None.

◆ SetImage()

void foxit.pdf.annots.Stamp.SetImage ( Image  image,
int  frame_index,
int  compress 
)
inline

Set image to current stamp annotation, with a specified frame index.

Input image may contain multiple frames, and only one frame of the image can be set to current stamp annotation.
If user wants the new image has effect on annotation's appearance, please call function Annot.ResetAppearanceStream after setting the new image.

Parameters
[in]imageAn image. One of its frames will be set to current stamp. This image contains at least one frame and the image type should not be foxit.common.Image.Type.e_Unknown .
[in]frame_indexFrame index. Valid range: from 0 to (count-1). count is returned by function common.Image.GetFrameCount .
[in]compressCompress algorithm type used to compress image data. Currently, it only supports 2 valid value:
  • 0: no compress.
  • 1: do default compress.

Returns
None.

◆ SetRotation()

void foxit.pdf.annots.Stamp.SetRotation ( int  angle)
inline

Set rotation angle (in clockwise).

This property has effect on stamp annotation's appearance. If user wants the effect to be shown in annotation's appearance, please call function Annot.ResetAppearanceStream after this function.

Parameters
[in]angleNew rotation angle (in clockwise) to be set to current annotation. Value range: from 0 to 360.
Returns
None.