dotnet-api

C1.Xamarin.Forms.Grid.FlexGrid

FlexGrid Class

Control used to display and edit tabular information.

Inheritance

object

GridBase

FlexGrid

Implements

IComponent

IDisposable

Namespace: C1.Xamarin.Forms.Grid

Assembly: C1.Xamarin.Forms.Grid.dll

Syntax

public class FlexGrid : GridBase, IComponent, IDisposable

Remarks

Supports virtualized data-binding and automatic sorting and filters in client/server scenarios.

Constructors

Name	Description
FlexGrid()	Initializes a new instance of the FlexGrid class.

Fields

Name	Description
AllowSortingProperty
AlternatingRowBackgroundColorProperty
AlternatingRowTextColorProperty
AutoGenerateColumnsProperty
AutoSizeModeProperty
DefaultColumnHeaderRowHeightProperty
DefaultColumnWidthProperty
DefaultGroupRowHeightProperty
DefaultRowHeaderColumnWidthProperty
DefaultRowHeightProperty
EditIconTemplateProperty
GroupCollapsedIconTemplateProperty
GroupExpandedIconTemplateProperty
GroupHeaderConverterProperty
GroupHeaderFormatProperty
GroupRowBackgroundColorProperty
GroupRowFontAttributesProperty
GroupRowFontFamilyProperty
GroupRowFontSizeProperty
GroupRowPositionProperty
GroupRowTextColorProperty
ItemsSourceProperty
MaxColumnWidthProperty
MaxRowHeightProperty
MinColumnWidthProperty
MinRowHeightProperty
NewRowBackgroundColorProperty
NewRowIconTemplateProperty
NewRowPlaceholderProperty
NewRowPositionProperty
NewRowTextColorProperty
ShowOutlineBarProperty
ShowSortProperty
SortAscendingIconTemplateProperty
SortDescendingIconTemplateProperty
SortIconPositionProperty
TreeIndentProperty

Properties

Name	Description
AllowSorting	Gets or sets whether users are allowed to sort columns by tapping or clicking the column header cells.
AlternatingRowBackgroundColor	Gets or sets the Xamarin.Forms.Color that is used to paint the background of odd-numbered rows.
AlternatingRowTextColor	Gets or sets the Xamarin.Forms.Color that is used to paint the text of odd-numbered rows.
AutoGenerateColumns	Gets or sets a value to determine whether columns are generated automatically from the properties of the items of ItemsSource.
AutoSizeMode	Gets or sets which cells should be taken into account when auto-sizing a row or column.
CellFactory	Gets or sets the factory of cells.
Cells	Gets the GridPanel that contains the data cells in the grid.
ClassicStyle	Gets a style that mimics excel-style.
ColumnHeaders	Gets the GridPanel that contains the column header cells.
Columns	Gets the collection of columns of the grid.
DataCollection	Gets the inner collection view.
DefaultColumnHeaderRowHeight	Gets or sets the default height of the rows used to display column headers.
DefaultColumnWidth	Gets or sets the default width of the columns.
DefaultGroupRowHeight	Gets or sets the default height of the group rows.
DefaultRowHeaderColumnWidth	Gets or sets the default width of the columns used to display row headers.
DefaultRowHeight	Gets or sets the default height of the rows.
EditIconTemplate	Gets or sets the template used to create the icon displayed in the header when a row is being edited.
GroupCollapsedIconTemplate	Gets or sets the template used to create the icon displayed when the group is collapsed.
GroupExpandedIconTemplate	Gets or sets the template used to create the icon displayed when the group is expanded.
GroupHeaderConverter	Gets or sets the Xamarin.Forms.IValueConverter used to create the content shown in GridGroupRow cells to summarize group information.
GroupHeaderFormat	Gets or sets the format string used to create the group header content.
GroupRowBackgroundColor	Gets or sets the Xamarin.Forms.Color of the group row background.
GroupRowFontAttributes	Gets or sets the font attributes applied to group row cells.
GroupRowFontFamily	Gets or sets the font family applied to group row cells.
GroupRowFontSize	Gets or sets the font size applied to group row cells.
GroupRowPosition	Gets or sets a value that indicates where group rows should be displayed with respect to the data.
GroupRowTextColor	Gets or sets the Xamarin.Forms.Color of the text and glyphs of the group rows.
this[GridRow, GridColumn]	Gets or sets the value of the cell specified by its row and column.
this[int, int]	Gets or sets the value of the cell specified by its row and column.
ItemsSource	Gets or sets the collection of items.
MaxColumnWidth	Gets or sets the maximum width of columns in the FlexGrid.
MaxGroupLevel	Gets the maximum group level present in the grid.
MaxRowHeight	Gets or sets the maximum height of rows in the FlexGrid.
MergeManager	Gets or sets the merge manager.
MinColumnWidth	Gets or sets the minimum width of columns in the FlexGrid.
MinRowHeight	Gets or sets the minimum height of rows in the FlexGrid.
NewRowBackgroundColor	Gets or sets the Xamarin.Forms.Color of the new row background.
NewRowIconTemplate	Gets or sets the template used to create the icon displayed in the header of a new row.
NewRowPlaceholder	Gets or sets the message displayed in the new row template.
NewRowPosition	Gets or sets a value that indicates whether the new row template should be displayed at the bottom or at the top of the grid, or if there should not be displayed.
NewRowTextColor	Gets or sets the Xamarin.Forms.Color of the text and glyphs of the new row.
RowHeaders	Gets the GridPanel that contains the row header cells.
Rows	Gets the collection of rows of the grid.
ShowOutlineBar	Gets or sets a value that determines whether the grid should display the outline button bar.
ShowSort	Gets or sets whether the grid should display sort indicators in the column headers.
SortAscendingIconTemplate	Gets or sets the template of the sort icon when it is sorted ascendingly.
SortDescendingIconTemplate	Gets or sets the template of the sort icon when it is sorted descendingly.
SortIconPosition	Gets or sets the position of the sort icon inside the column header.
TopLeftCells	Gets the GridPanel that contains the cells in the upper left corner of the grid.
TreeIndent	Gets or sets the indent used to offset each group of rows in the grid.

