New to Telerik UI for WinForms? Start a free 30-day trial

UILayer

Class

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

Definition

Namespace:Telerik.WinForms.Controls.Spreadsheet.Layers

Assembly:Telerik.WinControls.RadSpreadsheet.dll

Syntax:

public abstract class UILayer : INamedObject

Inheritance: objectUILayer

Derived Classes: PooledUILayer

Implements: INamedObject

Constructors

UILayer()

Initializes a new instance of the UILayer class.

protected UILayer()

Properties

ContainerManager

UILayerContainerManager

Gets the container manager.

public UILayerContainerManager ContainerManager { get; }

Property Value:

The container manager.

Name

string

Gets the name of the layer.

public abstract string Name { get; }

Property Value:

The name of the layer.

Implements: INamedObject.Name

Owner

IUILayerOwner

Gets the owner.

protected IUILayerOwner Owner { get; }

Property Value:

The owner.

UIUpdateContextCache

UIUpdateContext

Gets the UI update context cache.

protected UIUpdateContext UIUpdateContextCache { get; }

Property Value:

The UI update context cache.

Methods

Clear()

Clears this instance.

public virtual void Clear()

GetAddedUIElements(ViewportPaneType)

Gets the added UI elements.

protected virtual IEnumerable<UIElement> GetAddedUIElements(ViewportPaneType viewportPaneType)

Parameters:viewportPaneTypeViewportPaneType

Type of the viewport pane.

Returns:

IEnumerable<UIElement>

The added UI elements.

GetElementVisibility(UIElement)

Gets the element visibility.

protected virtual ElementVisibility GetElementVisibility(UIElement element)

Parameters:elementUIElement

The element.

Returns:

ElementVisibility

The visibility.

IsElementVisible(UIElement)

Determines whether the specified element is visible.

protected bool IsElementVisible(UIElement element)

Parameters:elementUIElement

The element.

Returns:

bool

True if is visible.

OnOwnerChanged(IUILayerOwner, IUILayerOwner)

Called when owner is changed.

protected virtual void OnOwnerChanged(IUILayerOwner oldOwner, IUILayerOwner newOwner)

Parameters:oldOwnerIUILayerOwner

The old owner.

newOwnerIUILayerOwner

The new owner.

OnUIUpdated()

Called when UI is updated.

protected virtual void OnUIUpdated()

SetElementVisibility(UIElement, ElementVisibility)

Sets the element visibility.

protected virtual void SetElementVisibility(UIElement element, ElementVisibility visibility)

Parameters:elementUIElement

The element.

visibilityElementVisibility

The visibility.

Translate(Point, ViewportPaneType, UIUpdateContext)

Translates the specified point.

protected Point Translate(Point point, ViewportPaneType viewportPaneType, UIUpdateContext updateContext)

Parameters:pointPoint

The point.

viewportPaneTypeViewportPaneType

Type of the viewport pane.

updateContextUIUpdateContext

The update context.

Returns:

Point

The translated point.

Translate(Rect, ViewportPaneType, UIUpdateContext)

Translates the specified rectangle.

protected Rect Translate(Rect rect, ViewportPaneType viewportPaneType, UIUpdateContext updateContext)

Parameters:rectRect

The rectangle.

viewportPaneTypeViewportPaneType

Type of the viewport pane.

updateContextUIUpdateContext

The update context.

Returns:

Rect

The translated rectangle.

TranslateAndScale(UIUpdateContext)

Translates and scales the UI elements of the layer.

protected abstract void TranslateAndScale(UIUpdateContext updateContext)

Parameters:updateContextUIUpdateContext

The update context.

UpdateUI()

Updates the UI.

public void UpdateUI()

UpdateUI(UIUpdateContext)

Updates the UI.

public void UpdateUI(UIUpdateContext updateContext)

Parameters:updateContextUIUpdateContext

The update context.

UpdateUIOverride(UIUpdateContext)

Updates the UI.

protected virtual void UpdateUIOverride(UIUpdateContext updateContext)

Parameters:updateContextUIUpdateContext

The update context.