Class
BaseGridNavigator

This class defines methods used to change the currently selected row and column

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:

cs-api-definition
public class BaseGridNavigator : IGridNavigator, IGridViewEventListener

Inheritance: objectBaseGridNavigator

Implements: IGridNavigatorIGridViewEventListener

Constructors

BaseGridNavigator()

Declaration

cs-api-definition
public BaseGridNavigator()

Properties

AnchoredPosition

Gets the anchored position.

Declaration

cs-api-definition
protected AnchoredPosition AnchoredPosition { get; }

Property Value

AnchoredPosition

The anchored position.

Columns

Gets the render columns associated with the CurrentView in grid

Declaration

cs-api-definition
protected IList<GridViewColumn> Columns { get; }

Property Value

IList<GridViewColumn>

Context

Gets the context.

Declaration

cs-api-definition
protected GridNavigationContext Context { get; }

Property Value

GridNavigationContext

The context.

CurrentColumn

Gets grid's current column

Declaration

cs-api-definition
protected GridViewColumn CurrentColumn { get; }

Property Value

GridViewColumn

CurrentColumnIndex

Gets the column index of the current column in grid

Declaration

cs-api-definition
protected int CurrentColumnIndex { get; }

Property Value

int

CurrentRow

Gets grid's current row

Declaration

cs-api-definition
protected GridViewRowInfo CurrentRow { get; }

Property Value

GridViewRowInfo

GridViewElement

The RadGridViewElement associated with this navigator

Declaration

cs-api-definition
public RadGridViewElement GridViewElement { get; }

Property Value

RadGridViewElement

Implements IGridNavigator.GridViewElement

IsControlButtonPressed

Gets a value that indicates whether the CONTROL button is performed

Declaration

cs-api-definition
protected bool IsControlButtonPressed { get; }

Property Value

bool

IsMouseSelection

Gets a value that indicates whether Mouse Selection is performed

Declaration

cs-api-definition
protected bool IsMouseSelection { get; }

Property Value

bool

IsRightMouseButtonClicked

Gets a value that indicates whether right mouse button is performed

Declaration

cs-api-definition
protected bool IsRightMouseButtonClicked { get; }

Property Value

bool

IsShiftButtonPressed

Gets a value that indicates whether the SHIFT button is performed

Declaration

cs-api-definition
protected bool IsShiftButtonPressed { get; }

Property Value

bool

MasterTemplate

The MasterTemplate associated with this navigator

Declaration

cs-api-definition
public MasterGridViewTemplate MasterTemplate { get; }

Property Value

MasterGridViewTemplate

RightToLeft

Gets a value indicating whether the grid is in right-to-left mode

Declaration

cs-api-definition
protected bool RightToLeft { get; }

Property Value

bool

Traverser

Gets the traverser.

Declaration

cs-api-definition
protected GridTraverser Traverser { get; }

Property Value

GridTraverser

The traverser.

ViewInfo

Gets the GridViewInfo associated with the CurrentView in grid

Declaration

cs-api-definition
protected GridViewInfo ViewInfo { get; }

Property Value

GridViewInfo

ViewTemplate

Gets the GridViewTemplate associated with the CurrentView in grid

Declaration

cs-api-definition
protected GridViewTemplate ViewTemplate { get; }

Property Value

GridViewTemplate

Methods

AnalyzeQueueCore(List<GridViewEvent>)

Declaration

cs-api-definition
protected virtual bool AnalyzeQueueCore(List<GridViewEvent> events)

Parameters

events

List<GridViewEvent>

Returns

bool

BeginSelection(GridNavigationContext)

Begins grid selection

Declaration

cs-api-definition
public virtual void BeginSelection(GridNavigationContext context)

Parameters

context

GridNavigationContext

An instance of GridNavigationContext.

Implements IGridNavigator.BeginSelection(GridNavigationContext)

CellSelect(GridViewRowInfo, GridViewColumn)

Cells the select.

Declaration

cs-api-definition
protected virtual bool CellSelect(GridViewRowInfo row, GridViewColumn column)

Parameters

row

GridViewRowInfo

The row.

column

GridViewColumn

The column.

Returns

bool

ClearSelection()

Clears the selection

Declaration

cs-api-definition
public virtual void ClearSelection()

Implements IGridNavigator.ClearSelection()

DeleteSelectedRows()

Deletes the selected rows.

Declaration

cs-api-definition
public virtual bool DeleteSelectedRows()

Returns

bool

Implements IGridNavigator.DeleteSelectedRows()

DoMultiSelect(GridViewRowInfo, GridViewColumn, GridViewRowInfo, GridViewColumn)

