New to Telerik UI for WinFormsStart a free 30-day trial

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

Definition

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

Assembly:Telerik.WinControls.RadSpreadsheet.dll

Type Parameters:

T

The type of the T.

Syntax:

C#
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, ElementVisibility)UILayer.UIUpdateContextCacheUILayer.ContainerManagerUILayer.Name...

Constructors

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

C#
protected BoxBasedUILayer()

Methods

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

C#
public override void Clear()

Overrides: PooledUILayer.Clear()

Creates the UI element for box.

C#
protected abstract UIElement CreateUIElementForBox(ViewportPaneType viewportPaneType, T box, WorksheetUIUpdateContextBase updateContext)
Parameters:viewportPaneTypeViewportPaneType

Type of the viewport pane.

boxT

The desired box.

updateContextWorksheetUIUpdateContextBase

The update context.

Returns:

UIElement

The created UI element.

Gets the added UI elements.

C#
protected override IEnumerable<UIElement> GetAddedUIElements(ViewportPaneType viewportPaneType)
Parameters:viewportPaneTypeViewportPaneType

Type of the viewport pane.

Returns:

IEnumerable<UIElement>

The added UI elements.

Overrides: UILayer.GetAddedUIElements(ViewportPaneType)

Gets the associated box for UI element.

C#
protected T GetAssociatedBoxForUIElement(ViewportPaneType viewportPaneType, UIElement uiElement)
Parameters:viewportPaneTypeViewportPaneType

Type of the viewport pane.

uiElementUIElement

The UI element.

Returns:

T

The associated box.

Gets the associated UI element for box.

C#
protected UIElement GetAssociatedUIElementForBox(ViewportPaneType viewportPaneType, T box)
Parameters:viewportPaneTypeViewportPaneType

Type of the viewport pane.

boxT

The desired box.

Returns:

UIElement

The UI element.

Gets the visible boxes.

C#
protected abstract IEnumerable<T> GetVisibleBoxes(ViewportPaneType viewportPaneType, WorksheetUIUpdateContextBase updateContext)
Parameters:viewportPaneTypeViewportPaneType

Type of the viewport pane.

updateContextWorksheetUIUpdateContextBase

The update context.

Returns:

IEnumerable<T>

The visible boxes.

Determines whether the specified UI element box is valid.

C#
protected abstract bool IsUIElementValidOverride(T box, WorksheetUIUpdateContextBase updateContext)
Parameters:boxT

The box of the UI element.

updateContextWorksheetUIUpdateContextBase

The update context.

Returns:

bool

True if valid.

Sets the UI element properties for box.

C#
protected abstract void SetUIElementPropertiesForBox(UIElement uiElement, T box, WorksheetUIUpdateContextBase updateContext)
Parameters:uiElementUIElement

The UI element.

boxT

The box of the UI element.

updateContextWorksheetUIUpdateContextBase

The update context.

Translates and scales the UI elements of the layer.

C#
protected override void TranslateAndScale(UIUpdateContext updateContext)
Parameters:updateContextUIUpdateContext

The update context.

Overrides: UILayer.TranslateAndScale(UIUpdateContext)

Updates the UI.

C#
public override void UpdateUIOverride(WorksheetUIUpdateContextBase updateContext)
Parameters:updateContextWorksheetUIUpdateContextBase

The update context.

Overrides: WorksheetUILayerBase.UpdateUIOverride(WorksheetUIUpdateContextBase)