Interface IGridCellRenderer

Provides an interface for GridCellRendererBase for the cell renderers.

Inherited Members

ICellRenderer.Arrange(ArrangeCellArgs)

ICellRenderer.CancelMouseCapture(UIElement)

ICellRenderer.Hide(UIElement)

ICellRenderer.PrepareUIElements(ArrangeCellArgs, List<UIElement>, ScrollControlChildFrame)

ICellRenderer.RecaptureMouse(UIElement)

ICellRenderer.RefreshCellUIElementsContent(VirtualizingCellsControl, CellUIElements, RowColumnIndex)

ICellRenderer.Render(DrawingContext, RenderCellArgs)

ICellRenderer.UnloadUIElements(VirtualizingCellsControl, RowColumnIndex, CellUIElements)

ICellRenderer.UnloadUIElementsWhenScrolledOutOfView

System.IDisposable.Dispose()

Namespace: Syncfusion.Windows.Controls.Grid

Assembly: Syncfusion.Grid.Wpf.dll

Syntax

public interface IGridCellRenderer : ICellRenderer, IDisposable

Properties

ActivateOptions

Provides various activation options for the cell.

Declaration

GridActivateCurrentCellOptions ActivateOptions { get; }

Property Value

Type
GridActivateCurrentCellOptions

AllowGridToFocus

Gets or sets a value indicating whether [allow grid to focus].

Declaration

bool AllowGridToFocus { get; set; }

Property Value

Type	Description
System.Boolean	true if [allow grid to focus]; otherwise, false.

CellModel

Gets the cell model.

Declaration

GridCellModelBase CellModel { get; }

Property Value

Type
GridCellModelBase

CellRowColumnIndex

Returns the cell's row column index.

Declaration

RowColumnIndex CellRowColumnIndex { get; }

Property Value

Type
RowColumnIndex

ColumnIndex

Returns the column index of the cell.

Declaration

int ColumnIndex { get; }

Property Value

Type
System.Int32

ControlText

Gets or sets the active text that is displayed for the current cell, e.g. TextBox.Text.

Declaration

string ControlText { get; set; }

Property Value

Type
System.String

ControlValue

Gets or sets the cell value for the current cell.

Declaration

object ControlValue { get; set; }

Property Value

Type
System.Object

CurrentCell

Returns the current cell.

Declaration

GridCurrentCell CurrentCell { get; }

Property Value

Type
GridCurrentCell

CurrentCellUIElement

Returns the UI element of current cell.

Declaration

UIElement CurrentCellUIElement { get; }

Property Value

Type
System.Windows.UIElement

CurrentStyle

Returns current cell style.

Declaration

GridRenderStyleInfo CurrentStyle { get; }

Property Value

Type
GridRenderStyleInfo

GridControl

Gets or sets the parent grid.

Declaration

GridControlBase GridControl { get; set; }

Property Value

Type
GridControlBase

HasControlText

Checks if ControlText for the current cell has been set.

Declaration

bool HasControlText { get; }

Property Value

Type
System.Boolean

HasControlValue

Returns whether the cell value for the current cell has been changed.

Declaration

bool HasControlValue { get; }

Property Value

Type
System.Boolean

HasCurrentCellState

Specifies whether the cell state for the current cell has been set.

Declaration

bool HasCurrentCellState { get; }

Property Value

Type
System.Boolean

IsControlTextShown

Gets or sets a value that indicates whether the ControlText is shown in the cell.

Declaration

bool IsControlTextShown { get; set; }

Property Value

Type
System.Boolean

IsDropDownable

Gets or sets a value that indicates whether the cell can be dropped down.

Declaration

bool IsDropDownable { get; set; }

Property Value

Type
System.Boolean

IsDroppedDown

Specifies whether the current cell is dropped down.

Declaration

bool IsDroppedDown { get; set; }

Property Value

Type
System.Boolean

IsEditable

Gets or sets a value that indicates whether the cell is editable.

Declaration

bool IsEditable { get; set; }

Property Value

Type
System.Boolean

IsFocusable

Gets or sets a value that indicates whether the cell is focusable.

Declaration

bool IsFocusable { get; set; }

Property Value

Type
System.Boolean

IsFocused

Gets or sets a value that indicates whether the cell has the focus.

Declaration

bool IsFocused { get; set; }

Property Value

Type
System.Boolean

IsModifiable

Gets or sets a value that indicates whether the cell is modifiable.

Declaration

bool IsModifiable { get; set; }

Property Value

Type
System.Boolean

IsModified

