Foxit PDF SDK
|
Instance Methods | |
(FSMarkup *) | - getReplyTo |
Get the markup annotation, which current note annotation is in reply to. More... | |
(FSMarkupStateModel) | - getStateModel |
Get the state model. More... | |
(id) | - init |
Constructor. | |
(id) | - initWithAnnot: |
Constructor, with parent class object. More... | |
(BOOL) | - isStateAnnot |
Check if current note annotation is used as a state annotation. More... | |
![]() | |
(FSNote *) | - addReply |
Add a new reply to the end of reply list. More... | |
(void) | - addRichText:style: |
Add a new rich text string to the end. More... | |
(FSNote *) | - addStateAnnot:model:state: |
Add a new state annotation. More... | |
(FSMarkupArray *) | - getGroupElements |
Get an element (as markup annotation) from the group that current markup annotation belongs to. More... | |
(FSMarkup *) | - getGroupHeader |
Get the header annotation (as primary annotation) of the group that current markup annotation belongs to. More... | |
(FSNote *) | - getReply: |
Get a reply by index. More... | |
(int) | - getReplyCount |
Count all replies. More... | |
(NSString *) | - getRichTextContent: |
Get text string of a rich text string specified by index. More... | |
(int) | - getRichTextCount |
Get the count of rich text string. More... | |
(FSRichTextStyle *) | - getRichTextStyle: |
Get style data of a rich text string specified by index. More... | |
(FSNoteArray *) | - getStateAnnots: |
Get all state annotations in a specified state model. More... | |
(void) | - insertRichText:content: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: |
Remove a reply by index. More... | |
(void) | - removeRichText: |
Remove a rich text string specified by index. More... | |
(void) | - setRichTextContent:content: |
Set text string of a rich text string specified by index. More... | |
(void) | - setRichTextStyle:style: |
Set style data of a rich text string specified by index. More... | |
(BOOL) | - ungroup |
Ungroup current markup annotation from the group it belongs to. More... | |
![]() | |
(FSPDFStream *) | - getAppearanceStream:appearance_state: |
Get annotation's appearance stream with specified type and state. More... | |
(FSRectI *) | - getDeviceRect: |
Get annotation rectangle in device coordinate system. More... | |
(FSPDFDictionary *) | - getDict |
Get annotation's dictionary object. More... | |
(FSMatrix2D *) | - getDisplayMatrix: |
Get the display matrix, from PDF coordinate system to targeted device coordinate system. More... | |
(int) | - getIndex |
Get the index of current annotation in the page which current annotation belongs to. More... | |
(FSPDFDictionary *) | - getOptionalContent |
Get the PDF dictionary of annotation's optional content. More... | |
(FSPDFPage *) | - getPage |
Get the related PDF page. More... | |
(FSRectF *) | - getRect |
Get rectangle, in PDF coordinate system. More... | |
(FSAnnotType) | - getType |
Get actual annotation type of current annotation. More... | |
(BOOL) | - hasProperty: |
Whether current annotation has the specified annotation's property. More... | |
(id) | - initWithPage:annot_dict: |
Constructor, with PDF page and annotation's PDF dictionary. 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: |
Move current annotation to a new position, specified by a new rectangle in PDF coordinate system. More... | |
(BOOL) | - removeProperty: |
Remove a specified annotation's property. More... | |
(BOOL) | - resetAppearanceStream |
Reset appearance stream. More... | |
Properties | |
NSString * | iconName |
Get or Set icon name. More... | |
BOOL | openStatus |
Get or Set open status. More... | |
FSMarkupState | state |
Get or Set the state. More... | |
![]() | |
FSDateTime * | creationDateTime |
Get or Set creation date time. | |
NSString * | intent |
Get or Set intent name. More... | |
float | opacity |
Get or Set opacity value. More... | |
FSPopup * | popup |
Get or Set related pop-up annotation. More... | |
NSString * | subject |
Get or Set subject string. | |
NSString * | title |
Get or Set title string. More... | |
![]() | |
unsigned int | borderColor |
Get or Set border color. More... | |
FSBorderInfo * | borderInfo |
Get or Set border information. More... | |
NSString * | content |
Get or Set content. | |
unsigned int | flags |
Get or Set annotation flags. | |
FSDateTime * | modifiedDateTime |
Get or Set last modified date time. | |
NSString * | uniqueID |
Get or Set unique ID. | |
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 FSNote is derived from class FSMarkup . It offers functions to get/set note annotation's properties and reset appearance of a note annotation.
- (FSMarkup *) 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.
- (FSMarkupStateModel) getStateModel |
Get the state model.
This function can only be used when current note annotation is used as a state annotation. Function FSNote::isStateAnnot can be used to check if current note annotation is used as a state annotation.
- (id) initWithAnnot: | (FSAnnot*) | annot |
Constructor, with parent class object.
[in] | annot | Parent class object. |
Reimplemented from FSMarkup.
- (BOOL) isStateAnnot |
Check if current note annotation is used as a state annotation.
|
readwritenonatomicweak |
Get or 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.
|
readwritenonatomicassign |
Get or Set open status.
Open status is a boolean value that specifies whether a note annotation should initially be displayed open:
|
readwritenonatomicassign |
Get or Set the state.
This function can only be used when current note annotation is used as a state annotation. Function FSNote::isStateAnnot can be used to check if current note annotation is used as a state annotation.