Class VirtualGridViewInfo

Represents the view info.

Inheritance
System.Object
DisposableObject
RadObject
VirtualGridViewInfo
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

public class VirtualGridViewInfo : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor

Constructors

VirtualGridViewInfo(RadVirtualGridElement)

Initializes a new instance of the VirtualGridViewInfo class.

Declaration
public VirtualGridViewInfo(RadVirtualGridElement gridElement)
Parameters
RadVirtualGridElement gridElement

The grid element.

VirtualGridViewInfo(VirtualGridViewInfo, Int32)

Initializes a new instance of the VirtualGridViewInfo class.

Declaration
public VirtualGridViewInfo(VirtualGridViewInfo parentViewInfo, int parentRowIndex)
Parameters
VirtualGridViewInfo parentViewInfo

The parent view info.
System.Int32 parentRowIndex

Index of the parent row.

Fields

DefaultColumnWidth

Declaration
public const int DefaultColumnWidth = 100
Field Value
System.Int32

DefaultFilterRowHeight

Declaration
public const int DefaultFilterRowHeight = 26
Field Value
System.Int32

DefaultHeaderRowHeight

Declaration
public const int DefaultHeaderRowHeight = 30
Field Value
System.Int32

DefaultNewRowHeight

Declaration
public const int DefaultNewRowHeight = 24
Field Value
System.Int32

DefaultRowHeight

Declaration
public const int DefaultRowHeight = 24
Field Value
System.Int32

DefaultSpacing

Declaration
public const int DefaultSpacing = -1
Field Value
System.Int32

FilterRowHeightProperty

Declaration
public static RadProperty FilterRowHeightProperty
Field Value
RadProperty

HeaderRowHeightProperty

Declaration
public static RadProperty HeaderRowHeightProperty
Field Value
RadProperty

NewRowHeightProperty

Declaration
public static RadProperty NewRowHeightProperty
Field Value
RadProperty

RowHeightProperty

Declaration
public static RadProperty RowHeightProperty
Field Value
RadProperty

Properties

AllowCellContextMenu

Gets or sets a value indicating whether right-clicking on a data cell will show the default data cell context menu.

Declaration
public bool AllowCellContextMenu { get; set; }
Property Value
System.Boolean

AllowColumnHeaderContextMenu

Gets or sets a value indicating whether right-clicking on a header cell will show the default header cell context menu.

Declaration
public bool AllowColumnHeaderContextMenu { get; set; }
Property Value
System.Boolean

AllowColumnResize

Gets or sets a value indicating whether users can resize columns through the grid UI.

Declaration
public bool AllowColumnResize { get; set; }
Property Value
System.Boolean

AllowColumnSort

Gets or sets a value indicating whether users can sort columns by clicking the header or through the header context menu.

Declaration
public bool AllowColumnSort { get; set; }
Property Value
System.Boolean

AllowCopy

Gets or sets a value indicating whether the Copy option in the context menu and the Ctrl+C shortcut will be available to the user.

Declaration
public bool AllowCopy { get; set; }
Property Value
System.Boolean

AllowCut

Gets or sets a value indicating whether the Cut option in the context menu and the Ctrl+X shortcut will be available to the user.

Declaration
public bool AllowCut { get; set; }
Property Value
System.Boolean

AllowDelete

Gets or sets a value indicating whether users can delete rows.

Declaration
public bool AllowDelete { get; set; }
Property Value
System.Boolean

AllowEdit

Gets or sets a value indicating whether users can edit the values in data cells.

Declaration
public bool AllowEdit { get; set; }
Property Value
System.Boolean

AllowMultiColumnSorting

Gets or sets a value indicating whether the users can sort by more than one column.

Declaration
public bool AllowMultiColumnSorting { get; set; }
Property Value
System.Boolean

AllowPaste

Gets or sets a value indicating whether the Paste option in the context menu and the Ctrl+V shortcut will be available to the user.

Declaration
public bool AllowPaste { get; set; }
Property Value
System.Boolean

AllowRowResize

Gets or sets a value indicating whether users can resize rows through the grid UI.

Declaration
public bool AllowRowResize { get; set; }
Property Value
System.Boolean

