HeadersFooters

<< Click to Display Table of Contents >>

Navigation:  Printing Process > IPXCPrinter Interface > Properties > Property Options >

HeadersFooters


 

DAPI_ICON_ HeadersFooters

 


 

The HeadersFooters properties define the placement of headers and footers in printed documents. Headers and footers contain three sections: left, center and right. Each section specifies the text color and font in the associated area of printed documents. Macros can be used as desired. Please note that all properties are case-sensitive:

 

 

NAME

 

 

VALUES

 

DEFINITION

Enabled

Boolean Value

 

Enables headers and footers. If set to False then headers and footers are not created and no further properties from this section are used.

 

Default value: False

 

FirstPageNumber

Integer

 

Defines the page at which headers and footers start. The value of this property is used in the %[Page] macro.

 

Default value: 1

 

OffsetLeft

OffsetTop

OffsetRight

OffsetBottom

Integer

 

These properties define the location of headers and footers. The units used are tenths of a millimeter.

 

Default value: 127

 

 

Headers and footers are defined with two sections: Header and Footer. These sections are identical and contain three identical subsections: Left, Center and Right. The following properties apply to all subsections:

 

 

NAME

 

 

VALUES

 

DEFINITION

Font

String

 

Specifies the font used for headers and footers.

 

Default value: Arial

 

FontSize

All values from 10 - 32768

 

Specifies font size in tenths of a point. (1 point is 1/72 inch).

 

Default value: 100

 

FontBold

Boolean Value

 

Enables/disables bold for the text used.

 

Default value: False

 

FontItalic

Boolean Value

 

Enables/disables italics for the text used.

 

Default value: False

 

 

Color

 

RGB COLORREF

 

Defines the color of the text used.

 

Default value: 0 (black)

 

Value

String

 

Defines the text used. Macros can be used in this property as desired.

 

Default value: empty string

 

 

Example

 

The following example will place a red label with the current page number at the right-top corner of each page, with the font Verdana, in bold and at 12 pt size:

 

(C++)

 

printer.Option[L"HeadersFooters.Enabled"] = TRUE;

printer.Option[L"HeadersFooters.Header.Right.Font"] = L"Verdana";

printer.Option[L"HeadersFooters.Header.Right.FontBold"] = TRUE;

printer.Option[L"HeadersFooters.Header.Right.FontSize"] = 120;

printer.Option[L"HeadersFooters.Header.Right.color"] = RGB(25500);

printer.Option[L"HeadersFooters.Header.Right.Value"] = L"Page %[Page]";

 

(VB)

 

With PDFPrinter

.Option("HeadersFooters.Enabled") = TRUE;

.Option("HeadersFooters.Header.Right.Font") = "Verdana";

.Option("HeadersFooters.Header.Right.FontBold") = "Yes";

.Option("HeadersFooters.Header.Right.FontSize") = 120;

.Option("HeadersFooters.Header.Right.color") = 255;

.Option("HeadersFooters.Header.Right.Value") = "Page %[Page]";

End With