Does the multi select.

Declaration

cs-api-definition
protected virtual bool DoMultiSelect(GridViewRowInfo oldRow, GridViewColumn oldColumn, GridViewRowInfo row, GridViewColumn column)

Parameters

oldRow

GridViewRowInfo

The old row.

oldColumn

GridViewColumn

The old column.

row

GridViewRowInfo

The row.

column

GridViewColumn

The column.

Returns

bool

DoMultiSelectCore()

Does the multi select core.

Declaration

cs-api-definition
protected virtual bool DoMultiSelectCore()

Returns

bool

EndSelection()

Ends selection

Declaration

cs-api-definition
public virtual void EndSelection()

Implements IGridNavigator.EndSelection()

FullRowSelect(GridViewRowInfo, GridViewRowInfo)

Returns a boolean value indicating whether the full row is selected.

Declaration

cs-api-definition
protected virtual bool FullRowSelect(GridViewRowInfo oldCurrentRow, GridViewRowInfo row)

Parameters

oldCurrentRow

GridViewRowInfo

The old current row.

row

GridViewRowInfo

The row.

Returns

bool

GetEventListenerPirotiy()

Declaration

cs-api-definition
protected virtual EventListenerPriority GetEventListenerPirotiy()

Returns

EventListenerPriority

GetEventProcessMode()

Declaration

cs-api-definition
protected virtual GridEventProcessMode GetEventProcessMode()

Returns

GridEventProcessMode

Initialize(RadGridViewElement)

Initializes the IGridNavigator with the specified RadGridView

Declaration

cs-api-definition
public virtual void Initialize(RadGridViewElement element)

Parameters

element

RadGridViewElement

The RadGridViewElement to associate with this object

Implements IGridNavigator.Initialize(RadGridViewElement)

IsFirstColumn(GridViewColumn)

Checks whether the specified column is the first one.

Declaration

cs-api-definition
public virtual bool IsFirstColumn(GridViewColumn column)

Parameters

column

GridViewColumn

the column to check

Returns

bool

true if this is the first column

Implements IGridNavigator.IsFirstColumn(GridViewColumn)

IsFirstEditableColumn(GridViewColumn)

Checks whether the specified column is the first editable one.

Declaration

cs-api-definition
public virtual bool IsFirstEditableColumn(GridViewColumn column)

Parameters

column

GridViewColumn

the column to check

Returns

bool

true if this is the first editable column

Implements IGridNavigator.IsFirstEditableColumn(GridViewColumn)

IsFirstRow(GridViewRowInfo)

Checks whether the specified row is the last one.

Declaration

cs-api-definition
public virtual bool IsFirstRow(GridViewRowInfo row)

Parameters

row

GridViewRowInfo

the row to check

Returns

bool

true if this is the last row

Implements IGridNavigator.IsFirstRow(GridViewRowInfo)

IsLastColumn(GridViewColumn)

Checks whether the specified column is the last one.

Declaration

cs-api-definition
public virtual bool IsLastColumn(GridViewColumn column)

Parameters

column

GridViewColumn

the column to check

Returns

bool

true if this is the last column

Implements IGridNavigator.IsLastColumn(GridViewColumn)

IsLastEditableColumn(GridViewColumn)

Checks whether the specified column is the last editable one.

Declaration

cs-api-definition
public virtual bool IsLastEditableColumn(GridViewColumn column)

Parameters

column

GridViewColumn

the column to check

Returns

bool

true if this is the last editable column

Implements IGridNavigator.IsLastEditableColumn(GridViewColumn)

IsLastRow(GridViewRowInfo)

Checks whether the specified row is the first one.

Declaration

cs-api-definition
public virtual bool IsLastRow(GridViewRowInfo row)

Parameters

row

GridViewRowInfo

the row to check

Returns

bool

true if this is the first row

Implements IGridNavigator.IsLastRow(GridViewRowInfo)

NavigateToRow(GridViewRowInfo, bool)

Navigates to row.

Declaration

cs-api-definition
protected virtual bool NavigateToRow(GridViewRowInfo row, bool select)

Parameters

row

GridViewRowInfo

The row.

select

bool

The select.

Returns

bool

PostProcessEventCore(GridViewEvent)

Declaration

cs-api-definition
protected virtual GridViewEventResult PostProcessEventCore(GridViewEvent eventData)

Parameters

eventData

GridViewEvent

Returns

GridViewEventResult

PreProcessEventCore(GridViewEvent)

Declaration

cs-api-definition
protected virtual GridViewEventResult PreProcessEventCore(GridViewEvent eventData)

Parameters

eventData

GridViewEvent

Returns

GridViewEventResult

ProcessCurrentChangedEvent(GridViewEvent)

Declaration

cs-api-definition
protected virtual GridViewEventResult ProcessCurrentChangedEvent(GridViewEvent eventData)

Parameters

eventData

GridViewEvent

Returns

GridViewEventResult

ProcessEventCore(GridViewEvent)

Declaration

cs-api-definition
protected virtual GridViewEventResult ProcessEventCore(GridViewEvent eventData)

Parameters

eventData

GridViewEvent

Returns

GridViewEventResult

ProcessViewChangedEvent(GridViewEvent)

Declaration

cs-api-definition
protected virtual GridViewEventResult ProcessViewChangedEvent(GridViewEvent eventData)

Parameters

eventData

GridViewEvent

Returns

GridViewEventResult

Select(GridViewRowInfo, GridViewColumn)

Selects the sepcified row as current and specified column as current

Declaration

cs-api-definition
public virtual bool Select(GridViewRowInfo row, GridViewColumn column)

Parameters

row

GridViewRowInfo

An instance of GridViewRowInfo.

column

GridViewColumn

An instance of GridViewColumn.

Returns

bool

Implements IGridNavigator.Select(GridViewRowInfo, GridViewColumn)

SelectAll()

Select all rows and cells

Declaration

cs-api-definition
public virtual void SelectAll()

Implements IGridNavigator.SelectAll()

SelectCore(GridViewRowInfo, GridViewColumn)

Selects the cell associated with the respective row and column.

Declaration

cs-api-definition
protected virtual bool SelectCore(GridViewRowInfo row, GridViewColumn column)

Parameters

row

GridViewRowInfo

The row.

column

GridViewColumn

The column.

Returns

bool

SelectFirstColumn()

Selects the first column as current column in grid

Declaration

cs-api-definition
public virtual bool SelectFirstColumn()

Returns

bool

true if successfull.

Implements IGridNavigator.SelectFirstColumn()

SelectFirstRow()

Selects the first row as current column in grid

Declaration

cs-api-definition
public virtual bool SelectFirstRow()

Returns

bool

true if successfull.

Implements IGridNavigator.SelectFirstRow()

SelectLastColumn()

Selects the last column as current column in grid

Declaration

cs-api-definition
public virtual bool SelectLastColumn()

Returns

bool

true if successfull.

Implements IGridNavigator.SelectLastColumn()

SelectLastRow()

Selects the last row as current row in grid

Declaration

cs-api-definition
public virtual bool SelectLastRow()

Returns

bool

true if successfull.

Implements IGridNavigator.SelectLastRow()

SelectNextColumn()

Selects the next column as current column in grid

Declaration

cs-api-definition
public virtual bool SelectNextColumn()

Returns

bool

true if successfull.

Implements IGridNavigator.SelectNextColumn()

SelectNextRow(int)

Selects the row at specified distance after the current position as current row in grid

Declaration

cs-api-definition
public virtual bool SelectNextRow(int step)

Parameters

step

int

The distance to the row

Returns

bool

true if successfull.

Implements IGridNavigator.SelectNextRow(int)

SelectOverride(GridViewRowInfo, GridViewColumn)

Selects the override.

Declaration

cs-api-definition
protected virtual bool SelectOverride(GridViewRowInfo row, GridViewColumn column)

Parameters

row

GridViewRowInfo

The row.

column

GridViewColumn

The column.

Returns

bool

SelectPreviousColumn()

Selects the previous column as current column in grid

Declaration

cs-api-definition
public virtual bool SelectPreviousColumn()

Returns

bool

true if successfull.

Implements IGridNavigator.SelectPreviousColumn()

SelectPreviousRow(int)

Selects the row at specified distance before the current position as current row in grid

Declaration

cs-api-definition
public virtual bool SelectPreviousRow(int step)

Parameters

step

int

The distance to the row

Returns

bool

true if successfull.

Implements IGridNavigator.SelectPreviousRow(int)

SelectRow(GridViewRowInfo)

Selects the specified row as current row in grid

Declaration

cs-api-definition
public virtual bool SelectRow(GridViewRowInfo row)

Parameters

row

GridViewRowInfo

The GridViewRowInfo to be selected

Returns

bool

true if successfull.

Implements IGridNavigator.SelectRow(GridViewRowInfo)

SetSelectedCell(GridViewRowInfo, GridViewColumn)

Sets the selected cell.

Declaration

cs-api-definition
protected virtual void SetSelectedCell(GridViewRowInfo row, GridViewColumn column)

Parameters

row

GridViewRowInfo

The row.

column

GridViewColumn

The column.