Library Class Documentation

class Library : SystemIDisposable

Namespace:Datalogics::PDFL

Inherits from:
SystemIDisposable

Detailed Description

Used to create a new instance of a library object or change properties.

A Library object can be used to create a new instance of a library or change the properties of an existing library.

Constructor & Destructor Documentation

Library

Library()

Initialize the PDF Library on this thread. Note that each thread needs its own instance of the library.

Multiple Library objects can be created on a thread, but they all refer to the same underlying instantiation of the library.

Library

Library(LibraryFlags flags)

Parameters

flags: LibraryFlags

PDF Library initialization flags, optional

Initialize the PDF Library on this thread. Note that each thread needs its own instance of the library.

Multiple Library objects can be created on a thread, but they all refer to the same underlying instantiation of the library.

Library

Library(System.Collections.Generic.IList< System.String > fontPaths)

Parameters

fontPaths: System.Collections.Generic.IList< System.String >

list of directories to search for fonts

Initialize the PDF Library on this thread. Note that each thread needs its own instance of the library.

Multiple Library objects can be created on a thread, but they all refer to the same underlying instantiation of the library.

Library

Library(System.Collections.Generic.IList< System.String > fontPaths, LibraryFlags flags)

Parameters

fontPaths: System.Collections.Generic.IList< System.String >

list of directories to search for fonts

flags: LibraryFlags

PDF Library initialization flags, optional

Initialize the PDF Library on this thread. Note that each thread needs its own instance of the library.

Multiple Library objects can be created on a thread, but they all refer to the same underlying instantiation of the library.

Library

Library(System.Collections.Generic.IList< System.String > fontPaths, string CMapPath, string UnicodePath, LibraryFlags flags)

Parameters

fontPaths: System.Collections.Generic.IList< System.String >

list of directories to search for fonts

CMapPath: string

directory to search for CMap files (pass an empty string to use the default)

UnicodePath: string

directory to search for Unicode mapping files (pass an empty string to use the default)

flags: LibraryFlags

PDF Library initialization flags, optional

Initialize the PDF Library on this thread. Note that each thread needs its own instance of the library.

Multiple Library objects can be created on a thread, but they all refer to the same underlying instantiation of the library.

Library

Library(System.Collections.Generic.IList< System.String > fontPaths, string CMapPath, string UnicodePath, string ColorProfilePath, LibraryFlags flags)

Parameters

fontPaths: System.Collections.Generic.IList< System.String >

list of directories to search for fonts

CMapPath: string

directory to search for CMap files (pass an empty string to use the default)

UnicodePath: string

directory to search for Unicode mapping files (pass an empty string to use the default)

ColorProfilePath: string

directory to search for Color Profile files (pass an empty string to use the default)

flags: LibraryFlags

PDF Library initialization flags, optional

Initialize the PDF Library on this thread. Note that each thread needs its own instance of the library.

Multiple Library objects can be created on a thread, but they all refer to the same underlying instantiation of the library.

Property Documentation

APDFLVersion

static string APDFLVersion[get]

AllowOpeningXFA

bool AllowOpeningXFA[get, set]

Allow opening PDF files that contain XFA forms. By default, an exception will be raised when attempting to open this type of document.

AllowRelaxedSyntax

bool AllowRelaxedSyntax[get, set]

Check to see if minor parsing errors are ignored while opening PDF files.

DLEVersion

static string DLEVersion[get]

DefaultTempPath

string DefaultTempPath[get, set]

Gets the default temporary directory.

DefaultTempStore

TempStoreType DefaultTempStore[get, set]

Gets default temporary storage. PDFL uses Disk storage type by default.

DefaultTempStoreMemLimit

int DefaultTempStoreMemLimit[get, set]

Gets current memory limit.

FormsExtensionVersion

static string FormsExtensionVersion[get]

InstallLocation

static string InstallLocation[get]

LicenseKey

static string LicenseKey[get, set]

LogParams

LogParams LogParams[get, set]

Gets LogParams object with preferences for logging.

ResourceDirectory

static string ResourceDirectory[get]

Member Function Documentation

ChangeWorkingSpaceCMYK

void ChangeWorkingSpaceCMYK(ColorProfile colorProfile)

Parameters

colorProfile: ColorProfile

The Color Profile to be used.

Returns:

void

Sets the current CMYK working space to the specified ICC profile.

ChangeWorkingSpaceCMYK

void ChangeWorkingSpaceCMYK(string profilePath)

Parameters

profilePath: string

The path on disk of the Color Profile to be used.

Returns:

void

Sets the current CMYK working space to the specified ICC profile.

ChangeWorkingSpaceGray

void ChangeWorkingSpaceGray(ColorProfile colorProfile)

Parameters

colorProfile: ColorProfile

The Color Profile to be used.

Returns:

void

Sets the current Gray working space to the specified ICC profile.

ChangeWorkingSpaceGray

void ChangeWorkingSpaceGray(string profilePath)

Parameters

profilePath: string

The path on disk of the Color Profile to be used.

Returns:

void

Sets the current Gray working space to the specified ICC profile.

ChangeWorkingSpaceRGB

void ChangeWorkingSpaceRGB(ColorProfile colorProfile)

Parameters

colorProfile: ColorProfile

The Color Profile to be used.

Returns:

void

Sets the current RGB working space to the specified ICC profile.

ChangeWorkingSpaceRGB

void ChangeWorkingSpaceRGB(string profilePath)

Parameters

profilePath: string

The path on disk of the Color Profile to be used.

Returns:

void

Sets the current RGB working space to the specified ICC profile.

Dispose

void Dispose()

Returns:

void

EnableLicensedBehavior

static bool EnableLicensedBehavior(string arg0)

Parameters

arg0: string

A base64-encoded string containing the encrypted license key.

Returns:

bool

true if the licensed behavior has been successfully enabled.

This is used to turn on licensed behaviors in DLE.

The function parameter is a base64-encoded string containing the encrypted licensed key.

Initialized

static bool Initialized()

Returns:

bool

true if the PDF Library is initialized on this thread

Check to see if the library is initialized

IsFormsExtensionAvailable

bool IsFormsExtensionAvailable()

Returns:

bool

true if the Forms Extension dependencies are present, and false if they are not.

Validate the Forms Extension dependencies are present. Indicates if all of the necessary dependencies are present for the Forms extension.

Terminate

void Terminate()

Returns:

void

Terminate the library with regard to this handle. (Note that if there are other Library objects in this thread, they may keep the library initialized.