Foxit Namespace Reference

Foxit namespace. More...

Namespaces

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

Classes

class  DateTime
 Class to represent date and time. More...
 
class  Font
 Class to represent a font object. More...
 
class  Library
 Class to represent the library management. More...
 
class  Matrix
 Class to represent matrix used for transformation. More...
 
class  PathPoint
 Class to represent a path point. More...
 
class  Pause
 (Reserved, not used currently)Class to represent pause control in progressive process. More...
 
class  PDFPath
 Class to represent a PDF path. More...
 
class  PixelSource
 Class to represent DIB (Device Independent Bitmap) data created from Foxit PDF SDK. More...
 
class  PointF
 Class to represent point(float) in device or page coordinate. More...
 
class  RectF
 Class to represent rectangle area(float) in device or page coordinate. More...
 
class  SignatureHandler
 Class to represent signature handler. More...
 

Enumerations

Functions

public delegate Boolean NeedPauseNowDelegate (Object^ clientData)
 (Reserved, not used currently)A delegate function to indicate whether specific process needs to be paused or not. More...
 
public delegate Object^ StartCalcDigestDelegate (Object^ clientData, Foxit::PDF::Signature^ sig, IBuffer^ fileBuffer, const Array< uint32 >^byteRangeArray)
 A delegate function to start a custom digest calculation. More...
 
public delegate int32 ContinueCalcDigestDelegate (Object^ clientData, Object^ context, Pause^ pause)
 A delegate function to continue a custom digest calculation. More...
 
public delegate IBuffer^ FinishCalcDigestDelegate (Object^ clientData, Object^ context)
 A delegate function to finish the custom digest calculation and get the digest. More...
 
public delegate IBuffer^ SignDelegate (Object^ clientData, Object^ context, Foxit::PDF::Signature^ sig, IBuffer^ digest)
 A delegate function to sign a specified signature. More...
 
public delegate Boolean VerifyDelegate (Object^ clientData, Object^ context, Foxit::PDF::Signature^ sig, IBuffer^ digest, IBuffer^ signedData)
 A delegate function to verify a specified signature. More...
 

Detailed Description

Foxit namespace.

Enumeration Type Documentation

enum Foxit::ErrorCode
strong

Enumeration for error code.

This enumeration is used as return value of function Library::GetLastError. Values of this enumeration should be used alone.

Enumerator
Success 

Success.

Error 

Common error for any kind.

InvalidLibrary 

Invalid Foxit PDF SDK manager.

InvalidModule 

Invalid module or module uninitialized.

OutOfMemory 

Out of memory since there is no enough memory or the memory access is wrong.

Password 

Incorrect password.

Format 

Data format error.

File 

File access error, cannot read or write file data.

Param 

Parameter error.

InvalidLicense 

License authorization error: current license is not authorized or has no right to access some module.

Handler 

Callback functions in handler are error.

UnknownSecurityHandler 

Unknown security handler or cannot find availably one.

InvalidCertificate 

Incorrect certificate or its data error.

NotFound 

Data cannot be found.

InvalidType 

Invalid object type.

Unsupported 

Some features are not implemented, cannot be used, usually for user-side callback functions.

NotParsed 

Contents are not parsed.

UnknownState 

State is error or unknown.

BufferOverflow 

Buffer is overflow, need more space.

Conflict 

Data or values conflict.

DataNotReady 

Data not ready.

UnknownHandler 

Unknown handler or cannot find availably one.

ExpiredLicense 

Expired license.

InvaildHandle 

Current object handle is invalid.

enum Foxit::FontCharset
strong

Enumeration for font charsets.

This enumeration is used for parameter charset of function Font::Create. Values of this enumeration should be used alone.

Enumerator
ANSI 

Font charset: ANSI (United States, Western Europe).

Default 

Font charset: System default, for unknown or mapping purpose.

Symbol 

Font charset: Standard symbols.

