Class
HeaderFooterUIContext

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:

cs-api-definition

public class HeaderFooterUIContext

Inheritance: objectHeaderFooterUIContext

Constructors

HeaderFooterUIContext()

Declaration

cs-api-definition

public HeaderFooterUIContext()

Properties

ForceFooterFocus

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

Declaration

cs-api-definition

public bool ForceFooterFocus { get; }

Property Value

bool

ForceHeaderFocus

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

Declaration

cs-api-definition

public bool ForceHeaderFocus { get; }

Property Value

bool

IsFooterLastRightClickSource

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

Declaration

cs-api-definition

public bool IsFooterLastRightClickSource { get; }

Property Value

bool

IsHeaderClicked

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

Declaration

cs-api-definition

public bool IsHeaderClicked { get; }

Property Value

bool

IsHeaderFocused

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

Declaration

cs-api-definition

public bool IsHeaderFocused { get; }

Property Value

bool

IsHeaderFooterLastClickSource

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

Declaration

cs-api-definition

public bool IsHeaderFooterLastClickSource { get; }

Property Value

bool

IsHeaderLastRightClickSource

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

Declaration

cs-api-definition

public bool IsHeaderLastRightClickSource { get; }

Property Value

bool

LastChangeSource

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

Declaration

cs-api-definition

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

cs-api-definition

public IUILayerContainer LastDoubleClickSource { get; }

Property Value

IUILayerContainer

Methods

OnFooterUpdateNeeded(FooterUpdateNeededEventArgs)

Declaration

cs-api-definition

protected virtual void OnFooterUpdateNeeded(FooterUpdateNeededEventArgs e)

Parameters

FooterUpdateNeededEventArgs

OnHeaderFooterEditorPropertiesSynchronizationNeeded()

Declaration

cs-api-definition

protected virtual void OnHeaderFooterEditorPropertiesSynchronizationNeeded()

OnHeaderUpdateNeeded(HeaderUpdateNeededEventArgs)

Declaration

cs-api-definition

protected virtual void OnHeaderUpdateNeeded(HeaderUpdateNeededEventArgs e)

Parameters

HeaderUpdateNeededEventArgs

ResetDoubleClickSource()

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

Declaration

cs-api-definition

public void ResetDoubleClickSource()

SetDoubleClickSource(IUILayerContainer, bool)

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

Declaration

cs-api-definition

public void SetDoubleClickSource(IUILayerContainer lastDoubleClickSource, bool isHeaderClicked)

Parameters

lastDoubleClickSource

IUILayerContainer

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

isHeaderClicked

bool

A boolean value indicating whether the header is clicked

SetLastClickSource(bool)

Sets the last click source for the HeaderFooterUIContext.

Declaration

cs-api-definition

public void SetLastClickSource(bool isHeaderFooterLastClickSource)

Parameters

isHeaderFooterLastClickSource

bool

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

SetLastRightClickSource(bool, bool)

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

Declaration

cs-api-definition

public void SetLastRightClickSource(bool isHeaderFooterLastClickSource, bool isInHeader)

Parameters

isHeaderFooterLastClickSource

bool

Indicates whether the source is the previous one.

isInHeader

bool

Indicates whether the source is in header.

UpdateFooter(Section, HeaderFooterType, Footer)

Updates the footer of a specified section within the document.

Declaration

cs-api-definition

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

Parameters

section

Section

The section in which the footer is to be updated.

footerType

HeaderFooterType

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

cs-api-definition

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

Parameters

section

Section

The section to update the header for.

headerType

HeaderFooterType

The type of header or footer to be updated.

header

Header

The header content to set for the specified section.

Events

FooterUpdateNeeded

Declaration

cs-api-definition

public event EventHandler<FooterUpdateNeededEventArgs> FooterUpdateNeeded

Event Value

EventHandler<FooterUpdateNeededEventArgs>

HeaderFooterEditorPropertiesSynchronizationNeeded

Declaration

cs-api-definition

public event EventHandler HeaderFooterEditorPropertiesSynchronizationNeeded

Event Value

EventHandler

HeaderUpdateNeeded

Declaration

cs-api-definition

public event EventHandler<HeaderUpdateNeededEventArgs> HeaderUpdateNeeded

Event Value

EventHandler<HeaderUpdateNeededEventArgs>

ClassHeaderFooterUIContext

Class
HeaderFooterUIContext