skip navigation
  • Product Bundles

    DevCraft

    All Telerik .NET tools and Kendo UI JavaScript components in one package. Now enhanced with:

    • AI Coding Assistants
    • Embedded Reporting
    • Document Processing Libraries
    • SSO Account Sign-in

    Web

    Kendo UI UI for Angular UI for Vue UI for jQuery KendoReact UI for Blazor UI for ASP.NET Core UI for ASP.NET MVC UI for ASP.NET AJAX

    Mobile

    UI for .NET MAUI

    Document Management

    Telerik Document Processing

    Desktop

    UI for .NET MAUI UI for WinUI UI for WinForms UI for WPF

    Reporting

    Telerik Reporting Telerik Report Server

    Testing & Mocking

    Test Studio Telerik JustMock

    CMS

    Sitefinity

    AI Productivity Tools

    AI Coding Assistants

    UI/UX Tools

    ThemeBuilder Design System Kit Templates and Building Blocks

    Debugging

    Fiddler Fiddler Everywhere Fiddler Classic Fiddler Everywhere Reporter FiddlerCore

    Free Tools

    KendoReact Free VB.NET to C# Converter Testing Framework
    View all products
  • Overview
  • Demos
    • What's New
    • Roadmap
    • Release History
  • Support and Learning

    • Support and Learning Hub
    • First Steps
    • Docs
    • Demos
    • Virtual Classroom
    • Forums
    • Videos
    • Blogs
    • Accessibility
    • Submit a Ticket

    Productivity and Design Tools

    • Visual Studio Extensions
    • Visual Studio Templates
    • Embedded Reporting
  • Pricing
  • Shopping cart
    • Account Overview
    • Your Licenses
    • Downloads
    • Support Center
    • Forum Profile
    • Payment Methods
    • Edit Profile
    • Log out
  • Login
  • Contact Us
  • Try now

Class BoxBasedUILayer<T>

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

Inheritance
System.Object
UILayer
PooledUILayer
WorksheetUILayerBase
BoxBasedUILayer<T>
CellBasedUILayer
ColumnBasedUILayer
RowBasedUILayer
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.UpdateOnSelectionChanged
WorksheetUILayerBase.Owner
WorksheetUILayerBase.Worksheet
PooledUILayer.OnUIUpdated()
PooledUILayer.ResetPooledElementProperties(Object)
PooledUILayer.CanRecycle(Object)
PooledUILayer.AddElementToPool(Object)
PooledUILayer.GetElementFromPool<T>(ViewportPaneType)
PooledUILayer.GetElementFromPool<T>()
PooledUILayer.ReuseUIElementsWithoutRemovingFromVisualTree
UILayer.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.UIUpdateContextCache
UILayer.ContainerManager
UILayer.Name
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinForms.Controls.Spreadsheet.Worksheets.Layers
Assembly: Telerik.WinControls.RadSpreadsheet.dll

Syntax

public abstract class BoxBasedUILayer<T> : WorksheetUILayerBase, INamedObject where T : LayoutBox
Type Parameters
T

The type of the T.

Constructors

BoxBasedUILayer()

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

Declaration
protected BoxBasedUILayer()

Methods

Clear()

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

Declaration
public override void Clear()
Overrides
PooledUILayer.Clear()

CreateUIElementForBox(ViewportPaneType, T, WorksheetUIUpdateContextBase)

Creates the UI element for box.

Declaration
protected abstract UIElement CreateUIElementForBox(ViewportPaneType viewportPaneType, T box, WorksheetUIUpdateContextBase updateContext)
Parameters
ViewportPaneType viewportPaneType

Type of the viewport pane.

T box

The desired box.

WorksheetUIUpdateContextBase updateContext

The update context.

Returns
UIElement

The created UI element.

GetAddedUIElements(ViewportPaneType)

Gets the added UI elements.

Declaration
protected override IEnumerable<UIElement> GetAddedUIElements(ViewportPaneType viewportPaneType)
Parameters
ViewportPaneType viewportPaneType

Type of the viewport pane.

Returns
System.Collections.Generic.IEnumerable<UIElement>

The added UI elements.

Overrides
UILayer.GetAddedUIElements(ViewportPaneType)

GetAssociatedBoxForUIElement(ViewportPaneType, UIElement)

Gets the associated box for UI element.

Declaration
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
protected UIElement GetAssociatedUIElementForBox(ViewportPaneType viewportPaneType, T box)
Parameters
ViewportPaneType viewportPaneType

Type of the viewport pane.

T box

The desired box.

Returns
UIElement

The UI element.

GetVisibleBoxes(ViewportPaneType, WorksheetUIUpdateContextBase)

Gets the visible boxes.

Declaration
protected abstract IEnumerable<T> GetVisibleBoxes(ViewportPaneType viewportPaneType, WorksheetUIUpdateContextBase updateContext)
Parameters
ViewportPaneType viewportPaneType

Type of the viewport pane.

WorksheetUIUpdateContextBase updateContext

The update context.

Returns
System.Collections.Generic.IEnumerable<T>

The visible boxes.

IsUIElementValidOverride(T, WorksheetUIUpdateContextBase)

Determines whether the specified UI element box is valid.

Declaration
protected abstract bool IsUIElementValidOverride(T box, WorksheetUIUpdateContextBase updateContext)
Parameters
T box

The box of the UI element.

WorksheetUIUpdateContextBase updateContext

The update context.

Returns
System.Boolean

True if valid.

SetUIElementPropertiesForBox(UIElement, T, WorksheetUIUpdateContextBase)

Sets the UI element properties for box.

Declaration
protected abstract void SetUIElementPropertiesForBox(UIElement uiElement, T box, WorksheetUIUpdateContextBase updateContext)
Parameters
UIElement uiElement

The UI element.

T box

The box of the UI element.

WorksheetUIUpdateContextBase updateContext

The update context.

TranslateAndScale(UIUpdateContext)

Translates and scales the UI elements of the layer.

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

The update context.

Overrides
UILayer.TranslateAndScale(UIUpdateContext)

UpdateUIOverride(WorksheetUIUpdateContextBase)

Updates the UI.

Declaration
public override void UpdateUIOverride(WorksheetUIUpdateContextBase updateContext)
Parameters
WorksheetUIUpdateContextBase updateContext

The update context.

Overrides
WorksheetUILayerBase.UpdateUIOverride(WorksheetUIUpdateContextBase)

Extension Methods

SvgExtentions.Traverse<T>(T, Func<T, IEnumerable<T>>)
SvgExtentions.TraverseDepthFirst<T>(T, Func<T, IEnumerable<T>>)
Getting Started
  • Install Now
  • Demos
  • Step-by-Step Tutorial
  • Sample Applications
  • SDK Samples
  • Visual Studio Extensions
Support Resources
  • Code Library
  • Knowledge Base
  • Videos
Community
  • Forums
  • Blogs
  • Feedback Portal
  • Document Processing Feedback Portal

Copyright © 2018 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.

Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. See Trademarks for appropriate markings.