Class

RadGridViewElement

Initializes a new instance of the RadGridViewElement class. Sets up the grid navigator and initializes core functionality for the grid element.

Declaration

public RadGridViewElement()

Gets the active editor

Declaration

[Browsable(false)]
public IInputEditor ActiveEditor { get; }

Property Value

Gets or sets a value indicating whether row heights will automatically expand to accommodate multiline cell text.

Declaration

[Browsable(true)]
public bool AutoSizeRows { get; set; }

Property Value

Gets or sets a value indicating how the user can initiate cell editing in the grid.

Declaration

[Browsable(true)]
public RadGridViewBeginEditMode BeginEditMode { get; set; }

Property Value

Gets the current column chooser

Declaration

[Browsable(false)]
public GridViewColumnChooser ColumnChooser { get; }

Property Value

Gets or sets the column chooser sort order.

Declaration

[Browsable(false)]
public RadSortOrder ColumnChooserSortOrder { get; set; }

Property Value

Gets an instance of GridViewContextMenuManager or the instance that implements IContextMenuManager interface.

Declaration

[Browsable(false)]
public virtual IContextMenuManager ContextMenuManager { get; }

Property Value

Gets the currently active cell in the grid view.

Declaration

[Browsable(false)]
public GridDataCellElement CurrentCell { get; }

Property Value

Gets or sets the currently selected column in the active grid view.

Declaration

[Browsable(false)]
public GridViewColumn CurrentColumn { get; set; }

Property Value

Gets or sets the currently selected row in the active grid view.

Declaration

[Browsable(false)]
public GridViewRowInfo CurrentRow { get; set; }

Property Value

Gets or sets the current row view responsible for displaying data in the grid.

Declaration

public IRowView CurrentView { get; set; }

Property Value

Gets an instance of GridViewEditManager that defines how to initialize and create cells and editors.

Declaration

[Browsable(false)]
public GridViewEditManager EditorManager { get; set; }

Property Value

Gets or sets a value indicating whether the PaintCell and PaintRow events are enabled.

Declaration

[Browsable(true)]
public bool EnableCustomDrawing { get; set; }

Property Value

Gets or sets value indicating the behavior when the user presses Enter while adding new row.

Declaration

[Browsable(true)]
public RadGridViewEnterKeyMode EnterKeyMode { get; set; }

Property Value

Gets or sets an instance of BaseGridBehavior or the instance that implements IGridBehavior interface.

Declaration

[Browsable(false)]
public virtual IGridBehavior GridBehavior { get; set; }

Property Value

Gets or sets the animation effect used when expanding or collapsing grouped rows.

Declaration

public GridExpandAnimationType GroupExpandAnimationType { get; set; }

Property Value

Gets the group panel element used for displaying grouped columns and allowing drag-drop grouping operations.

Declaration

public GroupPanelElement GroupPanelElement { get; }

Property Value

Gets or sets a value indicating whether the selected item remains highlighted when the control loses focus. When true, selection is hidden when focus is lost; when false, selection remains visible even when the control is not focused.

Declaration

[Browsable(true)]
public bool HideSelection { get; set; }

Property Value

Gets a value indicating whether any cell in the grid is currently in edit mode.

Declaration

[Browsable(false)]
public bool IsInEditMode { get; }

Property Value

Gets an instance of IGridNavigator used to navigate between rows and cells in grid.

Declaration

public IGridNavigator Navigator { get; set; }

Property Value

Gets or sets value indicating the behavior when the user presses Enter while adding new row.

Declaration

[Browsable(true)]
public RadGridViewNewRowEnterKeyMode NewRowEnterKeyMode { get; set; }

Property Value

Gets the paging panel element used for data pagination controls and navigation.

Declaration

public PagingPanelElement PagingPanelElement { get; }

Property Value

Gets the main layout panel used to arrange the grid's child elements.

Declaration

public DockLayoutPanel Panel { get; }

Property Value

Gets or sets a value indicating whether to show cell errors.

Declaration

[Browsable(true)]
public bool ShowCellErrors { get; set; }

Property Value

Gets or sets value indicating whether the GridGroupPanel is visible.

Declaration

[Browsable(true)]
public bool ShowGroupPanel { get; set; }

