New to Telerik UI for WinFormsStart a free 30-day trial

Represents the view info.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.GridView.dll

Syntax:

C#
public class VirtualGridViewInfo : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor

Inheritance: objectDisposableObjectRadObjectVirtualGridViewInfo

Implements: ICustomTypeDescriptorIDisposableINotifyPropertyChanged

Inherited Members RadObject.BindingContextPropertyRadObject.RadTypeRadObject.ReplaceDefaultDescriptors(PropertyDescriptorCollection)RadObject.DisposeManagedResources()RadObject.ClearPropertyStore()RadObject.SuspendPropertyNotifications()RadObject.ResumePropertyNotifications()RadObject.GetPropertyValue(RadProperty)RadObject.SetDefaultValueOverride(RadProperty, object)RadObject.GetValue(RadProperty)RadObject.SetValue(RadProperty, object)RadObject.ResetValue(RadProperty)RadObject.ResetLocalValue(RadProperty)RadObject.ResetValue(RadProperty, ValueResetFlags)RadObject.UpdateValue(RadProperty)RadObject.GetValueSource(RadProperty)RadObject.GetRegisteredRadProperty(string)RadObject.UpdateValueCore(RadPropertyValue)RadObject.SetValueCore(RadPropertyValue, object, object, ValueSource)RadObject.ResetValueCore(RadPropertyValue, ValueResetFlags)RadObject.GetDefaultValue(RadPropertyValue, object)RadObject.CoerceValue(RadPropertyValue, object)RadObject.ShouldSerializeProperty(RadProperty)RadObject.CanRaisePropertyChangeNotifications(RadPropertyValue)RadObject.BindProperty(RadProperty, RadObject, RadProperty, PropertyBindingOptions)RadObject.UnbindProperty(RadProperty)RadObject.AddStylePropertySetting(IPropertySetting)RadObject.GetInheritedValue(RadProperty)RadObject.OnPropertyChanging(RadPropertyChangingEventArgs)RadObject.OnNotifyPropertyChanged(string)RadObject.OnShouldSerializeProperty(ShouldSerializePropertyEventArgs)RadObject.IsPropertyCancelable(RadPropertyMetadata)RadObject.PropertyValuesRadObject.PropertyFilterRadObject.RadObjectTypeRadObject.BindingContextRadObject.PropertyChangedRadObject.RadPropertyChangedRadObject.RadPropertyChangingDisposableObject.GetBitState(long)DisposableObject.SetBitState(long, bool)DisposableObject.OnBitStateChanged(long, bool, bool)DisposableObject.Dispose()DisposableObject.Dispose(bool)DisposableObject.PerformDispose(bool)DisposableObject.DisposeUnmanagedResources()DisposableObject.BitStateDisposableObject.EventsDisposableObject.IsDisposingDisposableObject.IsDisposedDisposableObject.DisposedDisposableObject.Disposing...

Constructors

Initializes a new instance of the VirtualGridViewInfo class.

C#
public VirtualGridViewInfo(RadVirtualGridElement gridElement)
Parameters:gridElementRadVirtualGridElement

The grid element.

Initializes a new instance of the VirtualGridViewInfo class.

C#
public VirtualGridViewInfo(VirtualGridViewInfo parentViewInfo, int parentRowIndex)
Parameters:parentViewInfoVirtualGridViewInfo

The parent view info.

parentRowIndexint

Index of the parent row.

Fields

C#
public const int DefaultColumnWidth = 100
C#
public const int DefaultFilterRowHeight = 26
C#
public const int DefaultHeaderRowHeight = 30
C#
public const int DefaultNewRowHeight = 24
C#
public const int DefaultRowHeight = 24
C#
public const int DefaultSpacing = -1
C#
public static RadProperty FilterRowHeightProperty
C#
public static RadProperty HeaderRowHeightProperty
C#
public static RadProperty NewRowHeightProperty
C#
public static RadProperty RowHeightProperty

Properties

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

C#
public bool AllowCellContextMenu { get; set; }

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

C#
public bool AllowColumnHeaderContextMenu { get; set; }

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

C#
public bool AllowColumnResize { get; set; }

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

C#
public bool AllowColumnSort { get; set; }

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.

C#
public bool AllowCopy { get; set; }

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.

C#
public bool AllowCut { get; set; }

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

C#
public bool AllowDelete { get; set; }

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

C#
public bool AllowEdit { get; set; }

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

