PDFCOMMONSETTINGS

typedef struct _tagPdfCommonSettings
{
   L_UINT32 uStructSize;
   L_BOOL bAdditionalFonts;
   L_CHAR * pszAppendFrom;
   L_CHAR * pszAppendFromPassword;
   DOC2_PDFCOLORQUALITY PdfClrQuality;
   DOC2_PDFCOMPATIBILITY PdfCompatible;
   L_BOOL bCompForContents;
   L_BOOL bCompForTTF;
   L_BOOL bUseFlate;
   L_BOOL bUseJBIG2;
   L_BOOL bUseJPEG2000;
   L_BOOL bUseLZWInsteadOfFlate;
   L_BOOL bDropCaps;
   L_BOOL bOutline;
   L_BOOL bOutlineNumbering;
   L_CHAR * pszOutlinePageName;
   L_BOOL bPDFFormVisuality;
   L_BOOL bEnableAdd;
   L_BOOL bEnableAssemble;
   L_BOOL bEnableCopy;
   L_BOOL bEnableExtract;
   L_BOOL bEnableForms;
   L_BOOL bEnableModify;
   L_BOOL bEnablePrint;
   L_BOOL bEnablePrintQ;
   L_CHAR * pszOwnerPassword;
   DOC2_PDFSECURITY Type;
   L_CHAR * pszUserPassword;
   DOC2_PDFBPP PdfBpp;
   L_CHAR * pszCertificateDescription;
   L_CHAR * pszCertificateSHA1;
   DOC2_PDFSIGNATURE PdfSign;
   COLORREF crUrlBackground;
   COLORREF crUrlForeground;
   L_BOOL bURLForegroundDef;
   L_BOOL bURLUnderline;
   DOC2_PDFMRC PdfMrc;
} PDFCOMMONSETTINGS, * pPDFCOMMONSETTINGS;

The structure provides information for the common settings for all PDF output formats (DOC2_PDF, DOC2_PDF_IMAGE_SUBSTITUTES, DOC2_PDF_IMAGE_ON_TEXT and DOC2_PDF_EDITED).

Member

Description

uStructSize

Structure size. It should be equal to sizeof(PDFCOMMONSETTINGS ).

bAdditionalFonts

Enables or disables the use of additional fonts.

 

Value

Meaning

 

TRUE

Enable use of additional fonts.

 

FALSE

Disable use of additional fonts.

pszAppendFrom

Character string that contains the output to be appended  to this file .
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszAppendFromPassword

Character string that contains the password to enable the output to be appended  to this file.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

PdfClrQuality

Specifies the color quality for the output PDF file. For a list of possible values, refer to DOC2_PDFCOLORQUALITY

PdfCompatible

Specifies which version of PDF to use for compatibility. For a list of possible values, refer to DOC2_PDFCOMPATIBILITY.

bCompForContents

Enables or disables compression of Text and Line Art.

 

Value

Meaning

 

TRUE

Enable compression of text and line art..

 

FALSE

Disable compression of text and line art..

bCompForTTF

Enables or disables compression of Embedded Files.

 

Value

Meaning

 

TRUE

Enable embedded files to be compressed.

 

FALSE

Disable embedded files to be compressed.

bUseFlate

Enables or disables Flate compression. Possible values are:

 

Value

Meaning

 

TRUE

Enable Flate compression.

 

FALSE

Disable Flate compression.

bUseJBIG2

Enables or disables JBIG2 compression. Possible values are:

 

Value

Meaning

 

TRUE

Enable JBIG2 compression.

 

FALSE

Disable JBIG2 compression.

bUseJPEG2000

Enables or disables JPEG2000 compression. Possible values are:

 

Value

Meaning

 

TRUE

Enable JPEG2000 compression.

 

FALSE

Disable JPEG2000compression.

bUseLZWInsteadOfFlate

Specifies whether to use LZW instead of Flate compression Possible values are:

 

Value

Meaning

 

TRUE

Use LZW instead of Flate compression.

 

FALSE

Do not use LZW instead of Flate compression .

bDropCaps

Specifies whether to retain drop caps. Possible values are:

 

Value

Meaning

 

TRUE

