TXTextControl.HeaderFooterCollection.Add Method

Adds a new header or footer to a Text Control document or to a certain section of the document. If a header or footer is added to the complete document the first section receives the header or footer and all other sections receive headers or footers which are connected to their previous section. To add more than one header or footer a combination of the HeaderFooterType enumeration values can be used.

Syntax

[C#]
public bool Add(HeaderFooterType headerFooterType);
[Visual Basic]
Public Function Add(ByVal headerFooterType As HeaderFooterType) As Boolean
Parameter Description
headerFooterType

Specifies the headers and/or footers to add. A combination of the following values of the HeaderFooterType enumeration is possible:


Value Meaning
Header Adds a header to the document.
FirstPageHeader Adds a special header to the document's first page.
Footer Adds a footer to the document.
FirstPageFooter Adds a special footer to the document's first page.
EvenHeader Adds an even header to the document. Even and odd headers can only exist together. If a header already exists, the existing header becomes the odd header. Otherwise an odd header is also created.
EvenFooter Adds an even footer to the document. Even and odd footers can only exist together. If a footer already exists, the existing footer becomes the odd footer. Otherwise an odd footer is also created.
All Adds all headers and footers.

Return Value

The return value is true, if the header or footer could be added. Otherwise it is false.

See Also