AutoSizeColumnsMode

Gets or sets a value indicating how column widths are determined.

Declaration
public VirtualGridAutoSizeColumnsMode AutoSizeColumnsMode { get; set; }
Property Value
VirtualGridAutoSizeColumnsMode

See Also

CellSpacing

Gets or sets the distance betwween adjucent cells.

Declaration
public int CellSpacing { get; set; }
Property Value
System.Int32

ColumnCount

Gets or sets the total number of columns to be displayed in the grid.

Declaration
public int ColumnCount { get; set; }
Property Value
System.Int32

ColumnDataTypes

This property is only used for serialization purposes.

Declaration
public Dictionary<int, Type> ColumnDataTypes { get; set; }
Property Value
System.Collections.Generic.Dictionary<System.Int32, System.Type>

ColumnsViewState

Gets an VirtualGridTableViewState containing information and settings for the currently displayed columns.

Declaration
public VirtualGridTableViewState ColumnsViewState { get; }
Property Value
VirtualGridTableViewState

ColumnWidth

Gets or sets the default column width.

Declaration
public int ColumnWidth { get; set; }
Property Value
System.Int32

CustomColumns

This property is only used for serialization purposes.

Declaration
public List<int> CustomColumns { get; set; }
Property Value
System.Collections.Generic.List<System.Int32>

EnableAlternatingRowColor

Gets or sets a value indicating whether event and odd rows will have a different back color.

Declaration
public bool EnableAlternatingRowColor { get; set; }
Property Value
System.Boolean

EnablePaging

Gets or sets a value indicating whether data is presented in chunks (pages) to the user.

Declaration
public bool EnablePaging { get; set; }
Property Value
System.Boolean

ExpandedHeight

Gets or sets the height of the current view when it is a child view and UseScrollbarsInHierarchy is set to true.

Declaration
public int ExpandedHeight { get; set; }
Property Value
System.Int32

FilterDescriptors

Gets the filter descriptors currently applied to the grid.

Declaration
public FilterDescriptorCollection FilterDescriptors { get; }
Property Value
FilterDescriptorCollection

FilterRowHeight

Gets or sets the height of the filter row.

Declaration
public int FilterRowHeight { get; set; }
Property Value
System.Int32

FilterRowValues

Gets a dictionary containing a cache of the values entered in the filter row. The key is the column index.

Declaration
public Dictionary<int, FilterOperator> FilterRowValues { get; }
Property Value
System.Collections.Generic.Dictionary<System.Int32, FilterOperator>

GridElement

Gets an instance of RadVirtualGridElement which is the main element of this control.

Declaration
public RadVirtualGridElement GridElement { get; }
Property Value
RadVirtualGridElement

HeaderRowHeight

Gets or sets the height of the header row.

Declaration
public int HeaderRowHeight { get; set; }
Property Value
System.Int32

HierarchyLevel

Gets the hierarchy level of the current view.

Declaration
public int HierarchyLevel { get; }
Property Value
System.Int32

HorizontalScrollState

Gets or sets the ScrollState of the horizontal scroll bar.

Declaration
public ScrollState HorizontalScrollState { get; set; }
Property Value
ScrollState

IsExpanded

Gets a value indicating whether this view's parent row is expanded.

Declaration
public bool IsExpanded { get; }
Property Value
System.Boolean

IsWaiting

Gets or sets a value indicating whether the busy indicator of the current view is visible.

Declaration
public bool IsWaiting { get; set; }
Property Value
System.Boolean

MinColumnWidth

Gets or sets the minimum width a column can be.

Declaration
public int MinColumnWidth { get; set; }
Property Value
System.Int32

MinRowHeight

Gets or sets the minimum height a data row can be.

Declaration
public int MinRowHeight { get; set; }
Property Value
System.Int32

Name

Gets or sets the name of the view.

Declaration
public string Name { get; set; }
Property Value
System.String

NewRowHeight

Gets or sets the height of the add new row.

Declaration
public int NewRowHeight { get; set; }
Property Value
System.Int32

NewRowValues

Gets a dictionary containing a cache of the values entered in the new row. The key is the column index.

Declaration
public Dictionary<int, object> NewRowValues { get; }
Property Value
System.Collections.Generic.Dictionary<System.Int32, System.Object>

Padding

Gets or sets the amount of padding to be applied to child views.

Declaration
public Padding Padding { get; set; }
Property Value
System.Windows.Forms.Padding

PageIndex

Gets or sets the index of the page currently presented in the grid.

Declaration
public int PageIndex { get; set; }
Property Value
System.Int32

PageSize

Gets or sets the number of rows shown per page when paging is enabled.

Declaration
public int PageSize { get; set; }
Property Value
System.Int32

ParentRowIndex

Gets the index of the parent row when the current view is a child view.

Declaration
public int ParentRowIndex { get; }
Property Value
System.Int32

ParentViewInfo

Gets the parent view info when the current view info is a child view info.

Declaration
public VirtualGridViewInfo ParentViewInfo { get; }
Property Value
VirtualGridViewInfo

RowCount

Gets or sets the total number of rows to be displayed in the grid.

Declaration
public int RowCount { get; set; }
Property Value
System.Int32

RowHeight

Gets or sets the default height of the data rows.

Declaration
public int RowHeight { get; set; }
Property Value
System.Int32

RowSpacing

Gets or sets the space between adjucent rows.

Declaration
public int RowSpacing { get; set; }
Property Value
System.Int32

RowsViewState

Gets an VirtualGridTableViewState containing information and settings for the currently displayed rows.

Declaration
public VirtualGridTableViewState RowsViewState { get; }
Property Value
VirtualGridTableViewState

ShowFilterRow

Gets or sets a value indicating whether the filter row is visible.

Declaration
public bool ShowFilterRow { get; set; }
Property Value
System.Boolean

ShowHeaderRow

Gets or sets a value indicating whether the header row is visible.

Declaration
public bool ShowHeaderRow { get; set; }
Property Value
System.Boolean

ShowNewRow

Gets or sets a value indicating whether the add new row is visible.

Declaration
public bool ShowNewRow { get; set; }
Property Value
System.Boolean

SortDescriptors

Gets the sort descriptors currently applied to the grid.

Declaration
public SortDescriptorCollection SortDescriptors { get; }
Property Value
SortDescriptorCollection

Tag

Gets or sets an object used for storing any user data.

Declaration
public object Tag { get; set; }
Property Value
System.Object

TotalPages

Gets the total number of pages when paging is enabled.

Declaration
public int TotalPages { get; }
Property Value
System.Int32

VerticalScrollState

Gets or sets the ScrollState of the vertical scroll bar.

Declaration
public ScrollState VerticalScrollState { get; set; }
Property Value
ScrollState

Methods

BindProperties(VirtualGridTableElement)

Binds the properties.

Declaration
public void BindProperties(VirtualGridTableElement source)
Parameters
VirtualGridTableElement source

The source.

ClearRowErrorText(Int32)

Clears the error text of the specified row.

Declaration
public void ClearRowErrorText(int rowIndex)
Parameters
System.Int32 rowIndex

The index of the row.

CollapseRow(Int32)

Collapses the specified row.

Declaration
public bool CollapseRow(int rowIndex)
Parameters
System.Int32 rowIndex

The row index to collapse.
Returns
System.Boolean

True if the operation is successful, otherwise false.

CreateChildViewInfo(Int32)

Creates a child view info for the specified row.

Declaration
protected virtual VirtualGridViewInfo CreateChildViewInfo(int rowIndex)
Parameters
System.Int32 rowIndex

The index of the row.
Returns
VirtualGridViewInfo

A new instance of VirtualGridViewInfo.

ExpandRow(Int32)

Expands the specified row.

Declaration
public bool ExpandRow(int rowIndex)
Parameters
System.Int32 rowIndex

The row index to expand.
Returns
System.Boolean

True if the operation is successful, otherwise false.

GetChildViewInfo(Int32)

Gets the child view info for the specified row.

Declaration
public VirtualGridViewInfo GetChildViewInfo(int rowIndex)
Parameters
System.Int32 rowIndex

The index of the row.
Returns
VirtualGridViewInfo

The child view info if it exists, otherwise null.

GetChildViewInfo(Int32, Boolean)

