ClassGridViewInfo
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:
[TypeConverter(typeof(ExpandableObjectConverter))]
public class GridViewInfo
Inheritance: objectGridViewInfo
Constructors
GridViewInfo(GridViewTemplate)
Initializes a new instance of the GridViewInfo class.
Declaration
public GridViewInfo(GridViewTemplate ownerTemplate)
Parameters
ownerTemplate
The GridViewTemplate which this view corresponds to.
GridViewInfo(GridViewTemplate, GridViewHierarchyRowInfo)
Initializes a new instance of the GridViewInfo class.
Declaration
public GridViewInfo(GridViewTemplate ownerTemplate, GridViewHierarchyRowInfo parentRow)
Parameters
ownerTemplate
The owner template that this view corresponds to.
parentRow
The parent row in a hierarchical structure.
Properties
ChildRows
Gets the rows in this view.
Declaration
public GridViewChildRowCollection ChildRows { get; }
Property Value
The collection of child rows.
CurrentIndex
Gets the index of the CurrentRow in the currently selected group.
Declaration
[Browsable(false)]
public int CurrentIndex { get; }
Property Value
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
[Browsable(false)]
public GridViewRowInfo CurrentRow { get; set; }
Property Value
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
public virtual bool NeedsRefresh { get; }
Property Value
true if the child rows need to be refreshed; otherwise, false.
ParentRow
Gets the parent GridViewRowInfo which the current view is linked to.
Declaration
[Browsable(false)]
public GridViewHierarchyRowInfo ParentRow { get; }
Property Value
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
public GridViewPinnedRowCollection PinnedRows { get; }
Property Value
The collection of pinned rows.
Rows
Gets the rows in this view.
Declaration
public GridViewChildRowCollection Rows { get; }
Property Value
The collection of rows.
SummaryRows
Gets a readonly collection of GridViewSummaryRowInfo containing the summary rows in this view.
Declaration
public GridViewSummaryRowCollection SummaryRows { get; }
Property Value
The collection of summary rows.
SystemRows
Gets a readonly collection of GridViewRowInfo containing the system rows in this view.
Declaration
[Browsable(false)]
public GridViewSystemRowCollection SystemRows { get; }
Property Value
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
[Browsable(false)]
public GridViewNewRowInfo TableAddNewRow { get; }
Property Value
The table add new row information.
TableFilteringRow
Gets the instance of GridViewFilteringRowInfo representing the filtering row for the current view.
Declaration
[Browsable(false)]
public GridViewFilteringRowInfo TableFilteringRow { get; }
Property Value
The table filtering row information.
TableHeaderRow
Gets the instance of GridViewTableHeaderRowInfo representing the header row for the current view.
Declaration
[Browsable(false)]
public GridViewTableHeaderRowInfo TableHeaderRow { get; }
Property Value
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
[Browsable(false)]
public GridViewSearchRowInfo TableSearchRow { get; }
Property Value
The table search row information.
ViewTemplate
Gets the instance of GridViewTemplate which the current view corresponds to.
Declaration
[Browsable(false)]
public GridViewTemplate ViewTemplate { get; }
Property Value
The view template that owns this grid view information.
Methods
CreateAddNewRow()
Creates the add new row for this view.
Declaration
protected virtual GridViewNewRowInfo CreateAddNewRow()
Returns
A new instance of GridViewNewRowInfo.
CreateFilteringRow()
Creates the filtering row for this view.
Declaration
protected virtual GridViewFilteringRowInfo CreateFilteringRow()
Returns
A new instance of GridViewFilteringRowInfo.
CreateSearchRow()
Creates the search row for this view.
Declaration
protected virtual GridViewSearchRowInfo CreateSearchRow()
Returns
A new instance of GridViewSearchRowInfo.
CreateTableHeaderRow()
Creates the table header row for this view.
Declaration
protected virtual GridViewTableHeaderRowInfo CreateTableHeaderRow()
Returns
A new instance of GridViewTableHeaderRowInfo.
EnsureVisible()
Ensures that this view is visible in the hierarchy by expanding parent rows if necessary.
Declaration
public void EnsureVisible()
FindGroupParent(GridViewRowInfo)
Finds the group parent for the specified row information.
Declaration
protected virtual IHierarchicalRow FindGroupParent(GridViewRowInfo rowInfo)
Parameters
rowInfo
The row information to find the group parent for.
Returns
The group parent row, or null if not found.
FindParent(GridViewRowInfo)
Finds the parent of the specified GridViewRowInfo instance.
Declaration
public IHierarchicalRow FindParent(GridViewRowInfo rowInfo)
Parameters
rowInfo
The row information to find the parent for.
Returns
The parent of the specified GridViewRowInfo instance.
Exceptions
Thrown when rowInfo is null.
Thrown when the row info is owned by another view.
HasChildRows()
Determines whether this view has child rows to display.
Declaration
[Browsable(false)]
public bool HasChildRows()
Returns
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
protected virtual void InitializeTableAddNewRow()
InitializeTableFilteringRow()
Initializes the table filtering row if it hasn't been created yet.
Declaration
protected virtual void InitializeTableFilteringRow()
InitializeTableHeaderRow()
Initializes the table header row if it hasn't been created yet.
Declaration
protected virtual void InitializeTableHeaderRow()
InitializeTableSearchRow()
Initializes the table search row if it hasn't been created yet.
Declaration
protected virtual void InitializeTableSearchRow()
LoadHierarchicalData(GridViewHierarchyRowInfo, ICollectionView<GridViewRowInfo>)
Loads the hierarchical data for the specified parent row.
Declaration
protected ICollectionView<GridViewRowInfo> LoadHierarchicalData(GridViewHierarchyRowInfo parent, ICollectionView<GridViewRowInfo> sourceView)
Parameters
parent
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
public virtual void Refresh()