Class
BoxBasedUILayer<T>

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

Definition

Namespace:Telerik.Windows.Controls.Spreadsheet.Worksheets.Layers

Assembly:Telerik.Windows.Controls.Spreadsheet.dll

Type Parameters:

T

The type of the T.

Syntax:

cs-api-definition
public abstract class BoxBasedUILayer<T> : WorksheetUILayerBase, INamedObject where T : LayoutBox

Inheritance: objectUILayerPooledUILayerWorksheetUILayerBaseBoxBasedUILayer<T>

Derived Classes: CellBasedUILayerColumnBasedUILayerRowBasedUILayer

Implements: INamedObject

Inherited Members WorksheetUILayerBase.UpdateUIOverride(UIUpdateContext)WorksheetUILayerBase.OnOwnerChanged(IUILayerOwner, IUILayerOwner)WorksheetUILayerBase.Initialize(IRadWorksheetEditorPresenter)WorksheetUILayerBase.OnSelectionChanged()WorksheetUILayerBase.OnOwnerChanged(RadWorksheetEditor, RadWorksheetEditor)WorksheetUILayerBase.DetachFromEditorDependentEvents(RadSheetEditorBase)WorksheetUILayerBase.AttachToEditorDependentEvents(RadSheetEditorBase)WorksheetUILayerBase.TranslateAndScale(Point, ViewportPaneType, WorksheetUIUpdateContextBase)WorksheetUILayerBase.Scale(Size, WorksheetUIUpdateContextBase)WorksheetUILayerBase.Scale(Point, WorksheetUIUpdateContextBase)WorksheetUILayerBase.Scale(double, WorksheetUIUpdateContextBase)WorksheetUILayerBase.UpdateOnSelectionChangedWorksheetUILayerBase.OwnerWorksheetUILayerBase.WorksheetPooledUILayer.OnUIUpdated()PooledUILayer.ResetPooledElementProperties(object)PooledUILayer.CanRecycle(object)PooledUILayer.AddElementToPool(object)PooledUILayer.GetElementFromPool<T>(ViewportPaneType)PooledUILayer.GetElementFromPool<T>()PooledUILayer.ReuseUIElementsWithoutRemovingFromVisualTreeUILayer.UpdateUI()UILayer.UpdateUI(UIUpdateContext)UILayer.Translate(Point, ViewportPaneType, UIUpdateContext)UILayer.Translate(Rect, ViewportPaneType, UIUpdateContext)UILayer.IsElementVisible(UIElement)UILayer.GetElementVisibility(UIElement)UILayer.SetElementVisibility(UIElement, Visibility)UILayer.UIUpdateContextCacheUILayer.ContainerManagerUILayer.Name

Constructors

BoxBasedUILayer()

Initializes a new instance of the BoxBasedUILayer<T> class.

Declaration

cs-api-definition
protected BoxBasedUILayer()

Methods

Clear()

Clears this instance by removing all UI elements and returning them in the pool.

Declaration

cs-api-definition
public override void Clear()

Overrides PooledUILayer.Clear()

CreateUIElementForBox(ViewportPaneType, T, WorksheetUIUpdateContextBase)

Creates the UI element for box.

Declaration

cs-api-definition
protected abstract UIElement CreateUIElementForBox(ViewportPaneType viewportPaneType, T box, WorksheetUIUpdateContextBase updateContext)

Parameters

viewportPaneType

ViewportPaneType

Type of the viewport pane.

box

T

The desired box.

updateContext

WorksheetUIUpdateContextBase

The update context.

Returns

UIElement

The created UI element.

GetAddedUIElements(ViewportPaneType)

Gets the added UI elements.

Declaration

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

Parameters

viewportPaneType

ViewportPaneType

Type of the viewport pane.

Returns

IEnumerable<UIElement>

The added UI elements.

Overrides UILayer.GetAddedUIElements(ViewportPaneType)

GetAssociatedBoxForUIElement(ViewportPaneType, UIElement)

Gets the associated box for UI element.

Declaration

cs-api-definition
protected T GetAssociatedBoxForUIElement(ViewportPaneType viewportPaneType, UIElement uiElement)

Parameters

viewportPaneType

ViewportPaneType

Type of the viewport pane.

uiElement

UIElement

The UI element.

Returns

T

The associated box.

GetAssociatedUIElementForBox(ViewportPaneType, T)

Gets the associated UI element for box.

Declaration

cs-api-definition
protected UIElement GetAssociatedUIElementForBox(ViewportPaneType viewportPaneType, T box)

Parameters

viewportPaneType

ViewportPaneType

Type of the viewport pane.

box

T

The desired box.

Returns

UIElement

The UI element.

GetVisibleBoxes(ViewportPaneType, WorksheetUIUpdateContextBase)

Gets the visible boxes.

Declaration

cs-api-definition
protected abstract IEnumerable<T> GetVisibleBoxes(ViewportPaneType viewportPaneType, WorksheetUIUpdateContextBase updateContext)

Parameters

viewportPaneType

ViewportPaneType

Type of the viewport pane.

updateContext

WorksheetUIUpdateContextBase

The update context.

Returns

IEnumerable<T>

The visible boxes.

IsUIElementValidOverride(T, WorksheetUIUpdateContextBase)

Determines whether the specified UI element box is valid.

Declaration

cs-api-definition
protected abstract bool IsUIElementValidOverride(T box, WorksheetUIUpdateContextBase updateContext)

Parameters

box

T

The box of the UI element.

updateContext

WorksheetUIUpdateContextBase

The update context.

Returns

bool

True if valid.

SetUIElementPropertiesForBox(UIElement, T, WorksheetUIUpdateContextBase)

Sets the UI element properties for box.

Declaration

cs-api-definition
protected abstract void SetUIElementPropertiesForBox(UIElement uiElement, T box, WorksheetUIUpdateContextBase updateContext)

Parameters

uiElement

UIElement

The UI element.

box

T

The box of the UI element.

updateContext

WorksheetUIUpdateContextBase

The update context.

TranslateAndScale(UIUpdateContext)

Translates and scales the UI elements of the layer.

Declaration

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

Parameters

updateContext

UIUpdateContext

The update context.

Overrides UILayer.TranslateAndScale(UIUpdateContext)

UpdateUIOverride(WorksheetUIUpdateContextBase)

Updates the UI.

Declaration

cs-api-definition
public override void UpdateUIOverride(WorksheetUIUpdateContextBase updateContext)

Parameters

updateContext

WorksheetUIUpdateContextBase

The update context.

Overrides WorksheetUILayerBase.UpdateUIOverride(WorksheetUIUpdateContextBase)