Methods

Name	Description
AutoSizeColumn(int, bool)	Resizes a column to fit their visible content.
AutoSizeColumns(int, int, bool)	Resizes a column range to fit their visible content.
AutoSizeRow(int, bool)	Resizes a row to fit their visible contents.
AutoSizeRows(int, int, bool)	Resizes a row range to fit their visible contents.
CanRefresh()	Determines whether the grid shows the refresh indicator when pulled.
CollapseGroups(int)	Collapses the groups.
CreateSelectionMenu(GridCellRange)	Creates the selection menu.
FinishRowEditing(bool)	Finishes the row editing.
GetCellText(GridCellRange)	Gets the text corresponding to the cell in the specified range.
GetCellText(GridCellType, GridCellRange)	Gets the text corresponding to the cell in the specified range.
GetCellText(GridCellType, GridRow, GridColumn)	Gets the text corresponding to the cell in the specified row and column.
GetCellValue(GridCellRange)	Gets the value corresponding to the cell in the specified range.
GetCellValue(GridCellType, GridCellRange)	Gets the value corresponding to the cell in the specified range.
GetCellValue(GridCellType, GridRow, GridColumn)	Gets the value corresponding to the cell in the specified row and column.
LoadDesignTimeData()	Loads dummy design time content visible in Storyboard and Android designer
OnAutoGeneratingColumn(GridAutoGeneratingColumnEventArgs)	Raises the AutoGeneratingColumn event.
OnBeginningRowEdit(GridCellEditEventArgs)	Raises the BeginningRowEdit event.
OnCellDoubleTapped(GridCellType, GridCellRange, C1TappedEventArgs)	Called when a cell is double tapped.
OnCellLongPressed(GridCellType, GridCellRange, C1TappedEventArgs)	Called when a cell is being held.
OnCellTapped(GridCellType, GridCellRange, C1TappedEventArgs)	Called when a cell is tapped.
OnDisposing()	Called when the object is being disposed.
OnGroupCollapsedChanged(GridCellRangeEventArgs)	Raises the GroupCollapsedChanged event.
OnGroupCollapsedChanging(GridCellRangeEventArgs)	Raises the GroupCollapsedChanging event.
OnIsReadOnlyChanged()	Called when the property IsReadOnly changed.
OnPropertyChanged(string)
OnRefreshAsync(GridRefreshEventArgs)	Called when the refresh was pulled.
OnRowEditEnded(GridCellEditEventArgs)	Raises the RowEditEnded event.
OnRowEditEnding(GridCellEditEventArgs)	Raises the RowEditEnding event.
Save(Stream, GridFileFormat)	Saves the contents of the grid to an UTF8-encoded stream.
Save(Stream, GridFileFormat, GridSaveOptions)	Saves the contents of the grid to an UTF8-encoded stream.
Save(Stream, GridFileFormat, Encoding, GridSaveOptions)	Saves the contents of the grid to a stream.
Save(StreamWriter, GridFileFormat, GridSaveOptions)	Saves the contents of the grid to a StreamWriter.
Save(string, GridFileFormat)	Saves the contents of the grid to an UTF8-encoded file.
Save(string, GridFileFormat, GridSaveOptions)	Saves the contents of the grid to an UTF8-encoded file.
Save(string, GridFileFormat, Encoding, GridSaveOptions)	Saves the contents of the grid to a file.
SetCellValue(GridCellRange, object)	Sets the value corresponding to the cell in the specified range.
SetCellValue(GridCellType, GridCellRange, object)	Sets the value corresponding to the cell in the specified range.
SetCellValue(GridCellType, GridRow, GridColumn, object)	Sets the value corresponding to the cell in the specified row and column.
SetCellValue(GridCellType, int, int, object)	Sets the value corresponding to the cell in the specified range.
StartEditing(int, int, bool, bool)	Starts editing a specific cell.
StartEditingAsync(int, int, bool, bool)	Starts the editing of the specified cell asynchronously.

Events

Name	Description
AutoGeneratingColumn	Occurs when an auto-generated column is being created.
BeginningRowEdit	Occurs when the edit of a row is about to start.
GroupCollapsedChanged	Occurs after the IsCollapsed property of a GridGroupRow object changes.
GroupCollapsedChanging	Occurs before the IsCollapsed property of a GridGroupRow object changes.
ItemsSourceChanged	Occurs after the items source is changed.
ItemsSourceChanging	Occurs before the items source is changed.
RowEditEnded	Occurs when a row edit has been committed or canceled.
RowEditEnding	Occurs when a row edit is ending.