Shift_JIS 

Font charset: Japanese (Shift-JIS).

Hangeul 

Font charset: Korean (Wansung).

GB2312 

Font charset: Simplified Chinese.

ChineseBig5 

Font charset: Traditional Chinese.

Thai 

Font charset: Thai.

EastEurope 

Font charset: Eastern European.

Russian 

Font charset: Russian.

Greek 

Font charset: Greek.

Turkish 

Font charset: Turkish.

Hebrew 

Font charset: Hebrew.

Arabic 

Font charset: Arabic.

Baltic 

Font charset: Baltic.

enum Foxit::FontStyles
strong

Enumeration for font styles.

This enumeration is used for parameter fontStyles of function Font::Create. Values of this enumeration can be used alone or in combination.

Enumerator
FixedPitch 

Font style: fixed pitch.

Serif 

Font style: serif.

Symbolic 

Font style: symbolic.

Script 

Font style: script.

NonSymbolic 

Font style: non-symbolic.

Italic 

Font style: italic.

AllCap 

Font style: all cap.

SmallCap 

Font style: small cap.

Bold 

Font style: force bold.

enum Foxit::PageBoxType
strong

Enumeration for page boundary box type.

This enumeration is used for paramter boxType of function PDF::Page::GetBox. Values of this enumeration should be used alone.
For some purposes, PDF defines a set of page boxes. User can select a proper page box according to application intentions.

Enumerator
MediaBox 

Media box for page boundary.

Media box represents the boundary of the physical medium on which page is to be displayed or printed.

CropBox 

Crop box for page boundary.

Crop box represents the region to which the contents of page are to be clipped (cropped) while displaying or printing.

TrimBox 

Trim box for page boundary.

Trim box represents the region to which the contents of page should be clipped while outputting in a production environment.

ArtBox 

Art box for page boundary.

Art box represents the intended dimensions of a finished page after trimming.

BleedBox 

Bleed box for page boundary.

Bleed box represents the extent of page's meaningful content (including potential white space) as intended by page's creator.

enum Foxit::PathPointType
strong

Enumeration for types of path point.

This enumeration is used for property PathPoint::Type. Values of this enumeration can be used alone or in combination, but with some limitation. Please check comment of each value in this enumeration for more details.

Enumerator
CloseFigure 

Specify that a figure is automatically closed after the corresponding line or curve is drawn.

The figure is closed by drawing a line from the line or curve endpoint to the point corresponding to the last PathPointType::MoveTo. This cannot be used alone. This should be combined with PathPointType::LineTo or PathPointType::BezierTo.

LineTo 

Specify that a line is to be drawn from the current position to this point, which becomes a new current position.

This can be used alone, or can only be combined with PathPointType::CloseFigure.

BezierTo 

Specifies that this point is a control point or ending point for a Bezier spline.

This can be used alone or can only be combined with PathPointType::CloseFigure.

MoveTo 

Specify that this point starts a figure. This point becomes a new current position.

This can only be used alone, usually for the first path point of a new path.

enum Foxit::StandardFontID
strong

Enumeration for standard font IDs.

This enumeration is used for parameter fontID of function Font::CreateStandard. Values of this enumeration should be used alone.

Enumerator
Courier 

Standard font: Courier.

CourierB 

Standard font: Courier-Bold.

CourierBI 

Standard font: Courier-BoldOblique, Bold italic.

CourierI 

Standard font: Courier-Oblique, Italic.

Helvetica 

Standard font: Helvetica.

HelveticaB 

Standard font: Helvetica-Bold.

HelveticaBI 

Standard font: Helvetica-BoldOblique, Bold italic.

HelveticaI 

Standard font: Helvetica-Oblique, Italic.

Times 

Standard font: Times-Roman.

TimesB 

Standard font: Times-Bold.

TimesBI 

Standard font: Times-BoldItalic.

TimesI 

