HeaderFooter Class

An instance of the HeaderFooter class represents a header or footer in a Text Control document. A header or footer can be obtained through the TextControl.HeadersAndFooters or through the Section.HeadersAndFooters property. The collection obtained through the TextControl.HeadersAndFooters property contains headers and footers which are common to all sections of the document. If a header or footer is added to this collection all sections of the document have the same header or footer. These headers and footers are connected, which means that changing the contents of such a header or footer also changes the content of all other section's headers or footers. The HeaderFooter.ConnectedToPrevious property of these headers and footers is set to true. The collection obtained through the Section.HeadersAndFooters property contains headers and footers which are single to this section. Changing the contents of such a header or footer does not change the contents of other headers and footers.

The TextControl class has events that inform about different occurrences like activation or deactivation of a header or footer. The HeaderFooter class implements the IFormattedText interface.

Syntax

• C#
• VB.NET

​public class HeaderFooter : IFormattedText

​Public Class HeaderFooter
  Implements IFormattedText

Examples

The following examples shows how to insert a header to the first section.

• C#
• VB.NET

​textControl1.ViewMode = TXTextControl.ViewMode.PageView;
textControl1.Sections[1].HeadersAndFooters.Add(TXTextControl.HeaderFooterType.Header);

TXTextControl.HeaderFooter header = textControl1.Sections[1].HeadersAndFooters.GetItem( TXTextControl.HeaderFooterType.Header); 

header.Selection.Text = "TX Text Control"; 
header.Selection.Start = 3; 
header.Selection.Length = 4; 
header.Selection.Bold = true;

​TextControl1.ViewMode = TXTextControl.ViewMode.PageView 

TextControl1.Sections(1).HeadersAndFooters.Add(TXTextControl.HeaderFooterType.Header) 

Dim header As TXTextControl.HeaderFooter = TextControl1.Sections(1).HeadersAndFooters.GetItem( _ TXTextControl.HeaderFooterType.Header) 

header.Selection.Text = "TX Text Control" 
header.Selection.Start = 3
header.Selection.Length = 4 
header.Selection.Bold = True

Methods

Properties