Class HeaderFooterPresenterBase

Represents the base class for presenting header and footer elements in a document.

Inheritance
System.Object
HeaderFooterPresenterBase
FooterPresenter
HeaderPresenter
Namespace: Telerik.Windows.Documents.UI
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public abstract class HeaderFooterPresenterBase : Control

Constructors

HeaderFooterPresenterBase()

Initializes a new instance of the HeaderFooterPresenterBase class.

Declaration
public HeaderFooterPresenterBase()

HeaderFooterPresenterBase(IUILayerContainer)

Initializes a new instance of the HeaderFooterPresenterBase class.

Declaration
public HeaderFooterPresenterBase(IUILayerContainer owner)
Parameters
IUILayerContainer owner

The owner element implementing IUILayerContainer.

Properties

AssociatedSectionBox

Declaration
protected SectionLayoutBox AssociatedSectionBox { get; }
Property Value
SectionLayoutBox

BodyRichTextBox

Declaration
protected RadRichTextBox BodyRichTextBox { get; }
Property Value
RadRichTextBox

DocumentEditorType

Gets or sets the type of the document editor used by the header and footer presenter.

Declaration
public abstract DocumentEditorType DocumentEditorType { get; }
Property Value
DocumentEditorType

The type of the document editor. This value determines the editing capabilities available for the header and footer sections.

IsInEditHeaderFooterMode

Declaration
protected bool IsInEditHeaderFooterMode { get; set; }
Property Value
System.Boolean

MouseClickRectangle

Declaration
protected Rectangle MouseClickRectangle { get; }
Property Value
System.Windows.Shapes.Rectangle

Owner

Declaration
protected IUILayerContainer Owner { get; }
Property Value
IUILayerContainer

OwnerDocumentEditor

Declaration
protected IDocumentEditorPresenterContainer OwnerDocumentEditor { get; }
Property Value
IDocumentEditorPresenterContainer

WrappingStackPanel

Declaration
protected StackPanel WrappingStackPanel { get; }
Property Value
System.Windows.Controls.StackPanel

Methods

CleanUp()

Cleans up any resources used by the HeaderFooterPresenterBase instance. This method is responsible for releasing unmanaged resources and performing other cleanup operations.

Declaration
public void CleanUp()

GetBody()

Declaration
protected abstract RadDocument GetBody()
Returns
RadDocument

GetUIHeight()

Retrieves the height of the UI element associated with the header/footer presenter.

Declaration
public abstract double GetUIHeight()
Returns
System.Double

A floating-point number representing the height of the UI in pixels.

InvalidateBody()

Invalidates the body of the header and footer presenter, forcing a complete re-render of the content.

Declaration
public void InvalidateBody()
Remarks

This method should be called when there are changes in the header or footer content that require the body to be updated.

OnApplyTemplate()

Invoked whenever the template is applied, allowing for custom initialization logic when the control's visual tree is created.

Declaration
public override void OnApplyTemplate()
Remarks

This method is typically overridden in derived classes to add custom behavior when the template is applied.

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

SetAssociatedSectionBox(SectionLayoutBox, Boolean)

Declaration
protected void SetAssociatedSectionBox(SectionLayoutBox value, bool delayed)
Parameters
SectionLayoutBox value

System.Boolean delayed

SetDocumentSilently(RadDocument)

Declaration
protected void SetDocumentSilently(RadDocument document)
Parameters
RadDocument document

SetMaxHeight(Single)

Sets the maximum height for the header or footer presenter.

Declaration
public void SetMaxHeight(float maxHeight)
Parameters
System.Single maxHeight

The maximum height to set, in pixels.

SetOwner(IUILayerContainer)

Sets the owner of the HeaderFooterPresenterBase instance.

Declaration
public void SetOwner(IUILayerContainer owner)
Parameters
IUILayerContainer owner

The IUILayerContainer that will be set as the owner.

Update(SectionLayoutBox, Boolean, Boolean)

Updates the header and footer presentation for the specified section layout box.

Declaration
public void Update(SectionLayoutBox associatedSectionBox, bool isInEditHeaderFooterMode, bool shouldFocus)
Parameters
SectionLayoutBox associatedSectionBox

The layout box that represents the section to update.
System.Boolean isInEditHeaderFooterMode

A boolean indicating whether the header or footer are being edited
System.Boolean shouldFocus

A boolean indicating whether the footer or the header should be focused.

Update(SectionLayoutBox, Boolean, Boolean, Boolean)

Updates the header and footer presenter with the specified layout box and visibility settings.

Declaration
public void Update(SectionLayoutBox associatedSectionBox, bool isInEditHeaderFooterMode, bool shouldFocus, bool delayed)
Parameters
SectionLayoutBox associatedSectionBox

The layout box that represents the section to update.
System.Boolean isInEditHeaderFooterMode

A boolean indicating whether the header or footer are being edited
System.Boolean shouldFocus

A boolean indicating whether the footer or the header should be focused.
System.Boolean delayed

A boolean indicating whether the presenter update should be delayed

UpdateBodyMargin()

Declaration
protected abstract void UpdateBodyMargin()

UpdateOwnerEditingContext(HeaderFooterEditingContext)

Declaration
protected abstract void UpdateOwnerEditingContext(HeaderFooterEditingContext context)
Parameters
HeaderFooterEditingContext context

UpdateOwnerUIContext()

Declaration
protected abstract void UpdateOwnerUIContext()

UpdateSource()

Declaration
protected abstract void UpdateSource()

Extension Methods