Class HeadersFootersBase<T>

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

Inheritance

System.Object

HeadersFootersBase<T>

Footers

Headers

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Telerik.Windows.Documents.Flow.Model

Assembly: Telerik.Windows.Documents.Flow.dll

Syntax

public abstract class HeadersFootersBase<T>
    where T : HeaderFooterBase

Type Parameters

T

Properties

Default

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

Declaration

public T Default { get; }

Property Value

T The default header or footer.

Document

Gets the document containing this header or footer collection.

Declaration

public RadFlowDocument Document { get; }

Property Value

RadFlowDocument 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 Section.HasDifferentFirstPageHeaderFooter property.

Declaration

public T Even { get; }

Property Value

T 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.

Declaration

public T First { get; }

Property Value

T The first header or footer.

Section

Gets the section that owns this header or footer collection.

Declaration

public Section Section { get; }

Property Value

Section The owner section.

Methods

Add()

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

Declaration

public T Add()

Returns

T 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 Section.HasDifferentFirstPageHeaderFooter and HasDifferentEvenOddPageHeadersFooters properties.

Declaration

public T Add(HeaderFooterType headerFooterType)

Parameters

HeaderFooterType headerFooterType Type of the header or footer.

Returns

T The added Header or Footer.

CreateHeaderFooterInstance()

Creates an instance of Header or Footer class.

Declaration

protected abstract T CreateHeaderFooterInstance()

Returns

T The new Header or Footer instance.

Remove(HeaderFooterType)

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

Declaration

public void Remove(HeaderFooterType headerFooterType)

Parameters

HeaderFooterType headerFooterType Type of the header footer.