Specifies wheter the cell has been modified.

Declaration

bool IsModified { get; }

Property Value

Type
System.Boolean

RowIndex

Returns the row index of the cell.

Declaration

int RowIndex { get; }

Property Value

Type
System.Int32

SupportsRenderOptimization

Gets or sets whether the renderer supports rendering itsself directly to the drawing context.

Declaration

bool SupportsRenderOptimization { get; set; }

Property Value

Type
System.Boolean

Methods

EmptyRecycleBin()

Empties the recyclebin.

Declaration

void EmptyRecycleBin()

IsCurrentCell(GridControlBase, RowColumnIndex)

Determines whether the given cell coordinates represent the current cell.

Declaration

bool IsCurrentCell(GridControlBase grid, RowColumnIndex pos)

Parameters

Type	Name	Description
GridControlBase	grid
RowColumnIndex	pos

Returns

Type	Description
System.Boolean	True if it is current cell; false otherwise.

IsCurrentCell(GridRenderStyleInfo)

Determines whether the given cell style represents the current cell.

Declaration

bool IsCurrentCell(GridRenderStyleInfo style)

Parameters

Type	Name	Description
GridRenderStyleInfo	style	Cell style information.

Returns

Type	Description
System.Boolean	True if it is current cell; false otherwise.

IsCurrentCell(UIElement)

Determines whether the given cell element corresponds to the current cell.

Declaration

bool IsCurrentCell(UIElement uiElement)

Parameters

Type	Name	Description
System.Windows.UIElement	uiElement	The cell control.

Returns

Type	Description
System.Boolean	True if it is current cell; false otherwise.

OnCreateAutomationPeer()

Declaration

AutomationPeer OnCreateAutomationPeer()

Returns

Type
System.Windows.Automation.Peers.AutomationPeer

RaiseActivated()

Occurs when the cell has been activated.

Declaration

void RaiseActivated()

RaiseActivateFailed()

Occurs when activation of cell has been failed.

Declaration

void RaiseActivateFailed()

RaiseActivating(GridControlBase, RowColumnIndex, GridActivateCurrentCellOptions)

Occurs when the cell is being activated.

Declaration

bool RaiseActivating(GridControlBase gridControlBase, RowColumnIndex rowColumnIndex, GridActivateCurrentCellOptions options)

Parameters

Type	Name	Description
GridControlBase	gridControlBase	The grid.
RowColumnIndex	rowColumnIndex	Cell row column index.
GridActivateCurrentCellOptions	options	Activation options for current cell.

Returns

Type	Description
System.Boolean	True if the cell has been activated successfully; false otherwise.

RaiseBeginEdit()

Occurs when the cell switches to editing mode.

Declaration

void RaiseBeginEdit()

RaiseClipboardPaste(GridCutPasteEventArgs)

Occurs when Clipboard Paste.

Declaration

void RaiseClipboardPaste(GridCutPasteEventArgs args)

Parameters

Type	Name	Description
GridCutPasteEventArgs	args

RaiseClipboardPasted(GridCutPasteEventArgs)

Occurs After Clipboard Paste.

Declaration

void RaiseClipboardPasted(GridCutPasteEventArgs args)

Parameters

Type	Name	Description
GridCutPasteEventArgs	args

RaiseConfirmChangesFailed()

Raises event.

Declaration

void RaiseConfirmChangesFailed()

RaiseCreated(GridCellModelBase)

Occurs when the cell model is created.

Declaration

void RaiseCreated(GridCellModelBase cellModel)

Parameters

Type	Name	Description
GridCellModelBase	cellModel	The cell model.

RaiseDeactivated()

Occurs when the cell has been deactivated successfully.

Declaration

void RaiseDeactivated()

RaiseDeactivateFailed()

Occurs when the cell deactivation is failed.

Declaration

void RaiseDeactivateFailed()

RaiseDeactivating()

Occurs when the cell is being deactivated.

Declaration

bool RaiseDeactivating()

Returns

Type	Description
System.Boolean	True if the cell has been deactivated successfully; false otherwise.

RaiseEditingComplete()

Occurs once the grid completes the editing mode for the cell.

Declaration

void RaiseEditingComplete()

RaiseEndEdit()

Occurs when the editing mode ends for the cell.

Declaration

void RaiseEndEdit()

RaiseGridCellClick(Int32, Int32, MouseControllerEventArgs)

Raises CellClick event.

Declaration

void RaiseGridCellClick(int rowIndex, int colIndex, MouseControllerEventArgs e)

Parameters

