BackgroundUIProvider
Renders the background fill for a paragraph, table cell, or table layout box.
Definition
Namespace:Telerik.WinForms.Documents.UI.UIProviders
Assembly:Telerik.WinControls.RichTextEditor.dll
Syntax:
public class BackgroundUIProvider : IUIProvider
Inheritance: objectBackgroundUIProvider
Implements:
Constructors
Initializes a provider for a paragraph, table-cell, or table layout box.
public BackgroundUIProvider(LayoutBox layoutBox)
The layout box whose document element provides the fill color.
Properties
Gets the pooled rectangle used to render the background.
public Rectangle BackgroundUI { get; }
Gets the current layout bounds of the background element.
public RectangleF BoundingRectangle { get; }
Implements:
Gets or sets the layer that hosts the background rectangle.
public IUILayer ContainingLayer { get; set; }
Implements:
Gets the most recently supplied layer-update context.
public UILayerUpdateContext CurrentUpdateContext { get; }
Gets whether the background rectangle must be recreated after a clone is materialized or its fill changes.
public bool IsInvalidated { get; protected set; }
Implements:
Gets whether the associated layout box has been removed.
public bool IsRemoved { get; }
Implements:
Methods
Sizes and positions the background rectangle to match the layout box in the current view.
public void Arrange(UILayerUpdateContext uILayerUpdateContext)
The current layer context.
Implements:
Lazily creates the background rectangle and subscribes to changes of the document element's background.
public IEnumerable<UIElement> GetUIElements(UILayerUpdateContext context)
The current layer context.
Returns:IEnumerable<UIElement>
The rectangle that renders the background.
Exceptions: NotImplementedExceptionThe layout box is associated with an unsupported document-element type.
Implements:
Detaches the background-change handler and returns the rectangle to the object pool.
public void ReleaseElements()
Implements:
Does nothing; background-color changes invalidate the provider so the rectangle can be recreated with the new fill.
public virtual void UpdateUI(UILayerUpdateContext uILayerUpdateContext)
The current layer context.
Implements: