Class HeaderFooterUIContext

Represents the user interface context for managing header and footer elements in a document.

Inheritance
System.Object
HeaderFooterUIContext
Namespace: Telerik.Windows.Documents.UI
Assembly: Telerik.Windows.Controls.RichTextBox.dll

Syntax

public class HeaderFooterUIContext : Object

Constructors

HeaderFooterUIContext()

Declaration
public HeaderFooterUIContext()

Properties

ForceFooterFocus

Forces focus to the footer area of the header/footer UI context.

Declaration
public bool ForceFooterFocus { get; }
Property Value
System.Boolean

ForceHeaderFocus

Forces the focus on the header section of the document's header and footer UI context.

Declaration
public bool ForceHeaderFocus { get; }
Property Value
System.Boolean

IsFooterLastRightClickSource

Gets a value indicating whether the last right-click action came from a footer source.

Declaration
public bool IsFooterLastRightClickSource { get; }
Property Value
System.Boolean

IsHeaderClicked

Determines whether the header area of the document has been clicked.

Declaration
public bool IsHeaderClicked { get; }
Property Value
System.Boolean

IsHeaderFocused

Gets a value indicating whether the header is currently focused in the header/footer UI context.

Declaration
public bool IsHeaderFocused { get; }
Property Value
System.Boolean

IsHeaderFooterLastClickSource

Gets a value indicating whether the last click was on a header or footer element.

Declaration
public bool IsHeaderFooterLastClickSource { get; }
Property Value
System.Boolean

IsHeaderLastRightClickSource

Gets a value indicating whether the last right-click source was the header.

Declaration
public bool IsHeaderLastRightClickSource { get; }
Property Value
System.Boolean

LastChangeSource

Gets the source of the last change made in the header or footer UI context.

Declaration
public HeaderFooterPresenterBase LastChangeSource { get; set; }
Property Value
HeaderFooterPresenterBase

LastDoubleClickSource

Gets the source of the last double-click event in the Header and Footer UI context.

Declaration
public IUILayerContainer LastDoubleClickSource { get; }
Property Value
IUILayerContainer

Methods

OnFooterUpdateNeeded(FooterUpdateNeededEventArgs)

Declaration
protected virtual void OnFooterUpdateNeeded(FooterUpdateNeededEventArgs e)
Parameters
FooterUpdateNeededEventArgs e

OnHeaderFooterEditorPropertiesSynchronizationNeeded()

Declaration
protected virtual void OnHeaderFooterEditorPropertiesSynchronizationNeeded()

OnHeaderUpdateNeeded(HeaderUpdateNeededEventArgs)

Declaration
protected virtual void OnHeaderUpdateNeeded(HeaderUpdateNeededEventArgs e)
Parameters
HeaderUpdateNeededEventArgs e

ResetDoubleClickSource()

Resets the source for double-click events in the header and footer user interface context.

Declaration
public void ResetDoubleClickSource()

SetDoubleClickSource(IUILayerContainer, Boolean)

Sets the double-click source for the specified UI layer container.

Declaration
public void SetDoubleClickSource(IUILayerContainer lastDoubleClickSource, bool isHeaderClicked)
Parameters
IUILayerContainer lastDoubleClickSource

The UI layer container to which the double-click source is set.
System.Boolean isHeaderClicked

A boolean value indicating whether the header is clicked

SetLastClickSource(Boolean)

Sets the last click source for the HeaderFooterUIContext.

Declaration
public void SetLastClickSource(bool isHeaderFooterLastClickSource)
Parameters
System.Boolean isHeaderFooterLastClickSource

A boolean value indicating whether the last click source was initiated by the user.

SetLastRightClickSource(Boolean, Boolean)

Sets the last right-click source used in the Header/Footer UI context.

Declaration
public void SetLastRightClickSource(bool isHeaderFooterLastClickSource, bool isInHeader)
Parameters
System.Boolean isHeaderFooterLastClickSource

Indicates whether the source is the previous one.
System.Boolean isInHeader

Indicates whether the source is in header.

UpdateFooter(Section, HeaderFooterType, Footer)

Updates the footer of a specified section within the document.

Declaration
public void UpdateFooter(Section section, HeaderFooterType footerType, Footer footer)
Parameters
Section section

The section in which the footer is to be updated.
HeaderFooterType footerType

The type of footer to update (e.g., first page, even pages, or odd pages).
Footer footer

The new footer object that will replace the existing footer.

UpdateHeader(Section, HeaderFooterType, Header)

Updates the header of the specified section with the provided header content.

Declaration
public void UpdateHeader(Section section, HeaderFooterType headerType, Header header)
Parameters
Section section

The section to update the header for.
HeaderFooterType headerType

The type of header or footer to be updated.
Header header

The header content to set for the specified section.

Events

FooterUpdateNeeded

Declaration
public event EventHandler<FooterUpdateNeededEventArgs> FooterUpdateNeeded
Event Type
System.EventHandler<FooterUpdateNeededEventArgs>

HeaderFooterEditorPropertiesSynchronizationNeeded

Declaration
public event EventHandler HeaderFooterEditorPropertiesSynchronizationNeeded
Event Type
System.EventHandler

HeaderUpdateNeeded

Declaration
public event EventHandler<HeaderUpdateNeededEventArgs> HeaderUpdateNeeded
Event Type
System.EventHandler<HeaderUpdateNeededEventArgs>

Extension Methods