THeaderAndFooter Record
Contains all information about headers and footers in an Excel sheet.
Syntax
Unit: FlexCel.Core
THeaderAndFooter = record;
Methods
Name | Description |
---|---|
Create | Initializes an empty THeaderAndFooter record. |
SetAllHeaders | Sets the headers for all the pages to a given string. Note that setting this value will set DiffEvenPages and DiffFirstPage to false. For a description of the possible values of this string, see TExcelFile.PageHeader |
SetAllFooters | Sets the footers for all the pages to a given string. Note that setting this value will set DiffEvenPages and DiffFirstPage to false. For a description of the possible values of this string, see TExcelFile.PageHeader |
GetHeader | Returns the header for a given page, considering if there are differences in even/odd pages or the first page. |
GetFooter | Returns the footer for a given page, considering if there are differences in even/odd pages or the first page. |
GetHeaderAndFooterKind | Returns the kind of footer image for a given page. This method is normally useful to get the correct image for a specific page. |
Equals | Returns true if both objects are the same. |
GetHashCode | Hashcode for the obeject. |
Operators
Name | Description |
---|---|
Equality | Adapts the = operator so it returns true when both instances have the same values. |
Inequality | Adapts the <> operator so it returns true when both instances have different values. |
Properties
Name | Description |
---|---|
DefaultHeader | Returns or sets the header for all pages that are not even or the first page. If DiffFirstPage is false, then this string also applies to the first page. If DiffEvenPages is false, this string also applies for even pages. For a description of the possible values of this string, see TExcelFile.PageHeader To set a header for all pages, use SetAllHeaders |
DefaultFooter | Returns or sets the footer for all pages that are not even or the first page. If DiffFirstPage is false, then this string also applies to the first page. If DiffEvenPages is false, this string also applies for even pages. For a description of the possible values of this string, see TExcelFile.PageHeader To set a footer for all pages, use SetAllFooters |
EvenHeader | Header for even pages. Note that this value is valid if and only if DiffEvenPages is true. For a description of the possible values of this string, see TExcelFile.PageHeader If you don't want a different header for even pages, set DiffEvenPages to false or call SetAllHeaders. |
EvenFooter | Footer for even pages. Note that this value is valid if and only if DiffEvenPages is true. For a description of the possible values of this string, see TExcelFile.PageHeader If you don't want a different footer for even pages, set DiffEvenPages to false or call SetAllFooters. |
FirstHeader | Header for the first page. Note that this value is valid if and only if DiffFirstPage is true. For a description of the possible values of this string, see TExcelFile.PageHeader If you don't want a different header for the first page, set DiffFirstPage to false or call SetAllHeaders. |
FirstFooter | Footer for the first page.Note that this value is valid if and only if DiffFirstPage is true. For a description of the possible values of this string, see TExcelFile.PageHeader If you don't want a different footer for the first page, set DiffFirstPage to false or call SetAllFooters. |
DiffFirstPage | When true the first page will have a different header and footer from the rest, and it will be specified in FirstHeader and FirstFooter. When false, FirstHeader and FirstFooter have no meaning. |
DiffEvenPages | When true even pages will have different headers and footers from odd pages, and headers/footer for even pages will be specified in EvenHeader and EvenFooter. When false, EvenHeader and EvenFooter have no meaning. |
ScaleWithDoc | Determines if to scale header and footer with document scaling or not. |
AlignMargins | Align header footer margins with page margins. When true, as left/right margins grow and shrink, the header and footer edges stay aligned with the margins. When false, headers and footers are aligned on the paper edges, regardless of margins. |