Class
GridViewInfo

This class contains logical information about visual presentation of flat tabular data in RadGridView.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:

cs-api-definition
[TypeConverter(typeof(ExpandableObjectConverter))]
public class GridViewInfo

Inheritance: objectGridViewInfo

Constructors

GridViewInfo(GridViewTemplate)

Initializes a new instance of the GridViewInfo class.

Declaration

cs-api-definition
public GridViewInfo(GridViewTemplate ownerTemplate)

Parameters

ownerTemplate

GridViewTemplate

The GridViewTemplate which this view corresponds to.

GridViewInfo(GridViewTemplate, GridViewHierarchyRowInfo)

Initializes a new instance of the GridViewInfo class.

Declaration

cs-api-definition
public GridViewInfo(GridViewTemplate ownerTemplate, GridViewHierarchyRowInfo parentRow)

Parameters

ownerTemplate

GridViewTemplate

The owner template that this view corresponds to.

parentRow

GridViewHierarchyRowInfo

The parent row in a hierarchical structure.

Properties

ChildRows

Gets the rows in this view.

Declaration

cs-api-definition
public GridViewChildRowCollection ChildRows { get; }

Property Value

GridViewChildRowCollection

The collection of child rows.

CurrentIndex

Gets the index of the CurrentRow in the currently selected group.

Declaration

cs-api-definition
[Browsable(false)]
public int CurrentIndex { get; }

Property Value

int

The zero-based index of the current row, or -1 if there is no current row.

CurrentRow

Gets or sets the current row of the current view.

Declaration

cs-api-definition
[Browsable(false)]
public GridViewRowInfo CurrentRow { get; set; }

Property Value

GridViewRowInfo

The current row, or null if no row is current.

NeedsRefresh

Gets a value that indicates whether the ChildRows collection of GridViewInfo needs to be refreshed.

Declaration

cs-api-definition
public virtual bool NeedsRefresh { get; }

Property Value

bool

true if the child rows need to be refreshed; otherwise, false.

ParentRow

Gets the parent GridViewRowInfo which the current view is linked to.

Declaration

cs-api-definition
[Browsable(false)]
public GridViewHierarchyRowInfo ParentRow { get; }

Property Value

GridViewHierarchyRowInfo

The parent row in a hierarchical structure, or null if this is the root view.

PinnedRows

Gets a readonly collection of GridViewRowInfo containing the pinned rows in this view.

Declaration

cs-api-definition
public GridViewPinnedRowCollection PinnedRows { get; }

Property Value

GridViewPinnedRowCollection

The collection of pinned rows.

Rows

Gets the rows in this view.

Declaration

cs-api-definition
public GridViewChildRowCollection Rows { get; }

Property Value

GridViewChildRowCollection

The collection of rows.

SummaryRows

Gets a readonly collection of GridViewSummaryRowInfo containing the summary rows in this view.

Declaration

cs-api-definition
public GridViewSummaryRowCollection SummaryRows { get; }

Property Value

GridViewSummaryRowCollection

The collection of summary rows.

SystemRows

Gets a readonly collection of GridViewRowInfo containing the system rows in this view.

Declaration

cs-api-definition
[Browsable(false)]
public GridViewSystemRowCollection SystemRows { get; }

Property Value

GridViewSystemRowCollection

The collection of system rows including header, filtering, search, and add new rows.

TableAddNewRow

Gets the instance of GridViewNewRowInfo for the current view. This row represents the row which is used by users to add new data.

Declaration

cs-api-definition
[Browsable(false)]
public GridViewNewRowInfo TableAddNewRow { get; }

Property Value

GridViewNewRowInfo

The table add new row information.

TableFilteringRow

Gets the instance of GridViewFilteringRowInfo representing the filtering row for the current view.

Declaration

cs-api-definition
[Browsable(false)]
public GridViewFilteringRowInfo TableFilteringRow { get; }

Property Value

GridViewFilteringRowInfo

The table filtering row information.

TableHeaderRow

Gets the instance of GridViewTableHeaderRowInfo representing the header row for the current view.

Declaration

cs-api-definition
[Browsable(false)]
public GridViewTableHeaderRowInfo TableHeaderRow { get; }

Property Value

GridViewTableHeaderRowInfo

The table header row information.

TableSearchRow

Gets the instance of GridViewSearchRowInfo for the current view. This row represents the row which is used by users to search through the data inside RadGridView.

Declaration

cs-api-definition
[Browsable(false)]
public GridViewSearchRowInfo TableSearchRow { get; }

Property Value

GridViewSearchRowInfo

The table search row information.

ViewTemplate

Gets the instance of GridViewTemplate which the current view corresponds to.

Declaration

cs-api-definition
[Browsable(false)]
public GridViewTemplate ViewTemplate { get; }

Property Value

GridViewTemplate

The view template that owns this grid view information.

Methods

CreateAddNewRow()

Creates the add new row for this view.

Declaration

cs-api-definition
protected virtual GridViewNewRowInfo CreateAddNewRow()

Returns

GridViewNewRowInfo

A new instance of GridViewNewRowInfo.

CreateFilteringRow()

Creates the filtering row for this view.

Declaration

cs-api-definition
protected virtual GridViewFilteringRowInfo CreateFilteringRow()

Returns

GridViewFilteringRowInfo

A new instance of GridViewFilteringRowInfo.

CreateSearchRow()

Creates the search row for this view.

Declaration

cs-api-definition
protected virtual GridViewSearchRowInfo CreateSearchRow()

Returns

GridViewSearchRowInfo

A new instance of GridViewSearchRowInfo.

CreateTableHeaderRow()

Creates the table header row for this view.

Declaration

cs-api-definition
protected virtual GridViewTableHeaderRowInfo CreateTableHeaderRow()

Returns

GridViewTableHeaderRowInfo

A new instance of GridViewTableHeaderRowInfo.

EnsureVisible()

Ensures that this view is visible in the hierarchy by expanding parent rows if necessary.

Declaration

cs-api-definition
public void EnsureVisible()

FindGroupParent(GridViewRowInfo)

Finds the group parent for the specified row information.

Declaration

cs-api-definition
protected virtual IHierarchicalRow FindGroupParent(GridViewRowInfo rowInfo)

Parameters

rowInfo

GridViewRowInfo

The row information to find the group parent for.

Returns

IHierarchicalRow

The group parent row, or null if not found.

FindParent(GridViewRowInfo)

Finds the parent of the specified GridViewRowInfo instance.

Declaration

cs-api-definition
public IHierarchicalRow FindParent(GridViewRowInfo rowInfo)

Parameters

rowInfo

GridViewRowInfo

The row information to find the parent for.

Returns

IHierarchicalRow

The parent of the specified GridViewRowInfo instance.

Exceptions

ArgumentNullException

Thrown when rowInfo is null.

InvalidOperationException

Thrown when the row info is owned by another view.

HasChildRows()

Determines whether this view has child rows to display.

Declaration

cs-api-definition
[Browsable(false)]
public bool HasChildRows()

Returns

bool

true if there are child rows, system rows, or other content to display; otherwise, false.

InitializeTableAddNewRow()

Initializes the table add new row if it hasn't been created yet.

Declaration

cs-api-definition
protected virtual void InitializeTableAddNewRow()

InitializeTableFilteringRow()

Initializes the table filtering row if it hasn't been created yet.

Declaration

cs-api-definition
protected virtual void InitializeTableFilteringRow()

InitializeTableHeaderRow()

Initializes the table header row if it hasn't been created yet.

Declaration

cs-api-definition
protected virtual void InitializeTableHeaderRow()

InitializeTableSearchRow()

Initializes the table search row if it hasn't been created yet.

Declaration

cs-api-definition
protected virtual void InitializeTableSearchRow()

LoadHierarchicalData(GridViewHierarchyRowInfo, ICollectionView<GridViewRowInfo>)

Loads the hierarchical data for the specified parent row.

Declaration

cs-api-definition
protected ICollectionView<GridViewRowInfo> LoadHierarchicalData(GridViewHierarchyRowInfo parent, ICollectionView<GridViewRowInfo> sourceView)

Parameters

parent

GridViewHierarchyRowInfo

The parent row to load data for.

sourceView

ICollectionView<GridViewRowInfo>

The source collection view.

Returns

ICollectionView<GridViewRowInfo>

The loaded hierarchical data collection view.

Refresh()

Refreshes the ChildRows collection of this GridViewInfo.

Declaration

cs-api-definition
public virtual void Refresh()