Foxit PDF SDK
|
Enumeration for application's information type.
Values of this enumeration should be used alone.
Enumeration for language.
Values of this enumeration should be used alone.
enum FSActionType |
Enumeration for action type.
Values of this enumeration should be used alone.
Enumeration for trigger event.
Values of this enumeration should be used alone.
Enumerator | |
---|---|
FSAdditionalActionTriggerPageOpened | Trigger an action to be performed when the page is opened. This represents "O" entry in a page object's additional-actions dictionary. Only applicable for additional action object constructed from PDF page. |
FSAdditionalActionTriggerPageClosed | Trigger an action to be performed when the page is closed. This represents "C" entry in a page object's additional-actions dictionary. Only applicable for additional action object constructed from PDF page. |
FSAdditionalActionTriggerDocWillClose | Trigger a JavaScript action to be performed before closing a document. This represents "WC" entry in a document catalog's additional-actions dictionary. Only applicable for additional action object constructed from PDF document. |
FSAdditionalActionTriggerDocWillSave | Trigger a JavaScript action to be performed before saving a document. This represents "WS" entry in a document catalog's additional-actions dictionary. Only applicable for additional action object constructed from PDF document. |
FSAdditionalActionTriggerDocSaved | Trigger a JavaScript action to be performed after saving a document. This represents "DS" entry in a document catalog's additional-actions dictionary. Only applicable for additional action object constructed from PDF document. |
FSAdditionalActionTriggerDocWillPrint | Trigger a JavaScript action to be performed before printing a document. This represents "WP" entry in a document catalog's additional-actions dictionary. Only applicable for additional action object constructed from PDF document. |
FSAdditionalActionTriggerDocPrinted | Trigger a JavaScript action to be performed after printing a document. This represents "DP" entry in a document catalog's additional-actions dictionary. Only applicable for additional action object constructed from PDF document. |
FSAdditionalActionTriggerFieldKeyStroke | Trigger a JavaScript action to be performed when the user types a keystroke into a text field or combo box or modifies the selection in a scrollable list box. This represents "K" entry in a form field's additional-actions dictionary. Only applicable for additional action object constructed from PDF form field. |
FSAdditionalActionTriggerFieldWillFormat | Trigger a JavaScript action to be performed before the field is formatted to display its current value. This represents "F" entry in a form field's additional-actions dictionary. Only applicable for additional action object constructed from PDF form field. |
FSAdditionalActionTriggerFieldValueChanged | Trigger a JavaScript action to be performed when the field's value is changed. This represents "V" entry in a form field's additional-actions dictionary. Only applicable for additional action object constructed from PDF form field. |
FSAdditionalActionTriggerFieldRecalculateValue | Trigger a JavaScript action to be performed to recalculate the value of this field when that of another field changes. This represents "C" entry in a form field's additional-actions dictionary. Only applicable for additional action object constructed from PDF form field. |
FSAdditionalActionTriggerAnnotCursorEnter | Trigger an action to be performed when the cursor enters the annotation's active area. This represents "E" entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation. |
FSAdditionalActionTriggerAnnotCursorExit | Trigger an action to be performed when the cursor exits the annotation's active area. This represents "X" entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation. |
FSAdditionalActionTriggerAnnotMouseButtonPressed | Trigger an action to be performed when the mouse button is pressed inside the annotation's active area. This represents "D" (stands for "Down") entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation. |
FSAdditionalActionTriggerAnnotMouseButtonReleased | Trigger an action to be performed when the mouse button is released inside the annotation's active area. This represents "U" (stands for "Up") entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation. |
FSAdditionalActionTriggerAnnotReceiveInputFocus | (Applicable for widget annotation only) Trigger an action to be performed when the annotation receives the input focus. This represents "Fo" entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from a widget annotation. |
FSAdditionalActionTriggerAnnotLoseInputFocus | (Applicable for widget annotation only) Trigger an action to be performed when the annotation loses the input focus. This represents "Bl" (Uppercase B and lowercase L, which stands for "blurred") entry in an annotation's additional- actions dictionary. Only applicable for additional action object constructed from a widget annotation. |
FSAdditionalActionTriggerAnnotPageOpened | Trigger an action to be performed when the page containing the annotation is opened. This represents "PO" entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation. The triggered action is executed after action for FSAdditionalActionTriggerPageOpened is triggered and open action of PDF document, if such actions present. |
FSAdditionalActionTriggerAnnotPageClosed | Trigger an action to be performed when the page containing the annotation is closed. This represents "PC" entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation. The triggered action is executed after action for FSAdditionalActionTriggerPageClosed is triggered, if such action present. |
FSAdditionalActionTriggerAnnotPageVisible | Trigger an action to be performed when the page containing the annotation becomes visible in the viewer application's user interface. This represents "PV" entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation. |
FSAdditionalActionTriggerAnnotPageInvisible | Trigger an action to be performed when the page containing the annotation is no longer visible in the viewer application's user interface. This represents "PI" entry in an annotation's additional-actions dictionary. Only applicable for additional action object constructed from PDF annotation. |
enum FSAlignment |
Enumeration for string ID used to specify the string or prefix in result document when summarizing annotation.
Values of this enumeration can be used alone.
Enumeration for options used for font size type in result document.
Values of this enumeration can be used alone.
Enumeration for options used for sorting annotation in result document.
Values of this enumeration can be used alone.
Enumeration for options used for annotation summary layout.
Values of this enumeration can be used alone.
enum FSAnnotFlags |
Enumeration for PDF annotation flags.
Values of this enumeration can be used alone or in combination.
Enumerator | |
---|---|
FSAnnotFlagInvisible | Annotation flag: invisible. If set, do not display the annotation if it does not belong to one of the standard annotation types and no annotation handler is available. If clear, display such an non-standard annotation using an appearance stream specified by its appearance dictionary, if any. |
FSAnnotFlagHidden | Annotation flag: hidden. If set, do not display or print the annotation or allow it to interact with the user, regardless of its annotation type or whether an annotation handler is available. |
FSAnnotFlagPrint | Annotation flag: print. If set, print the annotation when the page is printed. If clear, never print the annotation, regardless of whether it is displayed on the screen. This can be useful, for example, for annotations representing interactive pushbuttons, which would serve no meaningful purpose on the printed page. |
FSAnnotFlagNoZoom | Annotation flag: no zoom. If set, do not scale the annotation's appearance to match the magnification of the page. The location of the annotation on the page (defined by the upper-left corner of its annotation rectangle) remains fixed, regardless of the page magnification. See below for further discussion. |
FSAnnotFlagNoRotate | Annotation flag: no rotate. If set, do not rotate the annotation's appearance to match the rotation of the page. The upper-left corner of the annotation rectangle remains in a fixed location on the page, regardless of the page rotation. |
FSAnnotFlagNoView | Annotation flag: no view. If set, do not display the annotation on the screen or allow it to interact with the user. The annotation may be printed (depending on the setting of flag FSAnnotFlagPrint) but should be considered hidden for purposes of on- screen display and user interaction. |
FSAnnotFlagReadOnly | Annotation flag: read only. If set, do not allow the annotation to interact with the user. The annotation may be displayed or printed (depending on the settings of flags FSAnnotFlagNoView and FSAnnotFlagPrint) but should not respond to mouse clicks or change its appearance in response to mouse motions.
|
FSAnnotFlagLocked | Annotation flag: locked. If set, do not allow the annotation to be deleted or its properties (including position and size) to be modified by the user. However, this flag does not restrict changes to the annotation's contents, such as the value of a form field. |
FSAnnotFlagToggleNoView | Annotation flag: toggle no view. If set, invert the interpretation of the NoView flag for certain events. A typical use is to have an annotation that appears only when a mouse cursor is held over it. |
FSAnnotFlagLockedContents | Annotation flag: locked contents. If set, do not allow the contents of the annotation to be modified by the user. This flag does not restrict deletion of the annotation or changes to other annotation properties, such as position and size. |
Enumeration for PDF annotation highlighting mode.
Values of this enumeration should be used alone.
enum FSAnnotMKEntry |
Enumeration for annotation's MK dictionary (an appearance characteristics) entry.
Values of this enumeration should be used alone.
Enumeration for icon and caption relative position in annotation's MK dictionary.
Values of this enumeration should be used alone.
enum FSAnnotProperty |
Enumeration for some PDF annotation property.
Values of this enumeration should be used alone.
enum FSAnnotType |
Enumeration for PDF annotation type.
Values of this enumeration should be used alone.
Enumeration for XFA application information type.
Values of this enumeration should be used alone.
Enumeration for XFA beep type.
Values of this enumeration should be used alone.
Enumeration for button ID of XFA message box.
Values of this enumeration should be used alone.
Enumeration for button type of XFA message box.
Values of this enumeration should be used alone.
Enumeration for icon type of XFA message box.
Values of this enumeration should be used alone.
Enumeration for string ID used to specify a case.
Values of this enumeration should be used alone.
Enumeration for the relationship between PDF document and the associated file.
Values of this enumeration should be used alone.
enum FSBarcodeFormat |
Enumeration for barcode format.
Values of this enumeration should be used alone.
Enumeration for format error correction level of QR Code.
Values of this enumeration should be used alone.
enum FSBitmapDIBFormat |
Enumeration for DIB format.
Values of this enumeration should be used alone.
Enumeration for bitmap interpolation flags.
Values of this enumeration can be used alone or in combination.
enum FSBookmarkPosition |
Enumeration for bookmark position.
Values of this enumeration should be used alone.
Actually, "bookmark position" means the relationship between a bookmark and another bookmark.
enum FSBookmarkStyle |
enum FSBorderInfoStyle |
Enumeration for PDF annotation border style.
Values of this enumeration should be used alone.
Enumerator | |
---|---|
FSBorderInfoSolid | Border style: Solid. |
FSBorderInfoDashed | Border style: Dashed. This is only useful for link, free text, line, square, circle, polygon, polyline and screen annotation. If this is set to other type annotation, Foxit PDF SDK will change to set border style as FSBorderInfoSolid by default internally. |
FSBorderInfoUnderLine | Border style: Underline. This is only useful for link annotation. If this is set to other type annotation, Foxit PDF SDK will change to set border style as FSBorderInfoSolid by default internally. |
FSBorderInfoBeveled | Border style: Beveled. Currently, Foxit PDF SDK does not support the annotation appearance of this border style. If this is set to any annotation, Foxit PDF SDK will change to set border style as FSBorderInfoSolid by default internally. |
FSBorderInfoInset | Border style: Inset. Currently, Foxit PDF SDK does not support the annotation appearance of this border style. If this is set to any annotation, Foxit PDF SDK will change to set border style as FSBorderInfoSolid by default internally. |
FSBorderInfoCloudy | Border style: Cloudy. This is only useful for free text, square, circle, and polygon annotations. If this is set to other type annotation, Foxit PDF SDK will change to set border style as FSBorderInfoSolid by default internally. |
Enumeration for certificate status.
Values of this enumeration should be used alone.
Enumeration for response information location.
Values of this enumeration should be used alone.
Enumeration for revocation reason for a certificate.
Values of this enumeration should be used alone.
Enumeration for rendering intent.
Values of this enumeration should be used alone.
Rendering intent can be used for color conversion. Please refer to Section 8.6.5.8 "Rendering intents" in the reference doucment for PDF 2.0 for more details.
enum FSColorSpaceType |
Enumeration for color space.
Values of this enumeration should be used alone.
Enumeration for options used for combining PDF files.
Values of this enumeration can be used alone or in combination.
Enumeration for compare result type.
Values of this enumeration can be used alone.
Enumeration for default appearance flags.
Values of this enumeration can be used alone or in combination.
Enumerator | |
---|---|
FSDefaultAppearanceFlagFont | Indicates property font of FSDefaultAppearance is meaningful. |
FSDefaultAppearanceFlagTextColor | Indicates property text color of FSDefaultAppearance is meaningful. |
FSDefaultAppearanceFlagFontSize | Indicates property text size of FSDefaultAppearance is meaningful. |
Enumeration for zoom mode.
Values of this enumeration should be used alone.
Enumeration for the event type of page view.
Values of this enumeration should be used alone.
Enumeration for XFA print options.
Values of this enumeration should be used alone.
Enumeration for XFA submit format.
Values of this enumeration should be used alone.
Enumeration for text encoding for XFA submit.
Values of this enumeration should be used alone.
Enumeration for how various GUI elements should behave when the document is opened.
Values of this enumeration should be used alone.
enum FSErrorCode |
Enumeration for error code.
Values of this enumeration should be used alone.
enum FSFDFDocType |
enum FSFieldFlags |
Enumeration for form field flags.
Values of this enumeration can be used alone or in a combination.
enum FSFieldType |
Enumeration for form field type.
Values of this enumeration should be used alone.
enum FSFileFormatType |
Enumeration for file format type.
Values of this enumeration can be used alone.
Enumeration for popup menu item.
Values of this enumeration should be used alone.
enum FSFillerEventFlags |
Enumeration for key event flags.
Values of this enumeration can be used alone or in combination.
Enumeration for virtual key code.
Values of this enumeration should be used alone.
enum FSFillMode |
Enumeration for filling mode type, mainly for path graphics object.
Values of this enumeration should be used alone.
Enumeration for fill-sign object type.
Values of this enumeration can be used alone.
enum FSFontCharset |
Enumeration for font charset.
Values of this enumeration should be used alone.
enum FSFontCIDCharset |
Enumeration for CID font charset.
Values of this enumeration should be used alone.
enum FSFontFontTypes |
enum FSFontStandardID |
Enumeration for standard font ID.
Values of this enumeration should be used alone.
enum FSFontStyles |
Enumeration for font styles.
Values of this enumeration can be used alone or in combination.
Enumeration for rank mode of full text search.
Values of this enumeration should be used alone.
Enumeration for render blend mode.
Values of this enumeration should be used alone.
Enumeration for text merge.
Values of this enumeration should be used alone.
enum FSGraphicsObjectType |
Enumeration for PDF graphics object type.
Values of this enumeration should be used alone.
Enumeration for line cap style.
Values of this enumeration should be used alone. The line cap style specifies the shape to be used at the ends of open sub paths (and dashes, if any) when they are stroked.
Enumeration for line join style.
Values of this enumeration should be used alone. The line join style specifies the shape to be used at the corners of paths that are stroked.
Enumeration for date format type.
Values of this enumeration can be used alone.
Enumeration for page number format type.
Values of this enumeration can be used alone.
Enumeration for encoding format used for converting HTML to PDF.
Values of this enumeration should be used alone.
Enumeration for media style used for converting HTML to PDF.
Values of this enumeration should be used alone.
Enumeration for scaling mode used for converting HTML to PDF.
Values of this enumeration should be used alone.
Enumeration for the type of icon scaling way.
Values of this enumeration should be used alone.
Enumeration for compression mode used for color or gray image.
Values of this enumeration should be used alone.
Enumeration for loss compression quality used for color or gray image.
Values of this enumeration should be used alone.
Enumeration for stretch mode.
Values of this enumeration should be used alone.
enum FSImageType |
Enumeration for image type.
Values of this enumeration should be used alone.
Enumerator | |
---|---|
FSImageUnknown | Unknown image type. |
FSImageNone | Not have image type yet.
|
FSImageBMP | Image type is BMP. |
FSImageJPG | Image type is JPG or JPEG. |
FSImagePNG | Image type is PNG. |
FSImageGIF | Image type is GIF. |
FSImageTIF | Image type is TIF or TIFF. |
FSImageJPX | Image type is JPX or JPEG-2000. |
FSImageJBIG2 | Image type is JBIG2.
|
Enumeration for PDF layer usage type.
Values of this enumeration should be used alone.
enum FSLineCapPos |
enum FSLocaleID |
Enumeration for locale ID.
Values of this enumeration can be used alone.
Enumeration for standard structure types.
Values of this enumeration should be used alone. Please refer to description of "Standard Structure Types" in Section 10.7.3 of <PDF Reference 1.7> and in description of "Standard structure types" in Section 14.8.4 of <PDF Reference 2.0> for more details.
Enumeration for element general layout attribute types.
Values of this enumeration should be used alone. For more details, please refer to "Layout Attributes" in <PDF reference 1.7> P916.
Enumerator | |
---|---|
FSLRStructureElementAttributeTypeInvalid | Attribute type: invalid. |
FSLRStructureElementAttributeTypeRole | Attribute type: role, which means strings of structure element meaning and standard type it maps to.
|
FSLRStructureElementAttributeTypePlacement | Attribute type: Placement, which means the positioning of the element with respect to the enclosing reference area and other content.
|
FSLRStructureElementAttributeTypeRotation | Attribute type: Rotation.
|
FSLRStructureElementAttributeTypeWritingMode | Attribute type: WritingMode, which means the directions of layout progression for packing of ILSEs (inline progression) and stacking of BLSEs (block progression).
|
FSLRStructureElementAttributeTypeDestination | Attribute type: Destination (PDF 2.0), which provides a means to access content.
|
FSLRStructureElementAttributeTypeBBox | Attribute type: BBox, which represents the element's bounding box (the rectangle that completely encloses its visible content).
|
FSLRStructureElementAttributeTypeWidth | Attribute type: Width, which represents the width of the element's content rectangle.
|
FSLRStructureElementAttributeTypeHeight | Attribute type: Height, which represents the height of the element's content rectangle.
|
FSLRStructureElementAttributeTypeBackgroundColor | Attribute type: BackgroundColor, which represents the color to be used to fill the background of a table cell or any element's content rectangle.
|
FSLRStructureElementAttributeTypeBorderColor | Attribute type: BorderColor, which represents the color of the border drawn on the edges of a table cell or any element's content rectangle.
|
FSLRStructureElementAttributeTypeBorderStyle | Attribute type: BorderStyle, which represents the style of an element's border.
|
FSLRStructureElementAttributeTypeBorderThickness | Attribute type: BorderThickness, which represents the thickness of the border drawn on the edges of a table cell or any element's content rectangle.
|
FSLRStructureElementAttributeTypeAttached | Attribute type: Attached, which specifies the edges of the page, if any, to which the artifact is logically attached.
|
FSLRStructureElementAttributeTypeSubType | Attribute type: Subtype, which means the subtype of annotation or artifact.
|
FSLRStructureElementAttributeTypePadding | Attribute type: Padding, which specifies an offset to account for the separation between the element's content rectangle and the surrounding border.
|
FSLRStructureElementAttributeTypeColor | Attribute type: Color, which represents the color to be used for drawing text and the default value for the color of table borders and text decorations.
|
FSLRStructureElementAttributeTypeSpaceBefore | Attribute type: SpaceBefore, which represents the amount of extra space preceding the before edge of the BLSE.
|
FSLRStructureElementAttributeTypeSpaceAfter | Attribute type: SpaceAfter, which represents the amount of extra space following the after edge of the BLSE.
|
FSLRStructureElementAttributeTypeStartIndent | Attribute type: StartIndent, which represents the distance from the start edge of the reference area to that of the BLSE.
|
FSLRStructureElementAttributeTypeEndIndent | Attribute type: EndIndent, which represents the distance from the end edge of the BLSE to that of the reference area.
|
FSLRStructureElementAttributeTypeTextIndent | Attribute type: TextIndent, which represents the additional distance from the start edge of the BLSE, as specified by FSLRStructureElementAttributeTypeStartIndent, to that of the first line of text.
|
FSLRStructureElementAttributeTypeTextAlign | Attribute type: TextAlign, which represents the alignment of text and other content within lines of the BLSE.
|
FSLRStructureElementAttributeTypeBlockAlign | Attribute type: BlockAlign, which represents the alignment, in the block-progression direction, of content within the table cell.
|
FSLRStructureElementAttributeTypeInlineAlign | Attribute type: InlineAlign, which represents the alignment, in the inline-progression direction, of content within the table cell.
|
FSLRStructureElementAttributeTypeTBorderStyle | Attribute type: TBorderStyle, which represents the style of the border drawn on each edge of a table cell.
|
FSLRStructureElementAttributeTypeTPadding | Attribute type: TPadding, which specifies an offset to account for the separation between the table cell's content rectangle and the surrounding border.
|
FSLRStructureElementAttributeTypeBaselineShift | Attribute type: BaselineShift, which means the distance by which the element's baseline is shifted relative to that of its parent element.
|
FSLRStructureElementAttributeTypeLineHeight | Attribute type: LineHeight, which means the element's preferred height, in the block-progression direction.
|
FSLRStructureElementAttributeTypeTextDecorationColor | Attribute type: TextDecorationColor, which represents the color to be used for drawing text decorations.
|
FSLRStructureElementAttributeTypeTextDecorationThickness | Attribute type: TextDecorationThickness, which represents the thickness of each line drawn as part of the text decoration.
|
FSLRStructureElementAttributeTypeTextDecorationType | Attribute type: TextDecorationType, which represents the text decoration, if any, to be applied to the element's text.
|
FSLRStructureElementAttributeTypeRubyAlign | Attribute type: RubyAlign, which represents the justification of the lines within a ruby assembly.
|
FSLRStructureElementAttributeTypeRubyPosition | Attribute type: RubyPosition, which represents the placement of the RT structure element relative to the RB element in a ruby assembly.
|
FSLRStructureElementAttributeTypeGlyphOrientationVertical | Attribute type: GlyphOrientationVertical, which specifies the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top.
|
FSLRStructureElementAttributeTypeColumnCount | Attribute type: ColumnCount, which represents the number of columns in the content of the grouping element.
|
FSLRStructureElementAttributeTypeColumnGap | Attribute type: ColumnGap, which represents the desired space between adjacent columns, measured in the inline- progression direction.
|
FSLRStructureElementAttributeTypeColumnWidths | Attribute type: ColumnWidths, which represents the desired width of the columns, measured in the inline-progression direction.
|
FSLRStructureElementAttributeTypeListNumbering | Attribute type only for List: ListNumbering, which represents the numbering system to be used to generate the content of the Lbl (Label) elements in an autonumbered list, or the symbol used to identify each item in an unnumbered list.
|
FSLRStructureElementAttributeTypeFieldRole | Attribute type only for PrintField: Role, which represents the type of form field represented by this graphic.
|
FSLRStructureElementAttributeTypeFieldChecked | Attribute type only for PrintField: checked, which represents the state of a radio button or check box field.
|
FSLRStructureElementAttributeTypeFieldDesc | Attribute type only for PrintField: Desc, which represents the alternate name of the field, similar to the value supplied in the TU entry of the field dictionary for interactive fields.
|
FSLRStructureElementAttributeTypeRowSpan | Attribute type only for Table: RowSpan, which represents the number of rows in the enclosing table that are spanned by the cell.
|
FSLRStructureElementAttributeTypeColSpan | Attribute type only for Table: ColSpan, which represents the number of columns in the enclosing table that are spanned by the cell.
|
FSLRStructureElementAttributeTypeTableHeaders | (Currently, unsupported) Attribute type only for Table: Headers, which represents an array of element identifiers.
|
FSLRStructureElementAttributeTypeTableHeaderScope | Attribute type only for Table: Scope, which indicates whether the header cell applies to the rest of the cells in the row that contains it, the column that contains it, or both the row and the column that contain it.
|
FSLRStructureElementAttributeTypeTableSummary | Attribute type only for Table: Summary, which represents a summary of the table's purpose and structure, for use in non- visual rendering such as speech or braille.
|
FSLRStructureElementAttributeTypeShort | Attribute type: Short (PDF 2.0), which contains a short form of the content of a TH structure element's content.
|
FSLRStructureElementAttributeTypeDirection | (Reserved) Attribute type: Direction.
|
FSLRStructureElementAttributeTypeABox | (Reserved) Attribute type: ABox.
|
FSLRStructureElementAttributeTypeVersion | (Reserved) Attribute type: Version, which represents schema version of layout recognition engine.
|
Enumeration for element general layout attribute enum values.
Values of this enumeration should be used alone. This is the set of enum values for all attribute types whose value types are enum or an array of enum values.
Enumerator | |
---|---|
FSLRStructureElementAttributeValueEnumInvalid | Invalid enum value. |
FSLRStructureElementAttributeValueEnumBlock | Enum value: Block, which means to be stacked in the block-progression direction within an enclosing reference area or parent BLSE.
|
FSLRStructureElementAttributeValueEnumInline | Enum value: Inline, which means the placement for attributes Placement/RubyPosition.
|
FSLRStructureElementAttributeValueEnumWarichu | Enum value: Warichu, which means the RT and associated RP elements are to be formatted as a warichu, following the RB element.
|
FSLRStructureElementAttributeValueEnumBefore | Enum value: Before, which means the placement for attributes Placement/RubyPosition or alignment for attribute BlockAlign.
|
FSLRStructureElementAttributeValueEnumAfter | Enum value: After, which means the alignment for attribute BlockAlign or the placement for attribute RubyPosition.
|
FSLRStructureElementAttributeValueEnumStart | Enum value: Start, which means the place for attribute Placement, or the alignment for attributes TextAlign/InlineAlign/RubyAlign.
|
FSLRStructureElementAttributeValueEnumEnd | Enum value: End, which means the place for attribute Placement, or the alignment for attributes TextAlign/InlineAlign/RubyAlign.
|
FSLRStructureElementAttributeValueEnumLrTb | Enum value: LtTb, which means inline progression from left to right; block progression from top to bottom.
|
FSLRStructureElementAttributeValueEnumRlTb | Enum value: RlTb, which means inline progression from right to left; block progression from top to bottom.
|
FSLRStructureElementAttributeValueEnumTbRl | Enum value: TbRl, which means inline progression from top to bottom; block progression from right to left.
|
FSLRStructureElementAttributeValueEnumTbLr | Enum value: TbLr (PDF 2.0), which means inline progression from top to bottom; block progression from left to right.
|
FSLRStructureElementAttributeValueEnumNone | Enum value: None, which means no such attribute.
|
FSLRStructureElementAttributeValueEnumHidden | Enum value: Hidden, which is same as None except in terms of border conflict resolution for table elements.
|
FSLRStructureElementAttributeValueEnumDotted | Enum value: Dotten, which means the border is a series of dots.
|
FSLRStructureElementAttributeValueEnumDashed | Enum value: Dashed, which means the border is a series of short line segments.
|
FSLRStructureElementAttributeValueEnumSolid | Enum value: Solid, which means the border is a single line segment.
|
FSLRStructureElementAttributeValueEnumDouble | Enum value: Double, which means the border is two solid lines.
|
FSLRStructureElementAttributeValueEnumGroove | Enum value: Groove, which means the border looks as though it were carved into the canvas.
|
FSLRStructureElementAttributeValueEnumRidge | Enum value: Ridge, which means the border looks as though it were coming out of the canvas (the opposite of Groove).
|
FSLRStructureElementAttributeValueEnumInset | Enum value: Inset, which means the border makes the entire box look as though it were embedded in the canvas.
|
FSLRStructureElementAttributeValueEnumOutset | Enum value: Outset, which means the border makes the entire box look as though it were coming out of the canvas (the opposite of Inset).
|
FSLRStructureElementAttributeValueEnumNormal | Enum value: Normal, which means to adjust the line height to include any nonzero value specified for attribute BaselineShift . @note This can be used with attribute type @link LRStructureElement::e_AttributeTypeLineHeight @endlink. |
FSLRStructureElementAttributeValueEnumAuto | Enum value: Auto.
|
FSLRStructureElementAttributeValueEnumCenter | Enum value: Center, which means the alignment for attributes TextAlign/InlineAlign/RubyAlign.
|
FSLRStructureElementAttributeValueEnumJustify | Enum value: Justify, which means the alignment for attributes TextAlign/BlockAlign/RubyAlign.
|
FSLRStructureElementAttributeValueEnumMiddle | Enum value: Middle, which means children are centered within the table cell.
|
FSLRStructureElementAttributeValueEnumUnderline | Enum value: Underline, which means a line below the text.
|
FSLRStructureElementAttributeValueEnumOverline | Enum value: Overline, which means a line above the text.
|
FSLRStructureElementAttributeValueEnumLineThrough | Enum value: LineThrough, which means a line through the middle of the text.
|
FSLRStructureElementAttributeValueEnumDistribute | Enum value: Distribute, which means the content is to be expanded to fill the available width in the inline-progression direction.
|
FSLRStructureElementAttributeValueEnumDisc | Enum value: Disc, which means solid circular bullet.
|
FSLRStructureElementAttributeValueEnumCircle | Enum value: Circle, which means open circular bullet.
|
FSLRStructureElementAttributeValueEnumSquare | Enum value: Square, which means solid square bullet.
|
FSLRStructureElementAttributeValueEnumDecimal | Enum value: Decimal, which means decimal arabic numerals (1-9, 10-99, ...).
|
FSLRStructureElementAttributeValueEnumUpperRoman | Enum value: UpperRoman, which means uppercase roman numerals (I, II, III, IV, ...).
|
FSLRStructureElementAttributeValueEnumLowerRoman | Enum value: LowerRoman, which means lowercase roman numerals (i, ii, iii, iv, ...).
|
FSLRStructureElementAttributeValueEnumUpperAlpha | Enum value: UpperAlpha, which means uppercase letters (A, B, C, ...).
|
FSLRStructureElementAttributeValueEnumLowerAlpha | Enum value: LowerAlpha, which means lowercase letters (a, b, c, ...).
|
FSLRStructureElementAttributeValueEnumUnordered | Enum value: Unordered (PDF 2.0), which means unordered list with unspecified bullets.
|
FSLRStructureElementAttributeValueEnumOrdered | Enum value: Ordered (PDF 2.0), which means ordered lists with unspecified numbering.
|
FSLRStructureElementAttributeValueEnumFloat | Enum value: float. |
FSLRStructureElementAttributeValueEnumRB | Enum value: rb, which means radio button.
|
FSLRStructureElementAttributeValueEnumCB | Enum value: cb, which means check box.
|
FSLRStructureElementAttributeValueEnumPB | Enum value: pb, which means push button.
|
FSLRStructureElementAttributeValueEnumTV | Enum value: tv, which means text-value field.
|
FSLRStructureElementAttributeValueEnumOn | Enum value: on, which means the state is on.
|
FSLRStructureElementAttributeValueEnumOff | Enum value: off, which means the state is off.
|
FSLRStructureElementAttributeValueEnumNeutral | Enum value: neutral, which means the state is neutral.
|
FSLRStructureElementAttributeValueEnumRow | Enum value: Row, which means row of a table.
|
FSLRStructureElementAttributeValueEnumColumn | Enum value: Row, which means column of a table.
|
FSLRStructureElementAttributeValueEnumBoth | Enum value: Row, which means both row and column of a table.
|
FSLRStructureElementAttributeValueEnumLeft | Enum value: Left, which means left edge of the page.
|
FSLRStructureElementAttributeValueEnumTop | Enum value: Top, which means top edge of the page.
|
FSLRStructureElementAttributeValueEnumBottom | Enum value: Bottom, which means bottom edge of the page.
|
FSLRStructureElementAttributeValueEnumRight | Enum value: Right, which means right edge of the page.
|
FSLRStructureElementAttributeValueEnumPagination | Enum value: Pagination, which means pagination artifacts. Ancillary page features such as running heads and folios (page numbers).
|
FSLRStructureElementAttributeValueEnumLayout | Enum value: Layout, which means layout artifacts. Purely cosmetic typographical or design elements such as footnote rules or background screens.
|
FSLRStructureElementAttributeValueEnumPage | Enum value: Page, which means page artifacts. Production aids extraneous to the document itself, such as cut marks and color bars.
|
FSLRStructureElementAttributeValueEnumBackground | Enum value: Background, which means background artifacts. Background artifacts typically serve as a background for content shown either on top of or placed adjacent to that background.
|
FSLRStructureElementAttributeValueEnumHeader | Enum value: Header. |
FSLRStructureElementAttributeValueEnumFooter | Enum value: Footer. |
FSLRStructureElementAttributeValueEnumWatermark | Enum value: Watermark. |
FSLRStructureElementAttributeValueEnumPageNum | Enum value: PageNum (PDF2.0). |
FSLRStructureElementAttributeValueEnumBates | Enum value: Bates (PDF2.0). |
FSLRStructureElementAttributeValueEnumOther | Enum value: Other (PDF 2.0).
|
Enumeration for value type of element general layout attribute.
Values of this enumeration should be used alone.
Enumeration for time type.
Values of this enumeration should be used alone.
enum FSMarkupEndingStyle |
Enumeration for line ending style.
Values of this enumeration should be used alone.
enum FSMarkupMeasureType |
Enumeration for annotation's measure type.
Values of this enumeration should be used alone.
enum FSMarkupState |
Enumeration for markup annotation's state.
Values of this enumeration should be used alone.
Enumerator | |
---|---|
FSMarkupStateNone | (Used with state model FSMarkupStateModelReview) The user has indicated nothing about the change. |
FSMarkupStateMarked | (Used with state model FSMarkupStateModelMarked) The annotation has been marked by the user. |
FSMarkupStateUnmarked | (Used with state model FSMarkupStateModelMarked) The annotation has not been marked by the user. |
FSMarkupStateAccepted | (Used with state model FSMarkupStateModelReview) The user agrees with the change. |
FSMarkupStateRejected | (Used with state model FSMarkupStateModelReview) The user disagrees with the change. |
FSMarkupStateCancelled | (Used with state model FSMarkupStateModelReview) The change has been cancelled. |
FSMarkupStateCompleted | (Used with state model FSMarkupStateModelReview) The change has been completed. |
FSMarkupStateDeferred | (Used with state model FSMarkupStateModelReview) The change has been deferred. |
FSMarkupStateFuture | (Used with state model FSMarkupStateModelReview) The change will be working in the future. |
enum FSMarkupStateModel |
enum FSModuleName |
Enumeration for module name which is used in license information.
Values of this enumeration should be used alone.
Enumeration for compression mode used for monochrome image.
Values of this enumeration should be used alone.
Enumeration for stretch mode.
Values of this enumeration should be used alone.
Enumeration for cleaning up options.
Values of this enumeration can be used alone or in a combination.
Enumeration for discarding objects options.
Values of this enumeration can be used alone or in a combination.
Enumeration for discarding user data options.
Values of this enumeration can be used alone or in a combination.
Enumeration for optimizer options.
Values of this enumeration can be used alone or in a combination.
Enumeration for show type.
Values of this enumeration should be used alone.
enum FSPageLabelsStyle |
Enumeration for page label style.
Values of this enumeration should be used alone.
Enumeration for paging seal position.
Values of this enumeration should be used alone.
Enumeration for paging seal signature state to set appearance.
Values of this enumeration should be used alone.
enum FSPathPointType |
Enumeration for point type in path.
Values of this enumeration should be used alone.
Enumerator | |
---|---|
FSPathTypeMoveTo | Indicates that the point is the first point of a figure. |
FSPathTypeLineTo | Indicates that a line is drawn from the previous point to this point. |
FSPathTypeLineToCloseFigure | Indicates that a line is drawn from the previous point to this point, and this point will also be connected to the nearest FSPathTypeMoveTo point before this point, in order to close current figure. |
FSPathTypeBezierTo | Indicates that this point is a control point or ending point for a Bezier spline. |
FSPathTypeBezierToCloseFigure | Indicates that this point is the ending point for a Bezier spline, and this point will also be connected to the nearest FSPathTypeMoveTo point before this point, in order to close current figure. |
Enumeration for PDF/A version.
Values of this enumeration should be used alone.
enum FSPDFDocDataType |
Enumeration for data type used to decide which object(s) will be imported from or exported to FDF/XFDF document.
Values of this enumeration can be used alone or in combination.
enum FSPDFDocDisplayMode |
Enumeration for display mode which specifies how the document should be displayed when opened.
Values of this enumeration should be used alone.
enum FSPDFDocEncryptType |
Enumeration for encryption type.
Values of this enumeration should be used alone.
Enumeration for options used for extracting pages.
Values of this enumeration can be used alone or in combination.
Enumerator | |
---|---|
FSPDFDocExtractPagesOptionAnnotation | If set, that means annotations related to extracted pages will be extracted as well. |
FSPDFDocExtractPagesOptionStructureTree | If set, that means structure tree will be extracted as well. |
FSPDFDocExtractPagesOptionJavascript | If set, that means Javascript will be extracted as well. |
FSPDFDocExtractPagesOptionOCProperties | If set, that means OCProperties will be extracted as well. |
FSPDFDocExtractPagesOptionObjectStream | If set, that means to use FSPDFDocSaveFlagXRefStream saving flag for the result file in order to reduce the size of result file. |
FSPDFDocExtractPagesOptionAttachFiles | If set, that means attachment files will be extracted as well. |
Enumeration for flags used for importing pages.
Values of this enumeration can be used alone or in combination.
enum FSPDFDocPasswordType |
Enumeration for the type of current used password in a PDF document.
Values of this enumeration should be used alone.
enum FSPDFDocSaveFlags |
Enumeration for PDF document saving flags.
Values of this enumeration can be used alone or in combination.
Enumerator | |
---|---|
FSPDFDocSaveFlagNormal | Save document normally, without using any special flag. This can only be used alone. |
FSPDFDocSaveFlagIncremental | Save document incrementally. This can be used alone or be combined with other saving flags except FSPDFDocSaveFlagNormal. Especially, if this is combined with FSPDFDocSaveFlagNoOriginal, only the increment data will be saved. |
FSPDFDocSaveFlagNoOriginal | Save document without original data or unchanged objects. This can be used alone or be combined with other saving flags except FSPDFDocSaveFlagNormal. Especially, if this is combined with FSPDFDocSaveFlagIncremental, only the increment data will be saved. |
FSPDFDocSaveFlagXRefStream | Save document by using XRef stream. This can be used alone or be combined with other saving flags except FSPDFDocSaveFlagNormal. |
FSPDFDocSaveFlagLinearized | Save document as a linearized file. This should be used alone and cannot be used with other saving flags. This can only be used for function FSPDFDoc::saveAs:save_flags: or FSPDFDoc::startSaveAs:save_flags:pause:. |
FSPDFDocSaveFlagRemoveRedundantObjects | Save document with removing redundant PDF objects. This can be used alone or be combined with FSPDFDocSaveFlagNoOriginal or FSPDFDocSaveFlagXRefStream. This can only be used for function FSPDFDoc::saveAs:save_flags: or FSPDFDoc::startSaveAs:save_flags:pause:. |
Enumeration for user access permissions in a PDF document.
Values of this enumeration can be used alone or in combination.
Enumerator | |
---|---|
FSPDFDocPermPrint | Print PDF document with normal mode. (Bit 3 in permission value) If user wants to print a higher quality level of PDF document, please set current value with value FSPDFDocPermPrintHigh together. |
FSPDFDocPermModify | Modify PDF contents. (Bit 4 in permission value) If this value is set, user can modify contents of PDF document by operations other than those controlled by values FSPDFDocPermAnnotForm, FSPDFDocPermFillForm and FSPDFDocPermAssemble. |
FSPDFDocPermExtract | Extract PDF contents. (Bit 5 in permission value) If this value is set, user can copy or otherwise extract text and graphics from the document by operations other than that controlled by value FSPDFDocPermExtractAccess. |
FSPDFDocPermAnnotForm | Operate text annotations and fill in interactive form fields. (Bit 6 in permission value) If value FSPDFDocPermModify is also set, user can create or modify interactive form fields (including signature fields). |
FSPDFDocPermFillForm | Fill PDF form. (Bit 9 in permission value) If this value is set, user can fill in interactive form fields (including signature fields), even if value FSPDFDocPermAnnotForm is not used. |
FSPDFDocPermExtractAccess | Disabilities support. (Bit 10 in permission value) If this value is set, user can extract text and graphics in support of accessibility to users with disabilities or for other purposes. |
FSPDFDocPermAssemble | Assemble PDF document. (Bit 11 in permission value) If this value is set, it enables to assemble the document (Insert, rotate, or delete pages and create bookmarks or thumbnail images), regardless if value FSPDFDocPermModify is set or not. |
FSPDFDocPermPrintHigh | Print PDF document with higher qualities. (Bit 12 in permission value) If this value is not set (and value FSPDFDocPermPrint is set), printing is limited to a low-level representation of the appearance, possibly of degraded quality. |
enum FSPDFDocWrapperType |
enum FSPDFNameTreeType |
Enumeration for name tree type.
Values of this enumeration should be used alone.
enum FSPDFNumberTreeType |
enum FSPDFObjectType |
Enumeration for PDF object type.
Values of this enumeration should be used alone.
enum FSPDFPageBoxType |
Enumeration for page box type.
Values of this enumeration should be used alone.
enum FSPDFPageParseFlags |
enum FSPDFPageSize |
Enumeration for page size type.
Values of this enumeration should be used alone.
enum FSPDFStreamFilter |
Enumeration for stream filter type.
Values of this enumeration should be used alone. The stream filter indicates how the data in the PDF stream must be decoded before the data is used.
Enumeration for initial view mode for a portfolio PDF document.
Values of this enumeration should be used alone.
enum FSPortfolioNodeType |
enum FSProgressiveState |
enum FSRangeFilter |
enum FSReflowPageFlags |
Enumeration for parsing flags used for a reflow page.
Values of this enumeration can be used alone or in combination.
enum FSRendererColorMode |
Enumeration for rendering color mode.
Values of this enumeration should be used alone.
Enumeration for operation type to perform when the rendition action is triggered.
Values of this enumeration should be used alone.
Enumeration for offscreen event type of floating window.
Values of this enumeration should be used alone.
Offscreen event type is used to specifies what should occur if the floating window is positioned totally or partially offscreen (that is, not visible on any physical monitor).
Enumeration for the type of floating window's related window.
Values of this enumeration should be used alone.
Related window type specifies the place to which the floating window should be positioned.
Enumeration for resize type of floating window.
Values of this enumeration should be used alone.
Enumeration for media option type.
Values of this enumeration should be used alone.
Please refer to <PDF reference 1.7> P757 Section "9.1.1 Viability" for more details.
Enumeration for PDF media player permission.
Values of this enumeration should be used alone.
Media permission indicates the circumstances under which it is acceptable to write a temporary file in order to play a media clip.
Enumeration for the fit style.
Values of this enumeration should be used alone.
Fit style (manner) specifies how the player should treat a visual media type that does not exactly fit the rectangle in which it plays.
Enumeration for PDF media player classified type.
Values of this enumeration should be used alone.
Enumeration for monitor specifier type.
Values of this enumeration should be used alone.
Monitor specifier is used to specify which monitor in a multi-monitor system a floating or full-screen window should appear on.
Enumeration for the type of window that the media should play in.
Values of this enumeration should be used alone.
enum FSRotation |
Enumeration for rotation.
Values of this enumeration should be used alone.
Enumeration for Encryption Algorithm.
Values of this enumeration should be used alone.
enum FSSignatureAPFlags |
Enumeration for signature appearance flags.
Values of this enumeration can be used alone or in combination.
Enumeration for certificate validity.
Values of this enumeration should be used alone.
Enumeration for signature digest algorithm.
Values of this enumeration should be used alone.
Enumeration for signature document permission.
Values of this enumeration should be used alone.
Enumeration for signature FieldMDP("MDP" means modification detection and prevention) action type.
Values of this enumeration should be used alone.
Enumerator | |
---|---|
FSSignatureFieldMDPActionNone | No Field MDP action. |
FSSignatureFieldMDPActionAll | All form fields' flags will be set read-only. |
FSSignatureFieldMDPActionInclude | Specified form fields' flags will be set read-only.
|
FSSignatureFieldMDPActionExclude | Flags of form fields (except specified form fields) will be set read-only.
|
enum FSSignatureKeyName |
Enumeration for signature key name.
Values of this enumeration should be used alone.
enum FSSignatureLabelName |
Enumeration for signature label name.
Values of this enumeration should be used alone.
Enumeration for PAdES level.
Values of this enumeration should be used alone.
enum FSSignatureStates |
Enumeration for signature states.
Values of this enumeration can be used alone or in combination.
These values can be divided into four parts:
Enumeration for LTV state that indicates if a signature is a LTV signature.
Values of this enumeration should be used alone.
Enumeration for snapped point type.
Values of this enumeration should be used alone.
Enumeration for snapping point flags which are used to specify what kind of point in a path is to be snapped.
Values of this enumeration can be used alone or in combination.
Enumeration for encoding format of sound sample data.
Values of this enumeration must be used alone.
(Only for AES-256) Enumeration for modify flag used to decide which security data or password will be modified during encryption process
Values of this enumeration can be used alone or in combination.
Enumerator | |
---|---|
FSStdSecurityHandlerModifyPermission | If set, user permissions and "is encrypt metadata" values (which are defined in FSStdEncryptData ) will be modified during encryption process. |
FSStdSecurityHandlerModifyUserPassword | If set, user password and owner password will be modified during encryption process. |
FSStdSecurityHandlerModifyOwnerPassword | If set, only owner password will be modified during encryption process. |
Enumeration for flags of submit form action.
Values of this enumeration could be used alone or in a combination.
Enumerator | |
---|---|
FSSubmitFormActionFlagExclude | Bit 1. If set, fields name defined in submit form action should be excluded from submitting; if not set, only these fields name (including their descendants) are to be submit. |
FSSubmitFormActionFlagIncludeNoValueFields | Bit 2. Submit fields regardless of whether they have a value.
|
FSSubmitFormActionFlagExportFormat | Bit 3. Field names and values are submitted in HTML Form format.
|
FSSubmitFormActionFlagGetMethod | Bit 4. Field names and values are submitted using an HTTP GET request.
|
FSSubmitFormActionFlagWithCoordinates | Bit 5. Coordinates of the mouse are transmitted as part of the form data. |
FSSubmitFormActionFlagAsXFDF | Bit 6. Field names and values are submitted as XFDF. |
FSSubmitFormActionFlagIncludeAppendSaves | Bit 7. Submitted FDF file includes contents as contained in differences entry in the FDF dictionary.
|
FSSubmitFormActionFlagIncludeAnnotations | Bit 8. Submitted FDF file includes all markup annotations in underlying PDF document.
|
FSSubmitFormActionFlagSubmitAsPDF | Bit 9. The document is submitted as PDF. |
FSSubmitFormActionFlagCanonicalFormat | Bit 10. Any submitted field values representing dates are converted to the standard format. |
FSSubmitFormActionFlagExclNonUserAnnots | Bit 11. Only those markup annotations whose "T" entry matches the name of the current user are being submitted. |
FSSubmitFormActionFlagExclFKey | Bit 12. Submitted FDF excludes "F" entry. |
FSSubmitFormActionFlagEmbedForm | Bit 14. "F" entry of submitted FDF is an embedded file stream. |
Enumeration for tab order type.
Values of this enumeration should be used alone.
Enumeration for PDF textpage character flag.
Values of this enumeration should be used alone.
Enumeration for text order flag which is used when getting text content of a PDF page.
Values of this enumeration can be used alone.
Enumeration for parsing flags used for text page.
Values of this enumeration can be used alone or in combination.
Enumeration for searching flags.
Values of this enumeration can be used alone or in combination.
enum FSTextStateMode |
Enumeration for text mode.
Values of this enumeration should be used alone.
Enumeration for the result of sending time stamp request.
Values of this enumeration should be used alone.
Enumeration for watermark setting flags.
Values of this enumeration can be used alone or in combination.
Enumeration for line spacing style.
Values of this enumeration should be used alone.
enum FSXFADocEventType |
Enumeration for XFA event type.
Values of this enumeration should be used alone.
enum FSXFADocType |
Enumeration for hit test area of XFA widget.
Values of this enumeration should be used alone.
Enumeration for presence attribute of XFA widget.
Values of this enumeration should be used alone.
The presence property controls the participation of the associated object in different phases of processing.
Enumeration for the positon of XFA widget edge position.
Enumeration for watermark position in a PDF page.
Values of this enumeration should be used alone.
Enumeration for the type of text horizontal alignment of XFA widget.
Values of this enumeration should be used alone.
Enumeration for the type of XFA widget name.
Values of this enumeration should be used alone.
Enumeration for the type of XFA widget.
Values of this enumeration should be used alone.
Enumeration for the type of text vertical alignment of XFA widget.
Values of this enumeration should be used alone.