menu

WPF

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

    Show / Hide Table of Contents

    Class GridCurrentCell

    Manages the current cell for a grid. Provides methods for activating, deactivating, and moving the current cell.

    Inheritance
    System.Object
    GridCurrentCell
    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.Windows.Controls.Grid
    Assembly: Syncfusion.Grid.Wpf.dll
    Syntax
    public class GridCurrentCell : IDisposable

    Constructors

    GridCurrentCell(GridControlBase)

    Initializes the object, attaches it to a grid, and subscribes to events.

    Declaration
    public GridCurrentCell(GridControlBase grid)
    Parameters
    Type Name Description
    GridControlBase grid

    The parent grid for this object.

    Properties

    ActivateOptions

    Declaration
    public GridActivateCurrentCellOptions ActivateOptions { get; }
    Property Value
    Type
    GridActivateCurrentCellOptions

    CellRowColumnIndex

    The row and column index of the current cell as a RowColumnIndex.

    Declaration
    public RowColumnIndex CellRowColumnIndex { get; set; }
    Property Value
    Type
    RowColumnIndex
    Remarks

    Changing this property will trigger a call to MoveTo(Int32, Int32). When the value is Empty, the current cell will be deactivated.

    ColumnIndex

    The column index.

    Declaration
    public int ColumnIndex { get; }
    Property Value
    Type
    System.Int32

    Exception

    Holds the details of any exceptin that has been caught during current cell operations.

    Declaration
    public Exception Exception { get; }
    Property Value
    Type
    System.Exception

    ExternalMove

    Used by GridSelectCellsMouseController.

    Declaration
    public GridCurrentCellMoveDelegateHandler ExternalMove { get; set; }
    Property Value
    Type
    GridCurrentCellMoveDelegateHandler

    Grid

    The parent grid.

    Declaration
    public GridControlBase Grid { get; }
    Property Value
    Type
    GridControlBase

    HasCurrentCell

    Gets a value indicating whether the grid has an active current cell.

    Declaration
    public bool HasCurrentCell { get; }
    Property Value
    Type
    System.Boolean

    IsDroppedDown

    Gets a value indicating whether the drop-down window of a current cell is dropped-down.

    Declaration
    public bool IsDroppedDown { get; }
    Property Value
    Type
    System.Boolean

    IsEditing

    Gets a value indicating whether the current cell is in editing mode.

    Declaration
    public bool IsEditing { get; }
    Property Value
    Type
    System.Boolean

    IsInAcceptedChanges

    Gets a value indicating whether IsInAcceptedChanges.

    Declaration
    public bool IsInAcceptedChanges { get; }
    Property Value
    Type
    System.Boolean

    IsInActivate

    Returns whether Activate(Int32, Int32) is in progress.

    Declaration
    public bool IsInActivate { get; }
    Property Value
    Type
    System.Boolean

    IsInActivated

    Gets a value indicating whether IsInActivated.

    Declaration
    public bool IsInActivated { get; }
    Property Value
    Type
    System.Boolean

    IsInActivateFailed

    Gets a value indicating whether IsInActivateFailed.

    Declaration
    public bool IsInActivateFailed { get; }
    Property Value
    Type
    System.Boolean

    IsInActivateOrDeactivate

    Returns whether Deactivate() or Activate(Int32, Int32) is in progress.

    Declaration
    public bool IsInActivateOrDeactivate { get; }
    Property Value
    Type
    System.Boolean

    IsInBeginEdit

    Returns true when BeginEdit() was called; False after method returned.

    Declaration
    public bool IsInBeginEdit { get; }
    Property Value
    Type
    System.Boolean

    IsInCancelEdit

    Returns true when CancelEdit() was called; False after method returned.

    Declaration
    public bool IsInCancelEdit { get; }
    Property Value
    Type
    System.Boolean

    IsInChanged

    Indicates if the current cell's CurrentCellChanged event is being handled.

    Declaration
    public bool IsInChanged { get; }
    Property Value
    Type
    System.Boolean

    IsInChanging

    Indicates if the current cell's CurrentCellChanging event is being handled.

    Declaration
    public bool IsInChanging { get; }
    Property Value
    Type
    System.Boolean

    IsInConfirmChanges

    Gets a value indicating whether IsInConfirmChanges.

    Declaration
    public bool IsInConfirmChanges { get; }
    Property Value
    Type
    System.Boolean

    IsInDeactivate

    Gets a value indicating whether Deactivate() is in progress.

    Declaration
    public bool IsInDeactivate { get; }
    Property Value
    Type
    System.Boolean

    IsInDeactivated

    Gets a value indicating whether IsInDeactivated.

    Declaration
    public bool IsInDeactivated { get; }
    Property Value
    Type
    System.Boolean

    IsInDeactivateFailed

    Returns whether IsInDeactivateFailed.

    Declaration
    public bool IsInDeactivateFailed { get; }
    Property Value
    Type
    System.Boolean

    IsInEndEdit

    Gets a value indicating whether IsInEndEdit.

    Declaration
    public bool IsInEndEdit { get; }
    Property Value
    Type
    System.Boolean

    IsInMove

    Gets a value indicating whether Move(GridDirectionType, Int32, Boolean, Boolean) is in progress.

    Declaration
    public bool IsInMove { get; }
    Property Value
    Type
    System.Boolean

    IsInMoved

    Gets a value indicating whether IsInMoved.

    Declaration
    public bool IsInMoved { get; }
    Property Value
    Type
    System.Boolean

    IsInMoveFailed

    Gets a value indicating whether IsInMoveFailed.

    Declaration
    public bool IsInMoveFailed { get; }
    Property Value
    Type
    System.Boolean

    IsInMoveTo

    Gets a value indicating whether MoveTo(Int32, Int32) is in progress. MoveTo saves information about the current cell state and its target cell so that events can more easily compare previous and new states of the current cell during MoveTo(Int32, Int32) calls.

    Declaration
    public bool IsInMoveTo { get; }
    Property Value
    Type
    System.Boolean

    IsInRefresh

    Gets a value indicating whether IsInRefresh.

    Declaration
    public bool IsInRefresh { get; }
    Property Value
    Type
    System.Boolean

    IsInRejectChanges

    Gets a value indicating whether IsInRejectChanges.

    Declaration
    public bool IsInRejectChanges { get; }
    Property Value
    Type
    System.Boolean

    IsLocked

    Determines if the current cell's state is "locked". If the current cell is locked, any attempts to move, deactivate, save, or activate the current cell will fail.

    Declaration
    public bool IsLocked { get; }
    Property Value
    Type
    System.Boolean

    IsModified

    Gets or sets a value indicating whether there are pending changes in the current cell.

    Declaration
    public bool IsModified { get; }
    Property Value
    Type
    System.Boolean

    IsSuspendEvents

    Checks if raising events is temporarily disabled.

    Declaration
    public bool IsSuspendEvents { get; }
    Property Value
    Type
    System.Boolean

    IsValid

    Returns success of the latest Validate() method call.

    Declaration
    public bool IsValid { get; }
    Property Value
    Type
    System.Boolean

    MoveFromActiveState

    Gets a value indicating whether there was an activated current cell at the time that MoveTo(Int32, Int32) was called.

    Declaration
    public bool MoveFromActiveState { get; }
    Property Value
    Type
    System.Boolean

    MoveFromColIndex

    Gets the saved column index information about the previous position of the current cell at the time that MoveTo(Int32, Int32) was called.

    Declaration
    public int MoveFromColIndex { get; }
    Property Value
    Type
    System.Int32

    MoveFromRowIndex

    Gets the saved row index information about the previous position of the current cell at the time that MoveTo(Int32, Int32) was called.

    Declaration
    public int MoveFromRowIndex { get; }
    Property Value
    Type
    System.Int32

    MoveToDone

    Gets the state if the MoveTo method is complete.

    Declaration
    public bool MoveToDone { get; }
    Property Value
    Type
    System.Boolean

    MoveToRowIndex

    Declaration
    public int MoveToRowIndex { get; }
    Property Value
    Type
    System.Int32

    RangeInfo

    The row and column index of the current cell as a GridRangeInfo.

    Declaration
    public GridRangeInfo RangeInfo { get; set; }
    Property Value
    Type
    GridRangeInfo
    Remarks

    Changing this property will trigger a call to MoveTo(Int32, Int32). When the value is Empty, the current cell will be deactivated.

    Renderer

    The cell renderer.

    Declaration
    public IGridCellRenderer Renderer { get; }
    Property Value
    Type
    IGridCellRenderer

    RowIndex

    The row index.

    Declaration
    public int RowIndex { get; }
    Property Value
    Type
    System.Int32

    Methods

    Activate(RowColumnIndex, GridActivateCurrentCellOptions)

    Activates the current cell at the specified position.

    Declaration
    public bool Activate(RowColumnIndex cellRowColumnIndex, GridActivateCurrentCellOptions activateOptions)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    The cell's row column index as RowColumnIndex.

    GridActivateCurrentCellOptions activateOptions

    A GridActivateCurrentCellOptions value that details options how to activate the current cell. You can specify if the associated control should get focus, if range selection should be ignored and more.

    Returns
    Type Description
    System.Boolean

    True if activating the current cell was successful; False otherwise.

    Activate(Int32, Int32)

    Activates the current cell at the specified position.

    Declaration
    public bool Activate(int rowIndex, int columnIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Int32 columnIndex

    The column index.

    Returns
    Type Description
    System.Boolean

    True if activating the current cell was successful; False otherwise.

    Activate(Int32, Int32, GridActivateCurrentCellOptions)

    Activates the current cell at the specified position.

    Declaration
    public bool Activate(int rowIndex, int columnIndex, GridActivateCurrentCellOptions activateOptions)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Int32 columnIndex

    The column index.

    GridActivateCurrentCellOptions activateOptions

    A GridActivateCurrentCellOptions value that details options how to activate the current cell. You can specify if the associated control should get focus, if range selection should be ignored and more.

    Returns
    Type Description
    System.Boolean

    True if activating the current cell was successful; False otherwise.

    BeginEdit()

    Starts editing mode for the current cell.

    Declaration
    public bool BeginEdit()
    Returns
    Type Description
    System.Boolean

    True if current cell supports editing; False otherwise.

    BeginEdit(Boolean)

    Starts editing mode for the current cell and allows setting the focus to the cell editor.

    Declaration
    public bool BeginEdit(bool focusCellUIElement)
    Parameters
    Type Name Description
    System.Boolean focusCellUIElement

    Specifies if focus can be set to the cell editor.

    Returns
    Type Description
    System.Boolean

    True if current cell supports editing; False otherwise.

    CancelEdit()

    Cancels editing for the current cell and discards any changes.

    Declaration
    public void CancelEdit()

    CancelEdit(Boolean)

    Cancels editing for the current cell and discards any changes.

    Declaration
    public void CancelEdit(bool setGridFocus)
    Parameters
    Type Name Description
    System.Boolean setGridFocus

    When true, the focus will be set to the grid.

    ConfirmChanges()

    Confirms any pending changes for the current cell and closes any open drop-down windows.

    Declaration
    public bool ConfirmChanges()
    Returns
    Type Description
    System.Boolean

    True if changes could be saved or if current cell was not modified; False if saving the changes failed.

    CreateCurrentCellUIElements()

    Creates the UI elements of current cell.

    Declaration
    public bool CreateCurrentCellUIElements()
    Returns
    Type Description
    System.Boolean

    True if the operation was successful; False otherwise.

    Deactivate()

    Deactivates the current cell and confirms or rejects changes made to the current cell.

    Declaration
    public bool Deactivate()
    Returns
    Type Description
    System.Boolean

    True if current cell can be deactivated; False otherwise.

    Deactivate(Boolean)

    Deactivates the current cell and confirms or rejects changes made to the current cell.

    Declaration
    public bool Deactivate(bool discardChangesIfCommitFails)
    Parameters
    Type Name Description
    System.Boolean discardChangesIfCommitFails

    True if changes can be discarded; False otherwise.

    Returns
    Type Description
    System.Boolean

    True if current cell can be deactivated; False otherwise.

    Dispose()

    Declaration
    public void Dispose()

    EndEdit()

    Finished up editing mode for the current cell.

    Declaration
    public void EndEdit()

    GetCurrentCell(out RowColumnIndex)

    Returns position of the current cell together with a boolean if the current cell is active or not.

    Declaration
    public bool GetCurrentCell(out RowColumnIndex cellRowColumnIndex)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    The row and column indices of the current cell as RowColumnIndex.

    Returns
    Type Description
    System.Boolean

    True if grid has active current cell; False otherwise.

    GetCurrentCell(out Int32, out Int32)

    Returns position of the current cell together with a boolean if the current cell is active or not.

    Declaration
    public bool GetCurrentCell(out int rowIndex, out int columnIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index of the current cell.

    System.Int32 columnIndex

    The column index of the current cell.

    Returns
    Type Description
    System.Boolean

    True if grid has active current cell; False otherwise.

    HasCurrentCellAt(RowColumnIndex)

    Checks if the current cell is active at the specified RowColumnIndex.

    Declaration
    public bool HasCurrentCellAt(RowColumnIndex cellRowColumnIndex)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    The row and column index as RowColumnIndex.

    Returns
    Type Description
    System.Boolean

    True if current cell was found at the given RowColumnIndex; False otherwise.

    HasCurrentCellAt(GridRangeInfo)

    Checks if the current cell is active at the specific range.

    Declaration
    public bool HasCurrentCellAt(GridRangeInfo range)
    Parameters
    Type Name Description
    GridRangeInfo range

    The cell range.

    Returns
    Type Description
    System.Boolean

    True if current cell was found at the given range; False otherwise.

    HasCurrentCellAt(Int32)

    Checks if the current cell is active and at the specific row index.

    Declaration
    public bool HasCurrentCellAt(int rowIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    Returns
    Type Description
    System.Boolean

    True if current cell was found at row index; False otherwise.

    HasCurrentCellAt(Int32, Int32)

    Checks if the current cell is active and at the specific row and column index.

    Declaration
    public bool HasCurrentCellAt(int rowIndex, int columnIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Int32 columnIndex

    The column index.

    Returns
    Type Description
    System.Boolean

    True if current cell was found at row and column indices; False otherwise.

    InsertColumns(Int32, Int32, GridCurrentCellMoveState)

    Insert a specified number of columns at a specified column index.

    Declaration
    public void InsertColumns(int insertAtColumnIndex, int count, GridCurrentCellMoveState moveState)
    Parameters
    Type Name Description
    System.Int32 insertAtColumnIndex

    The starting column index where new columns should be inserted.

    System.Int32 count

    The number of columns to insert.

    GridCurrentCellMoveState moveState

    The GridCurrentCellMoveState.

    InsertRows(Int32, Int32, GridCurrentCellMoveState)

    Insert a specified number of rows at a specified row index.

    Declaration
    public void InsertRows(int insertAtRowIndex, int count, GridCurrentCellMoveState moveState)
    Parameters
    Type Name Description
    System.Int32 insertAtRowIndex

    The starting row index where new rows should be inserted.

    System.Int32 count

    The number of rows to insert.

    GridCurrentCellMoveState moveState

    The GridCurrentCellMoveState.

    IsValidCellRowColumnIndex(RowColumnIndex)

    Checks if the specified row and column indices are valid.

    Declaration
    public bool IsValidCellRowColumnIndex(RowColumnIndex cellRowColumnIndex)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    The row and column indices as RowColumnIndex.

    Returns
    Type Description
    System.Boolean

    True if it is valid; False otherwise.

    Lock()

    Lets you temporarily "lock" the current cell. While a current cell is locked, any attempts to move, deactivate, save, or activate the current cell will fail.

    Declaration
    public void Lock()

    Move(GridDirectionType, Int32, Boolean)

    Moves the current cell in a given direction skipping a specified number of cells and optionally selecting the cells.

    Declaration
    public bool Move(GridDirectionType direction, int num, bool extendSelection)
    Parameters
    Type Name Description
    GridDirectionType direction

    The GridDirectionType that specifies the direction of the current cell movement.

    System.Int32 num

    The number of cells to move.

    System.Boolean extendSelection

    When true, extends the current selection.

    Returns
    Type Description
    System.Boolean

    True if the current cell was moved to a new position; False otherwise (e.g. if current cell is at first row and you tried to move up).

    Move(GridDirectionType, Int32, Boolean, Boolean)

    Moves the current cell in a given direction skipping a specified number of cells and optionally selecting the cells.

    Declaration
    public bool Move(GridDirectionType direction, int num, bool extendSelection, bool wrapCell)
    Parameters
    Type Name Description
    GridDirectionType direction

    The GridDirectionType that specifies the direction of the current cell movement.

    System.Int32 num

    The number of cells to move.

    System.Boolean extendSelection

    When true, extends the current selection.

    System.Boolean wrapCell

    Indicates if grid should move to beginning of next row when at end of row or vice versa.

    Returns
    Type Description
    System.Boolean

    True if the current cell was moved to a new position; False otherwise (e.g. if current cell is at first row and you tried to move up).

    MoveDown()

    Moves the current cell down to the next enabled row.

    Declaration
    public void MoveDown()
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    MoveDown(Int32)

    Moves the current cell down to the next enabled row after skipping a specified number of rows.

    Declaration
    public void MoveDown(int num)
    Parameters
    Type Name Description
    System.Int32 num

    The number of rows to move.

    MoveDown(Int32, Boolean)

    Moves the current cell down to the next enabled row after skipping a specified number of rows and selects the cells.

    Declaration
    public void MoveDown(int num, bool extendSelection)
    Parameters
    Type Name Description
    System.Int32 num

    The number of rows to move.

    System.Boolean extendSelection

    When true, extends the current selection.

    MoveLeft()

    Moves the current cell left to the next enabled column.

    Declaration
    public void MoveLeft()
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    MoveLeft(Int32)

    Moves the current cell left to the next enabled column after skipping a specified number of columns.

    Declaration
    public void MoveLeft(int num)
    Parameters
    Type Name Description
    System.Int32 num

    The number of columns to move.

    MoveLeft(Int32, Boolean)

    Moves the current cell left to the next enabled column after skipping a specified number of columns and selects the cells.

    Declaration
    public void MoveLeft(int num, bool extendSelection)
    Parameters
    Type Name Description
    System.Int32 num

    The number of columns to move.

    System.Boolean extendSelection

    When true, extends the current selection.

    MoveRight()

    Moves the current cell right to the next enabled column.

    Declaration
    public void MoveRight()
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    MoveRight(Int32)

    Moves the current cell right to the next enabled column after skipping a specified number of columns.

    Declaration
    public void MoveRight(int num)
    Parameters
    Type Name Description
    System.Int32 num

    The number of columns to move.

    MoveRight(Int32, Boolean)

    Moves the current cell right to the next enabled column after skipping a specified number of columns and selects the cells.

    Declaration
    public void MoveRight(int num, bool extendSelection)
    Parameters
    Type Name Description
    System.Int32 num

    The number of columns to move.

    System.Boolean extendSelection

    When true, extends the current selection.

    MoveTo(RowColumnIndex)

    Moves the current cell to the specified position.

    Declaration
    public bool MoveTo(RowColumnIndex cellRowColumnIndex)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    The row and column indices as RowColumnIndex.

    Returns
    Type Description
    System.Boolean

    True if the current cell could be moved; False otherwise.

    MoveTo(RowColumnIndex, GridActivateCurrentCellOptions)

    Moves the current cell to the specified position.

    Declaration
    public bool MoveTo(RowColumnIndex cellRowColumnIndex, GridActivateCurrentCellOptions activateOptions)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    The row and column indices as RowColumnIndex.

    GridActivateCurrentCellOptions activateOptions

    A GridSetCurrentCellOptions value that details options how to activate the current cell. You can specify if the associated control should get focus, if range selection should be ignored and more.

    Returns
    Type Description
    System.Boolean

    True if the current cell could be moved; False otherwise.

    MoveTo(Int32, Int32)

    Moves the current cell to the specified position.

    Declaration
    public bool MoveTo(int rowIndex, int columnIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Int32 columnIndex

    The column index.

    Returns
    Type Description
    System.Boolean

    True if the current cell could be moved; False otherwise.

    MoveTo(Int32, Int32, GridActivateCurrentCellOptions)

    Moves the current cell to the specified position.

    Declaration
    public bool MoveTo(int rowIndex, int columnIndex, GridActivateCurrentCellOptions activateOptions)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Int32 columnIndex

    The column index.

    GridActivateCurrentCellOptions activateOptions

    A GridSetCurrentCellOptions value that details options how to activate the current cell. You can specify if the associated control should get focus, if range selection should be ignored and more.

    Returns
    Type Description
    System.Boolean

    True if the current cell could be moved; False otherwise.

    MoveToBottom()

    Moves the current cell down one page to the next enabled row.

    Declaration
    public void MoveToBottom()
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    MoveToBottom(Boolean)

    Moves the current cell down one page to the next enabled row.

    Declaration
    public void MoveToBottom(bool extendSelection)
    Parameters
    Type Name Description
    System.Boolean extendSelection

    When true, extends the current selection.

    MoveToBottomRight()

    Declaration
    public void MoveToBottomRight()

    MoveToBottomRight(Boolean)

    Declaration
    public void MoveToBottomRight(bool extendSelection)
    Parameters
    Type Name Description
    System.Boolean extendSelection

    MoveToLeftEnd()

    Moves the current cell down one page to the next enabled row.

    Declaration
    public void MoveToLeftEnd()
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    MoveToLeftEnd(Boolean)

    Moves the current cell down one page to the next enabled row.

    Declaration
    public void MoveToLeftEnd(bool extendSelection)
    Parameters
    Type Name Description
    System.Boolean extendSelection

    When true, extends the current selection.

    MoveToRightEnd()

    Moves the current cell down one page to the next enabled row.

    Declaration
    public void MoveToRightEnd()
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    MoveToRightEnd(Boolean)

    Moves the current cell down one page to the next enabled row.

    Declaration
    public void MoveToRightEnd(bool extendSelection)
    Parameters
    Type Name Description
    System.Boolean extendSelection

    When true, extends the current selection.

    MoveToTop()

    Moves the current cell down one page to the next enabled row.

    Declaration
    public void MoveToTop()
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    MoveToTop(Boolean)

    Moves the current cell down one page to the next enabled row.

    Declaration
    public void MoveToTop(bool extendSelection)
    Parameters
    Type Name Description
    System.Boolean extendSelection

    When true, extends the current selection.

    MoveToTopLeft()

    Declaration
    public void MoveToTopLeft()

    MoveToTopLeft(Boolean)

    Declaration
    public void MoveToTopLeft(bool extendSelection)
    Parameters
    Type Name Description
    System.Boolean extendSelection

    MoveUp()

    Moves the current cell up to the next enabled row.

    Declaration
    public void MoveUp()
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    MoveUp(Int32)

    Moves the current cell up to the next enabled row after skipping a specified number of rows.

    Declaration
    public void MoveUp(int num)
    Parameters
    Type Name Description
    System.Int32 num

    The number of rows to move.

    MoveUp(Int32, Boolean)

    Moves the current cell up to the next enabled row after skipping a specified number of rows and selects the cells.

    Declaration
    public void MoveUp(int num, bool extendSelection)
    Parameters
    Type Name Description
    System.Int32 num

    The number of rows to move.

    System.Boolean extendSelection

    When true, extends the current selection.

    NotifyChanged()

    Signifies the current cell change.

    Declaration
    public void NotifyChanged()

    NotifyChanging()

    Indicates that the current cell is being changed.

    Declaration
    public bool NotifyChanging()
    Returns
    Type Description
    System.Boolean

    The boolean value NotifyChanging

    PageDown()

    Moves the current cell down one page to the next enabled row.

    Declaration
    public void PageDown()
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    PageDown(Boolean)

    Moves the current cell down one page to the next enabled row.

    Declaration
    public void PageDown(bool extendSelection)
    Parameters
    Type Name Description
    System.Boolean extendSelection

    When true, extends the current selection.

    PageLeft()

    Moves the current cell left one page to the next enabled row.

    Declaration
    public void PageLeft()
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    PageLeft(Boolean)

    Moves the current cell left one page to the next enabled row.

    Declaration
    public void PageLeft(bool extendSelection)
    Parameters
    Type Name Description
    System.Boolean extendSelection

    When true, extends the current selection.

    PageRight()

    Moves the current cell right one page to the next enabled row.

    Declaration
    public void PageRight()
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    PageRight(Boolean)

    Moves the current cell right one page to the next enabled row.

    Declaration
    public void PageRight(bool extendSelection)
    Parameters
    Type Name Description
    System.Boolean extendSelection

    When true, extends the current selection.

    PageUp()

    Moves the current cell up one page to the next enabled row.

    Declaration
    public void PageUp()
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    PageUp(Boolean)

    Moves the current cell up one page to the next enabled row.

    Declaration
    public void PageUp(bool extendSelection)
    Parameters
    Type Name Description
    System.Boolean extendSelection

    When true, extends the current selection.

    QueryNextEnabledCell(GridDirectionType, ref Int32, ref Int32)

    Determines the next enabled cell when current cell wants to move into a given direction. Cells that are not marked as enabled with Enabled will be skipped. The search in a given direction is aborted when the row or column index hits the boundaries of the NavigateWithArrowKeysCellsRange range.

    Declaration
    public bool QueryNextEnabledCell(GridDirectionType direction, ref int rowIndex, ref int columnIndex)
    Parameters
    Type Name Description
    GridDirectionType direction

    The GridDirectionType that specifies the direction of the current cell movement.

    System.Int32 rowIndex

    The row index.

    System.Int32 columnIndex

    The column index.

    Returns
    Type Description
    System.Boolean

    True if an enabled cell was found; False otherwise.

    Remarks

    This method will not raise the QueryNextCurrentCellPosition event. Instead you can call this method from your QueryNextMoveCell event handler to find out about the next enabled cell and then decide on further criteria if the suggested cell is good.

    You should call GetNextCurrentCellPosition(GridDirectionType, ref Int32, ref Int32) instead if you want the QueryNextCurrentCellPosition event to be raised.

    QueryNextEnabledCellCheck(GridDirectionType, ref Int32, ref Int32)

    Declaration
    public bool QueryNextEnabledCellCheck(GridDirectionType direction, ref int row, ref int col)
    Parameters
    Type Name Description
    GridDirectionType direction
    System.Int32 row
    System.Int32 col
    Returns
    Type
    System.Boolean

    Refresh()

    Refreshes the current cell.

    Declaration
    public void Refresh()

    RejectChanges()

    Discards any changes for the current cell.

    Declaration
    public void RejectChanges()

    RemoveColumns(Int32, Int32, GridCurrentCellMoveState)

    Removes a specified number of columns at a specified column index.

    Declaration
    public void RemoveColumns(int removeAtColumnIndex, int count, GridCurrentCellMoveState moveState)
    Parameters
    Type Name Description
    System.Int32 removeAtColumnIndex

    The starting column index where columns should be removed.

    System.Int32 count

    The number of columns to remove.

    GridCurrentCellMoveState moveState

    The GridCurrentCellMoveState.

    RemoveRows(Int32, Int32, GridCurrentCellMoveState)

    Removes a specified number of rows at a specified row index.

    Declaration
    public void RemoveRows(int removeAtRowIndex, int count, GridCurrentCellMoveState moveState)
    Parameters
    Type Name Description
    System.Int32 removeAtRowIndex

    The starting row index where columns should be removed.

    System.Int32 count

    The number of rows to remove.

    GridCurrentCellMoveState moveState

    The GridCurrentCellMoveState.

    ResumeEvents()

    Resumes raising events.

    Declaration
    public void ResumeEvents()

    ScrollInView()

    Brings the current cell into view.

    Declaration
    public void ScrollInView()

    SuspendEvents()

    Suspends raising events.

    Declaration
    public void SuspendEvents()

    UnloadCurrentCellUIElement()

    Disposes the UI element of current cell.

    Declaration
    public void UnloadCurrentCellUIElement()

    Unlock()

    Unlocks a temporarily "locked" current cell with Lock().

    Declaration
    public void Unlock()

    UpdateCellRowColumnIndex(RowColumnIndex)

    Updates the cell's row and column indices with the given value.

    Declaration
    public void UpdateCellRowColumnIndex(RowColumnIndex cellRowColumnIndex)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    The new row and column indices as RowColumnIndex.

    Validate()

    Validates the current cell.

    Declaration
    public void Validate()

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved