Class
UILayer

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

Definition

Namespace:Telerik.Windows.Controls.Spreadsheet.Layers

Assembly:Telerik.Windows.Controls.Spreadsheet.dll

Syntax:

cs-api-definition
public abstract class UILayer : INamedObject

Inheritance: objectUILayer

Derived Classes: PooledUILayer

Implements: INamedObject

Constructors

UILayer()

Initializes a new instance of the UILayer class.

Declaration

cs-api-definition
protected UILayer()

Properties

ContainerManager

Gets the container manager.

Declaration

cs-api-definition
public UILayerContainerManager ContainerManager { get; }

Property Value

UILayerContainerManager

The container manager.

Name

Gets the name of the layer.

Declaration

cs-api-definition
public abstract string Name { get; }

Property Value

string

The name of the layer.

Owner

Gets the owner.

Declaration

cs-api-definition
protected IUILayerOwner Owner { get; }

Property Value

IUILayerOwner

The owner.

UIUpdateContextCache

Gets the UI update context cache.

Declaration

cs-api-definition
protected UIUpdateContext UIUpdateContextCache { get; }

Property Value

UIUpdateContext

The UI update context cache.

Methods

Clear()

Clears this instance.

Declaration

cs-api-definition
public virtual void Clear()

GetAddedUIElements(ViewportPaneType)

Gets the added UI elements.

Declaration

cs-api-definition
protected virtual IEnumerable<UIElement> GetAddedUIElements(ViewportPaneType viewportPaneType)

Parameters

viewportPaneType

ViewportPaneType

Type of the viewport pane.

Returns

IEnumerable<UIElement>

The added UI elements.

GetElementVisibility(UIElement)

Gets the element visibility.

Declaration

cs-api-definition
protected virtual Visibility GetElementVisibility(UIElement element)

Parameters

element

UIElement

The element.

Returns

Visibility

The visibility.

IsElementVisible(UIElement)

Determines whether the specified element is visible.

Declaration

cs-api-definition
protected bool IsElementVisible(UIElement element)

Parameters

element

UIElement

The element.

Returns

bool

True if is visible.

OnOwnerChanged(IUILayerOwner, IUILayerOwner)

Called when owner is changed.

Declaration

cs-api-definition
protected virtual void OnOwnerChanged(IUILayerOwner oldOwner, IUILayerOwner newOwner)

Parameters

oldOwner

IUILayerOwner

The old owner.

newOwner

IUILayerOwner

The new owner.

OnUIUpdated()

Called when UI is updated.

Declaration

cs-api-definition
protected virtual void OnUIUpdated()

SetElementVisibility(UIElement, Visibility)

Sets the element visibility.

Declaration

cs-api-definition
protected virtual void SetElementVisibility(UIElement element, Visibility visibility)

Parameters

element

UIElement

The element.

visibility

Visibility

The visibility.

Translate(Point, ViewportPaneType, UIUpdateContext)

Translates the specified point.

Declaration

cs-api-definition
protected Point Translate(Point point, ViewportPaneType viewportPaneType, UIUpdateContext updateContext)

Parameters

point

Point

The point.

viewportPaneType

ViewportPaneType

Type of the viewport pane.

updateContext

UIUpdateContext

The update context.

Returns

Point

The translated point.

Translate(Rect, ViewportPaneType, UIUpdateContext)

Translates the specified rectangle.

Declaration

cs-api-definition
protected Rect Translate(Rect rect, ViewportPaneType viewportPaneType, UIUpdateContext updateContext)

Parameters

rect

Rect

The rectangle.

viewportPaneType

ViewportPaneType

Type of the viewport pane.

updateContext

UIUpdateContext

The update context.

Returns

Rect

The translated rectangle.

TranslateAndScale(UIUpdateContext)

Translates and scales the UI elements of the layer.

Declaration

cs-api-definition
protected abstract void TranslateAndScale(UIUpdateContext updateContext)

Parameters

updateContext

UIUpdateContext

The update context.

UpdateUI()

Updates the UI.

Declaration

cs-api-definition
public void UpdateUI()

UpdateUI(UIUpdateContext)

Updates the UI.

Declaration

cs-api-definition
public void UpdateUI(UIUpdateContext updateContext)

Parameters

updateContext

UIUpdateContext

The update context.

UpdateUIOverride(UIUpdateContext)

Updates the UI.

Declaration

cs-api-definition
protected virtual void UpdateUIOverride(UIUpdateContext updateContext)

Parameters

updateContext

UIUpdateContext

The update context.