Tracks header/footer interaction state and coordinates document updates and editor synchronization.
Definition
Namespace:Telerik.WinForms.Documents.UI
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class HeaderFooterUIContext
Inheritance: objectHeaderFooterUIContext
Constructors
Initializes the interaction state used by header and footer presenters.
public HeaderFooterUIContext()
Properties
Gets whether a request to focus the footer presenter is pending. The header container clears this request after applying it.
public bool ForceFooterFocus { get; }
Gets whether a request to focus the header presenter is pending. The header container clears this request after applying it.
public bool ForceHeaderFocus { get; }
Gets whether the most recent right-click originated in a footer.
public bool IsFooterLastRightClickSource { get; }
Gets whether the most recent double-click was in the header.
public bool IsHeaderClicked { get; }
Gets whether the header editor currently has focus.
public bool IsHeaderFocused { get; }
Gets whether the most recent click or right-click originated in a header or footer presenter.
public bool IsHeaderFooterLastClickSource { get; }
Gets whether the most recent right-click originated in a header.
public bool IsHeaderLastRightClickSource { get; }
Gets or sets the presenter whose latest user edit is being synchronized with the document.
public HeaderFooterPresenterBase LastChangeSource { get; set; }
Gets the layer container that received the most recent double-click, if any.
public IUILayerContainer LastDoubleClickSource { get; }
Methods
Raises the FooterUpdateNeeded event.
protected virtual void OnFooterUpdateNeeded(FooterUpdateNeededEventArgs e)
The requested section footer update.
Raises the HeaderFooterEditorPropertiesSynchronizationNeeded event.
protected virtual void OnHeaderFooterEditorPropertiesSynchronizationNeeded()
Raises the HeaderUpdateNeeded event.
protected virtual void OnHeaderUpdateNeeded(HeaderUpdateNeededEventArgs e)
The requested section header update.
Clears the recorded double-click source.
public void ResetDoubleClickSource()
Records the layer container that received a double-click and whether it occurred in the header.
public void SetDoubleClickSource(IUILayerContainer lastDoubleClickSource, bool isHeaderClicked)
The layer container that received the double-click.
isHeaderClickedbooltrue if the double-click was in the header; otherwise, in the footer.
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.
Raises FooterUpdateNeeded to request an update to the specified section footer.
public void UpdateFooter(Section section, HeaderFooterType footerType, Footer footer)
The section whose footer is being updated.
footerTypeHeaderFooterTypeThe page variant to update.
footerFooterThe footer model object supplied for the update.
Raises HeaderUpdateNeeded to request an update to the specified section header.
public void UpdateHeader(Section section, HeaderFooterType headerType, Header header)
The section whose header is being updated.
headerTypeHeaderFooterTypeThe page variant to update.
headerHeaderThe header model object supplied for the update.
Events
Occurs when a section footer update is requested.
public event EventHandler<FooterUpdateNeededEventArgs> FooterUpdateNeeded
Occurs when the parent editor's properties need to be synchronized with its header/footer editors.
public event EventHandler HeaderFooterEditorPropertiesSynchronizationNeeded
Occurs when a section header update is requested.
public event EventHandler<HeaderUpdateNeededEventArgs> HeaderUpdateNeeded