TdxSpreadSheetTableViewOptionsPrintHeaderFooterText Class
Stores text strings that a specific Table View worksheet’s header or footer can display.
Declaration
TdxSpreadSheetTableViewOptionsPrintHeaderFooterText = class(
TdxSpreadSheetTableViewOptionsPrintCustomPersistent
)Remarks
You can add printable headers and/or footers at the top and/or bottom of worksheet page printouts. Each header and footer is split horizontally into three independent sections. A section’s content is a string that can include header/footer placeholder codes. The ExpressSpreadsSheet Suite supports the following codes preceded with ampersand (&) as an escape character:
| Code | Description | |
|---|---|---|
 |
&P | Inserts the current worksheet printout page number. The actual page numbering order depends on the worksheet’s OptionsPrint.Printing.PageOrder property value. |
 |
&N | Inserts the total number of printout pages the worksheet content is split into. The number of printout pages depends on the printed area, selected paper size, and custom horizontal and vertical page breaks. |
 |
&D | Inserts the current date in the short format that depends on locale settings. |
 |
&T | Inserts the current time in the short format that depends on locale settings. |
 |
&A | Inserts the source worksheet’s caption. |
The “Header and Footer” dialog provides end-user header and footer content-related functionality. To invoke the dialog, click the “Custom Header/Footer” button on the “Page Setup” dialog’s “Header/Footer” tab.
The TdxSpreadSheetTableViewOptionsPrintHeaderFooterText class provides the following members that allow you to:
Set the text content for the left, center, or right section within a worksheet page header or footer (LeftSection, CenterSection, and RightSection);
Identify if the associated document-based report link considers that a worksheet page header or footer has any content (Assigned);
Clear all sections within a page header or footer (Reset);
The CommonFooter, CommonHeader, EvenPagesFooter, EvenPagesHeader, FirstPageFooter, and FirstPageHeader properties accessible via the Table View worksheet’s OptionsPrint.HeaderFooter property reference a TdxSpreadSheetTableViewOptionsPrintHeaderFooterText object.