C#
public bool AllowMultiColumnSorting { get; set; }

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.

C#
public bool AllowPaste { get; set; }

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

C#
public bool AllowRowResize { get; set; }

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

C#
public VirtualGridAutoSizeColumnsMode AutoSizeColumnsMode { get; set; }

Gets or sets the distance between adjacent cells.

C#
public int CellSpacing { get; set; }

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

C#
public int ColumnCount { get; set; }

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

C#
public VirtualGridTableViewState ColumnsViewState { get; }

Gets or sets the default column width.

C#
public int ColumnWidth { get; set; }

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

C#
public bool EnableAlternatingRowColor { get; set; }

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

C#
public bool EnablePaging { get; set; }

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

C#
public int ExpandedHeight { get; set; }

Gets the filter descriptors currently applied to the grid.

C#
public FilterDescriptorCollection FilterDescriptors { get; }

Gets or sets the height of the filter row.

C#
public int FilterRowHeight { get; set; }

FilterRowValues

Dictionary<int, FilterOperator>

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

C#
public Dictionary<int, FilterOperator> FilterRowValues { get; }

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

C#
public RadVirtualGridElement GridElement { get; }

Gets or sets the height of the header row.

C#
public int HeaderRowHeight { get; set; }

Gets the hierarchy level of the current view.

C#
public int HierarchyLevel { get; }

Gets or sets the ScrollState of the horizontal scroll bar.

C#
public ScrollState HorizontalScrollState { get; set; }

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

C#
public bool IsExpanded { get; }

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

C#
public bool IsWaiting { get; set; }

Gets or sets the minimum width a column can be.

C#
public int MinColumnWidth { get; set; }

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

C#
public int MinRowHeight { get; set; }

Gets or sets the name of the view.

C#
public string Name { get; set; }

Gets or sets the height of the add new row.

C#
public int NewRowHeight { get; set; }

NewRowValues

Dictionary<int, object>

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

C#
public Dictionary<int, object> NewRowValues { get; }

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

C#
public Padding Padding { get; set; }

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

C#
public int PageIndex { get; set; }

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

C#
public int PageSize { get; set; }

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

C#
public int ParentRowIndex { get; }

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

C#
public VirtualGridViewInfo ParentViewInfo { get; }

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

C#
public int RowCount { get; set; }

Gets or sets the default height of the data rows.

C#
public int RowHeight { get; set; }

Gets or sets the space between adjacent rows.

C#
public int RowSpacing { get; set; }

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

C#
public VirtualGridTableViewState RowsViewState { get; }

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

C#
public bool ShowFilterRow { get; set; }

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

C#
public bool ShowHeaderRow { get; set; }

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

C#
public bool ShowNewRow { get; set; }

Gets the sort descriptors currently applied to the grid.

C#
public SortDescriptorCollection SortDescriptors { get; }

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

C#
public object Tag { get; set; }

Gets the total number of pages when paging is enabled.

C#
public int TotalPages { get; }

Gets or sets the ScrollState of the vertical scroll bar.

C#
public ScrollState VerticalScrollState { get; set; }

Methods

Binds the properties.

C#
public void BindProperties(VirtualGridTableElement source)
Parameters:sourceVirtualGridTableElement

The source.

Clears the error text of the specified row.

C#
public void ClearRowErrorText(int rowIndex)
Parameters:rowIndexint

The index of the row.

Collapses the specified row.

C#
public bool CollapseRow(int rowIndex)
Parameters:rowIndexint

The row index to collapse.

Returns:

bool

True if the operation is successful, otherwise false.

Creates a child view info for the specified row.

C#
protected virtual VirtualGridViewInfo CreateChildViewInfo(int rowIndex)
Parameters:rowIndexint

The index of the row.

Returns:

VirtualGridViewInfo

A new instance of VirtualGridViewInfo.

Expands the specified row.

C#
public bool ExpandRow(int rowIndex)
Parameters:rowIndexint

The row index to expand.

Returns:

bool

True if the operation is successful, otherwise false.

Gets the child view info for the specified row.

C#
public VirtualGridViewInfo GetChildViewInfo(int rowIndex, bool forceCreate)
Parameters:rowIndexint

The index of the row.

forceCreatebool

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.

Gets the child view info for the specified row.

C#
public VirtualGridViewInfo GetChildViewInfo(int rowIndex)
Parameters:rowIndexint

The index of the row.

Returns:

VirtualGridViewInfo

