New to Telerik UI for WPF? Start a free 30-day trial

RadGridView

Class

Provides AI-assisted behaviors for the RadGridView control.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.GridView.dll

Syntax:

[Themable]
[TelerikToolboxCategory("Data")]
public class RadGridView : GridViewDataControl, INotifyPropertyChanged, IScrollingServiceCore, IScrollingInfo

Inheritance: objectDataControlBaseItemsControlGridViewDataControlRadGridView

Derived Classes: FileBrowserGridView

Implements: INotifyPropertyChangedIScrollingInfoIScrollingServiceCore

Constructors

RadGridView()

Initializes a new instance of the RadGridView class.

public RadGridView()

Fields

AISettingsProperty

DependencyProperty

Identifies the AISettings dependency property.

public static readonly DependencyProperty AISettingsProperty

CancelPromptRequestCommandProperty

DependencyProperty

Identifies the CancelPromptRequestCommand property.

public static readonly DependencyProperty CancelPromptRequestCommandProperty

CanUserGroupColumnsProperty

DependencyProperty

Identifies the CanUserGroupColumnsProperty dependency property.

public static readonly DependencyProperty CanUserGroupColumnsProperty

CanUserSearchInHiddenColumnsProperty

DependencyProperty

Represents the CanUserSearchInHiddenColumns DependencyProperty.

public static readonly DependencyProperty CanUserSearchInHiddenColumnsProperty

CanUserSearchProperty

DependencyProperty

Identifies the CanUserSearch dependency property.

public static readonly DependencyProperty CanUserSearchProperty

CanUserSelectColumnsProperty

DependencyProperty

Identifies the CanUserSelectColumns dependency property.

public static readonly DependencyProperty CanUserSelectColumnsProperty

ColumnAggregatesAlignmentProperty

DependencyProperty

Represents the ColumnAggregatesAlignment dependency property.

public static readonly DependencyProperty ColumnAggregatesAlignmentProperty

ColumnsSelectionButtonVisibilityProperty

DependencyProperty

Identifies the ColumnsSelectionButtonVisibility dependency property.

public static readonly DependencyProperty ColumnsSelectionButtonVisibilityProperty

EnableStickyGroupHeadersProperty

DependencyProperty

Represents the EnableStickyGroupHeaders DependencyProperty.

public static readonly DependencyProperty EnableStickyGroupHeadersProperty

GroupHeaderRowMinHeightProperty

DependencyProperty

Identifies the GroupHeaderRowMinHeight dependency property.

public static readonly DependencyProperty GroupHeaderRowMinHeightProperty

IsAIEnabledProperty

DependencyProperty

Identifies the IsAIEnabled dependency property.

public static readonly DependencyProperty IsAIEnabledProperty

PromptRequestCommandProperty

DependencyProperty

Identifies the PromptRequestCommand property.

public static readonly DependencyProperty PromptRequestCommandProperty

SearchModeProperty

DependencyProperty

Identifies the SearchMode dependency property.

public static readonly DependencyProperty SearchModeProperty

Properties

AISettings

GridViewAISettings

Gets or sets the AI configuration settings for the grid.

public GridViewAISettings AISettings { get; set; }

CancelPromptRequestCommand

ICommand

Gets the command that is executed when a cancel prompt request is made.

public ICommand CancelPromptRequestCommand { get; }

CanUserGroupColumns

bool

Gets or sets a value indicating whether the columns can be grouped.

public bool CanUserGroupColumns { get; set; }

CanUserSearch

bool

Gets or sets a value that indicates whether the user can open the SearchPanel by using the Ctrl+F combination.

public bool CanUserSearch { get; set; }

CanUserSearchInHiddenColumns

bool

Gets or sets a value that indicates whether search will seek for results in hidden columns.

public bool CanUserSearchInHiddenColumns { get; set; }

CanUserSelectColumns

bool

Gets or sets a value that indicates whether the user can select columns.

public bool CanUserSelectColumns { get; set; }

Property Value:

true if the user can select columns; otherwise, false. The default is false.

ColumnAggregatesAlignment

Gets or sets a value that indicates the layout mode for column aggregate results.

public ColumnAggregatesAlignment ColumnAggregatesAlignment { get; set; }

ColumnsSelectionButtonVisibility

Visibility

Gets or sets a value that indicates whether the ColumnsSelection button is visible.

public Visibility ColumnsSelectionButtonVisibility { get; set; }

Property Value:

ColumnsSelection button visibility.

EnableStickyGroupHeaders

bool

Gets or sets a value that indicates whether group headers will stay on top while scrolling through their items. Requires GroupRenderMode.Flat.

public bool EnableStickyGroupHeaders { get; set; }

GroupHeaderRowMinHeight

double

Gets or sets the MinHeight for all GroupHeaderRow elements. Only applicable when the GroupRenderMode is Flat.

public double GroupHeaderRowMinHeight { get; set; }

Property Value:

The MinHeight of the GroupHeaderRows, in device-independent units. The registered default is double.NaN.

Remarks:

When the value is double.NaN, which is the default, the MinHeight of the GroupHeaderRow for the current theme is used. When you set a value for the GroupHeaderRowMinHeight property, it must be equal to or greater than 0.0. Double.PositiveInfinity is not a valid value for this property.

IsAIEnabled

bool

Gets or sets a value indicating whether AI features are enabled for the grid.

public bool IsAIEnabled { get; set; }

PromptRequestCommand

ICommand

Gets the command that is executed when a prompt request is made.

public ICommand PromptRequestCommand { get; }

SearchMode

Gets or sets a value that represents the matching behavior when search operation is executed.

public SearchMode SearchMode { get; set; }

Methods

CreateTableDefinition()

TableDefinition

Creates the specific table definition for the DataControl.

protected override TableDefinition CreateTableDefinition()

Returns:

TableDefinition

The newly created TableDefinition.

Overrides: GridViewDataControl.CreateTableDefinition()

OnApplyTemplate()

public override void OnApplyTemplate()

Overrides: GridViewDataControl.OnApplyTemplate()

OnCancelPromptRequest()

Raises the CancelPromptRequest event.

protected virtual void OnCancelPromptRequest()

OnCreateAutomationPeer()

AutomationPeer

protected override AutomationPeer OnCreateAutomationPeer()

Returns:

AutomationPeer

OnGotFocus(RoutedEventArgs)

protected override void OnGotFocus(RoutedEventArgs e)

Parameters:eRoutedEventArgs

Overrides: GridViewDataControl.OnGotFocus(RoutedEventArgs)

OnHandlePromptRequest(GridViewPromptRequestCommandEventArgs)

Raises the HandlePromptRequest event.

protected virtual void OnHandlePromptRequest(GridViewPromptRequestCommandEventArgs context)

Parameters:contextGridViewPromptRequestCommandEventArgs

The prompt request context.

OnInitialized(EventArgs)

protected override void OnInitialized(EventArgs e)

Parameters:eEventArgs

Overrides: GridViewDataControl.OnInitialized(EventArgs)

PrepareContainerForItemOverride(DependencyObject, object)

Prepares the specified element to display the specified item.

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters:elementDependencyObjectitemobject

Overrides: GridViewDataControl.PrepareContainerForItemOverride(DependencyObject, object)

ResetTheme()

Resets the theme of the RadGridView to change it or to invalidate it.

public void ResetTheme()

SelectCellRegion(CellRegion)

Selects specified region of cells.

public void SelectCellRegion(CellRegion cellRegion)

Parameters:cellRegionCellRegion

SelectCellRegion(IEnumerable<CellRegion>)

Selects specified region of cells.

public void SelectCellRegion(IEnumerable<CellRegion> cellRegions)

Parameters:cellRegionsIEnumerable<CellRegion>

UnselectCellRegion(CellRegion)

Deselects specified region of cells.

public void UnselectCellRegion(CellRegion cellRegion)

Parameters:cellRegionCellRegion

UnselectCellRegion(IEnumerable<CellRegion>)

Deselects specified region of cells.

public void UnselectCellRegion(IEnumerable<CellRegion> cellRegions)

Parameters:cellRegionsIEnumerable<CellRegion>

Events

CancelPromptRequest

EventHandler

Occurs when cancellation of an AI prompt request is raised.

public event EventHandler CancelPromptRequest

HandlePromptRequest

EventHandler<GridViewPromptRequestCommandEventArgs>

Occurs when an AI prompt request is raised.

public event EventHandler<GridViewPromptRequestCommandEventArgs> HandlePromptRequest