Click or drag to resize

SDK Lite Edition

This topic contains the following sections:

Patagames offers two versions of the SDK – SDK and SDK Lite. Similar to the SDK, SDK Lite also enables you to view and print the PDF Documents. However, editing features (such as creating new documents, generating page content, annotating, fully functional flattening, etc.) are available only in the full version of the SDK.

The following constructors, methods and properties are not available in the Lite version. If you are using any of these, you will need to license the full SDK.

In the evaluation mode, SDK operates in full mode. In order to switch it to Lite mode, you can use a temporary key, which can be taken here: https://patagames.com/request-trial/

Constructors

Pdf3DAnnotation(PdfPage)

PdfAnnotation(PdfPage)

PdfAnnotation(PdfPage, PdfTypeBase)

PdfAttachment(PdfDocument, String, Byte)

PdfAttachment(String, PdfFileSpecification)

PdfAttachmentCollection(PdfDocument)

PdfBorderEffect

PdfBorderStyle

PdfCaretAnnotation(PdfPage)

PdfCaretAnnotation(PdfPage, FS_RECTF, FS_COLOR, Boolean)

PdfCircleAnnotation(PdfPage)

PdfCircleAnnotation(PdfPage, FS_RECTF, FS_COLOR, FS_COLOR)

PdfDestination(PdfDocument)

PdfFigureAnnotation(PdfPage)

PdfFile(PdfTypeStream)

PdfFile(Byte)

PdfFileAttachmentAnnotation(PdfPage)

PdfFileAttachmentAnnotation(PdfPage, FileIconNames, String, Byte, FS_COLOR, Single, Single)

PdfFileAttachmentAnnotation(PdfPage, FileIconNames, String, Byte, Single, Single)

PdfFileSpecification(PdfDocument)

PdfFileSpecification(PdfDocument, PdfTypeBase)

PdfFreeTextAnnotation(PdfPage)

PdfFreeTextAnnotation(PdfPage, PdfTextObject, Single, Single, Single, Single)

PdfFuncExponential(Int32, Int32, Single, Single, Single, Single, Single)

PdfFuncPostScript(Int32, Int32, Single, Single, Byte)

PdfFuncSampled(Int32, Int32, Single, Single, Int32, Int32, Byte, Single, Single, Int32)

PdfFuncStitching(PdfDocument, Int32, PdfFunction, Single, Single, Single, Single)

PdfHighlightAnnotation(PdfPage)

PdfHighlightAnnotation(PdfPage, FS_POINTF, FS_POINTF, FS_POINTF, FS_POINTF, FS_COLOR)

PdfInkAnnotation(PdfPage)

PdfInkPointCollection

PdfLineAnnotation(PdfPage)

PdfLineEndingCollection(LineEndingStyles, LineEndingStyles)

PdfLinePointCollectionT

PdfLinePointCollectionT(FS_POINTF, FS_POINTF)

PdfLinePointCollectionT(FS_POINTF, FS_POINTF, FS_POINTF)

PdfLinePointCollectionT(PdfTypeArray)

PdfLinkAnnotation(PdfPage)

PdfMarkupAnnotation(PdfPage)

PdfMovieAnnotation(PdfPage)

PdfPolygonalChainAnnotation(PdfPage)

PdfPolygonAnnotation(PdfPage)

PdfPolylineAnnotation(PdfPage)

PdfPopupAnnotation(PdfPage)

PdfPopupAnnotation(PdfPage, PdfAnnotation, Boolean)

PdfPrinterMarkAnnotation(PdfPage)

PdfQuadPointsCollection

PdfQuadPointsCollection(PdfTypeArray)

PdfScreenAnnotation(PdfPage)

PdfSound(PdfTypeStream)

PdfSound(Byte, SoundEncodingFormats, Int32, Int32, Int32)

PdfSoundAnnotation(PdfPage)

PdfSoundAnnotation(PdfPage, SoundIconNames, FS_COLOR, Single, Single, PdfSound)

PdfSoundAnnotation(PdfPage, SoundIconNames, FS_COLOR, Single, Single, Byte, SoundEncodingFormats, Int32, Int32, Int32)

