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

Public Member Functions

 Note ()
 Constructor.
 
 Note (Annot annot)
 Constructor, with parent class object. More...
 
string GetIconName ()
 Get icon name. More...
 
bool GetOpenStatus ()
 Get open status. More...
 
Markup GetReplyTo ()
 Get the markup annotation, which current note annotation is in reply to. More...
 
Markup.State GetState ()
 Get the state. More...
 
Markup.StateModel GetStateModel ()
 Get the state model. More...
 
bool IsStateAnnot ()
 Check if current note annotation is used as a state annotation. More...
 
void SetIconName (string icon_name)
 Set icon name. More...
 
void SetOpenStatus (bool status)
 Set open status. More...
 
void SetState (Markup.State state)
 Set the state. 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 strings. 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 RemovePopup ()
 Remove related pop-up annotation. 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 Move (RectF rect, bool is_reset_appearance)
 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...
 
bool ResetAppearanceStream (bool is_generate_new_appearance_obj)
 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_StateNone = 0, 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_StateDeferred = 7,
  State.e_StateFuture = 8
}
 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,
  Type.e_RichMedia = 28, Type.e_PagingSeal = 29
}
 Enumeration for PDF annotation type. More...
 

Detailed Description

A note annotation (known as "text" annotation in <PDF reference 1.7>) represents a "sticky note" attached to a point in the PDF document. When closed, the annotation appears as an icon; when open, it displays a pop-up window containing the text of the note in a font and size chosen by the viewer application.
A note annotation can also be used as a reply to a markup annotation, or a state annotation:

  • When as a reply, the note annotation should not be shown alone but together with other replies in the form of threaded comments. Function Note.GetReplyTo can be used to get the markup annotation, to which the note annotation replies.

  • When as a state, the note annotation would not be shown alone. Function Note.IsStateAnnot can be used to judge if a note annotation is used as a state.

Note annotation is a kind of markup annotation, so class Note is derived from class Markup . It offers functions to get/set note annotation's properties and reset appearance of a note annotation.

Note
For a newly created common note annotation, if user calls function Annot.ResetAppearanceStream directly without setting any properties, the default appearance will be used:
border color = 0xFFFFFF00 (yellow), opacity = 1.0, icon name = "Comment".
See also
Markup

Constructor & Destructor Documentation

◆ Note()

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

Constructor, with parent class object.

Parameters
[in]annotParent class object.

Member Function Documentation

◆ GetIconName()

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

Get icon name.

This property has effect on note annotation's appearance. Note annotation has predefined standard icon names:
"Check", "Circle", "Comment", "Cross", "Help", "Insert", "Key", "NewParagraph", "Note", "Paragraph", "RightArrow", "RightPointer", "Star", "UpArrow", "UpLeftArrow".
An empty icon name string means current note annotation would be treated as "Note" icon.

Returns
Icon name string.

◆ GetOpenStatus()

bool foxit.pdf.annots.Note.GetOpenStatus ( )
inline

Get open status.

Open status is a boolean value that specifies whether a note annotation should initially be displayed open:

  • true means the note annotation should be initially be displayed open.

  • false means the note annotation should be initially be displayed closed.

Returns
Open status.

◆ GetReplyTo()

Markup foxit.pdf.annots.Note.GetReplyTo ( )
inline

Get the markup annotation, which current note annotation is in reply to.

This function is only useful when current note annotation is used as a reply.

Returns
A markup annotation object, which current note annotation is in reply to. If the return value of function Annot.IsEmpty (inherited from Markup's parent class) for the returned markup annotation object is true, that means current note annotation is not used as a reply.

◆ GetState()

Markup.State foxit.pdf.annots.Note.GetState ( )
inline

Get the state.

This function can only be used when current note annotation is used as a state annotation. Function Note.IsStateAnnot can be used to check if current note annotation is used as a state annotation.

Returns
The state. Please refer to values starting from foxit.pdf.annots.Markup.State.e_StateMarked and this would be one of these values. If current note annotation is not a state annotation, This function will return 0.

◆ GetStateModel()

Markup.StateModel foxit.pdf.annots.Note.GetStateModel ( )
inline

Get the state model.

This function can only be used when current note annotation is used as a state annotation. Function Note.IsStateAnnot can be used to check if current note annotation is used as a state annotation.

Returns
The state model. If function succeeds, the return value would be foxit.pdf.annots.Markup.StateModel.e_StateModelMarked or foxit.pdf.annots.Markup.StateModel.e_StateModelReview .
If current note annotation is not a state annotation, this function will return 0.

◆ IsStateAnnot()

bool foxit.pdf.annots.Note.IsStateAnnot ( )
inline

Check if current note annotation is used as a state annotation.

Returns
true means current note annotation is used as a state annotation, while false means current note annotation is just a common note annotation.

◆ SetIconName()

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

Set icon name.

This property has effect on note annotation's appearance. Note annotation has predefined standard icon names:
"Check", "Circle", "Comment", "Cross", "Help", "Insert", "Key", "NewParagraph", "Note", "Paragraph", "RightArrow", "RightPointer", "Star", "UpArrow", "UpLeftArrow".
An empty icon name string means current note annotation would be treated as "Note" icon.
For a newly created note annotation, if current function is not called, icon name will be "Comment" by default.
If user wants the new icon name has effect on annotation's appearance, please call function Annot.ResetAppearanceStream after setting the new icon name.

Parameters
[in]icon_nameNew icon name string to be set.
Returns
None.

◆ SetOpenStatus()

void foxit.pdf.annots.Note.SetOpenStatus ( bool  status)
inline

Set open status.

Open status is a boolean value that specifies whether a note annotation should initially be displayed open:

  • true means the note annotation should be initially be displayed open.

  • false means the note annotation should be initially be displayed closed.

Parameters
[in]statusThe new open status value.
Returns
None.

◆ SetState()

void foxit.pdf.annots.Note.SetState ( Markup.State  state)
inline

Set the state.

This function can only be used when current note annotation is used as a state annotation. Function Note.IsStateAnnot can be used to check if current note annotation is used as a state annotation.

Parameters
[in]stateNew state. It should be one of following values: State model can be gotten by function Note.GetStateModel .
Returns
None.