Property Value

Gets or sets a value indicating whether the group panel displays scrollbars or expands to show all group headers.

Declaration

[Browsable(true)]
public bool ShowGroupPanelScrollbars { get; set; }

Property Value

Gets or sets the text to use when there is no data.

Declaration

[Browsable(true)]
public bool ShowNoDataText { get; set; }

Property Value

Gets or sets a value indicating whether to show row errors.

Declaration

[Browsable(true)]
public bool ShowRowErrors { get; set; }

Property Value

Gets or sets a value indicating how to split RadGridView.

Declaration

[Browsable(true)]
public RadGridViewSplitMode SplitMode { get; set; }

Property Value

Gets or sets a value indicating whether the TAB key moves the focus to the next control in the tab order rather than moving focus to the next cell in the control.

Declaration

[Browsable(true)]
public bool StandardTab { get; set; }

Property Value

Gets or sets whether when changing the current row in one split view the same row in the other split view will be brought into view.

Declaration

[Browsable(true)]
public bool SynchronizeCurrentRowInSplitMode { get; set; }

Property Value

Gets the core table element responsible for rendering the grid data. This is an advanced property intended for internal use or customization scenarios.

Declaration

[Browsable(false)]
public GridTableElement TableElement { get; }

Property Value

Gets the master template that defines the structure and behavior of the grid view.

Declaration

public MasterGridViewTemplate Template { get; }

Property Value

Gets the visual element used to display the grid title.

Declaration

public LightVisualElement TitleLabelElement { get; }

Property Value

Gets or sets the docking position of the grid title within the control.

Declaration

public Dock TitlePosition { get; set; }

Property Value

Gets or sets the text displayed in the grid title. When set to null or empty string, the title element will be collapsed.

Declaration

public string TitleText { get; set; }

Property Value

Gets or sets a value indicating whether each hierarchical level should display its own dedicated vertical scrollbar.

Declaration

public bool UseScrollbarsInHierarchy { get; set; }

Property Value

Arranges the RadElement to its final location. The element must call the Arrange method of each of its children.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides LightVisualElement.ArrangeOverride(SizeF)

Remarks

Puts the current cell in edit mode.

Declaration

public bool BeginEdit()

Returns

Close the currently active editor and discard changes.

Declaration

public bool CancelEdit()

Returns

Ends the edit operation without committing the changes

Declaration

public bool CloseEditor()

Returns

Creates and initializes the child elements of the RadGridViewElement. This method is called during the element's construction process and sets up the internal visual hierarchy.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Returns an instance of GridViewEditManager that defines how to initialize and create cells and editors.

Declaration

protected virtual GridViewEditManager CreateEditorManager()

Returns

Creates the group panel element used for column grouping functionality.

Declaration

protected virtual GroupPanelElement CreateGroupPanelElement()

Returns

Creates the paging panel element used for data pagination functionality.

Declaration

protected virtual PagingPanelElement CreatePagingPanelElement()

Returns

Creates the template.

Declaration

protected virtual MasterGridViewTemplate CreateTemplate()

Returns

Disposes all managed resources used by this element, including event handlers, column choosers, and template listeners.

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Commits any changes and ends the edit operation on the current cell.

Declaration

public bool EndEdit()

Returns

Gets the drag drop service.

Declaration

public RadDragDropService GetDragDropService()

Returns

Gets the row view.

Declaration

public IRowView GetRowView(GridViewInfo viewInfo)

Parameters

Returns

Gets the row views.

Declaration

public IEnumerable<IRowView> GetRowViews(GridViewInfo viewInfo)

Parameters

Returns

Retrieves currently registered RadService by the specified type.

Declaration

public T GetService<T>() where T : RadService

Returns

Implements IRadServiceProvider.GetService<T>()

Hides the GridViewColumnChooser

Declaration

public void HideColumnChooser()

Initializes member fields to their default values. This method is called prior the CreateChildItems one and allows for initialization of members on which child elements depend.

Declaration

protected override void InitializeFields()

Overrides GridVisualElement.InitializeFields()

Raises the event.

Declaration

protected override void OnBoundsChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides UIItemBase.OnBoundsChanged(RadPropertyChangedEventArgs)

Raises the CellFormatting event