Gets the child view info for the specified row.

Declaration
public VirtualGridViewInfo GetChildViewInfo(int rowIndex, bool forceCreate)
Parameters
System.Int32 rowIndex

The index of the row.
System.Boolean forceCreate

Determines if a new child view info should be created if one does not exist.
Returns
VirtualGridViewInfo

The child view info if it exists, otherwise null.

GetColumnDataType(Int32)

Gets the data type of the specified column.

Declaration
public Type GetColumnDataType(int columnIndex)
Parameters
System.Int32 columnIndex

The index of the column.
Returns
System.Type

The data type of the column if one is assigned to it, otherwise null.

GetColumnPinPosition(Int32)

Gets the column pin position.

Declaration
public PinnedColumnPosition GetColumnPinPosition(int columnIndex)
Parameters
System.Int32 columnIndex

Index of the column.
Returns
PinnedColumnPosition

GetColumnWidth(Int32)

Gets the height of the column at the given column index.

Declaration
public int GetColumnWidth(int columnIndex)
Parameters
System.Int32 columnIndex

The index of the column.
Returns
System.Int32

The height of the column.

GetRowErrorText(Int32)

Returns the error text for the specified row.

Declaration
public string GetRowErrorText(int rowIndex)
Parameters
System.Int32 rowIndex

The index of the row.
Returns
System.String

The error text if the row has one, otherwise null.

GetRowHeight(Int32)

Gets the height of the row at the given row index.

Declaration
public int GetRowHeight(int rowIndex)
Parameters
System.Int32 rowIndex

The index of the row.
Returns
System.Int32

The height of the row.

GetRowPinPosition(Int32)

Gets the row pin position.

Declaration
public PinnedRowPosition GetRowPinPosition(int rowIndex)
Parameters
System.Int32 rowIndex

Index of the row.
Returns
PinnedRowPosition

GetTotalRowHeight()

Gets the total height of the row.

Declaration
public int GetTotalRowHeight()
Returns
System.Int32

HandlePropertyChange(String)

Handles the property change.

Declaration
protected void HandlePropertyChange(string propertyName)
Parameters
System.String propertyName

Name of the property.

InitializeViewInfo()

Initializes the view info.

Declaration
protected virtual void InitializeViewInfo()

IsColumnPinned(Int32)

Returs a value indicating whether the specified column is pinned.

Declaration
public bool IsColumnPinned(int columnIndex)
Parameters
System.Int32 columnIndex

The index of the column.
Returns
System.Boolean

True if the column is pinned at left or right, otherwise false.

IsCustomColumn(Int32)

Returns a value indicating whether the specified column is registerd as custom.

Declaration
public bool IsCustomColumn(int columnIndex)
Parameters
System.Int32 columnIndex

The index of the column.
Returns
System.Boolean

True if the column is registered as custom, otherwise false.

IsRowExpanded(Int32)

Returs a value indicating whether the specified row is expanded.

Declaration
public bool IsRowExpanded(int rowIndex)
Parameters
System.Int32 rowIndex

The index of the row.
Returns
System.Boolean

True if the row is expanded, otherwise false.

IsRowPinned(Int32)

Returs a value indicating whether the specified row is pinned.

Declaration
public bool IsRowPinned(int rowIndex)
Parameters
System.Int32 rowIndex

The index of the row.
Returns
System.Boolean

True if the row is pinned at top or bottom, otherwise false.

IsRowWaiting(Int32)

Returns a value indicating whether the specified row is marked as waiting.

Declaration
public bool IsRowWaiting(int rowIndex)
Parameters
System.Int32 rowIndex

The index of the row.
Returns
System.Boolean

True if the row is marked as waiting, otherwise faslse.

MoveToFirstPage()

Moves the current view to the first page.

Declaration
public void MoveToFirstPage()

MoveToLastPage()

Moves the current view to the last page.

Declaration
public void MoveToLastPage()

MoveToNextPage()

Moves the current view to the next page index.

Declaration
public void MoveToNextPage()

MoveToPage(Int32)

Moves the current view to the specified page index.

Declaration
public void MoveToPage(int pageIndex)
Parameters
System.Int32 pageIndex

The index of the page.

MoveToPreviousPage()

Moves the current view to the previous page index.

Declaration
public void MoveToPreviousPage()

OnNotifyPropertyChanged(PropertyChangedEventArgs)

Raises the standard .NET PropertyChanged event.

Declaration
protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Parameters
System.ComponentModel.PropertyChangedEventArgs e

Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

RegisterCustomColumn(Int32)

Registers the column as one containing custom cells. This prevents default cells from being displayed in that column.

Declaration
public bool RegisterCustomColumn(int columnIndex)
Parameters
System.Int32 columnIndex

The index of the column.
Returns
System.Boolean

Returns true if the registration is successful, otherwise false.

ResetViewState()

Resets the view states of the view. Resets row heights, pin positions, expanded state, column widths and column pin positions.

Declaration
public void ResetViewState()

RowHasError(Int32)

Returns a value indicating whether the row has error text assigned to it.

Declaration
public bool RowHasError(int rowIndex)
Parameters
System.Int32 rowIndex

The index of the row.
Returns
System.Boolean

True if the row has error text assigned to it, otherwise false.

SetColumnDataType(Int32, Type)

Sets the data type of the column. This affects the editors in the column and the available filter options.

Declaration
public void SetColumnDataType(int columnIndex, Type dataType)
Parameters
System.Int32 columnIndex

The index of the column.
System.Type dataType

The type of the data in the column.

SetColumnDataType(Type[])

Sets the specified data types as the data type of the columns in the view info. The assignment starts from the first column and ends where the specified data types end. Data types affect the editors in the columns and the available filter options for each column.

Declaration
public void SetColumnDataType(params Type[] dataTypes)
Parameters
System.Type[] dataTypes

The data types.

SetColumnPinPosition(Int32, PinnedColumnPosition)

Sets the pin position of the specified column.

Declaration
public void SetColumnPinPosition(int columnIndex, PinnedColumnPosition pinPosition)
Parameters
System.Int32 columnIndex

The index of the column.
PinnedColumnPosition pinPosition

The new pin position.

SetColumnWidth(Int32, Int32)

Sets the width of the column at the specified column index in the master view info.

Declaration
public void SetColumnWidth(int columnIndex, int width)
Parameters
System.Int32 columnIndex

The index of the column
System.Int32 width

The new width of the column.

SetRowErrorText(Int32, String)

Sets the row error text for the specified row. Setting the error text to null has the same effect as calling ClearRowErrorText(Int32)

Declaration
public void SetRowErrorText(int rowIndex, string errorText)
Parameters
System.Int32 rowIndex

The index of the row.
System.String errorText

The error text.

SetRowHeight(Int32, Int32)

Sets the height of the row at the specified row index in the master view info.

Declaration
public void SetRowHeight(int rowIndex, int height)
Parameters
System.Int32 rowIndex

The index of the row.
System.Int32 height

The new height of the row.

SetRowPinPosition(Int32, PinnedRowPosition)

Sets the pin position of the specified row.

Declaration
public void SetRowPinPosition(int rowIndex, PinnedRowPosition position)
Parameters
System.Int32 rowIndex

The index of the row.
PinnedRowPosition position

The new pin position.

StartRowWaiting(Int32)

Marks the specified row as waiting. This will display a waiting indicator in the row indent cell.

Declaration
public void StartRowWaiting(int rowIndex)
Parameters
System.Int32 rowIndex

The index of the row.

StopRowWaiting(Int32)

Removes the mark of the specified row as waiting. This will hide the waiting indicator in the row indent cell.

Declaration
public void StopRowWaiting(int rowIndex)
Parameters
System.Int32 rowIndex

Index of the row.

UnbindProperties(VirtualGridTableElement)

Unbinds the properties.

Declaration
public void UnbindProperties(VirtualGridTableElement source)
Parameters
VirtualGridTableElement source

The source.

UnregisterCustomColumn(Int32)

Removes the column registration as one containing custom cells.

Declaration
public bool UnregisterCustomColumn(int columnIndex)
Parameters
System.Int32 columnIndex

The index of the column.
Returns
System.Boolean

Returns true if the registration removal is successful, otherwise false.

Extension Methods