PdfSoundAnnotation(PdfPage, SoundIconNames, Single, Single, PdfSound)

PdfSoundAnnotation(PdfPage, SoundIconNames, Single, Single, Byte, SoundEncodingFormats, Int32, Int32, Int32)

PdfSquareAnnotation(PdfPage)

PdfSquareAnnotation(PdfPage, FS_RECTF, FS_COLOR, FS_COLOR)

PdfSquigglyAnnotation(PdfPage)

PdfSquigglyAnnotation(PdfPage, FS_POINTF, FS_POINTF, FS_POINTF, FS_POINTF, FS_COLOR)

PdfStampAnnotation(PdfPage)

PdfStampAnnotation(PdfPage, StampIconNames, Single, Single, FS_COLOR)

PdfStampAnnotation(PdfPage, String, Single, Single, FS_COLOR)

PdfStrikeoutAnnotation(PdfPage)

PdfStrikeoutAnnotation(PdfPage, FS_POINTF, FS_POINTF, FS_POINTF, FS_POINTF, FS_COLOR)

PdfTextAnnotation(PdfPage)

PdfTextAnnotation(PdfPage, IconNames, FS_COLOR, String, String, Single, Single)

PdfTextAnnotation(PdfPage, IconNames, String, String, Single, Single)

PdfTextMarkupAnnotation(PdfPage)

PdfTextMarkupAnnotation(PdfPage, FS_POINTF, FS_POINTF, FS_POINTF, FS_POINTF, FS_COLOR)

PdfTrapNetAnnotation(PdfPage)

PdfUnderlineAnnotation(PdfPage)

PdfUnderlineAnnotation(PdfPage, FS_POINTF, FS_POINTF, FS_POINTF, FS_POINTF, FS_COLOR)

PdfWatermarkAnnotation(PdfPage)

PdfWatermarkAnnotation(PdfPage, PdfImageObject, PdfContentAlignment, Single, Single, Single, Single, Boolean, Boolean)

PdfWatermarkAnnotation(PdfPage, PdfTextObject, PdfContentAlignment, Single, Single, Single, Single, Boolean, Boolean)

PdfWidgetAnnotation(PdfPage)

PdfWrapper

Properties

Class Name

Prperty Name

Property Accessor

PdfLink

AnnotationRect

set

PdfPage

Annots

get

PdfDocument

Attachments

get

PdfDocument

Author

set

PdfDestination

Bottom

set

PdfSound

Bps

set

PdfFreeTextAnnotation

CalloutLine

get

PdfLineAnnotation

Cap

set

PdfLineAnnotation

CaptionOffset

set

PdfLineAnnotation

CaptionPosition

set

PdfSound

Channels

set

PdfFile

CheckSum

set

PdfAnnotation

Color

set

PdfPopupAnnotation

Color

get / set

PdfSound

CompressionFormat

set

PdfAnnotation

Contents

set

PdfPopupAnnotation

Contents

get / set

PdfDocument

CreationDate

set

PdfFile

CreationDate

set

PdfMarkupAnnotation

CreationDate

set

PdfDocument

Creator

set

PdfBorderStyle

DashPattern

set

PdfFreeTextAnnotation

DefaultAppearance

set

PdfFreeTextAnnotation

DefaultStyle

set

PdfFileSpecification

Description

set

PdfDestination

DestinationType

set

PdfAction

Dictionary

get

PdfControl

Dictionary

get

PdfField

Dictionary

get

PdfFont

Dictionary

get

PdfFuncExponential

Dictionary

get

PdfFuncStitching

Dictionary

get

PdfInteractiveForms

Dictionary

get

PdfLink

Dictionary

get

PdfPage

Dictionary

get

PdfTypeStream

Dictionary

get

PdfTypeUnknown

Dictionary

get

PdfAnnotation

DownAppearance

get

PdfBorderEffect

Effect

set

PdfFileSpecification

EmbeddedFile

get / set

PdfSound

Encoding

set

PdfFileAttachmentAnnotation

ExtendedIconName

