Foxit::PDF Namespace Reference

PDF namespace. Provide classes for accessing PDF document, page, text page, bookmark, annotation, signature (only support custom signature algorithms) and etc. More...

Namespaces

 Annotations
 Annotations namespace. Provide classes for accessing PDF annotation.
 

Classes

class  Action
 Class to represent action type and data. More...
 
class  Attachment
 Class to represent PDF attachment. More...
 
class  Bookmark
 Class to access a PDF bookmark. More...
 
class  CharInfo
 Class to represent character information. More...
 
class  CharRange
 Class to represent character range. More...
 
class  DefaultAppearance
 Class to represent default appearance data. More...
 
class  Destination
 Class to represent destination data. More...
 
class  Document
 Class to access PDF document. More...
 
class  EmbeddedGotoAction
 Class to represent embedded go-to action data. More...
 
class  EmbeddedGotoActionTarget
 Class to represent the target data of embedded go-to action. More...
 
class  GotoAction
 Class to represent go-to action data. More...
 
class  HideAction
 Class to represent hide action data. More...
 
class  ImportDataAction
 Class to represent import-data action data. More...
 
class  JavascriptAction
 Class to represent JavaScript action data. More...
 
class  LaunchAction
 Class to represent launch action data. More...
 
class  NamedAction
 Class to represent named action data. More...
 
class  Page
 Class to access PDF page. More...
 
class  PageInfo
 Class to represent page information. More...
 
class  RemoteGotoAction
 Class to represent remote go-to action data. More...
 
class  ResetFormAction
 Class to represent reset form action data. More...
 
class  Signature
 Class to represent PDF signature. More...
 
class  SubmitFormAction
 Class to represent submit-form action data. More...
 
class  TextPage
 Class to represent text page. More...
 
class  TextSearch
 Class to represent text search process. More...
 
class  TextSelection
 Class to represent text selection. More...
 
class  URIAction
 Class to represent URI action data. More...
 

Enumerations

Detailed Description

PDF namespace. Provide classes for accessing PDF document, page, text page, bookmark, annotation, signature (only support custom signature algorithms) and etc.

Enumeration Type Documentation

Enumeration for action type.

This enumeration is used for property Action::Type. Values of this enumeration should be used alone.

Enumerator
Unsupported 

Unsupported action type.

Goto 

Go to a destination within current document.

RemoteGoto 

Go to a destination within another document.

EmbeddedGoto 

Go to a destination within embedded another document.

Uri 

Universal Resource Identifier, including web pages and other Internet based resources.

Launch 

Launch an application or open a file.

Javascript 

Run a javascript.

Hide 

Hide or show one or more annotations.

Named 

Run a named action.

SubmitForm 

Transmit the names and values of selected interactive form fields.

ResetForm 

Reset selected interactive form fields to their default values.

ImportData 

Import Forms Data Format (FDF) data into the document's interactive form.

Enumeration for bookmark status.

This enumeration is used for property Bookmark::Status. Values of this enumeration can be used alone or in combination. Bookmark status contains the font style used for the bookmark title and the expanded state.

Enumerator
NORMAL 

Show bookmark title as normal text.

BOLD 

Show bookmark title as bold text.

ITALIC 

Show bookmark title as italic text.

EXPANDED 

Expand bookmark by default.

Enumeration for default appearance flags.

This enumeration is used for property DefaultAppearance::Flags. Values of this enumeration can be used alone or in combination. This is used to indicate which properties in PDF::DefaultAppearance are meaningful.

Enumerator
Font 

Indicates properties DefaultAppearance::Font and DefaultAppearance::FontSize are meaningful.

TextColor 

Indicates property DefaultAppearance::TextColor is meaningful.

TextMatrix 

Indicates property DefaultAppearance::TextMatrix is meaningful.

Enumeration for page loading flags.

This enumeration is used for parameter loadFlag in function Document::LoadPage. Values of this enumeration can be used alone or in combination.

Enumerator
Normal 

Parse page in normal mode during page loading process.

TextOnly 

Parse page for text-only mode during page loading process.

Annot 

If set, annotations will be loading during page loading process.

In some case, some annotations may not be rendered if annotations have not been loaded.

Enumeration for rendering flags.

This enumeration is used for parameter renderFlags in function Page::RenderPage. Values of this enumeration can be used alone or in combination.

Enumerator
LCDText 

Set if it needs text rendering optimization for LCD display.

BGRStripe 

Set if device is using BGR LCD stripe. This flag is reserved currently.

UseAntiAlias 

Use anti-aliasing to render graphics objects.

GrayScale 

Gray scale output.

NoNativeText 

Disable native text rendering feature (like GDI+, CGContext).

TextGamma 

Enable gamma to support to display small characters.

Annot 

Set if page annotations are to be rendered together.

DropObjects 

Drop page content objects while rendering page automatically.

This will make the most complicated pages renderable within very limited memory.
HOWEVER, after rendering a page, page content objects will not be used any more, and user has to re-parse page for any process on page contents.
DO NOT use this flag when caller shares one rendering context object between multi-threads.

