Class SerializableDataGrid

Represents a class that is used to serialize and deserialize SfDataGrid property settings.

Inheritance

System.Object

SerializableDataGrid

Namespace: Syncfusion.Maui.DataGrid

Assembly: Syncfusion.Maui.DataGrid.dll

Syntax

public class SerializableDataGrid : Object

Constructors

SerializableDataGrid()

Declaration

public SerializableDataGrid()

Properties

AllowColumnSelection

Gets or sets a value that indicates whether the column selection is applied by tapping or double tapping a header cell in SerializableDataGrid.

Declaration

public bool AllowColumnSelection { get; set; }

Property Value

Type
System.Boolean

AllowDeleting

Gets or sets a value that indicates whether deleting selected rows with the delete key is enabled during navigation in SerializableDataGrid.

Declaration

public bool AllowDeleting { get; set; }

Property Value

Type
System.Boolean

AllowDiagonalScrolling

Gets or sets a value that indicates whether diagonal scrolling is allowed in SerializableDataGrid.

Declaration

public bool AllowDiagonalScrolling { get; set; }

Property Value

Type
System.Boolean

AllowDraggingColumn

Gets or sets a value that indicates whether the column can be repositioned by using mouse or touch in SerializableDataGrid.

Declaration

public bool AllowDraggingColumn { get; set; }

Property Value

Type
System.Boolean

AllowDraggingRow

Gets or sets a value that indicates whether the row can be repositioned by using mouse or touch in SerializableDataGrid.

Declaration

public bool AllowDraggingRow { get; set; }

Property Value

Type
System.Boolean

AllowEditing

Gets or sets a value that indicates whether the editing is enabled in SerializableDataGrid.

Declaration

public bool AllowEditing { get; set; }

Property Value

Type
System.Boolean

AllowGroupExpandCollapse

Gets or sets a value that indicates whether to allow expanding and collapsing of groups in SerializableDataGrid.

Declaration

public bool AllowGroupExpandCollapse { get; set; }

Property Value

Type
System.Boolean

AllowKeyboardNavigation

Gets or sets a value that indicates whether to enable keyboard navigation in SerializableDataGrid.

Declaration

public bool AllowKeyboardNavigation { get; set; }

Property Value

Type
System.Boolean

AllowLoadMore

Gets or sets a value that indicates whether to enable load more in SerializableDataGrid.

Declaration

public bool AllowLoadMore { get; set; }

Property Value

Type
System.Boolean

AllowPullToRefresh

Gets or sets a value that indicates whether to enable/disable the refreshing option upon pulling the SerializableDataGrid.

Declaration

public bool AllowPullToRefresh { get; set; }

Property Value

Type
System.Boolean

AllowResizingColumns

Gets or sets a value that indicates whether the user can adjust the column width by using the mouse in SerializableDataGrid.

Declaration

public bool AllowResizingColumns { get; set; }

Property Value

Type
System.Boolean

AllowSwiping

Gets or sets a value that indicates whether swiping is enabled for the SerializableDataGrid.

Declaration

public bool AllowSwiping { get; set; }

Property Value

Type
System.Boolean

AllowTriStateSorting

Gets or sets a value that indicates whether the user can sort the data to its initial order other than Ascending or Descending state in SerializableDataGrid.

Declaration

public bool AllowTriStateSorting { get; set; }

Property Value

Type
System.Boolean

AlternationRowCount

Gets or sets a row count to apply the background for the rows alternatively in SerializableDataGrid.

Declaration

public int AlternationRowCount { get; set; }

Property Value

Type
System.Int32

AutoExpandGroups

Gets or sets a value that indicates whether the group is expanded automatically , when the column is grouped in SerializableDataGrid.

Declaration

public bool AutoExpandGroups { get; set; }

Property Value

Type
System.Boolean

AutoGenerateColumnsMode

Gets or sets a value that indicates how the columns are generated during automatic column generation .

Declaration

public AutoGenerateColumnsMode AutoGenerateColumnsMode { get; set; }

Property Value

