WatermarkUIProvider
Creates and positions the image or text watermark for a paged section.
Definition
Namespace:Telerik.WinForms.Documents.UI.UIProviders
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class WatermarkUIProvider : IUIProvider
Inheritance: objectWatermarkUIProvider
Implements:
Constructors
Initializes a provider for a section and subscribes to its current header's watermark changes.
public WatermarkUIProvider(SectionLayoutBox sectionBox)
The section whose watermark should be displayed.
Properties
Gets the section's layout bounds.
public RectangleF BoundingRectangle { get; }
Implements:
Gets the page-sized clip geometry applied by the watermark layer.
public Geometry ClippingGeometry { get; }
Gets or sets the layer that hosts the watermark visual.
public IUILayer ContainingLayer { get; set; }
Implements:
Gets the header whose watermark settings are observed by this provider.
public Header CurrentHeader { get; }
Gets the most recently supplied layer-update context.
public UILayerUpdateContext CurrentUpdateContext { get; }
Gets whether watermark settings changed or the section now uses a different header.
public bool IsInvalidated { get; }
Implements:
Gets whether the section layout box has been removed.
public bool IsRemoved { get; }
Implements:
Gets the section whose page is displayed by this provider.
public SectionLayoutBox SectionBox { get; }
Methods
Centers the configured watermark on the page and updates the page clipping geometry.
public void Arrange(UILayerUpdateContext uILayerUpdateContext)
The current layer context.
Implements:
Creates the configured image or text watermark, or returns no element when the section has no watermark.
public IEnumerable<UIElement> GetUIElements(UILayerUpdateContext context)
The current layer context.
Returns:IEnumerable<UIElement>
The watermark visual when one is configured.
Implements:
Detaches the header event handler, clears transient visual properties, and returns the visual to the object pool.
public void ReleaseElements()
Implements:
Does nothing; watermark-setting changes mark the provider invalidated so its visual can be recreated.
public void UpdateUI(UILayerUpdateContext uILayerUpdateContext)
The current layer context.
Implements: