Class
BaseGridBehavior

This class is a message filter for RadGridView and handles mouse and keyboard events

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:

cs-api-definition
public class BaseGridBehavior : SplitGridBehavior, IGridBehavior, IDisposable

Inheritance: objectGridBehaviorImplSplitGridBehaviorBaseGridBehavior

Derived Classes: MultiColumnComboGridBehavior

Implements: IDisposableIGridBehavior

Inherited Members SplitGridBehavior.OnMouseEnter(EventArgs)SplitGridBehavior.GetGridTableElementAtPoint(Point)GridBehaviorImpl.GridViewElementGridBehaviorImpl.GridControl

Constructors

BaseGridBehavior()

Initializes a new instance of the BaseGridBehavior class.

Declaration

cs-api-definition
public BaseGridBehavior()

Properties

CellAtPoint

Gets the cell at point.

Declaration

cs-api-definition
public GridCellElement CellAtPoint { get; }

Property Value

GridCellElement

The cell at point.

DefaultRowBehavior

Gets the default row behavior.

Declaration

cs-api-definition
public virtual IGridBehavior DefaultRowBehavior { get; }

Property Value

IGridBehavior

The default row behavior.

LockedBehavior

Gets the locked behavior.

Declaration

cs-api-definition
public IGridBehavior LockedBehavior { get; }

Property Value

IGridBehavior

The locked behavior.

OriginalCursor

Gets or sets the original control cursor.

Declaration

cs-api-definition
public Cursor OriginalCursor { get; set; }

Property Value

Cursor

The original cursor.

RowAtPoint

Gets the row at point.

Declaration

cs-api-definition
public GridRowElement RowAtPoint { get; }

Property Value

GridRowElement

The row at point.

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

cs-api-definition
public void Dispose()

Implements IDisposable.Dispose()

Dispose(bool)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

cs-api-definition
protected virtual void Dispose(bool disposing)

Parameters

disposing

bool

The disposing.

GetBehavior(Type)

Gets an instance of IGridBehavior for specified GridViewRowInfo type.

Declaration

cs-api-definition
public virtual IGridBehavior GetBehavior(Type rowType)

Parameters

rowType

Type

A type inherited from GridViewRowInfo.

Returns

IGridBehavior

Returns an instance of IGridBehavior

GetCurrentRowBehavior()

Gets the current row behavior.

Declaration

cs-api-definition
protected virtual IGridBehavior GetCurrentRowBehavior()

Returns

IGridBehavior

GetFirstScrollableRow(GridTableElement, bool)

Gets the first scrollable row.

Declaration

cs-api-definition
protected GridViewRowInfo GetFirstScrollableRow(GridTableElement tableElement, bool checkBounds)

Parameters

tableElement

GridTableElement

The table element.

checkBounds

bool

if set to true [check bounds].

Returns

GridViewRowInfo

GetLastScrollableRow(GridTableElement)

Gets the last scrollable row.

Declaration

cs-api-definition
protected GridViewRowInfo GetLastScrollableRow(GridTableElement tableElement)

Parameters

tableElement

GridTableElement

The table element.

Returns

GridViewRowInfo

GetRowBehaviorAtPoint(Point)

Gets the row behavior at point.

Declaration

cs-api-definition
protected virtual IGridBehavior GetRowBehaviorAtPoint(Point point)

Parameters

point

Point

The point.

Returns

IGridBehavior

Initialize(RadGridViewElement)

Initializes the IGridBehavior with the specified RadGridViewElement

Declaration

cs-api-definition
public override void Initialize(RadGridViewElement gridRootElement)

Parameters

gridRootElement

RadGridViewElement

Overrides GridBehaviorImpl.Initialize(RadGridViewElement)

LockBehavior(IGridBehavior)

Locks the specified behavior.

Declaration

cs-api-definition
public virtual void LockBehavior(IGridBehavior behavior)

Parameters

behavior

IGridBehavior

The behavior.

NavigateToPage(GridViewRowInfo, Keys)

Navigates to page.

Declaration

cs-api-definition
protected virtual void NavigateToPage(GridViewRowInfo row, Keys keys)

Parameters

row

GridViewRowInfo

The row.

keys

Keys

The keys.

OnClick(EventArgs)

Raises the event.

Declaration

cs-api-definition
public override bool OnClick(EventArgs e)

Parameters

e

EventArgs

The EventArgs instance containing the event data.

Returns

bool

Overrides SplitGridBehavior.OnClick(EventArgs)

OnContextMenu(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
public override bool OnContextMenu(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

Returns

bool

Overrides SplitGridBehavior.OnContextMenu(MouseEventArgs)

OnDoubleClick(EventArgs)

Raises the event.

Declaration

cs-api-definition
public override bool OnDoubleClick(EventArgs e)

Parameters

e

EventArgs

The EventArgs instance containing the event data.

Returns

bool

Overrides SplitGridBehavior.OnDoubleClick(EventArgs)

OnMouseDoubleClick(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
public override bool OnMouseDoubleClick(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

Returns

bool

Overrides SplitGridBehavior.OnMouseDoubleClick(MouseEventArgs)

OnMouseDown(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
public override bool OnMouseDown(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

Returns

bool

Overrides SplitGridBehavior.OnMouseDown(MouseEventArgs)

OnMouseDownLeft(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual bool OnMouseDownLeft(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

Returns

bool

OnMouseDownRight(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
protected virtual bool OnMouseDownRight(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

Returns

bool

OnMouseLeave(EventArgs)

Occurs when the mouse pointer leaves the RadGridView.

Declaration

cs-api-definition
public override bool OnMouseLeave(EventArgs e)

Parameters

e

EventArgs

Type: System.EventArgs

Returns

bool

Returns true if the event is processed

Overrides SplitGridBehavior.OnMouseLeave(EventArgs)

OnMouseMove(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
public override bool OnMouseMove(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

Returns

bool

Overrides SplitGridBehavior.OnMouseMove(MouseEventArgs)

OnMouseUp(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
public override bool OnMouseUp(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

Returns

bool

Overrides SplitGridBehavior.OnMouseUp(MouseEventArgs)

OnMouseWheel(MouseEventArgs)

Raises the event.

Declaration

cs-api-definition
public override bool OnMouseWheel(MouseEventArgs e)

Parameters

e

MouseEventArgs

The MouseEventArgs instance containing the event data.

Returns

bool

Overrides SplitGridBehavior.OnMouseWheel(MouseEventArgs)

ProcessKey(KeyEventArgs)

Processes the key.

Declaration

cs-api-definition
public override bool ProcessKey(KeyEventArgs keys)

Parameters

keys

KeyEventArgs

The KeyEventArgs instance containing the event data.

Returns

bool

Overrides SplitGridBehavior.ProcessKey(KeyEventArgs)

ProcessKeyDown(KeyEventArgs)

Processes the key down.

Declaration

cs-api-definition
public override bool ProcessKeyDown(KeyEventArgs keys)

Parameters

keys

KeyEventArgs

The KeyEventArgs instance containing the event data.

Returns

bool

Overrides SplitGridBehavior.ProcessKeyDown(KeyEventArgs)

ProcessKeyPress(KeyPressEventArgs)

Processes the key press.

Declaration

cs-api-definition
public override bool ProcessKeyPress(KeyPressEventArgs keys)

Parameters

keys

KeyPressEventArgs

The KeyPressEventArgs instance containing the event data.

Returns

bool

Overrides SplitGridBehavior.ProcessKeyPress(KeyPressEventArgs)

ProcessKeyUp(KeyEventArgs)

Processes the key up.

Declaration

cs-api-definition
public override bool ProcessKeyUp(KeyEventArgs keys)

Parameters

keys

KeyEventArgs

The KeyEventArgs instance containing the event data.

Returns

bool

Overrides SplitGridBehavior.ProcessKeyUp(KeyEventArgs)

ProcessPageDownKey(KeyEventArgs)

Processes the PageDown key

Declaration

cs-api-definition
protected virtual bool ProcessPageDownKey(KeyEventArgs keys)

Parameters

keys

KeyEventArgs

The KeyPressEventArgs containing data related to this event

Returns

bool

Returns true if the event is processed

ProcessPageUpKey(KeyEventArgs)

Processes the PageUp key

Declaration

cs-api-definition
protected virtual bool ProcessPageUpKey(KeyEventArgs keys)

Parameters

keys

KeyEventArgs

The KeyPressEventArgs containing data related to this event

Returns

bool

Returns true if the event is processed

RegisterBehavior(Type, IGridBehavior)

Registers IGridBehavior instance for specified row type

Declaration

cs-api-definition
public virtual void RegisterBehavior(Type rowType, IGridBehavior rowBehavior)

Parameters

rowType

Type

A type inherited from GridViewRowInfo.

rowBehavior

IGridBehavior

An instance of IGridBehavior.

UnlockBehavior(IGridBehavior)

Unlocks the behavior.

Declaration

cs-api-definition
public virtual void UnlockBehavior(IGridBehavior behavior)

Parameters

behavior

IGridBehavior

The behavior.

UnregisterBehavior(Type)

Unregisters IGridBehavior instance for specified row type

Declaration

cs-api-definition
public virtual bool UnregisterBehavior(Type rowType)

Parameters

rowType

Type

A type inherited from GridViewRowInfo.

Returns

bool

Returns true if succeed, otherwise false.

~BaseGridBehavior()

Declaration

cs-api-definition
protected ~BaseGridBehavior()