The child view info if it exists, otherwise null.

Gets a value indicating whether clicking on the header cell of this column would allow the user to set natural (no) sort.

C#
public bool GetColumnAllowNaturalSort(int columnIndex)
Parameters:columnIndexint

The index of the column.

Returns:

bool

True if the column allows natural sort, otherwise false. Default is true.

Gets the data type of the specified column.

C#
public Type GetColumnDataType(int columnIndex)
Parameters:columnIndexint

The index of the column.

Returns:

Type

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

Gets the column pin position.

C#
public PinnedColumnPosition GetColumnPinPosition(int columnIndex)
Parameters:columnIndexint

Index of the column.

Returns:

PinnedColumnPosition

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

C#
public int GetColumnWidth(int columnIndex)
Parameters:columnIndexint

The index of the column.

Returns:

int

The width of the column.

Returns the error text for the specified row.

C#
public string GetRowErrorText(int rowIndex)
Parameters:rowIndexint

The index of the row.

Returns:

string

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

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

C#
public int GetRowHeight(int rowIndex)
Parameters:rowIndexint

The index of the row.

Returns:

int

The height of the row.

Gets the row pin position.

C#
public PinnedRowPosition GetRowPinPosition(int rowIndex)
Parameters:rowIndexint

Index of the row.

Returns:

PinnedRowPosition

Gets the total height of the row.

C#
public int GetTotalRowHeight()
Returns:

int

Handles the property change.

C#
protected void HandlePropertyChange(string propertyName)
Parameters:propertyNamestring

Name of the property.

Initializes the view info.

C#
protected virtual void InitializeViewInfo()

Returns a value indicating whether the specified column is pinned.

C#
public bool IsColumnPinned(int columnIndex)
Parameters:columnIndexint

The index of the column.

Returns:

bool

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

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

C#
public bool IsCustomColumn(int columnIndex)
Parameters:columnIndexint

The index of the column.

Returns:

bool

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

Returns a value indicating whether the specified row is expanded.

C#
public bool IsRowExpanded(int rowIndex)
Parameters:rowIndexint

The index of the row.

Returns:

bool

True if the row is expanded, otherwise false.

Returns a value indicating whether the specified row is pinned.

C#
public bool IsRowPinned(int rowIndex)
Parameters:rowIndexint

The index of the row.

Returns:

bool

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

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

C#
public bool IsRowWaiting(int rowIndex)
Parameters:rowIndexint

The index of the row.

Returns:

bool

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

Moves the current view to the first page.

C#
public void MoveToFirstPage()

Moves the current view to the last page.

C#
public void MoveToLastPage()

Moves the current view to the next page index.

C#
public void MoveToNextPage()

Moves the current view to the specified page index.

C#
public void MoveToPage(int pageIndex)
Parameters:pageIndexint

The index of the page.

Moves the current view to the previous page index.

C#
public void MoveToPreviousPage()
C#
protected virtual void OnFilterDescriptorsCollectionChanged(NotifyCollectionChangedEventArgs e)
Parameters:eNotifyCollectionChangedEventArgs

Raises the standard .NET PropertyChanged event.

C#
protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Parameters:ePropertyChangedEventArgs

Overrides: RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)

Raises the RadPropertyChanged event and the standard .NET PropertyChanged event to notify subscribers of property value changes.

C#
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters:eRadPropertyChangedEventArgs

The RadPropertyChangedEventArgs containing information about the property change.

Overrides: RadObject.OnPropertyChanged(RadPropertyChangedEventArgs)

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

C#
public bool RegisterCustomColumn(int columnIndex)
Parameters:columnIndexint

The index of the column.

Returns:

bool

Returns true if the registration is successful, otherwise false.

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

C#
public void ResetViewState()

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

C#
public bool RowHasError(int rowIndex)
Parameters:rowIndexint

The index of the row.

Returns:

bool

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

Sets a value indicating whether clicking on the header cell of this column would allow the user to set natural (no) sort.

C#
public void SetColumnAllowNaturalSort(int columnIndex, bool allowNaturalSort)
Parameters:columnIndexint

The index of the column.

allowNaturalSortbool

True to allow natural sort, false otherwise.

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

C#
public void SetColumnDataType(int columnIndex, Type dataType)
Parameters:columnIndexint

The index of the column.

dataTypeType

The type of the data in the column.

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.

C#
public void SetColumnDataType(params Type[] dataTypes)
Parameters:dataTypesType[]