Standard font: Times-Italic.

Symbol 

Standard font: Symbol.

ZapfDingbats 

Standard font: ZapfDingbats.

Function Documentation

public delegate int32 Foxit::ContinueCalcDigestDelegate ( Object^  clientData,
Object^  context,
Pause pause 
)

A delegate function to continue a custom digest calculation.

Parameters
[in]clientDataAn object that stores user-defined data.
[in]contextAn object that specifies the context object, which is returned by callback delegate function Foxit::StartCalcDigestDelegate.
[in]pause(Reserved, should be nullptr currently) A Foxit::Pause object that specifies the pause control.
Returns
0 means success and finished; 1 means success but need to be continued; -1 means error.
public delegate IBuffer ^ Foxit::FinishCalcDigestDelegate ( Object^  clientData,
Object^  context 
)

A delegate function to finish the custom digest calculation and get the digest.

Parameters
[in]clientDataAn object that stores user-defined data.
[in]contextAn object that specifies the context object, which is returned by callback delegate function Foxit::StartCalcDigestDelegate.
Returns
A buffer object that receives the digest.
public delegate Boolean Foxit::NeedPauseNowDelegate ( Object^  clientData)

(Reserved, not used currently)A delegate function to indicate whether specific process needs to be paused or not.

Usually, applications can use a timer to determine how long the specific process can run.

Parameters
[in]clientDataAn object which stores user-defined data.
Returns
A boolean value: true means current running needs to be paused, while false means no pause is needed.
public delegate IBuffer ^ Foxit::SignDelegate ( Object^  clientData,
Object^  context,
Foxit::PDF::Signature sig,
IBuffer^  digest 
)

A delegate function to sign a specified signature.

This is used for class Foxit::SignatureHandler for customized signing signature.

Parameters
[in]clientDataAn object that stores user-defined data.
[in]contextAn object that specifies the context object, which is returned by callback delegate function Foxit::StartCalcDigestDelegate.
[in]sigA PDF::Signature object that specifies signature object to be signed.
[in]digestA buffer object that specifies the digest of source file buffer to be signed.
Returns
A buffer object that receives signed data.
public delegate Object ^ Foxit::StartCalcDigestDelegate ( Object^  clientData,
Foxit::PDF::Signature sig,
IBuffer^  fileBuffer,
const Array< uint32 >^  byteRangeArray 
)

A delegate function to start a custom digest calculation.

Parameters
[in]clientDataAn object that stores user-defined data.
[in]sigA PDF::Signature object.
[in]fileBufferA buffer that specifies the data of source PDF file:
  • When signing a signature, this is the data of source file object to be signed.
  • When verifying a signature, this is the data of source file object to be verified.
Foxit PDF SDK would keep this buffer valid during the custom digest calculation. If this calculation is finished by callback delegate function Foxit::FinishCalcDigestDelegate or any error occurs during this calculation, Foxit PDF SDK will release this buffer internally.
[in]byteRangeArrayAn array that specifies the byte range array of the signed document(not the source document). Elements in this array always be in pairs of offset-size values in order of : offset,size,offset,size...
Returns
An object that receives the customized context object.
public delegate Boolean Foxit::VerifyDelegate ( Object^  clientData,
Object^  context,
Foxit::PDF::Signature sig,
IBuffer^  digest,
IBuffer^  signedData 
)

A delegate function to verify a specified signature.

This is used for class Foxit::SignatureHandler for customized verifying signature.

Parameters
[in]clientDataAn object that stores user-defined data.
[in]contextAn object that specifies the context object, which is returned by callback delegate function Foxit::StartCalcDigestDelegate.
[in]sigA PDF::Signature object that specifies signature object to be verified.
[in]digestA buffer object that specifies the digest of source file buffer to be verified.
[in]signedDataA buffer object that specifies the signed data.
Returns
A boolean value: true means success, while false means failure.

Foxit Corporation