Type
AutoGenerateColumnsMode

AutoGenerateColumnsModeForCustomType

Gets or sets a value that indicates whether to generate the columns only for the custom type and not create the columns for all inner properties of custom types in SerializableDataGrid.

Declaration

public AutoGenerateColumnsModeForCustomType AutoGenerateColumnsModeForCustomType { get; set; }

Property Value

Type
AutoGenerateColumnsModeForCustomType

AutoGenerateRelations

Gets or sets a value that indicates whether the relations for Master-Details View is generated automatically in SerializableDataGrid.

Declaration

public bool AutoGenerateRelations { get; set; }

Property Value

Type
System.Boolean

CanMaintainScrollPosition

Gets or sets a value that indicates whether the scroll is maintained in SerializableDataGrid.

Declaration

public bool CanMaintainScrollPosition { get; set; }

Property Value

Type
System.Boolean

CanUseViewFilter

Gets or sets a value that indicates whether to create a view by considering ICollectionView.Filter or DataView.RowFilter in SerializableDataGrid.

Declaration

public bool CanUseViewFilter { get; set; }

Property Value

Type
System.Boolean

CaptionSummaryRow

Gets or sets the SerializableDataGridSummaryRow that displays the summary information at the header of each group .

Declaration

public SerializableDataGridSummaryRow CaptionSummaryRow { get; set; }

Property Value

Type
SerializableDataGridSummaryRow

Columns

Gets or sets the collection that contains all the columns in SerializableDataGrid.

Declaration

public SerializableColumns Columns { get; set; }

Property Value

Type
SerializableColumns

ColumnWidthMode

Gets or sets a value that indicates how the column widths are determined.

Declaration

public ColumnWidthMode ColumnWidthMode { get; set; }

Property Value

Type
ColumnWidthMode

DataFetchSize

Gets or sets the amount of data to fetch for virtualizing operations.

Declaration

public int DataFetchSize { get; set; }

Property Value

Type
System.Int32

DefaultColumnWidth

Gets or sets the default column width of the SerializableDataGrid .

Declaration

public double DefaultColumnWidth { get; set; }

Property Value

Type
System.Double

DetailsViewDefinition

Gets or sets the collection of ViewDefinition that enables you to represent the data in to hierarchical format.

Declaration

public SerializableDetailsViewDefinition DetailsViewDefinition { get; set; }

Property Value

Type
SerializableDetailsViewDefinition

DetailsViewPadding

Gets or sets the space between the edge of DetailsViewDataGrid and its content.

Declaration

public Thickness DetailsViewPadding { get; set; }

Property Value

Type
Microsoft.Maui.Thickness

EditTapAction

Gets or sets a value that indicates whether the editing action can be accomplished either at single or double click in SerializableDataGrid.

Declaration

public DataGridTapAction EditTapAction { get; set; }

Property Value

Type
DataGridTapAction

EnableDataVirtualization

Gets or sets a value indicating whether to create RecordEntry for all the objects in SourceCollection while loading itself in SerializableDataGrid.

Declaration

public bool EnableDataVirtualization { get; set; }

Property Value

Type
System.Boolean

ExpanderColumnWidth

Gets or sets the Expander column width.

Declaration

public double ExpanderColumnWidth { get; set; }

Property Value

Type
System.Double

FrozenColumnCount

Gets or sets the number of columns left to the SerializableDataGrid remains fixed in the view, when scrolled out of its visibility.

Declaration

public int FrozenColumnCount { get; set; }

Property Value

Type
System.Int32

FrozenRowCount

Gets or sets the number of top-most rows remains fixed in view, when scrolled out of its visibility.

Declaration

public int FrozenRowCount { get; set; }

Property Value

Type
System.Int32

GridLinesVisibility

Gets or sets a value that specifies the horizontal and vertical lines visibility of the cells in grid (except header cells).

Declaration

public GridLinesVisibility GridLinesVisibility { get; set; }

Property Value

Type
GridLinesVisibility

GroupCaptionTextFormat