set

PdfSoundAnnotation

ExtendedIconName

set

PdfStampAnnotation

ExtendedIconName

set

PdfTextAnnotation

ExtendedIconName

set

PdfFileSpecification

FileName

set

PdfFile

FileSize

set

PdfAnnotation

Flags

set

PdfDocument

Info

get

PdfCaretAnnotation

InnerRectangle

set

PdfFigureAnnotation

InnerRectangle

set

PdfFreeTextAnnotation

InnerRectangle

set

PdfBorderEffect

Intensity

set

PdfFreeTextAnnotation

Intent

set

PdfLineAnnotation

Intent

set

PdfPolygonAnnotation

Intent

set

PdfPolylineAnnotation

Intent

set

PdfFigureAnnotation

InteriorColor

set

PdfLineAnnotation

InteriorColor

set

PdfPolylineAnnotation

InteriorColor

set

PdfMarkupAnnotation

InternalIntent

set

PdfPopupAnnotation

IsOpen

set

PdfTextAnnotation

IsOpen

set

PdfDestination

IsSameDocument

set

PdfCaretAnnotation

IsSymbol

set

PdfFileSpecification

IsUrl

set

PdfFileSpecification

IsVolatile

set

PdfInkPointCollection

ItemInt32

get

PdfLineEndingCollection

ItemInt32

set

PdfLinePointCollectionT

ItemInt32

set

PdfQuadPointsCollection

ItemInt32

set

PdfDocument

Keywords

set

PdfLineAnnotation

LeaderLineExtension

set

PdfLineAnnotation

LeaderLineLenght

set

PdfLineAnnotation

LeaderLineOffset

set

PdfDestination

Left

set

PdfLineAnnotation

Line

get

PdfFreeTextAnnotation

LineEnding

get

PdfLineAnnotation

LineEnding

get

PdfPolylineAnnotation

LineEnding

get

PdfAnnotation

ModificationDate

set

PdfDocument

ModificationDate

set

PdfFile

ModificationDate

set

PdfPopupAnnotation

ModificationDate

get / set

PdfAnnotation

Name

set

PdfAnnotation

NormalAppearance

get

PdfMarkupAnnotation

Opacity

set

PdfDestination

PageIndex

set

PdfPopupAnnotation

Parent

get

PdfMarkupAnnotation

Popup

get

PdfDocument

Producer

set

PdfTextMarkupAnnotation

QuadPoints

get / set

PdfSound

Rate

set

PdfAnnotation

Rectangle

set

REFOBJ

ReferTo

get

PdfMarkupAnnotation

Relationship

set

PdfMarkupAnnotation

RelationshipAnnotation

get

PdfMarkupAnnotation

RichText

set

PdfDestination

Right

set

PdfAnnotation

RolloverAppearance

get

FdfDocument

Root

get

PdfDocument

Root

get

PdfSoundAnnotation

Sound

get

PdfFileAttachmentAnnotation

StandardIconName

set

PdfSoundAnnotation

StandardIconName

set

PdfStampAnnotation

StandardIconName

set

PdfTextAnnotation

StandardIconName

set

PdfTextAnnotation

State

set

PdfTextAnnotation

StateModel

set

PdfFuncPostScript

Stream

get

PdfFuncSampled

Stream

get

PdfImageObject

Stream

get

PdfBorderStyle

Style

set

PdfDocument

Subject

set

PdfMarkupAnnotation

Subject

set

PdfMarkupAnnotation

Text

set

PdfPopupAnnotation

Text

get / set

PdfFreeTextAnnotation

TextAlignment

set

PdfTextObject

TextUnicode

set

PdfBookmark

Title

set

PdfDocument

Title

set

PdfDestination

Top

set

PdfDocument

Trailer

get

PdfPolygonalChainAnnotation

Vertices

get

PdfBorderStyle

Width

set

PdfDestination

Zoom

set

Methods

Class Name

Method Name

Remarks

PdfLineEndingCollection

Add(LineEndingStyles)

PathPointsCollection

Add(FS_PATHPOINTF)

PdfLinePointCollectionT