NotTransformIcon 

Set if no need to rotate or scale annotation icon.

In PDF, "<b>Text</b>" and "<b>FileAttachment</b>" annotations show as icons.

LimitedImageCache 

Limit image cache size.

This will help to save memory for a large amount of image data.

NoSignature 

This flag indicates not to render signatures.

OCGPrint 

If this flag is set, only apply those content objects which allow to output to printer.

OCGDesign 

If this flag is set, only apply those content objects which allow to output for design mode.

OCGExport 

If this flag is set, only apply those content objects which allow to output for exportation.

QuickDraw 

PDF page parsing flag for quick draw mode.

enum Foxit::PDF::SaveFlags
strong

Enumeration for document saving flags.

This enumeration is used for parameter saveFlags in function Document::SaveAs and Document::SaveToFile. Values of this enumeration can be used alone or in combination.

Enumerator
Incremental 

Save PDF document incrementally.

RemoveSecurity 

Save PDF document with removing security.

ObjectStream 

Save PDF document by using object stream, in order to reduce the file size.

Enumeration for searching flag.

This enumeration is used for parameter flags in function Document::FindBookmark and TextPage::StartSearch. Values of this enumeration can be used alone or in combination.

Enumerator
MatchCase 

Whether to search by matching case.

MatchWholeWord 

Whether to search by matching whole word.

Consecutive 

Whether to search by matching consecutively (for example, "CC" will match twice in "CCC").

Enumeration for signature appearance flags.

This enumeration is used for functions Signature::GetAppearanceFlags and Signature::SetAppearanceFlags. Values of this enumeration can be used alone or in combination.

Enumerator
FoxitFlag 

If set, show Foxit flag on signature appearance.

Label 

If set, show lable on description.

Reason 

If set, show reason on description.

CreationTime 

If set, show creation time on description.

DistinguishName 

If set, show DN on description.

Location 

If set, show location on description.

Signer 

If set, show signer on description.

Bitmap 

If set, show bitmap on description.

Text 

If set, show text on description.

enum Foxit::PDF::SigState
strong

Enumeration for signature states.

This enumeration is used for functions Signature::GetState. Values of this enumeration should be used alone.

Enumerator
Unknown 

Signature state: unknown.

Unsigned 

Signature state: unsigned.

Valid 

Signature state: valid.

Invalid 

Signature state: invalid.

Enumeration for submitting form flags.

This enumeration is used for property SubmitFormAction::Flags. Values of this enumeration can be used alone or in combination.

Enumerator
Include 

Bit 1. Include fields to submit.

IncludeNoValueFields 

Bit 2. Submit fields regardless of whether they have a value.

For fields without a value, only the field name is transmitted.

ExportFormat 

Bit 3. Field names and values are submitted in HTML Form format.

Meaningful only if the SubmitPDF and XFDF flags are clear.
If clear, they are submitted in Forms Data Format (FDF).

GetMethod 

Bit 4. Field names and values are submitted using an HTTP GET request.

If clear, they are submitted using a POST request.
This flag is meaningful only when the ExportFormat flag is set.

SubmitCoordinates 

Bit 5. Coordinates of the mouse are transmitted as part of the form data.

XFDF 

Bit 6. Field names and values are submitted as XFDF.

IncludeAppendSaves 

Bit 7. Submitted FDF file includes contents as contained in differences entry in the FDF dictionary.

Meaningful only when the form is being submitted in Forms Data Format.

IncludeAnnotations 

Bit 8. Submitted FDF file includes all markup annotations in underlying PDF document.

Meaningful only when the form is being submitted in Forms Data Format.

SubmitPDF 

Bit 9. The document is submitted as PDF.

CanonicalFormat 

Bit 10. Any submitted field values representing dates are converted to the standard format.

ExclnonuserAnnots 

Bit 11. Only those markup annotations whose T entry matches the name of the current user are being submitted.

ExclFKey 

Bit 12. Submitted FDF excludes F entry.

EmbedForm 

Bit 14. F entry of submitted FDF is an embedded file stream.

Enumeration for text parsing option.

This enumeration is used for parameter option in function Page::LoadTextPage. Values of this enumeration can be used alone or in combination.

Enumerator
StreamOrder 

Parse the text content of PDF page by the stream order.

OutputHyphen 

Parse the text content of PDF page with outputting the hyphen on a line feed.

enum Foxit::PDF::ZoomMode
strong

Enumeration for zoom mode.

This enumeration is used for property Destination::ZoomMode. Values of this enumeration should be used alone.

Enumerator
Factor 

A specific zoom factor is used.

FitPage 

Fit the whole page on the screen.

FitWidth 

Fit the width of the page on the screen.

FitHeight 

Fit the height of the page on the screen.

FitRect 

Fit a particular rectangle on the screen.

FitContent 

Fit the whole content of page on the screen.

FitContentWidth 

Fit the content width of page on the screen.

FitContentHeight 

Fit the content height of page on the screen.

Foxit Corporation