Declaration

protected virtual void OnCellFormatting(object sender, CellFormattingEventArgs e)

Parameters

Raises the CellMerging event

Declaration

protected virtual void OnCellMerging(GridViewCellMergingEventArgs e)

Parameters

Called when the column chooser is created.

Declaration

protected virtual void OnColumnChooserCreated(object sender, ColumnChooserCreatedEventArgs e)

Parameters

Raises the CreateCell event.

Declaration

protected virtual void OnCreateCell(object sender, GridViewCreateCellEventArgs e)

Parameters

Raises the CreateRow event.

Declaration

protected virtual void OnCreateRow(object sender, GridViewCreateRowEventArgs e)

Parameters

Raises the CurrentViewChanged event

Declaration

protected virtual void OnCurrentViewChanged(GridViewCurrentViewChangedEventArgs e)

Parameters

Called when the element is loaded into the element tree. Initializes binding context and event handlers.

Declaration

protected override void OnLoaded()

Overrides LightVisualElement.OnLoaded()

Raises the RowFormatting event.

Declaration

protected void OnRowFormatting(object sender, RowFormattingEventArgs e)

Parameters

Called when the user manually changes the current row selection.

Declaration

protected virtual void OnUserChangedCurrentRow(object sender, EventArgs e)

Parameters

Raises the ViewCellFormatting event

Declaration

protected virtual void OnViewCellFormatting(object sender, CellFormattingEventArgs e)

Parameters

Raises the ViewRowFormatting event.

Declaration

protected void OnViewRowFormatting(object sender, RowFormattingEventArgs e)

Parameters

Declaration

protected virtual GridViewEventResult ProcessTemplatePropertyChangedEvent(GridViewEvent eventData)

Parameters

Returns

Declaration

protected virtual GridViewEventResult ProcessTemplatePropertyChanging(GridViewEvent eventData)

Parameters

Returns

Processes the view changed event.

Declaration

protected virtual GridViewEventResult ProcessViewChangedEvent(GridViewEvent eventData)

Parameters

Returns

Registers the specified service.

Declaration

public void RegisterService(RadService service)

Parameters

Implements IRadServiceProvider.RegisterService(RadService)

Shows the GridViewColumnChooser for the columns of the master view template.

Declaration

public void ShowColumnChooser()

Shows the GridViewColumnChooser.

Declaration

public void ShowColumnChooser(GridViewTemplate template)

Parameters

Fires when the content of a data cell needs to be formatted for display.

Declaration

[Browsable(true)]
public event CellFormattingEventHandler CellFormatting

Event Value

Fires when the two neighbor cells are compared and about to be merged.

Declaration

[Browsable(true)]
public event GridViewCellMergingEventHandler CellMerging

Event Value

Fires when a ColumnChooserCreated is created.

Declaration

[Browsable(true)]
public event ColumnChooserCreatedEventHandler ColumnChooserCreated

Event Value

Fires when a cell needs to be created.

Declaration

[Browsable(true)]
public event GridViewCreateCellEventHandler CreateCell

Event Value

Fires when a row needs to be created.

Declaration

[Browsable(true)]
public event GridViewCreateRowEventHandler CreateRow

Event Value

Fires when the current view in RadGridView has changed.

Declaration

[Browsable(true)]
public event GridViewCurrentViewChangedEventHandler CurrentViewChanged

Event Value

Fires when a data row is invalidated and needs to be formatted.

Declaration

[Browsable(true)]
public event RowFormattingEventHandler RowFormatting

Event Value

Example

void radGridView1_RowFormatting(object sender, RowFormattingEventArgs e) 
{ 
    if (e.RowElement.RowInfo.Cells.Count > 0 && (string)e.RowElement.RowInfo.Cells[0].Value == "3") 
        e.RowElement.Font = strikeoutFont; 
    else 
        e.RowElement.Font = SystemFonts.DialogFont; 
}

Fires when the content of any grid cell needs to be formatted for display.

Declaration

[Browsable(true)]
public event CellFormattingEventHandler ViewCellFormatting

Event Value

Fires when a grid row is invalidated and needs to be formatted.

Declaration

[Browsable(true)]
public event RowFormattingEventHandler ViewRowFormatting

Event Value