Class SpreadsheetCurrentCell

Holds the properties and operations for current cell of SpreadsheetGrid.

Inheritance
System.Object
GridCurrentCell
SpreadsheetCurrentCell
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.UI.Xaml.Spreadsheet
Assembly: Syncfusion.SfSpreadsheet.WPF.dll
Syntax
public class SpreadsheetCurrentCell : GridCurrentCell, IDisposable

Constructors

SpreadsheetCurrentCell(SpreadsheetGrid)

Initializes a new instance of the SpreadsheetCurrentCell class.

Declaration
public SpreadsheetCurrentCell(SpreadsheetGrid grid)
Parameters
Type Name Description
SpreadsheetGrid grid

An instance of the SpreadsheetGrid.

Properties

HasCurrentCellState

Gets a value indicating whether the current cell renderer is set or not .

Declaration
protected override bool HasCurrentCellState { get; }
Property Value
Type Description
System.Boolean

true if the current cell renderer state is set ; otherwise, false.
Overrides

Style

Gets the value indicating the IStyle which represents the current cell style.

Declaration
public IStyle Style { get; }
Property Value
Type Description
IStyle

An instance of IStyle for the current cell range.

Methods

BeginEdit(Boolean)

Determines whether the current cell enters into edit mode or not.

Declaration
public override bool BeginEdit(bool forceEdit = false)
Parameters
Type Name Description
System.Boolean forceEdit

Set this true to avoid triggering events.
Returns
Type Description
System.Boolean

True, if current cell enters into edit mode; otherwise false.
Overrides

CanMove(RowColumnIndex)

Determines whether to move the focus to next cell or not when sheet is in protected mode.

Declaration
protected override bool CanMove(RowColumnIndex rowCol)
Parameters
Type Name Description
RowColumnIndex rowCol

Coordinates of the cell.
Returns
Type Description
System.Boolean

True if the sheet is unprotected;otherwise false.
Overrides

Dispose(Boolean)

Releases all resources used by the. SpreadsheetCurrentCell.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing
Overrides

EndEdit(Boolean)

Commits and ends the edit operation for the current cell.

Declaration
public override void EndEdit(bool canCommit = true)
Parameters
Type Name Description
System.Boolean canCommit

If true, commit the new changes, otherwise revert to old value
Overrides

GetControlValue()

Used to get the control value from renderer when current cell is in edit mode.

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

Value of current cell.
Overrides

OnTextInput(TextCompositionEventArgs)

Invoked when the current cell gets input text.

Declaration
protected override void OnTextInput(TextCompositionEventArgs e)
Parameters
Type Name Description
System.Windows.Input.TextCompositionEventArgs e

An System.Windows.Input.TextCompositionEventArgs that contains the event data.
Overrides

ResetCurrentCellState()

Used to reset the current cell state of the renderer

Declaration
protected override void ResetCurrentCellState()
Overrides

SetControlValue(Object)

Used to set the control value to renderer of the current cell when current cell is in edit mode.

Declaration
protected override void SetControlValue(object value)
Parameters
Type Name Description
System.Object value

Value of the current cell.
Overrides

SetCurrentCellState()

Used to set the CurrentCellState of the Renderer.

Declaration
protected override void SetCurrentCellState()
Overrides

SetFocus(Boolean)

Used to set the focus on the current cell.

Declaration
protected override void SetFocus(bool needToFocus)
Parameters
Type Name Description
System.Boolean needToFocus

If true, set focus to edit element.
Overrides

ShouldGridTryToHandleKeyDown(KeyEventArgs)

Handles the key down events that occurs when a key is pressed while the current cell has its focus.

Declaration
protected override bool ShouldGridTryToHandleKeyDown(KeyEventArgs args)
Parameters
Type Name Description
System.Windows.Input.KeyEventArgs args

An System.Windows.Input.KeyEventArgs that contains the event data.
Returns
Type Description
System.Boolean

True or False.
Overrides

Implements

System.IDisposable