Class
WatermarkUIProvider

Represents a UI provider for managing watermarks in Telerik documents.

Definition

Namespace:Telerik.Windows.Documents.UI.UIProviders

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:

cs-api-definition
public class WatermarkUIProvider : IUIProvider

Inheritance: objectWatermarkUIProvider

Implements: IUIProvider

Constructors

WatermarkUIProvider(SectionLayoutBox)

Declaration

cs-api-definition
public WatermarkUIProvider(SectionLayoutBox sectionBox)

Parameters

sectionBox

SectionLayoutBox

Properties

BoundingRectangle

Gets the bounding rectangle for the watermark UI provider, which defines the area in which the watermark will be displayed.

Declaration

cs-api-definition
public RectangleF BoundingRectangle { get; }

Property Value

RectangleF

Implements IUIProvider.BoundingRectangle

ClippingGeometry

Gets the clipping geometry used for the watermark.

Declaration

cs-api-definition
public Geometry ClippingGeometry { get; }

Property Value

Geometry

ContainingLayer

Gets the containing layer of the watermark UI provider.

Declaration

cs-api-definition
public IUILayer ContainingLayer { get; set; }

Property Value

IUILayer

Implements IUIProvider.ContainingLayer

CurrentHeader

Gets the current header for the watermark UI provider.

Declaration

cs-api-definition
public Header CurrentHeader { get; }

Property Value

Header

CurrentUpdateContext

Gets the current update context for the watermark UI provider.

Declaration

cs-api-definition
public UILayerUpdateContext CurrentUpdateContext { get; }

Property Value

UILayerUpdateContext

IsInvalidated

Gets a value indicating whether the watermark UI provider has been invalidated.

Declaration

cs-api-definition
public bool IsInvalidated { get; }

Property Value

bool

Implements IUIProvider.IsInvalidated

IsRemoved

Gets a value indicating whether the watermark has been removed.

Declaration

cs-api-definition
public bool IsRemoved { get; }

Property Value

bool

Implements IUIProvider.IsRemoved

SectionBox

Represents a section box in the Watermark UI provider, which is used to define the area for displaying a watermark in a document section.

Declaration

cs-api-definition
public SectionLayoutBox SectionBox { get; }

Property Value

SectionLayoutBox

Methods

Arrange(UILayerUpdateContext)

Arranges the watermark UI based on the provided update context.

Declaration

cs-api-definition
public void Arrange(UILayerUpdateContext uILayerUpdateContext)

Parameters

uILayerUpdateContext

UILayerUpdateContext

The context that provides information for updating the UI layer.

Implements IUIProvider.Arrange(UILayerUpdateContext)

GetUIElements(UILayerUpdateContext)

Retrieves the UI elements associated with the watermark provider.

Declaration

cs-api-definition
public IEnumerable<UIElement> GetUIElements(UILayerUpdateContext context)

Parameters

context

UILayerUpdateContext

The context used for updating the UI layer.

Returns

IEnumerable<UIElement>

A collection of UI elements related to the watermark.

Implements IUIProvider.GetUIElements(UILayerUpdateContext)

ReleaseElements()

Releases the elements associated with the Watermark UI provider.

Declaration

cs-api-definition
public void ReleaseElements()

Implements IUIProvider.ReleaseElements()

UpdateUI(UILayerUpdateContext)

Updates the user interface for the watermark provider based on the given update context.

Declaration

cs-api-definition
public void UpdateUI(UILayerUpdateContext uILayerUpdateContext)

Parameters

uILayerUpdateContext

UILayerUpdateContext

The context that contains information about the UI layer update.

Implements IUIProvider.UpdateUI(UILayerUpdateContext)