Retain drop caps.

 

FALSE

Do not retain drop caps.

bOutline

Specifies whether to use bookmarks for pages. Possible values are:

 

Value

Meaning

 

TRUE

Use bookmarks.

 

FALSE

Do not use bookmarks.

bOutlineNumbering

Specifies whether to add page numbers to the page name. Possible values are:

 

Value

Meaning

 

TRUE

Add page numbers

 

FALSE

Do not add page numbers.

pszOutlinePageName

Character string that contains the page name of the bookmark.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

bPDFFormVisuality

Specifies whether to display the  visual components of the form. Possible values are:

 

Value

Meaning

 

TRUE

Display the visual components .

 

FALSE

Do not display the  visual components .

bEnableAdd

Enables whether comments and form fields can be changed or edited. Possible values are:

 

Value

Meaning

 

TRUE

Comments and form fields can be changed or edited.

 

FALSE

Comments and form fields cannot be changed or edited.

bEnableAssemble

Enables or disables document assembly. Possible values are:

 

Value

Meaning

 

TRUE

Documents can be assembled.

 

FALSE

Documents cannot be assembled.

bEnableCopy

Enables or disables whether material can be copied or extracted. Possible values are:

 

Value

Meaning

 

TRUE

Material can be copied or extracted.

 

FALSE

Material cannot be copied or extracted.

bEnableExtract

Enables or disables whether material can be extracted. Possible values are:

 

Value

Meaning

 

TRUE

Material can be extracted.

 

FALSE

Material cannot be extracted.

bEnableForms

Enables or disables whether forms can be filled out. Possible values are:

 

Value

Meaning

 

TRUE

Forms can be filled out.

 

FALSE

Forms cannot be filled out.

bEnableModify

Specifies whether documents can be modified.  Possible values are:

 

Value

Meaning

 

TRUE

Documents can be modified.

 

FALSE

Documents cannot be modified.

bEnablePrint

Specifies whether output PDF files can be printed.

 

Value

Meaning

 

TRUE

Output PDF files can be printed.

 

FALSE

Output PDF files cannot be printed.

bEnablePrintQ

Specifies whether high quality printing can be performed.

 

Value

Meaning

 

TRUE

High quality printing can be performed,

 

FALSE

High quality printing cannot be performed.

pszOwnerPassword

Character string that contains the owner password.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

Type

Specifies the PDF security type. For a list of possible values, refer to DOC2_PDFSECURITY.

pszUserPassword

Character string that contains the user password.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

DOC2_PDFBPP

The PDF color depth. For a list of possible values, refer to DOC2_PDFBPP.

pszCertificateDescription

Character string that contains the certificate description.
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

pszCertificateSHA1

Character string that contains the certificate SHA1 thumbprint
The toolkit will allocate memory internally for this member using the Windows GlobalAllocPtr macro. After you are done using this structure, you must use the Windows GlobalFreePtr macro to free the memory allocated by the toolkit if it contains a valid pointer (not NULL).

PdfSign

The PDF signature type. For a list of possible values, refer to DOC2_PDFSIGNATURE.

crUrlBackground

The color for the URL background.

crUrlForeground

The color for the URL foreground.

bURLForegroundDef

Specifies whether to use the default foreground color for the URL.

 

Value

Meaning

 

TRUE

Use the default foreground color for the URL.

 

FALSE

Do not use the default foreground color for the URL.

bURLUnderline

Specifies whether the URLS will be underlined.

 

Value

Meaning

 

TRUE

Underline URLs.

 

FALSE

Do not underline URLs.

DOC2_PDFMRC

The PDF MRC type for the output PDF file. For a list of possible values, refer to DOC2_PDFMRC.

Comments

pPDFCOMMONSETTINGS is a pointer to a PDFCOMMONSETTINGS structure. If the function parameter type is pPDFCOMMONSETTINGS, declare a PDFCOMMONSETTINGS variable, update the structure's fields, and pass the variable's address in the parameter. Declaring a pPDFCOMMONSETTINGS variable is necessary only if the program requires a pointer.

This structure is used with the following functions:

L_Doc2GetOutputFormatSettings

L_Doc2SetOutputFormatSettings