Class SerializableDataGrid

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

Inheritance

System.Object

SerializableDataGrid

Namespace: Syncfusion.UI.Xaml.Grid

Assembly: Syncfusion.SfGrid.WPF.dll

Syntax

public class SerializableDataGrid : Object

Constructors

SerializableDataGrid()

Declaration

public SerializableDataGrid()

Properties

AddNewRowPosition

Gets or sets a value that indicates whether the AddNewRow can be positioned either at top or bottom of SerializableDataGrid.

Declaration

public AddNewRowPosition AddNewRowPosition { get; set; }

Property Value

Type
AddNewRowPosition

AllowDeleting

Gets or sets a value that indicates whether the user can delete the rows using Delete Key.

Declaration

public bool AllowDeleting { get; set; }

Property Value

Type
System.Boolean

AllowDraggingColumns

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

Declaration

public bool AllowDraggingColumns { 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

AllowFiltering

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

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type
System.Boolean

AllowFrozenGroupHeaders

Gets or sets a value that indicates whether the group header remains fixed at the width of display area or scrolled(horizontal scrolling) out of its visibility in SerializableDataGrid .

Declaration

public bool AllowFrozenGroupHeaders { get; set; }

Property Value

Type
System.Boolean

AllowGrouping

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

Declaration

public bool AllowGrouping { 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

AllowResizingHiddenColumns

Gets or sets a value that indicates whether the hidden column can be resized using the mouse in SerializableDataGrid.

Declaration

public bool AllowResizingHiddenColumns { get; set; }

Property Value

Type
System.Boolean

AllowRowHoverHighlighting

Gets or sets a value that indicates whether the user can highlight the row being hovered through mouse or touch.

Declaration

public bool AllowRowHoverHighlighting { get; set; }

Property Value

Type
System.Boolean

AllowSelectionOnPointerPressed

Gets or sets a value that indicates whether the selection should be present at the PointerPressed state in SerializableDataGrid.

Declaration

public bool AllowSelectionOnPointerPressed { get; set; }

Property Value

Type
System.Boolean

AllowSort

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

Declaration

public bool AllowSort { 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

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

AutoGenerateColumns

Gets or sets a value that indicates whether the columns should be created automatically in SerializableDataGrid.

Declaration

public bool AutoGenerateColumns { get; set; }

Property Value

Type
System.Boolean

AutoGenerateColumnsForCustomType

Gets or sets a value that indicates whether to generate columns automatically for the custom types and its inner properties in SerializableDataGrid.

Declaration

public bool AutoGenerateColumnsForCustomType { 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

CaptionSummaryRow

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

Declaration

public SerializableGridSummaryRow CaptionSummaryRow { get; set; }

Property Value

Type
SerializableGridSummaryRow

Columns

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

Declaration

public SerializableColumns Columns { get; set; }

Property Value

Type
SerializableColumns

ColumnSizer

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

Declaration

public GridLengthUnitType ColumnSizer { get; set; }

Property Value

Type
GridLengthUnitType

CurrentCellBorderThickness

Gets or sets the width for the boundaries of the current cell border in SerializableDataGrid.

Declaration

public Thickness CurrentCellBorderThickness { get; set; }

Property Value

Type
System.Windows.Thickness

DataFetchSize

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

Declaration

public int DataFetchSize { get; set; }

Property Value

Type
System.Int32

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
System.Windows.Thickness

EditorSelectionBehavior

Gets or sets the selection behavior of editor that is loaded in GridCell.

Declaration

public EditorSelectionBehavior EditorSelectionBehavior { get; set; }

Property Value

Type
EditorSelectionBehavior

EditTrigger

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

Declaration

public EditTrigger EditTrigger { get; set; }

Property Value

Type
EditTrigger

ExpanderColumnWidth

Gets or sets the Expander column width

Declaration

public double ExpanderColumnWidth { get; set; }

Property Value

Type
System.Double

FilterRowPosition

Gets or sets a value that indicates whether the FilterRow can be positioned either at top or bottom of SerializableDataGrid.

Declaration

public FilterRowPosition FilterRowPosition { get; set; }

Property Value

Type
FilterRowPosition

FilterSettings

Gets or sets the filter settings for serializing filter predicates.

Declaration

public SerializableFilterSettings FilterSettings { get; set; }

Property Value

Type
SerializableFilterSettings

FooterColumnCount

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

Declaration

public int FooterColumnCount { get; set; }

Property Value

Type
System.Int32

FooterRowsCount

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

Declaration

public int FooterRowsCount { get; set; }

Property Value

Type
System.Int32

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

FrozenRowsCount

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

Declaration

public int FrozenRowsCount { get; set; }

Property Value

Type
System.Int32

GridCopyOption

Gets or sets a value that indicates how the content is copied from SerializableDataGrid control to the clipboard.

Declaration

public GridCopyOption GridCopyOption { get; set; }

Property Value

Type
GridCopyOption

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

GridPasteOption

Gets or sets a value that indicates how the clipboard value is pasted into SerializableDataGrid.

Declaration

public GridPasteOption GridPasteOption { get; set; }

Property Value

Type
GridPasteOption

GridValidationMode

Gets or sets a value to enable the built-in validation (IDataErrorInfo/DataAnnonations) to validate the user input and displays the error.

Declaration

public GridValidationMode GridValidationMode { get; set; }

Property Value

Type
GridValidationMode

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

GroupDropAreaText

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

Declaration

public string GroupDropAreaText { get; set; }

Property Value

Type
System.String

GroupSummaryRows

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

Declaration

public SerializableGridSummaryRows GroupSummaryRows { get; set; }

Property Value

Type
SerializableGridSummaryRows

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

IndentColumnWidth

Gets or sets the Indent column width.

Declaration

public double IndentColumnWidth { get; set; }

Property Value

Type
System.Double

IsDynamicItemsSource

Gets or sets a value that determines whether the underlying data source type is dynamic or not.

Declaration

public bool IsDynamicItemsSource { get; set; }

Property Value

Type
System.Boolean

IsGroupDropAreaExpanded

Gets or sets a value that indicates whether the GroupDropArea can be expanded by default.

Declaration

public bool IsGroupDropAreaExpanded { 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

NavigationMode

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

Declaration

public NavigationMode NavigationMode { get; set; }

Property Value

Type
NavigationMode

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

RowDropIndicatorMode

Gets or sets a value that indicates the mode of drop indicator notify the position of a row where the dragged rows are going to be dropped in SerializableGrid.

Declaration

public DropIndicatorMode RowDropIndicatorMode { get; set; }

Property Value

Type
DropIndicatorMode

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

SelectionMode

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

Declaration

public GridSelectionMode SelectionMode { get; set; }

Property Value

Type
GridSelectionMode

SelectionUnit

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

Declaration

public GridSelectionUnit SelectionUnit { get; set; }

Property Value

Type
GridSelectionUnit

ShowBusyIndicator

Gets or sets a value that indicates whether the busy indicator should be displayed while fetching the large amount data in .

Declaration

public bool ShowBusyIndicator { get; set; }

Property Value

Type
System.Boolean

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

ShowGroupDropArea

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

Declaration

public bool ShowGroupDropArea { 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

SortClickAction

Gets or sets a value that indicates whether the user can sort the data either at single or double click.

Declaration

public SortClickAction SortClickAction { get; set; }

Property Value

Type
SortClickAction

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

StackedHeaderRows

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

Declaration

public SerializableStackedHeaderRows StackedHeaderRows { get; set; }

Property Value

Type
SerializableStackedHeaderRows

SummaryCalculationUnit

Gets or sets the value that specifies the mode for calculating summaries.

Declaration

public SummaryCalculationUnit SummaryCalculationUnit { get; set; }

Property Value

Type
SummaryCalculationUnit

TableSummaryRows

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

Declaration

public SerializableTableGridSummaryRows TableSummaryRows { get; set; }

Property Value

Type
SerializableTableGridSummaryRows

UnBoundRows

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

Declaration

public SerializableGridUnBoundRows UnBoundRows { get; set; }

Property Value

Type
SerializableGridUnBoundRows

UsePLINQ

Gets or sets a value that indicates whether the Parallel LINQ is enabled during Sorting, Filtering, Grouping and summary calculation to improve performance.

Declaration

public bool UsePLINQ { get; set; }

Property Value

Type
System.Boolean