menu

UWP

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SpreadsheetTextBoxCellRenderer - UWP API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SpreadsheetTextBoxCellRenderer

    Represents a class which holds the cell renderer that displays in a GridCell. Override the methods for initializing content of the cell and arranging the cell visuals.

    Inheritance
    System.Object
    SpreadsheetCellRendererBase
    SpreadsheetVirtualizingCellRendererBase<Windows.UI.Xaml.Controls.TextBlock, Windows.UI.Xaml.Controls.TextBox>
    SpreadsheetTextBoxCellRenderer
    Implements
    ISpreadsheetCellRenderer
    System.IDisposable
    Inherited Members
    SpreadsheetCellRendererBase.AllowEditInFormulaBar
    SpreadsheetCellRendererBase.Arrange(RowColumnIndex, UIElement, Rect)
    SpreadsheetCellRendererBase.BeginEdit(RowColumnIndex, GridCell, SpreadsheetColumn)
    SpreadsheetCellRendererBase.CharacterReceived(CharacterReceivedEventArgs)
    SpreadsheetCellRendererBase.ClearRecycleBin()
    SpreadsheetCellRendererBase.CurrentCellElement
    SpreadsheetCellRendererBase.CurrentCellIndex
    SpreadsheetCellRendererBase.CurrentCellRendererElement
    SpreadsheetCellRendererBase.CurrentCellValueChanged(String)
    SpreadsheetCellRendererBase.CurrentStyle
    SpreadsheetCellRendererBase.DisplayElementOptimization
    SpreadsheetCellRendererBase.Dispose()
    SpreadsheetCellRendererBase.EndEdit(RowColumnIndex, GridCell, SpreadsheetColumn)
    SpreadsheetCellRendererBase.GetFormattedText(IStyle)
    SpreadsheetCellRendererBase.Grid
    SpreadsheetCellRendererBase.HasCurrentCellState
    SpreadsheetCellRendererBase.IsEditable
    SpreadsheetCellRendererBase.IsFocused
    SpreadsheetCellRendererBase.IsFocusible
    SpreadsheetCellRendererBase.IsInEditing
    SpreadsheetCellRendererBase.ISpreadsheetCellRenderer.ShouldGridTryToHandleKeyDown(KeyRoutedEventArgs)
    SpreadsheetCellRendererBase.Measure(RowColumnIndex, UIElement, Size)
    SpreadsheetCellRendererBase.MoveCurrentCell
    SpreadsheetCellRendererBase.OnArrange(RowColumnIndex, UIElement, Rect)
    SpreadsheetCellRendererBase.OnCharacterReceived(CharacterReceivedEventArgs)
    SpreadsheetCellRendererBase.OnMeasure(RowColumnIndex, UIElement, Size)
    SpreadsheetCellRendererBase.OnPrepareUIElements(RowColumnIndex, GridCell, SpreadsheetColumn, Boolean)
    SpreadsheetCellRendererBase.OnUnloadUIElements(GridCell)
    SpreadsheetCellRendererBase.PrepareUIElements(RowColumnIndex, GridCell, SpreadsheetColumn, Boolean)
    SpreadsheetCellRendererBase.PreviewInputText
    SpreadsheetCellRendererBase.RaiseSaveChanges()
    SpreadsheetCellRendererBase.RefreshContent()
    SpreadsheetCellRendererBase.ResetCurrentCellState()
    SpreadsheetCellRendererBase.SetCurrentCellState(RowColumnIndex, UIElement, Boolean, Boolean)
    SpreadsheetCellRendererBase.SetFocus(Boolean)
    SpreadsheetCellRendererBase.SetFocus(UIElement, Boolean)
    SpreadsheetCellRendererBase.SupportDrawingOptimization
    SpreadsheetCellRendererBase.SupportRenderOptimization
    SpreadsheetCellRendererBase.UnloadUIElements(GridCell)
    SpreadsheetCellRendererBase.UpdateCellStyle(RowColumnIndex, GridCell, SpreadsheetColumn, Boolean)
    SpreadsheetCellRendererBase.UpdateCurrentCellState(UIElement, Boolean)
    SpreadsheetCellRendererBase.UseOnlyRendererElement
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.AllowRecycle
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.BeginEdit(RowColumnIndex, GridCell, SpreadsheetColumn)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.ClearRecycleBin()
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.DisplayRecycleBin
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.Dispose(Boolean)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.EditRecycleBin
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.EndEdit(RowColumnIndex, GridCell, SpreadsheetColumn)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.InitializeDisplayElement(RowColumnIndex, TextBlock, SpreadsheetColumn)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.InitializeEditElement(RowColumnIndex, TextBox, SpreadsheetColumn)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnArrange(RowColumnIndex, UIElement, Rect)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnCreateDisplayUIElement()
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnCreateEditUIElement()
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnCreateTemplateUIElement()
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnEditElementLoaded(Object, RoutedEventArgs)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnEditElementLostFocus(Object, RoutedEventArgs)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnEditingComplete(UIElement)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnEnteredEditMode(UIElement)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnInitializeDisplayElement(RowColumnIndex, TextBlock, SpreadsheetColumn)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnInitializeEditElement(RowColumnIndex, TextBox, SpreadsheetColumn)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnMeasure(RowColumnIndex, UIElement, Size)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnPrepareUIElements(RowColumnIndex, GridCell, SpreadsheetColumn, Boolean)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnUnloadUIElements(GridCell)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnUnwireDisplayUIElement(TextBlock)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnUnwireEditUIElement(TextBox)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnUnWireTemplateUIElement(ContentControl)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnUpdateCellStyle(RowColumnIndex, TextBlock, SpreadsheetColumn)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnUpdateEditCellStyle(RowColumnIndex, TextBox, SpreadsheetColumn)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnUpdateTemplateElement(ContentControl, IStyle)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnWireDisplayUIElement(TextBlock)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnWireEditUIElement(TextBox)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.OnWireTemplateUIElement(ContentControl)
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.TemplateRecycleBin
    SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>.UpdateCellStyle(RowColumnIndex, GridCell, SpreadsheetColumn, Boolean)
    Namespace: Syncfusion.UI.Xaml.Spreadsheet.CellRenderer
    Assembly: Syncfusion.SfSpreadsheet.UWP.dll
    Syntax
    public class SpreadsheetTextBoxCellRenderer : SpreadsheetVirtualizingCellRendererBase<TextBlock, TextBox>, ISpreadsheetCellRenderer, IDisposable

    Constructors

    SpreadsheetTextBoxCellRenderer()

    Initializes a new instance of the SpreadsheetTextBoxCellRenderer class.

    Declaration
    public SpreadsheetTextBoxCellRenderer()

    Methods

    Dispose(Boolean)

    Releases all resources used by the SpreadsheetTextBoxCellRenderer class.

    Declaration
    protected override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing
    Overrides
    Syncfusion.UI.Xaml.Spreadsheet.CellRenderer.SpreadsheetVirtualizingCellRendererBase<Windows.UI.Xaml.Controls.TextBlock, Windows.UI.Xaml.Controls.TextBox>.Dispose(System.Boolean)

    GetControlValue()

    Invoked to get the control value of the current cell .

    Declaration
    public override object GetControlValue()
    Returns
    Type Description
    System.Object

    Text

    Overrides
    SpreadsheetCellRendererBase.GetControlValue()

    OnEditElementLoaded(Object, RoutedEventArgs)

    Occurs when edit UIElement is loaded into cell.

    Declaration
    protected override void OnEditElementLoaded(object sender, RoutedEventArgs e)
    Parameters
    Type Name Description
    System.Object sender

    The source of the event.

    Windows.UI.Xaml.RoutedEventArgs e

    An System.Windows.RoutedEventArgs that contains the event data.

    Overrides
    Syncfusion.UI.Xaml.Spreadsheet.CellRenderer.SpreadsheetVirtualizingCellRendererBase<Windows.UI.Xaml.Controls.TextBlock, Windows.UI.Xaml.Controls.TextBox>.OnEditElementLoaded(System.Object, Windows.UI.Xaml.RoutedEventArgs)

    OnInitializeDisplayElement(RowColumnIndex, TextBlock, SpreadsheetColumn)

    Invoked when display element is initialized on the cell.

    Declaration
    protected override void OnInitializeDisplayElement(RowColumnIndex rowColumnIndex, TextBlock uiElement, SpreadsheetColumn column)
    Parameters
    Type Name Description
    RowColumnIndex rowColumnIndex

    Coordinates of a cell.

    Windows.UI.Xaml.Controls.TextBlock uiElement

    An instance of .

    SpreadsheetColumn column

    An instance of SpreadsheetColumn.

    Overrides
    Syncfusion.UI.Xaml.Spreadsheet.CellRenderer.SpreadsheetVirtualizingCellRendererBase<Windows.UI.Xaml.Controls.TextBlock, Windows.UI.Xaml.Controls.TextBox>.OnInitializeDisplayElement(Syncfusion.UI.Xaml.Grid.ScrollAxis.RowColumnIndex, Windows.UI.Xaml.Controls.TextBlock, Syncfusion.UI.Xaml.Spreadsheet.SpreadsheetColumn)

    OnInitializeEditElement(RowColumnIndex, TextBox, SpreadsheetColumn)

    Invoked when the edit element of textbox is initialized on the cell.

    Declaration
    protected override void OnInitializeEditElement(RowColumnIndex rowColumnIndex, TextBox uiElement, SpreadsheetColumn column)
    Parameters
    Type Name Description
    RowColumnIndex rowColumnIndex

    Coordinates of a cell.

    Windows.UI.Xaml.Controls.TextBox uiElement

    An instance of .

    SpreadsheetColumn column

    An instance of SpreadsheetColumn.

    Overrides
    Syncfusion.UI.Xaml.Spreadsheet.CellRenderer.SpreadsheetVirtualizingCellRendererBase<Windows.UI.Xaml.Controls.TextBlock, Windows.UI.Xaml.Controls.TextBox>.OnInitializeEditElement(Syncfusion.UI.Xaml.Grid.ScrollAxis.RowColumnIndex, Windows.UI.Xaml.Controls.TextBox, Syncfusion.UI.Xaml.Spreadsheet.SpreadsheetColumn)

    OnSaveChanges()

    Saves the modified text in the specified range.

    Declaration
    protected override void OnSaveChanges()
    Overrides
    SpreadsheetCellRendererBase.OnSaveChanges()

    OnUnwireEditUIElement(TextBox)

    Unwire or Unhook the events associated with edit UIElement.

    Declaration
    protected override void OnUnwireEditUIElement(TextBox uiElement)
    Parameters
    Type Name Description
    Windows.UI.Xaml.Controls.TextBox uiElement

    An instance of .

    Overrides
    Syncfusion.UI.Xaml.Spreadsheet.CellRenderer.SpreadsheetVirtualizingCellRendererBase<Windows.UI.Xaml.Controls.TextBlock, Windows.UI.Xaml.Controls.TextBox>.OnUnwireEditUIElement(Windows.UI.Xaml.Controls.TextBox)

    OnUpdateCellStyle(RowColumnIndex, TextBlock, SpreadsheetColumn)

    Update the cell style and content for the display element .

    Declaration
    protected override void OnUpdateCellStyle(RowColumnIndex cellRowColumnIndex, TextBlock uiElement, SpreadsheetColumn column)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    Coordinates of a cell.

    Windows.UI.Xaml.Controls.TextBlock uiElement

    An instance of .

    SpreadsheetColumn column

    An instance of SpreadsheetColumn.

    Overrides
    Syncfusion.UI.Xaml.Spreadsheet.CellRenderer.SpreadsheetVirtualizingCellRendererBase<Windows.UI.Xaml.Controls.TextBlock, Windows.UI.Xaml.Controls.TextBox>.OnUpdateCellStyle(Syncfusion.UI.Xaml.Grid.ScrollAxis.RowColumnIndex, Windows.UI.Xaml.Controls.TextBlock, Syncfusion.UI.Xaml.Spreadsheet.SpreadsheetColumn)

    OnUpdateEditCellStyle(RowColumnIndex, TextBox, SpreadsheetColumn)

    Update the cell style and content for the edit element .

    Declaration
    protected override void OnUpdateEditCellStyle(RowColumnIndex cellRowColumnIndex, TextBox uiElement, SpreadsheetColumn column)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    Coordinates of a cell.

    Windows.UI.Xaml.Controls.TextBox uiElement

    An instance of .

    SpreadsheetColumn column

    An instance of SpreadsheetColumn.

    Overrides
    Syncfusion.UI.Xaml.Spreadsheet.CellRenderer.SpreadsheetVirtualizingCellRendererBase<Windows.UI.Xaml.Controls.TextBlock, Windows.UI.Xaml.Controls.TextBox>.OnUpdateEditCellStyle(Syncfusion.UI.Xaml.Grid.ScrollAxis.RowColumnIndex, Windows.UI.Xaml.Controls.TextBox, Syncfusion.UI.Xaml.Spreadsheet.SpreadsheetColumn)

    OnWireEditUIElement(TextBox)

    Wire or hook the events associated with edit UIElement.

    Declaration
    protected override void OnWireEditUIElement(TextBox uiElement)
    Parameters
    Type Name Description
    Windows.UI.Xaml.Controls.TextBox uiElement

    An instance of .

    Overrides
    Syncfusion.UI.Xaml.Spreadsheet.CellRenderer.SpreadsheetVirtualizingCellRendererBase<Windows.UI.Xaml.Controls.TextBlock, Windows.UI.Xaml.Controls.TextBox>.OnWireEditUIElement(Windows.UI.Xaml.Controls.TextBox)

    SetControlValue(Object)

    Invoked to set the control value of the current cell.

    Declaration
    public override bool SetControlValue(object value)
    Parameters
    Type Name Description
    System.Object value

    value of the current cell.

    Returns
    Type Description
    System.Boolean

    True or False.

    Overrides
    SpreadsheetCellRendererBase.SetControlValue(Object)

    ShouldGridTryToHandleKeyDown(KeyRoutedEventArgs)

    Handles all the keydown operations in the current cell.

    Declaration
    protected override bool ShouldGridTryToHandleKeyDown(KeyRoutedEventArgs e)
    Parameters
    Type Name Description
    Windows.UI.Xaml.Input.KeyRoutedEventArgs e

    An System.Windows.Input.KeyEventArgs that contains the event data.

    Returns
    Type Description
    System.Boolean

    True or False.

    Overrides
    SpreadsheetCellRendererBase.ShouldGridTryToHandleKeyDown(KeyRoutedEventArgs)

    Implements

    ISpreadsheetCellRenderer
    System.IDisposable

    Extension Methods

    DateTimeExtension.ToDateTime(Object)
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved