New to Telerik UI for WinForms? Start a free 30-day trial

Tracks header/footer interaction state and coordinates document updates and editor synchronization.

Definition

Namespace:Telerik.WinForms.Documents.UI

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

C#
public class HeaderFooterUIContext

Inheritance: objectHeaderFooterUIContext

Constructors

Initializes the interaction state used by header and footer presenters.

C#
public HeaderFooterUIContext()

Properties

Gets whether a request to focus the footer presenter is pending. The header container clears this request after applying it.

C#
public bool ForceFooterFocus { get; }

Gets whether a request to focus the header presenter is pending. The header container clears this request after applying it.

C#
public bool ForceHeaderFocus { get; }

Gets whether the most recent right-click originated in a footer.

C#
public bool IsFooterLastRightClickSource { get; }

Gets whether the most recent double-click was in the header.

C#
public bool IsHeaderClicked { get; }

Gets whether the header editor currently has focus.

C#
public bool IsHeaderFocused { get; }

Gets whether the most recent click or right-click originated in a header or footer presenter.

C#
public bool IsHeaderFooterLastClickSource { get; }

Gets whether the most recent right-click originated in a header.

C#
public bool IsHeaderLastRightClickSource { get; }

Gets or sets the presenter whose latest user edit is being synchronized with the document.

C#
public HeaderFooterPresenterBase LastChangeSource { get; set; }

Gets the layer container that received the most recent double-click, if any.

C#
public IUILayerContainer LastDoubleClickSource { get; }

Methods

Raises the FooterUpdateNeeded event.

C#
protected virtual void OnFooterUpdateNeeded(FooterUpdateNeededEventArgs e)
Parameters:eFooterUpdateNeededEventArgs

The requested section footer update.

C#
protected virtual void OnHeaderFooterEditorPropertiesSynchronizationNeeded()

Raises the HeaderUpdateNeeded event.

C#
protected virtual void OnHeaderUpdateNeeded(HeaderUpdateNeededEventArgs e)
Parameters:eHeaderUpdateNeededEventArgs

The requested section header update.

Clears the recorded double-click source.

C#
public void ResetDoubleClickSource()

Records the layer container that received a double-click and whether it occurred in the header.

C#
public void SetDoubleClickSource(IUILayerContainer lastDoubleClickSource, bool isHeaderClicked)
Parameters:lastDoubleClickSourceIUILayerContainer

The layer container that received the double-click.

isHeaderClickedbool

true if the double-click was in the header; otherwise, in the footer.

Records whether the most recent click originated in a header or footer presenter.

C#
public void SetLastClickSource(bool isHeaderFooterLastClickSource)
Parameters:isHeaderFooterLastClickSourcebool

true if the click was in a header or footer; otherwise, false.

Records whether the most recent right-click originated in a header or footer and identifies which one. Passing false clears both right-click source flags.

C#
public void SetLastRightClickSource(bool isHeaderFooterLastClickSource, bool isInHeader)
Parameters:isHeaderFooterLastClickSourcebool

true if the right-click was in a header or footer.

isInHeaderbool

true if the source was the header; otherwise, the footer.

Raises FooterUpdateNeeded to request an update to the specified section footer.

C#
public void UpdateFooter(Section section, HeaderFooterType footerType, Footer footer)
Parameters:sectionSection

The section whose footer is being updated.

footerTypeHeaderFooterType

The page variant to update.

footerFooter

The footer model object supplied for the update.

Raises HeaderUpdateNeeded to request an update to the specified section header.

C#
public void UpdateHeader(Section section, HeaderFooterType headerType, Header header)
Parameters:sectionSection

The section whose header is being updated.

headerTypeHeaderFooterType

The page variant to update.

headerHeader

The header model object supplied for the update.

Events

Occurs when a section footer update is requested.

C#
public event EventHandler<FooterUpdateNeededEventArgs> FooterUpdateNeeded

Occurs when the parent editor's properties need to be synchronized with its header/footer editors.

C#
public event EventHandler HeaderFooterEditorPropertiesSynchronizationNeeded

Occurs when a section header update is requested.

C#
public event EventHandler<HeaderUpdateNeededEventArgs> HeaderUpdateNeeded