Gets or sets the format of group caption text.

Declaration

public string GroupCaptionTextFormat { get; set; }

Property Value

Type
System.String

GroupColumnDescriptions

Gets or sets the collection of GroupColumnDescription object that describes how the column to be grouped in to view .

Declaration

public SerializableGroupColumnDescriptions GroupColumnDescriptions { get; set; }

Property Value

Type
SerializableGroupColumnDescriptions

GroupingMode

Gets or sets a value that indicates whether whether to allow single or multiple columns to perform grouping in SerializableDataGrid.

Declaration

public GroupingMode GroupingMode { get; set; }

Property Value

Type
GroupingMode

GroupSummaryRows

Gets or sets the collection of DataGridSummaryRow that displays summary information at the footer of each group.

Declaration

public SerializableDataGridSummaryRows GroupSummaryRows { get; set; }

Property Value

Type
SerializableDataGridSummaryRows

HeaderLinesVisibility

Gets or sets a value that specifies the horizontal and vertical lines visibility of the stacked header cells and header cells in grid.

Declaration

public GridLinesVisibility HeaderLinesVisibility { get; set; }

Property Value

Type
GridLinesVisibility

HeaderRowHeight

Gets or sets the height of the header row.

Declaration

public double HeaderRowHeight { get; set; }

Property Value

Type
System.Double

HorizontalScrollBarVisibility

Gets or sets a value that controls when the horizontal scrollbar is visible in SerializableDataGrid.

Declaration

public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }

Property Value

Type
Microsoft.Maui.ScrollBarVisibility

IndentColumnWidth

Gets or sets the Indent column width.

Declaration

public double IndentColumnWidth { get; set; }

Property Value

Type
System.Double

IsBusy

Gets or sets a value that indicates whether the SerializableDataGrid is in a busy state when executing the LoadMoreCommand.

Declaration

public bool IsBusy { get; set; }

Property Value

Type
System.Boolean

LiveDataUpdateMode

Gets or sets a value to control data manipulation operations during data updates.

Declaration

public LiveDataUpdateMode LiveDataUpdateMode { get; set; }

Property Value

Type
LiveDataUpdateMode

LoadMorePosition

Gets or sets a value to LoadMorePosition in SerializableDataGrid.

Declaration

public DataGridLoadMorePosition LoadMorePosition { get; set; }

Property Value

Type
DataGridLoadMorePosition

LoadMoreText

Gets or sets the string that is used to displayed on the LoadMoreText in SerializableDataGrid.

Declaration

public string LoadMoreText { get; set; }

Property Value

Type
System.String

MaxSwipeOffset

Gets or sets the maximum distance a row can be swiped before the swipe action is considered complete in SerializableDataGrid .

Declaration

public double MaxSwipeOffset { get; set; }

Property Value

Type
System.Double

NavigationMode

Gets or sets the NavigationMode that indicates whether the navigation can be accomplished based on either cell or row in SerializableDataGrid.

Declaration

public DataGridNavigationMode NavigationMode { get; set; }

Property Value

Type
DataGridNavigationMode

NotifyEventsToParentDataGrid

Gets or sets a value that indicates whether to notify details view SerializableDataGrid or child data SerializableDataGrid events to the parent.

Declaration

public bool NotifyEventsToParentDataGrid { get; set; }

Property Value

Type
System.Boolean

ReuseRowsOnItemssourceChange

Gets or sets a value that indicates whether the rows are reused when the ItemsSource for DetailsViewDataGrid(reusing DetailsViewDataRow) has changed.

Declaration

public bool ReuseRowsOnItemssourceChange { get; set; }

Property Value

Type
System.Boolean

RowHeaderWidth

Gets or sets the width of the RowHeader.

Declaration

public double RowHeaderWidth { get; set; }

Property Value

Type
System.Double

RowHeight

Gets or sets the height of all data rows in SerializableDataGrid .

Declaration

public double RowHeight { get; set; }

Property Value

Type
System.Double

SelectedIndex

Gets or sets an index of the currently selected row.

