New to Telerik Document Processing? Start a free 30-day trial

HeadersFootersBase<T>

Class

Manages a type-safe collection of headers or footers for a Section, coordinating Default, Even, and First instances based on page layout settings.

Definition

Namespace:Telerik.Windows.Documents.Flow.Model

Assembly:Telerik.Windows.Documents.Flow.dll

Type Parameters:

Syntax:

public abstract class HeadersFootersBase<T> where T : HeaderFooterBase

Inheritance: objectHeadersFootersBase<T>

Derived Classes: FootersHeaders

Methods

Add()

Creates and adds a default Header or Footer for all pages, and returns the new instance.

public T Add()

Returns:

The added Header or Footer.

Add(HeaderFooterType)

Creates and adds a Header or Footer for the specified page type, and returns the new instance.

Visualization of non-default headers or footers depends additionally on and HasDifferentEvenOddPageHeadersFooters properties.

public T Add(HeaderFooterType headerFooterType)

Parameters:headerFooterTypeHeaderFooterType

Type of the header or footer.

Returns:

The added Header or Footer.

CreateHeaderFooterInstance()

Creates an instance of Header or Footer class.

protected abstract T CreateHeaderFooterInstance()

Returns:

The new Header or Footer instance.

Remove(HeaderFooterType)

Removes the Header or Footer of the specified page type from the collection.

public void Remove(HeaderFooterType headerFooterType)

Parameters:headerFooterTypeHeaderFooterType

Type of the header footer.

Properties

Default

Gets the header or footer displayed on all pages except first and even pages when those are specifically defined.

public T Default { get; }

Property Value:

The default header or footer.

Document

RadFlowDocument

Gets the document containing this header or footer collection.

public RadFlowDocument Document { get; }

Property Value:

The document.

Even

Gets the header or footer displayed on even-numbered pages when different even/odd headers are enabled in the document.

Visualization of this header or footer depends additionally on property.

public T Even { get; }

Property Value:

The even header or footer.

First

Gets the header or footer displayed on the first page of the section when a different first-page header is enabled.

Visualization of this header or footer depends additionally on HasDifferentEvenOddPageHeadersFooters property.

public T First { get; }

Property Value:

The first header or footer.

Section

Gets the section that owns this header or footer collection.

public Section Section { get; }

Property Value:

The owner section.