Foxit PDF SDK
|
Public Member Functions | |
constructor () | |
Constructor. | |
constructor (annot) | |
Constructor, with parent class object. More... | |
GetIconName () | |
Get icon name. More... | |
GetOpenStatus () | |
Get open status. More... | |
GetReplyTo () | |
Get the markup annotation, which current note annotation is in reply to. More... | |
GetState () | |
Get the state. More... | |
GetStateModel () | |
Get the state model. More... | |
IsStateAnnot () | |
Check if current note annotation is used as a state annotation. More... | |
SetIconName (icon_name) | |
Set icon name. More... | |
SetOpenStatus (status) | |
Set open status. More... | |
SetState (state) | |
Set the state. More... | |
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:
Note annotation is a kind of markup annotation, so class FSDK.Note is derived from class FSDK.Markup. It offers functions to get/set note annotation's properties and reset appearance of a note annotation.
FSDK.Note.constructor | ( | annot | ) |
Constructor, with parent class object.
[in] | annot | Parent class object. |
FSDK.Note.GetIconName | ( | ) |
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.
FSDK.Note.GetOpenStatus | ( | ) |
Get open status.
Open status is a boolean value that specifies whether a note annotation should initially be displayed open:
FSDK.Note.GetReplyTo | ( | ) |
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.
FSDK.Note.GetState | ( | ) |
Get the state.
This function can only be used when current note annotation is used as a state annotation. Function FSDK.Note.IsStateAnnot can be used to check if current note annotation is used as a state annotation.
FSDK.Note.GetStateModel | ( | ) |
Get the state model.
This function can only be used when current note annotation is used as a state annotation. Function FSDK.Note.IsStateAnnot can be used to check if current note annotation is used as a state annotation.
FSDK.Note.IsStateAnnot | ( | ) |
Check if current note annotation is used as a state annotation.
FSDK.Note.SetIconName | ( | icon_name | ) |
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 FSDK.Annot.ResetAppearanceStream after setting the new icon name.
[in] | icon_name | New icon name string to be set. |
FSDK.Note.SetOpenStatus | ( | status | ) |
Set open status.
Open status is a boolean value that specifies whether a note annotation should initially be displayed open:
[in] | status | The new open status value. |
FSDK.Note.SetState | ( | state | ) |
Set the state.
This function can only be used when current note annotation is used as a state annotation. Function FSDK.Note.IsStateAnnot can be used to check if current note annotation is used as a state annotation.
[in] | state | New state. It should be one of following values:
|