Declaration

public int SelectedIndex { get; set; }

Property Value

Type
System.Int32

SelectionMode

Gets or sets the value that indicates how the rows or cells are selected in SerializableDataGrid.

Declaration

public DataGridSelectionMode SelectionMode { get; set; }

Property Value

Type
DataGridSelectionMode

SelectionUnit

Gets or sets a value that decides the type of selection behavior to be performed in SerializableDataGrid.

Declaration

public DataGridSelectionUnit SelectionUnit { get; set; }

Property Value

Type
DataGridSelectionUnit

ShowColumnWhenGrouped

Gets or sets a value that indicates whether the column is displayed on SerializableDataGrid after it is grouped.

Declaration

public bool ShowColumnWhenGrouped { get; set; }

Property Value

Type
System.Boolean

ShowRowHeader

Gets or sets a value that indicates whether the RowHeader can be enabled in SerializableDataGrid.

Declaration

public bool ShowRowHeader { get; set; }

Property Value

Type
System.Boolean

ShowSortNumbers

Gets or sets a value that indicates whether the sequence number should be displayed on the header cell of sorted column during multi-column sorting.

Declaration

public bool ShowSortNumbers { get; set; }

Property Value

Type
System.Boolean

SortColumnDescriptions

Gets or sets the collection of SortColumnDescription objects that are used to perform programmatic sorting.

Declaration

public SerializableSortColumnDescriptions SortColumnDescriptions { get; set; }

Property Value

Type
SerializableSortColumnDescriptions

SortingGestureType

Gets or sets a value that indicates how the sorting should be initiated.

Declaration

public DataGridSortingGestureType SortingGestureType { get; set; }

Property Value

Type
DataGridSortingGestureType

SortingMode

Gets or sets the value that indicates how the sorting should be applied.

Declaration

public DataGridSortingMode SortingMode { get; set; }

Property Value

Type
DataGridSortingMode

StackedHeaderRows

Gets or sets the collection of DataGridStackedHeaderRow that enables you to group more than one columns under particular category.

Declaration

public SerializableDataGridStackedHeaderRows StackedHeaderRows { get; set; }

Property Value

Type
SerializableDataGridStackedHeaderRows

SummaryCalculationMode

Gets or sets the mode for summary calculation.

Declaration

public Nullable<CalculationMode> SummaryCalculationMode { get; set; }

Property Value

Type
System.Nullable<CalculationMode>

SwipeOffsetMode

Gets or sets the DataGridSwipeOffsetMode that determines whether to use the MaxSwipeOffset or the swipe view's content width to calculate the swipe threshold.

Declaration

public DataGridSwipeOffsetMode SwipeOffsetMode { get; set; }

Property Value

Type
DataGridSwipeOffsetMode

TableSummaryRows

Gets or sets the collection of DataGridSummaryRow that displays the summary information of table either at top or bottom of SerializableDataGrid.

Declaration

public SerializableDataGridTableSummaryRows TableSummaryRows { get; set; }

Property Value

Type
SerializableDataGridTableSummaryRows

TransitionType

Gets or sets a PullToRefreshTransitionType, decides the transition of progress indicator.

Declaration

public PullToRefreshTransitionType TransitionType { get; set; }

Property Value

Type
PullToRefreshTransitionType

UnboundRows

Gets or sets the collection of DataGridUnboundRow that displays the custom information in SerializableDataGrid.

Declaration

public SerializableDataGridUnboundRows UnboundRows { get; set; }

Property Value

Type
SerializableDataGridUnboundRows

VerticalOverScrollMode

Gets or sets a value indicating what effect should be applied when SerializableDataGrid is vertically over-scrolled.

Declaration

public DataGridVerticalOverScrollMode VerticalOverScrollMode { get; set; }

Property Value

Type
DataGridVerticalOverScrollMode

VerticalScrollBarVisibility

Gets or sets a value that controls when the vertical scrollbar is visible.

Declaration

public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }

Property Value

Type
Microsoft.Maui.ScrollBarVisibility