Add(FS_POINTF)

PdfQuadPointsCollection

Add(FS_QUADPOINTSF)

PathPointsCollection

AppendPath(PathPointsCollection)

PathPointsCollection

AppendPath(PathPointsCollection, FS_MATRIX)

PathPointsCollection

AppendRect(FS_RECTF)

PathPointsCollection

Clear

PathPointsCollection

CopyPath(PathPointsCollection)

PdfTypeArray

Create

PdfTypeDictionary

Create

PdfTypeNull

Create

PdfTypeStream

Create

PdfTypeIndirect

Create(PdfIndirectList, Int32)

PdfFormObject

Create(PdfPage)

PdfTypeBoolean

Create(Boolean)

PdfTypeNumber

Create(Int32)

PdfTypeNumber

Create(Single)

PdfTypeName

Create(String)

PdfTypeString

Create(String, Boolean, Boolean)

PdfTextObject

Create(String, Single, Single, PdfFont, Single)

PdfPage

CreateAnnotations

PdfAnnotation

CreateEmptyAppearance(AppearanceStreamModes)

FdfDocument

CreateNew

PdfBookmarkCollections

DeleteAt(Int32)

PdfInteractiveForms

ExportToFdf(String, Boolean)

PdfIndirectList

FromFdfDocument(FdfDocument)

PdfIndirectList

FromPdfDocument(PdfDocument)

PdfRefObjectsCollection

FromPdfDocument(PdfDocument)

PdfSound

FromWave(Byte)

PdfAnnotation

GenerateAppearance(AppearanceStreamModes)

PdfPage

GenerateContent(Boolean)

PdfInteractiveForms

ImportFromFdf(FdfDocument)

PdfTypeStream

InitEmpty

PdfLineEndingCollection

Insert(Int32, LineEndingStyles)

PathPointsCollection

Insert(Int32, FS_PATHPOINTF)

PdfLinePointCollectionT

Insert(Int32, FS_POINTF)

PdfQuadPointsCollection

Insert(Int32, FS_QUADPOINTSF)

PdfBookmarkCollections

InsertAt(Int32, String, PdfPage)

FdfDocument

Load(Byte)

FdfDocument

Load(Stream, Int32)

FdfDocument

Load(String)

PdfImageObject

LoadJpegFile(Byte)

PdfCaretAnnotation

RegenerateAppearances

PdfFigureAnnotation

RegenerateAppearances

PdfFileAttachmentAnnotation

RegenerateAppearances

PdfFreeTextAnnotation

RegenerateAppearances

PdfInkAnnotation

RegenerateAppearances

PdfLineAnnotation

RegenerateAppearances

PdfMarkupAnnotation

RegenerateAppearances

PdfPolygonalChainAnnotation

RegenerateAppearances

PdfSoundAnnotation

RegenerateAppearances

PdfStampAnnotation

RegenerateAppearances

PdfTextAnnotation

RegenerateAppearances

PdfTextMarkupAnnotation

RegenerateAppearances

PathPointsCollection

RemoveAt(Int32)

PdfQuadPointsCollection

RemoveAt(Int32)

PdfControl

SetFocus(PdfPage)

PdfDocument

SetPasswordProtection(String, String, PdfUserAccessPermission, Boolean, EncriptionAlgorithm)

FS_COLOR

ToArray

FS_MATRIX

ToArray

FS_PATHPOINTF

ToArray

FS_QUADPOINTSF

ToArray

FS_RECTF

ToArray

PDF Viewer

Platform

Class Name

Method Name

Remarks

Windows Forms

PdfViewer

RegenerateAnnots(Int32)

Throws no NoLicenseException, but does nothing.

WPF

PdfViewer

RegenerateAnnots(Int32)

Throws no NoLicenseException, but does nothing.

Low-Level API

Class Name

Method Name

Pdfium

FFDF_CreateNew

Pdfium

FFDF_GetRoot(IntPtr)

Pdfium

FFDF_LoadDocument(String)

Pdfium

FFDF_LoadMemDocument(Byte)

Pdfium