The data types.

Sets the pin position of the specified column.

C#
public void SetColumnPinPosition(int columnIndex, PinnedColumnPosition pinPosition)
Parameters:columnIndexint

The index of the column.

pinPositionPinnedColumnPosition

The new pin position.

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

C#
public void SetColumnWidth(int columnIndex, int width)
Parameters:columnIndexint

The index of the column

widthint

The new width of the column.

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

C#
public void SetRowErrorText(int rowIndex, string errorText)
Parameters:rowIndexint

The index of the row.

errorTextstring

The error text.

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

C#
public void SetRowHeight(int rowIndex, int height)
Parameters:rowIndexint

The index of the row.

heightint

The new height of the row.

Sets the pin position of the specified row.

C#
public void SetRowPinPosition(int rowIndex, PinnedRowPosition position)
Parameters:rowIndexint

The index of the row.

positionPinnedRowPosition

The new pin position.

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

C#
public void StartRowWaiting(int rowIndex)
Parameters:rowIndexint

The index of the row.

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

C#
public void StopRowWaiting(int rowIndex)
Parameters:rowIndexint

Index of the row.

Unbinds the properties.

C#
public void UnbindProperties(VirtualGridTableElement source)
Parameters:sourceVirtualGridTableElement

The source.

Removes the column registration as one containing custom cells.

C#
public bool UnregisterCustomColumn(int columnIndex)
Parameters:columnIndexint

The index of the column.

Returns:

bool

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

In this article
DefinitionConstructorsVirtualGridViewInfo(RadVirtualGridElement)VirtualGridViewInfo(VirtualGridViewInfo, int)FieldsDefaultColumnWidthDefaultFilterRowHeightDefaultHeaderRowHeightDefaultNewRowHeightDefaultRowHeightDefaultSpacingFilterRowHeightPropertyHeaderRowHeightPropertyNewRowHeightPropertyRowHeightPropertyPropertiesAllowCellContextMenuAllowColumnHeaderContextMenuAllowColumnResizeAllowColumnSortAllowCopyAllowCutAllowDeleteAllowEditAllowMultiColumnSortingAllowPasteAllowRowResizeAutoSizeColumnsModeCellSpacingColumnCountColumnsViewStateColumnWidthEnableAlternatingRowColorEnablePagingExpandedHeightFilterDescriptorsFilterRowHeightFilterRowValuesGridElementHeaderRowHeightHierarchyLevelHorizontalScrollStateIsExpandedIsWaitingMinColumnWidthMinRowHeightNameNewRowHeightNewRowValuesPaddingPageIndexPageSizeParentRowIndexParentViewInfoRowCountRowHeightRowSpacingRowsViewStateShowFilterRowShowHeaderRowShowNewRowSortDescriptorsTagTotalPagesVerticalScrollStateMethodsBindProperties(VirtualGridTableElement)ClearRowErrorText(int)CollapseRow(int)CreateChildViewInfo(int)ExpandRow(int)GetChildViewInfo(int, bool)GetChildViewInfo(int)GetColumnAllowNaturalSort(int)GetColumnDataType(int)GetColumnPinPosition(int)GetColumnWidth(int)GetRowErrorText(int)GetRowHeight(int)GetRowPinPosition(int)GetTotalRowHeight()HandlePropertyChange(string)InitializeViewInfo()IsColumnPinned(int)IsCustomColumn(int)IsRowExpanded(int)IsRowPinned(int)IsRowWaiting(int)MoveToFirstPage()MoveToLastPage()MoveToNextPage()MoveToPage(int)MoveToPreviousPage()OnFilterDescriptorsCollectionChanged(NotifyCollectionChangedEventArgs)OnNotifyPropertyChanged(PropertyChangedEventArgs)OnPropertyChanged(RadPropertyChangedEventArgs)RegisterCustomColumn(int)ResetViewState()RowHasError(int)SetColumnAllowNaturalSort(int, bool)SetColumnDataType(int, Type)SetColumnDataType(params Type[])SetColumnPinPosition(int, PinnedColumnPosition)SetColumnWidth(int, int)SetRowErrorText(int, string)SetRowHeight(int, int)SetRowPinPosition(int, PinnedRowPosition)StartRowWaiting(int)StopRowWaiting(int)UnbindProperties(VirtualGridTableElement)UnregisterCustomColumn(int)
Not finding the help you need?
Contact Support