Library Class Documentation

classLibrary : 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.

Referenced by

Library

Constructor & Destructor Documentation

Library

Library(Libraryrhs, InternalConstructsignifier)

Parameters

rhs: Library
signifier: InternalConstruct

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(LibraryFlagsflags)

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, LibraryFlagsflags)

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, stringCMapPath, stringUnicodePath, LibraryFlagsflags)

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, stringCMapPath, stringUnicodePath, stringColorProfilePath, LibraryFlagsflags)

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.

~Library

~Library()

Destroy this handle to the PDF Library. Also terminate the library if this is the last Library object on this thread.

Property Documentation

APDFLVersion

static stringAPDFLVersion[get]

AllowOpeningXFA

boolAllowOpeningXFA[get, set]

AllowRelaxedSyntax

boolAllowRelaxedSyntax[get, set]

DLEVersion

static stringDLEVersion[get]

DefaultTempPath

stringDefaultTempPath[get, set]

DefaultTempStore

TempStoreTypeDefaultTempStore[get, set]

DefaultTempStoreMemLimit

intDefaultTempStoreMemLimit[get, set]

FormsExtensionVersion

static stringFormsExtensionVersion[get]

InstallLocation

static stringInstallLocation[get]

LicenseKey

static stringLicenseKey[get, set]

LogParams

LogParamsLogParams[get, set]

ResourceDirectory

static stringResourceDirectory[get]

Member Function Documentation

ChangeWorkingSpaceCMYK

voidChangeWorkingSpaceCMYK(ColorProfilecolorProfile)

Parameters

colorProfile: ColorProfile

The Color Profile to be used.

Returns:

void

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

ChangeWorkingSpaceCMYK

voidChangeWorkingSpaceCMYK(stringprofilePath)

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

voidChangeWorkingSpaceGray(ColorProfilecolorProfile)

Parameters

colorProfile: ColorProfile

The Color Profile to be used.

Returns:

void

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

ChangeWorkingSpaceGray

voidChangeWorkingSpaceGray(stringprofilePath)

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

voidChangeWorkingSpaceRGB(ColorProfilecolorProfile)

Parameters

colorProfile: ColorProfile

The Color Profile to be used.

Returns:

void

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

ChangeWorkingSpaceRGB

voidChangeWorkingSpaceRGB(stringprofilePath)

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.

ConstructorRetrieve

static LibraryConstructorRetrieve(System.IntPtrignored)

Parameters

ignored: System.IntPtr

Returns:

Library

Dispose

voidDispose()

Returns:

void

DisposeChildren

voidDisposeChildren()

Returns:

void

EnableLicensedBehavior

static boolEnableLicensedBehavior(stringarg0)

Parameters

arg0: string

Returns:

true if the licensed behavior has been successfully enabled. NOTE: When using the Render bypass key, this requires you also set the BypassCopyPerm property to true of the DrawParams or PageImageParams classes for it to work.

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 boolInitialized()

Returns:

true if the PDF Library is initialized on this thread

Check to see if the library is initialized

IsFormsExtensionAvailable

boolIsFormsExtensionAvailable()

Returns:

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

voidTerminate()

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.