Represents the user interface context for managing header and footer elements in a document.
Definition
Namespace:Telerik.Windows.Documents.UI
Assembly:Telerik.Windows.Controls.RichTextBox.dll
Syntax:
public class HeaderFooterUIContextInheritance: objectHeaderFooterUIContext
Constructors
public HeaderFooterUIContext()Properties
Forces focus to the footer area of the header/footer UI context.
public bool ForceFooterFocus { get; }Forces the focus on the header section of the document's header and footer UI context.
public bool ForceHeaderFocus { get; }Gets a value indicating whether the last right-click action came from a footer source.
public bool IsFooterLastRightClickSource { get; }Determines whether the header area of the document has been clicked.
public bool IsHeaderClicked { get; }Gets a value indicating whether the header is currently focused in the header/footer UI context.
public bool IsHeaderFocused { get; }Gets a value indicating whether the last click was on a header or footer element.
public bool IsHeaderFooterLastClickSource { get; }Gets a value indicating whether the last right-click source was the header.
public bool IsHeaderLastRightClickSource { get; }Gets the source of the last change made in the header or footer UI context.
public HeaderFooterPresenterBase LastChangeSource { get; set; }Gets the source of the last double-click event in the Header and Footer UI context.
public IUILayerContainer LastDoubleClickSource { get; }Methods
protected virtual void OnFooterUpdateNeeded(FooterUpdateNeededEventArgs e)protected virtual void OnHeaderFooterEditorPropertiesSynchronizationNeeded()protected virtual void OnHeaderUpdateNeeded(HeaderUpdateNeededEventArgs e)Resets the source for double-click events in the header and footer user interface context.
public void ResetDoubleClickSource()Sets the double-click source for the specified UI layer container.
public void SetDoubleClickSource(IUILayerContainer lastDoubleClickSource, bool isHeaderClicked)The UI layer container to which the double-click source is set.
isHeaderClickedboolA boolean value indicating whether the header is clicked
Sets the last click source for the HeaderFooterUIContext.
public void SetLastClickSource(bool isHeaderFooterLastClickSource)A boolean value indicating whether the last click source was initiated by the user.
Sets the last right-click source used in the Header/Footer UI context.
Updates the footer of a specified section within the document.
public void UpdateFooter(Section section, HeaderFooterType footerType, Footer footer)The section in which the footer is to be updated.
footerTypeHeaderFooterTypeThe type of footer to update (e.g., first page, even pages, or odd pages).
footerFooterThe new footer object that will replace the existing footer.
Updates the header of the specified section with the provided header content.
public void UpdateHeader(Section section, HeaderFooterType headerType, Header header)The section to update the header for.
headerTypeHeaderFooterTypeThe type of header or footer to be updated.
headerHeaderThe header content to set for the specified section.
Events
public event EventHandler<FooterUpdateNeededEventArgs> FooterUpdateNeededpublic event EventHandler HeaderFooterEditorPropertiesSynchronizationNeededpublic event EventHandler<HeaderUpdateNeededEventArgs> HeaderUpdateNeeded