Represents the base class for presenting header and footer elements in a document.
Definition
Namespace:Telerik.Windows.Documents.UI
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public abstract class HeaderFooterPresenterBase : ControlInheritance: objectHeaderFooterPresenterBase
Derived Classes:
Constructors
Initializes a new instance of the HeaderFooterPresenterBase class.
public HeaderFooterPresenterBase()Initializes a new instance of the HeaderFooterPresenterBase class.
public HeaderFooterPresenterBase(IUILayerContainer owner)The owner element implementing IUILayerContainer.
Properties
protected SectionLayoutBox AssociatedSectionBox { get; }protected RadRichTextBox BodyRichTextBox { get; }Gets or sets the type of the document editor used by the header and footer presenter.
public abstract DocumentEditorType DocumentEditorType { get; }The type of the document editor. This value determines the editing capabilities available for the header and footer sections.
protected bool IsInEditHeaderFooterMode { get; set; }MouseClickRectangle
Rectangle
protected Rectangle MouseClickRectangle { get; }protected IUILayerContainer Owner { get; }protected IDocumentEditorPresenterContainer OwnerDocumentEditor { get; }WrappingStackPanel
StackPanel
protected StackPanel WrappingStackPanel { get; }Methods
Cleans up any resources used by the HeaderFooterPresenterBase instance. This method is responsible for releasing unmanaged resources and performing other cleanup operations.
public void CleanUp()Retrieves the height of the UI element associated with the header/footer presenter.
public abstract double GetUIHeight()A floating-point number representing the height of the UI in pixels.
Invalidates the body of the header and footer presenter, forcing a complete re-render of the content.
public void InvalidateBody()This method should be called when there are changes in the header or footer content that require the body to be updated.
Invoked whenever the template is applied, allowing for custom initialization logic when the control's visual tree is created.
public override void OnApplyTemplate()This method is typically overridden in derived classes to add custom behavior when the template is applied.
Raises the event. This method is invoked whenever is set to true internally.
protected override void OnInitialized(EventArgs e)The RoutedEventArgs that contains the event data.
protected void SetAssociatedSectionBox(SectionLayoutBox value, bool delayed)Sets the maximum height for the header or footer presenter.
public void SetMaxHeight(float maxHeight)The maximum height to set, in pixels.
Sets the owner of the HeaderFooterPresenterBase instance.
public void SetOwner(IUILayerContainer owner)The IUILayerContainer that will be set as the owner.
Updates the header and footer presenter with the specified layout box and visibility settings.
public void Update(SectionLayoutBox associatedSectionBox, bool isInEditHeaderFooterMode, bool shouldFocus, bool delayed)The layout box that represents the section to update.
isInEditHeaderFooterModeboolA boolean indicating whether the header or footer are being edited
shouldFocusboolA boolean indicating whether the footer or the header should be focused.
delayedboolA boolean indicating whether the presenter update should be delayed
Updates the header and footer presentation for the specified section layout box.
public void Update(SectionLayoutBox associatedSectionBox, bool isInEditHeaderFooterMode, bool shouldFocus)The layout box that represents the section to update.
isInEditHeaderFooterModeboolA boolean indicating whether the header or footer are being edited
shouldFocusboolA boolean indicating whether the footer or the header should be focused.
protected abstract void UpdateBodyMargin()protected abstract void UpdateOwnerEditingContext(HeaderFooterEditingContext context)protected abstract void UpdateOwnerUIContext()protected abstract void UpdateSource()