|
Foxit PDF SDK
|
Instance Methods | |
| (float) | - getMeasureConversionFactor: |
| Get the conversion factor for measuring. More... | |
| (NSString *) | - getMeasureRatioW |
| Get the scale ratio Unicode string for measuring. More... | |
| (NSString *) | - getMeasureUnit: |
| Get the label for displaying the units for measuring. More... | |
| (NSString *) | - getMeasureUnitW: |
| Get the label (in Unicode string) for displaying the units for measuring. More... | |
| (id) | - init |
| Constructor. | |
| (id) | - initWithAnnot: |
| Constructor, with parent class object. More... | |
| (void) | - setMeasureConversionFactor:factor: |
| Set the conversion factor for measuring. More... | |
| (void) | - setMeasureUnit:unit: |
| Set the label for displaying the units for measuring. More... | |
Instance Methods inherited from FSMarkup | |
| (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 strings. 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) | - removePopup |
| Remove related pop-up annotation. 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... | |
Instance Methods inherited from FSAnnot | |
| (BOOL) | - FSMoveWithResetAppearance:is_reset_appearance: |
| Move current annotation to a new position, specified by a new rectangle in PDF coordinate system. More... | |
| (BOOL) | - FSResetApStreamWithIsGenerateNewAppearanceObj: |
| Reset appearance stream. 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 | |
| unsigned int | fillColor |
| Get or Set fill color. More... | |
| NSString * | measureRatio |
| Get or Set the scale ratio string for measuring. More... | |
| FSPointFArray * | vertexes |
| Get or Set vertexes. More... | |
Properties inherited from FSMarkup | |
| float | borderOpacity |
| Get or Set the border opacity of the annotation. | |
| FSDateTime * | creationDateTime |
| Get or Set creation date time. | |
| float | fillOpacity |
| Get or Set the fill opacity of the annotation. | |
| 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... | |
Properties inherited from FSAnnot | |
| 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 polygon annotation displays a closed polygon on the page.
Polygon annotation is a kind of markup annotation, so class FSPolygon is derived from class FSMarkup , and also offers functions to get/set polygon annotation's properties and reset appearance stream of a polygon annotation.
For a polygon annotation, vertexes property is required. So please ensure that a polygon annotation has valid vertexes property before resetting its appearance stream; otherwise the polygon annotation cannot be reset appearance stream.
| - (float) getMeasureConversionFactor: | (FSMarkupMeasureType) | measure_type |
Get the conversion factor for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
| [in] | measure_type | Measure type. Please refer to values starting from FSMarkupMeasureTypeX and this would be one of these values. |
| - (NSString *) getMeasureRatioW |
Get the scale ratio Unicode string for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Scale ratio string expresses the scale ratio of the drawing in the region. Please refer to P745 in <PDF Reference 1.7> for more details.
| - (NSString *) getMeasureUnit: | (FSMarkupMeasureType) | measure_type |
Get the label for displaying the units for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
| [in] | measure_type | Measure type. Please refer to values starting from FSMarkupMeasureTypeX and this should be one of these values. |
| - (NSString *) getMeasureUnitW: | (FSMarkupMeasureType) | measure_type |
Get the label (in Unicode string) for displaying the units for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
| [in] | measure_type | Measure type. Please refer to values starting from FSMarkupMeasureTypeX and this should be one of these values. |
| - (id) initWithAnnot: | (FSAnnot*) | annot |
Constructor, with parent class object.
| [in] | annot | Parent class object. |
Reimplemented from FSMarkup.
| - (void) setMeasureConversionFactor: | (FSMarkupMeasureType) | measure_type | |
| factor: | (float) | factor | |
Set the conversion factor for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
| [in] | measure_type | Measure type. Please refer to values starting from FSMarkupMeasureTypeX and this would be one of these values. |
| [in] | factor | The conversion factor. |
| - (void) setMeasureUnit: | (FSMarkupMeasureType) | measure_type | |
| unit: | (NSString *) | unit | |
Set the label for displaying the units for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Please refer to P745 in <PDF Reference 1.7> for more details.
| [in] | measure_type | Measure type. Please refer to values starting from FSMarkupMeasureTypeX and this should be one of these values. |
| [in] | unit | A UTF-8 text string that specifies a label for displaying the units. |
|
readwritenonatomicassign |
Get or Set fill color.
This property has effect on polygon annotation's appearance.
|
readwritenonatomicweak |
Get or Set the scale ratio string for measuring.
A polygon annotation may have a measure dictionary that specifies an alternate coordinate system for a region of a page. Scale ratio string expresses the scale ratio of the drawing in the region. Please refer to P745 in <PDF Reference 1.7> for more details.
|
readwritenonatomicweak |
Get or Set vertexes.
Vertexes property is required for a polygon annotation and this property has effect on polygon annotation's appearance.