FPDF_GenerateContentToStream(IntPtr, IntPtr, IntPtr, IntPtr)

Pdfium

FPDF_GenerateContentToStream(IntPtr, IntPtr, IntPtr, IntPtr, GenerateContentCallback, IntPtr)

Pdfium

FPDF_GetEncryptDictionary(IntPtr)

Pdfium

FPDF_GetInfo(IntPtr)

Pdfium

FPDF_GetPageDictionary(IntPtr, Int32)

Pdfium

FPDF_GetRoot(IntPtr)

Pdfium

FPDF_GetTrailer(IntPtr)

Pdfium

FPDF_SetMetaText(IntPtr, DocumentTags, String)

Pdfium

FPDFARRAY_Create

Pdfium

FPDFBOOLEAN_Create(Boolean)

Pdfium

FPDFDICT_Create

Pdfium

FPDFFont_GetFontDict(IntPtr)

Pdfium

FPDFFormControl_GetWidget(IntPtr)

Pdfium

FPDFFormField_GetFieldDict(IntPtr)

Pdfium

FPDFFunction_CreateExp(Int32, Int32, Single, Single, Single, Single, Single)

Pdfium

FPDFFunction_CreatePS(Int32, Int32, Single, Single, Byte)

Pdfium

FPDFFunction_CreateSampled(Int32, Int32, Single, Single, Int32, Int32, Byte, Single, Single, Int32)

Pdfium

FPDFFunction_CreateStitch(IntPtr, Int32, IntPtr, Single, Single, Single, Single)

Pdfium

FPDFFunction_GetObject(IntPtr)

Pdfium

FPDFHOLDER_FromFdfDocument(IntPtr)

Pdfium

FPDFHOLDER_FromPdfDocument(IntPtr)

Pdfium

FPDFHOLDER_GetRefsToObjects(IntPtr, Int32)

Pdfium

FPDFImageObj_GetInlineDict(IntPtr)

Pdfium

FPDFImageObj_GetOC(IntPtr)

Pdfium

FPDFImageObj_GetPixelSize(IntPtr, Int32, Int32)

Pdfium

FPDFImageObj_GetStream(IntPtr)

Pdfium

FPDFImageObj_IsInline(IntPtr)

Pdfium

FPDFImageObj_SetBitmap(IntPtr, Int32, IntPtr, IntPtr, ImageCompression)

Pdfium

FPDFImageObj_SetJpegImage(IntPtr, Byte)

Pdfium

FPDFInterForm_ExportToFDF(IntPtr, String, Boolean)

Pdfium

FPDFInterForm_GetFormDict(IntPtr)

Pdfium

FPDFInterForm_ImportFromFDF(IntPtr, IntPtr, Boolean)

Pdfium

FPDFNAME_Create(String)

Pdfium

FPDFNULL_Create

Pdfium

FPDFNUMBER_CreateFloat(Single)

Pdfium

FPDFNUMBER_CreateInt(Int32)

Pdfium

FPDFOBJ_GetDict(IntPtr)

Pdfium

FPDFPage_GenerateContentEx(IntPtr)

Pdfium

FPDFPage_GenerateContentEx(IntPtr, IntPtr)

Pdfium

FPDFPage_GenerateContentEx(IntPtr, IntPtr, GenerateContentCallback, IntPtr)

Pdfium

FPDFPageObj_SetMarkParam(IntPtr, Int32, PropertyListTypes, IntPtr)

Pdfium

FPDFPath_AddPointCount(IntPtr, Int32)

Pdfium

FPDFPath_AllocPointCount(IntPtr, Int32)

Pdfium

FPDFPath_AppendRect(IntPtr, FS_RECTF)

Pdfium

FPDFPath_AppendEx(IntPtr, IntPtr, FS_MATRIX)

Pdfium

FPDFPath_AppendRect(IntPtr, FS_RECTF)

Pdfium

FPDFPath_Copy(IntPtr, IntPtr)

Pdfium

FPDFPath_SetPoint(IntPtr, Int32, FS_PATHPOINTF)

Pdfium

FPDFPath_SetPointCount(IntPtr, Int32)

