Class

VirtualGridViewInfo

Initializes a new instance of the VirtualGridViewInfo class.

Declaration

public VirtualGridViewInfo(RadVirtualGridElement gridElement)

Parameters

Initializes a new instance of the VirtualGridViewInfo class.

Declaration

public VirtualGridViewInfo(VirtualGridViewInfo parentViewInfo, int parentRowIndex)

Parameters

Declaration

public const int DefaultColumnWidth = 100

Field Value

Declaration

public const int DefaultFilterRowHeight = 26

Field Value

Declaration

public const int DefaultHeaderRowHeight = 30

Field Value

Declaration

public const int DefaultNewRowHeight = 24

Field Value

Declaration

public const int DefaultRowHeight = 24

Field Value

Declaration

public const int DefaultSpacing = -1

Field Value

Declaration

public static RadProperty FilterRowHeightProperty

Field Value

Declaration

public static RadProperty HeaderRowHeightProperty

Field Value

Declaration

public static RadProperty NewRowHeightProperty

Field Value

Declaration

public static RadProperty RowHeightProperty

Field Value

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

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

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

Declaration

public bool AllowColumnResize { get; set; }

Property Value

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

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

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

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

Declaration

public bool AllowDelete { get; set; }

Property Value

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

Declaration

public bool AllowEdit { get; set; }

Property Value

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

Declaration

public bool AllowMultiColumnSorting { get; set; }

Property Value

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

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

Declaration

public bool AllowRowResize { get; set; }

Property Value

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

Declaration

public VirtualGridAutoSizeColumnsMode AutoSizeColumnsMode { get; set; }

Property Value

Gets or sets the distance between adjacent cells.

Declaration

public int CellSpacing { get; set; }

Property Value

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

Declaration

public int ColumnCount { get; set; }

Property Value

Gets or sets the default column width.

Declaration

public int ColumnWidth { get; set; }

Property Value

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

Declaration

public VirtualGridTableViewState ColumnsViewState { get; }

Property Value

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

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

Declaration

public bool EnablePaging { get; set; }

Property Value

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

Gets the filter descriptors currently applied to the grid.

Declaration

public FilterDescriptorCollection FilterDescriptors { get; }

Property Value

Gets or sets the height of the filter row.

Declaration

public int FilterRowHeight { get; set; }

Property Value

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

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

Declaration

public RadVirtualGridElement GridElement { get; }

Property Value

Gets or sets the height of the header row.

Declaration

public int HeaderRowHeight { get; set; }

Property Value

Gets the hierarchy level of the current view.

Declaration

public int HierarchyLevel { get; }

Property Value

Gets or sets the ScrollState of the horizontal scroll bar.

Declaration

public ScrollState HorizontalScrollState { get; set; }

Property Value

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

Declaration

public bool IsExpanded { get; }

Property Value

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

Declaration

public bool IsWaiting { get; set; }

Property Value

Gets or sets the minimum width a column can be.

Declaration

public int MinColumnWidth { get; set; }

Property Value

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

Declaration

public int MinRowHeight { get; set; }

Property Value

Gets or sets the name of the view.

Declaration

public string Name { get; set; }

Property Value

Gets or sets the height of the add new row.

Declaration

public int NewRowHeight { get; set; }

Property Value

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

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

Declaration

public Padding Padding { get; set; }

Property Value

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

Declaration

public int PageIndex { get; set; }

Property Value

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

Declaration

public int PageSize { get; set; }

Property Value

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

Declaration

public int ParentRowIndex { get; }

Property Value

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

Declaration

public VirtualGridViewInfo ParentViewInfo { get; }

Property Value

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

Declaration

public int RowCount { get; set; }

Property Value

Gets or sets the default height of the data rows.

Declaration

public int RowHeight { get; set; }

Property Value

Gets or sets the space between adjacent rows.

Declaration

public int RowSpacing { get; set; }

Property Value

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

Declaration

public VirtualGridTableViewState RowsViewState { get; }

Property Value

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

Declaration

public bool ShowFilterRow { get; set; }

Property Value

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

Declaration

public bool ShowHeaderRow { get; set; }

Property Value

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

Declaration

public bool ShowNewRow { get; set; }

Property Value

Gets the sort descriptors currently applied to the grid.

Declaration

public SortDescriptorCollection SortDescriptors { get; }

Property Value

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

Declaration

public object Tag { get; set; }

Property Value

Gets the total number of pages when paging is enabled.

Declaration

