Class UILayer

Provides the base class from which the classes that represent UI layers are derived.

Inheritance
System.Object
UILayer
PooledUILayer
Namespace: Telerik.Windows.Controls.Spreadsheet.Layers
Assembly: Telerik.Windows.Controls.Spreadsheet.dll

Syntax

public abstract class UILayer : Object, INamedObject

Constructors

UILayer()

Initializes a new instance of the UILayer class.

Declaration
protected UILayer()

Properties

ContainerManager

Gets the container manager.

Declaration
public UILayerContainerManager ContainerManager { get; }
Property Value
UILayerContainerManager

The container manager.

Name

Gets the name of the layer.

Declaration
public abstract string Name { get; }
Property Value
System.String

The name of the layer.

Owner

Gets the owner.

Declaration
protected IUILayerOwner Owner { get; }
Property Value
IUILayerOwner

The owner.

UIUpdateContextCache

Gets the UI update context cache.

Declaration
protected UIUpdateContext UIUpdateContextCache { get; }
Property Value
UIUpdateContext

The UI update context cache.

Methods

Clear()

Clears this instance.

Declaration
public virtual void Clear()

GetAddedUIElements(ViewportPaneType)

Gets the added UI elements.

Declaration
protected virtual IEnumerable<UIElement> GetAddedUIElements(ViewportPaneType viewportPaneType)
Parameters
Telerik.Windows.Documents.Spreadsheet.Layout.ViewportPaneType viewportPaneType

Type of the viewport pane.
Returns
System.Collections.Generic.IEnumerable<System.Windows.UIElement>

The added UI elements.

GetElementVisibility(UIElement)

Gets the element visibility.

Declaration
protected virtual Visibility GetElementVisibility(UIElement element)
Parameters
System.Windows.UIElement element

The element.
Returns
System.Windows.Visibility

The visibility.

IsElementVisible(UIElement)

Determines whether the specified element is visible.

Declaration
protected bool IsElementVisible(UIElement element)
Parameters
System.Windows.UIElement element

The element.
Returns
System.Boolean

True if is visible.

OnOwnerChanged(IUILayerOwner, IUILayerOwner)

Called when owner is changed.

Declaration
protected virtual void OnOwnerChanged(IUILayerOwner oldOwner, IUILayerOwner newOwner)
Parameters
IUILayerOwner oldOwner

The old owner.
IUILayerOwner newOwner

The new owner.

OnUIUpdated()

Called when UI is updated.

Declaration
protected virtual void OnUIUpdated()

SetElementVisibility(UIElement, Visibility)

Sets the element visibility.

Declaration
protected virtual void SetElementVisibility(UIElement element, Visibility visibility)
Parameters
System.Windows.UIElement element

The element.
System.Windows.Visibility visibility

The visibility.

Translate(Point, ViewportPaneType, UIUpdateContext)

Translates the specified point.

Declaration
protected Point Translate(Point point, ViewportPaneType viewportPaneType, UIUpdateContext updateContext)
Parameters
System.Windows.Point point

The point.
Telerik.Windows.Documents.Spreadsheet.Layout.ViewportPaneType viewportPaneType

Type of the viewport pane.
UIUpdateContext updateContext

The update context.
Returns
System.Windows.Point

The translated point.

Translate(Rect, ViewportPaneType, UIUpdateContext)

Translates the specified rectangle.

Declaration
protected Rect Translate(Rect rect, ViewportPaneType viewportPaneType, UIUpdateContext updateContext)
Parameters
System.Windows.Rect rect

The rectangle.
Telerik.Windows.Documents.Spreadsheet.Layout.ViewportPaneType viewportPaneType

Type of the viewport pane.
UIUpdateContext updateContext

The update context.
Returns
System.Windows.Rect

The translated rectangle.

TranslateAndScale(UIUpdateContext)

Translates and scales the UI elements of the layer.

Declaration
protected abstract void TranslateAndScale(UIUpdateContext updateContext)
Parameters
UIUpdateContext updateContext

The update context.

UpdateUI()

Updates the UI.

Declaration
public void UpdateUI()

UpdateUI(UIUpdateContext)

Updates the UI.

Declaration
public void UpdateUI(UIUpdateContext updateContext)
Parameters
UIUpdateContext updateContext

The update context.

UpdateUIOverride(UIUpdateContext)

Updates the UI.

Declaration
protected virtual void UpdateUIOverride(UIUpdateContext updateContext)
Parameters
UIUpdateContext updateContext

The update context.

Extension Methods