Pdfium

FPDFPath_TrimPoints(IntPtr, Int32)

Pdfium

FPDFREF_Create(IntPtr, Int32)

Pdfium

FPDFShadingPattern_Create(IntPtr, ShadingTypes, FS_MATRIX)

Pdfium

FPDFSTREAM_Create

Pdfium

FPDFSTRING_CreateChar(String, Boolean)

Pdfium

FPDFSTRING_CreateEmpty

Pdfium

FPDFSTRING_CreateUnicode(String)

Feature Comparasion

Document capability

Lite

Full

PDF document creation

Access to document bookmarks

Add, remove and modify bookmarks

Get access, create and manipulate attachments

Access to named destinations and pdf links

Create and modify destinations

Perform JavaScript and actions

Open password protected documents

Viewer preference

Get metadata and document properties

Set metadata and document properties

Save a copy of document

Save with object stream support

Incremental saving

Page management (document split and merge)

Page capability

Lite

Full

Get page index

Get page boundaries (media box, crop box, bleed box, trim box, art box)

Set page boundaries (media box, crop box, bleed box, trim box, art box)

Get/Set page rotation

Perform page JavaScript and actions

Check page transparency

Create new page

Delete a page

Flatten a page

Text capability

Lite

Full

Parse textual information

Text extraction

Search text

Asynchronous search

Copy and select text

Extract web links

Convert PDF to text

Search through document

Render capability

Lite

Full

Render PDF to bitmap

Render PDF to Graphics

Progressive rendering

Annotations rendering

Acroforms rendering

XFA forms rendering

Rendering of annotations which has no appearance stream

Asynchronous capability

Lite

Full

Check whether a document is linearized

Gets index of first available page

Check whether document is available

Check whether page is available

Check whether form is available

Allows to render and display of pages before the entire document data is available

Security

Lite

Full

Open password protected document

Remove document permissions

Set document permissions

Set a password to open PDF document

Set a password to change document restriction settings

Form capability

Lite

Full

Fill PDF forms

Get access to form object

Perform JavaScript

Form field edit

Works with XFA forms

PDF Page objects capability

Lite

Full

PDF object access and edit (Get/Set stroke color, Get/Set fill color, transform, copy, clone, bounding box, transparency,…)

Get color space of image object

Get access to Form Object

Get access to Image Object

Get access to Text object

Get access to Path object

Get access to Shading object

Generate page content (images only)

Generate page content (all objects)

Forms Data Format capability

Lite

Full

Import forms from FDF

Export forms to FDF

Get access to FDF document content

Inernal PDF objects capability

Lite

Full

Get access to cross-referenxe table

Rebuild cross-referenxe table

Search for orphaned objects

Get access to PDF Indirect objects

Get access to PDF Dictionaries

Get access to PDF Arrays

Get access to PDF Streams

Get access to PDF Strings

Get access to PDF Names

Get access to PDF Booleans

Get access to PDF Numbers

Get access to PDF Null objects

Get access to PDF References

Change, insert, destroy objects

Saving changes

Annotations capability

Lite

Full

Get access/create/modify Text Annotations

Get access/create/modify Link Annotations

Get access/create/modify Free Text Annotations

Get access/create/modify Line Annotations

Get access/create/modify Square Annotations

Get access/create/modify Circle Annotations

Get access/create/modify Polygon Annotations

Get access/create/modify Polyline Annotations

Get access/create/modify Highlight Annotations

Get access/create/modify Underline Annotations

Get access/create/modify Squiggly-underline Annotations

Get access/create/modify Strikeout Annotations

Get access/create/modify Rubber Stamp Annotations

Get access/create/modify Caret Annotations

Get access/create/modify Pop-up Annotations

Get access/create/modify File Attachment Annotations

Get access/create/modify Sound Annotations

Get access/create/modify Watermark Annotations

Regenerate annotations default appearance stream

PDF functions capability

Lite

Full

Get access/create/modify sampled function

Get access/create/modify exponential interpolation function

Get access/create/modify stitching function

Get access/create/modify PostScript calculator function