Type	Name	Description
System.Int32	rowIndex	Row index.
System.Int32	colIndex	Column index.
MouseControllerEventArgs	e	The that contains the event data.

RaiseGridPreviewMouseMove(RowColumnIndex, MouseEventArgs)

Raises PreviewMouseMove event.

Declaration

void RaiseGridPreviewMouseMove(RowColumnIndex rci, MouseEventArgs e)

Parameters

Type	Name	Description
RowColumnIndex	rci	The cell row column index.
System.Windows.Input.MouseEventArgs	e	The System.Windows.Input.MouseEventArgs that contains the event data.

RaiseGridPreviewTextInput(TextCompositionEventArgs)

Occurs before the cell shifts into editing mode.

Declaration

void RaiseGridPreviewTextInput(TextCompositionEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.TextCompositionEventArgs	e	A System.Windows.Input.TextCompositionEventArgs object.

RaiseInitialize(GridActivateCurrentCellOptions)

Occurs when the cell is getting initialized.

Declaration

void RaiseInitialize(GridActivateCurrentCellOptions options)

Parameters

Type	Name	Description
GridActivateCurrentCellOptions	options	Activation options for the current cell.

RaiseRejectChanges()

Occurs when the changes that are done in the cell are rejected.

Declaration

void RaiseRejectChanges()

RaiseSaveChanges()

Occurs when the changes that are done in the cell are saved.

Declaration

bool RaiseSaveChanges()

Returns

Type	Description
System.Boolean	True if the changed content are saved successfully; false otherwise.

RaiseStartEditing()

Occurs when the cell gets started editing.

Declaration

bool RaiseStartEditing()

Returns

Type	Description
System.Boolean	True

RaiseValidate()

Occurs when the cell is validated.

Declaration

bool RaiseValidate()

Returns

Type	Description
System.Boolean	True if the cell has been validated successfully.

RaiseValidated()

Occurs when the cell has been validated.

Declaration

void RaiseValidated()

RefreshContent()

Refreshes the current cell.

Declaration

void RefreshContent()

RenderForPrinting(DrawingContext, RenderCellArgs, GridRenderStyleInfo)

force to render graphics while printing that do not belong to live controls and the cells which is not view (e.g. static text). implements this method and calls the virtual method.

Declaration

void RenderForPrinting(DrawingContext dc, RenderCellArgs rca, GridRenderStyleInfo style)

Parameters

Type	Name	Description
System.Windows.Media.DrawingContext	dc	The drawing context.
RenderCellArgs	rca	The render cell layout information.
GridRenderStyleInfo	style	The cell style info.

ResetControlText()

Resets the ControlText to its original state.

Declaration

void ResetControlText()

ResetControlValue()

Resets the cell value of the current cell to its original state.

Declaration

void ResetControlValue()

SetControlText(String)

Sets the given value as control text for the cell.

Declaration

bool SetControlText(string value)

Parameters

Type	Name	Description
System.String	value	The value.

Returns

Type	Description
System.Boolean	True if the control text has been set successfully; false otherwise.

SetControlText(String, Boolean)

Sets the given value as control text for the cell.

Declaration

bool SetControlText(string value, bool enforceApplyControlText)

Parameters

Type	Name	Description
System.String	value	The value.
System.Boolean	enforceApplyControlText	When true, enforces applying control text.

Returns

Type	Description
System.Boolean	True if the control text has been set successfully; false otherwise.

ShouldGridTryToHandlePreviewKeyDown(KeyEventArgs)

Let Renderer decide whether the parent grid should be allowed to handle keys and prevent the key event from being handled by the visual UIElement for this renderer. If this method returns true the parent grid will handle arrow keys and set the Handled flag in the event data. Keys that the grid does not handle will be ignored and be routed to the UIElement for this renderer.

Declaration

bool ShouldGridTryToHandlePreviewKeyDown(KeyEventArgs e)

Parameters

Type	Name	Description
System.Windows.Input.KeyEventArgs	e	A System.Windows.Input.KeyEventArgs object.

Returns

Type	Description
System.Boolean	True if the parent grid should be allowed to handle keys; false otherwise.

UpdateCellRowColumnIndex(RowColumnIndex)

Updates the cell row column index with the given value

Declaration

void UpdateCellRowColumnIndex(RowColumnIndex cellRowColumnIndex)

Parameters

Type	Name	Description
RowColumnIndex	cellRowColumnIndex	The cell row column index.

UpdateCurrentStyle()

Declaration

void UpdateCurrentStyle()