Foxit PDF SDK
|
Instance Methods | |
(FSNote *) | - addReply |
Add a new reply to the end of reply list. More... | |
(FSNote *) | - addStateAnnot: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... | |
(FSNote *) | - getStateAnnot:index: |
Get a state annotation, under a specified state model. More... | |
(int) | - getStateAnnotCount: |
Get the count of state annotations, under a specified state model. More... | |
(id) | - initWithAnnot: |
Constructor, with parent class object. 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 state annotations. More... | |
(BOOL) | - removeReply: |
Remove a reply 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 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 . More... | |
(FSAnnotType) | - getType |
Get actual annotation type of current annotation. 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 . More... | |
(BOOL) | - removeProperty: |
Remove a specified annotation's property. More... | |
(BOOL) | - resetAppearanceStream |
Reset appearance stream. More... | |
Properties | |
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. | |
![]() | |
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. | |
Markup annotations are used primarily to mark up PDF documents. These annotations have text that appears as part of the annotation and may be displayed in other ways by a viewer application, such as in a Comments pane.
Class FSMarkup is derived from class FSAnnot , and is also the base class for all PDF markup annotations. It offers the base functions to get/set markup annotation's common properties. For concrete markup annotation types, please refer to derived classes.
Function FSAnnot::isMarkup can be used to judge if an annotation is a markup annotation.
- (FSNote *) addReply |
Add a new reply to the end of reply list.
- (FSNote *) addStateAnnot: | (FSMarkupStateModel) | model | |
state: | (FSMarkupState) | state | |
Add a new state annotation.
A markup annotation may have an author-specific state associated with it. The state is not specified in the annotation itself but in a separate text annotation that refers to the original annotation.
Usually, when state model is FSMarkupStateModelMarked, the markup annotation only has one state annotation.
When state model is FSMarkupStateModelReview, the markup annotation can have several state annotations in a chain: first state annotation refers to the markup annotation, second state annotation refers to the first state annotation, etc. Just like this: markup annotation <– reviewed state1 <– reviewed state2 ...
[in] | model | State model for the new state annotation. It should be one of following values:
|
[in] | state | State value for the new state annotation. It should be one of following values:
|
- (FSMarkupArray *) getGroupElements |
Get an element (as markup annotation) from the group that current markup annotation belongs to.
Markup annotations can be grouped. The group consists of a primary annotation and one or more subordinate annotations. Some entries in the primary annotation are treated as group attributes that should apply to the group as a whole; the corresponding entries in the subordinate annotations should be ignored. These entries are contents, last modification time, fill color/border color, title, pop-up annotation, creation time, subject, and open status. So user should respect the group property: when a property of an annotation in group is changed, the other annotations in the same group should be changed too.
Operations that manipulate any annotation in a group, such as movement, cut, and copy, should be treated by viewer applications as acting on the entire group.
- (FSMarkup *) getGroupHeader |
Get the header annotation (as primary annotation) of the group that current markup annotation belongs to.
Markup annotations can be grouped. The group consists of a primary annotation and one or more subordinate annotations. Some entries in the primary annotation are treated as group attributes that should apply to the group as a whole; the corresponding entries in the subordinate annotations should be ignored. These entries are contents, last modification time, fill color/border color, title, pop-up annotation, creation time, subject, and open status. So user should respect the group property: when a property of an annotation in group is changed, the other annotations in the same group should be changed too.
Operations that manipulate any annotation in a group, such as movement, cut, and copy, should be treated by viewer applications as acting on the entire group.
- (FSNote *) getReply: | (int) | index |
Get a reply by index.
[in] | index | The index for a specified reply. Valid range: from 0 to (count-1). count is returned by function FSMarkup::getReplyCount. |
- (int) getReplyCount |
Count all replies.
- (FSNote *) getStateAnnot: | (FSMarkupStateModel) | model | |
index: | (int) | index | |
Get a state annotation, under a specified state model.
A markup annotation may have an author-specific state associated with it. The state is not specified in the annotation itself but in a separate text annotation that refers to the original annotation.
Usually, when state model is FSMarkupStateModelMarked, the markup annotation only has one state annotation.
When state model is FSMarkupStateModelReview, the markup annotation can have several state annotations in a chain: first state annotation refers to the markup annotation, second state annotation refers to the first state annotation, etc. Just like this: markup annotation <– reviewed state1 <– reviewed state2 ...
[in] | model | State model. It should be one of following values:
|
[in] | index | The index of the state annotation to be retrieved. Valid range: from 0 to (count-1). count is returned by function FSMarkup::getStateAnnotCount: with the same parameter model. |
- (int) getStateAnnotCount: | (FSMarkupStateModel) | model |
Get the count of state annotations, under a specified state model.
A markup annotation may have an author-specific state associated with it. The state is not specified in the annotation itself but in a separate text annotation that refers to the original annotation.
Usually, when state model is FSMarkupStateModelMarked, the markup annotation only has one state annotation.
When state model is FSMarkupStateModelReview, the markup annotation can have several state annotations in a chain: first state annotation refers to the markup annotation, second state annotation refers to the first state annotation, etc. Just like this: markup annotation <– reviewed state1 <– reviewed state2 ...
[in] | model | State model It should be one of following values:
|
- (id) initWithAnnot: | (FSAnnot*) | annot |
Constructor, with parent class object.
[in] | annot | Parent class object. |
Reimplemented from FSAnnot.
Reimplemented in FSRedact, FSFileAttachment, FSCaret, FSPolyLine, FSPolygon, FSStamp, FSInk, FSLine, FSFreeText, FSCircle, FSSquare, FSTextMarkup, FSHighlight, FSUnderline, FSStrikeOut, FSSquiggly, and FSNote.
- (BOOL) isGrouped |
Check whether current markup annotation is in a group or not.
Markup annotations can be grouped. The group consists of a primary annotation and one or more subordinate annotations. Some entries in the primary annotation are treated as group attributes that should apply to the group as a whole; the corresponding entries in the subordinate annotations should be ignored. These entries are contents, last modification time, fill color/border color, title, pop-up annotation, creation time, subject, and open status. So user should respect the group property: when a property of an annotation in group is changed, the other annotations in the same group should be changed too.
Operations that manipulate any annotation in a group, such as movement, cut, and copy, should be treated by viewer applications as acting on the entire group.
- (BOOL) removeAllReplies |
Remove all the replies.
- (BOOL) removeAllStateAnnots |
Remove all state annotations.
State annotation is represented by note annotation, so, to remove state annotations also means to remove the special note annotations (with its popup if any) from the page.
- (BOOL) removeReply: | (int) | index |
Remove a reply by index.
If specified reply has its own replies, these sub replies will be removed at the same time.
[in] | index | The index for a specified reply to be removed. Valid range: from 0 to (count-1). count is returned by function FSMarkup::getReplyCount. |
- (BOOL) ungroup |
Ungroup current markup annotation from the group it belongs to.
|
readwritenonatomicweak |
Get or Set intent name.
Following annotation types have predefined intent name:
|
readwritenonatomicassign |
Get or Set opacity value.
This property has effect on markup annotation's appearance.
|
readwritenonatomicweak |
Get or Set related pop-up annotation.
Most markup annotations can have a pop-up annotation to show their content, except sound and free text annotations:
Though, in some special(or error) PDF document, sound or free text annotation may have a pop-up annotation, they still do not need a pop-up annotation.