public int TotalPages { get; }

Property Value

Gets or sets the ScrollState of the vertical scroll bar.

Declaration

public ScrollState VerticalScrollState { get; set; }

Property Value

Binds the properties.

Declaration

public void BindProperties(VirtualGridTableElement source)

Parameters

Clears the error text of the specified row.

Declaration

public void ClearRowErrorText(int rowIndex)

Parameters

Collapses the specified row.

Declaration

public bool CollapseRow(int rowIndex)

Parameters

Returns

Creates a child view info for the specified row.

Declaration

protected virtual VirtualGridViewInfo CreateChildViewInfo(int rowIndex)

Parameters

Returns

Expands the specified row.

Declaration

public bool ExpandRow(int rowIndex)

Parameters

Returns

Gets the child view info for the specified row.

Declaration

public VirtualGridViewInfo GetChildViewInfo(int rowIndex)

Parameters

Returns

Gets the child view info for the specified row.

Declaration

public VirtualGridViewInfo GetChildViewInfo(int rowIndex, bool forceCreate)

Parameters

Returns

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

Declaration

public bool GetColumnAllowNaturalSort(int columnIndex)

Parameters

Returns

Gets the data type of the specified column.

Declaration

public Type GetColumnDataType(int columnIndex)

Parameters

Returns

Gets the column pin position.

Declaration

public PinnedColumnPosition GetColumnPinPosition(int columnIndex)

Parameters

Returns

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

Declaration

public int GetColumnWidth(int columnIndex)

Parameters

Returns

Returns the error text for the specified row.

Declaration

public string GetRowErrorText(int rowIndex)

Parameters

Returns

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

Declaration

public int GetRowHeight(int rowIndex)

Parameters

Returns

Gets the row pin position.

Declaration

public PinnedRowPosition GetRowPinPosition(int rowIndex)

Parameters

Returns

Gets the total height of the row.

Declaration

public int GetTotalRowHeight()

Returns

Handles the property change.

Declaration

protected void HandlePropertyChange(string propertyName)

Parameters

Initializes the view info.

Declaration

protected virtual void InitializeViewInfo()

Returns a value indicating whether the specified column is pinned.

Declaration

public bool IsColumnPinned(int columnIndex)

Parameters

Returns

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

Declaration

public bool IsCustomColumn(int columnIndex)

Parameters

Returns

Returns a value indicating whether the specified row is expanded.

Declaration

public bool IsRowExpanded(int rowIndex)

Parameters

Returns

Returns a value indicating whether the specified row is pinned.

Declaration

public bool IsRowPinned(int rowIndex)

Parameters

Returns

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

Declaration

public bool IsRowWaiting(int rowIndex)

Parameters

Returns

Moves the current view to the first page.

Declaration

public void MoveToFirstPage()

Moves the current view to the last page.

Declaration

public void MoveToLastPage()

Moves the current view to the next page index.

Declaration

public void MoveToNextPage()

Moves the current view to the specified page index.

Declaration

public void MoveToPage(int pageIndex)

Parameters

Moves the current view to the previous page index.

Declaration

public void MoveToPreviousPage()

Declaration

protected virtual void OnFilterDescriptorsCollectionChanged(NotifyCollectionChangedEventArgs e)

Parameters

Raises the standard .NET PropertyChanged event.

Declaration

protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)

Parameters

Overrides RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)

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

Declaration

protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

Overrides RadObject.OnPropertyChanged(RadPropertyChangedEventArgs)

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

Returns

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

Declaration

public void ResetViewState()

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

Declaration

public bool RowHasError(int rowIndex)

Parameters

Returns

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

Declaration

public void SetColumnAllowNaturalSort(int columnIndex, bool allowNaturalSort)

Parameters

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

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

Sets the pin position of the specified column.

Declaration

public void SetColumnPinPosition(int columnIndex, PinnedColumnPosition pinPosition)

Parameters

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

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

Declaration

public void SetRowErrorText(int rowIndex, string errorText)

Parameters

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

Sets the pin position of the specified row.

Declaration

public void SetRowPinPosition(int rowIndex, PinnedRowPosition position)

Parameters

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

Declaration

public void StartRowWaiting(int rowIndex)

Parameters

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

Unbinds the properties.

Declaration

public void UnbindProperties(VirtualGridTableElement source)

Parameters

Removes the column registration as one containing custom cells.

Declaration

public bool UnregisterCustomColumn(int columnIndex)

Parameters

Returns