Class SerializableDataGrid

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

Inheritance

System.Object

SerializableDataGrid

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.WinForms.DataGrid.Serialization

Assembly: Syncfusion.SfDataGrid.WinForms.dll

Syntax

public class SerializableDataGrid

Constructors

SerializableDataGrid()

Declaration

public SerializableDataGrid()

Properties

AddNewRowPosition

Gets or sets the position of the AddNewRow in the SerializableDataGrid

Declaration

public RowPosition AddNewRowPosition { get; set; }

Property Value

Type
RowPosition

AddNewRowText

Gets or sets a value indicating whether change the add new row text.

Declaration

public string AddNewRowText { get; set; }

Property Value

Type
System.String

AdvancedFilterType

Gets or sets the filter type for advanced filter such as Text, Numeric or Date filter in the SerailizableDataGrid.

Declaration

public AdvancedFilterType AdvancedFilterType { get; set; }

Property Value

Type
AdvancedFilterType

AllowDeleting

Gets or sets a value indicating whether the user can delete the record rows by pressing Delete key.

Declaration

public bool AllowDeleting { get; set; }

Property Value

Type
System.Boolean

AllowDraggingColumns

Gets or sets a value indicating 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 indicating whether editing is enabled in SerializableDataGrid.

Declaration

public bool AllowEditing { get; set; }

Property Value

Type
System.Boolean

AllowFiltering

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

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type
System.Boolean

AllowGrouping

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

Declaration

public bool AllowGrouping { get; set; }

Property Value

Type
System.Boolean

AllowResizingColumns

Gets or sets a value indicating 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 indicating whether the hidden column can be resized using the mouse in SerializableDataGrid.

Declaration

public bool AllowResizingHiddenColumns { get; set; }

Property Value

Type
System.Boolean

AllowSelectionOnMouseDown

Gets or sets a value indicating whether the selection should be present at the MouseDown state in SerializableDataGrid.

Declaration

public bool AllowSelectionOnMouseDown { get; set; }

Property Value

Type
System.Boolean

AllowSorting

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

Declaration

public bool AllowSorting { get; set; }

Property Value

Type
System.Boolean

AllowStandardTab

Gets or sets a value indicating whether the TAB key moves the focus to the next control in the tab order rather than moving focus to the next cell in the SerializableDataGrid.

Declaration

public bool AllowStandardTab { get; set; }

Property Value

Type
System.Boolean

AllowTriStateSorting

Gets or sets a value indicating 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

AutoFitGroupDropAreaItem

Gets or sets a value indicating whether to auto fit the GroupDropAreaItem.

Declaration

public bool AutoFitGroupDropAreaItem { get; set; }

Property Value

Type
System.Boolean

AutoGenerateColumns

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

Declaration

public bool AutoGenerateColumns { get; set; }

Property Value

Type
System.Boolean

AutoGenerateColumnsMode

Gets or sets a value indicating 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 how the columns should be generated during automatic column generation for custom type in SerializableDataGrid.

Declaration

public AutoGenerateColumnsModeForCustomType AutoGenerateColumnsModeForCustomType { get; set; }

Property Value

Type
AutoGenerateColumnsModeForCustomType

AutoGenerateRelations

Gets or sets a value indicating whether to auto generate relations.

Declaration

public bool AutoGenerateRelations { get; set; }

Property Value

Type
System.Boolean

AutoSizeColumnsMode

Gets or sets the value indicating how all the columns widths of the SfDataGrid are determined.

Declaration

public AutoSizeColumnsMode AutoSizeColumnsMode { get; set; }

Property Value

Type
AutoSizeColumnsMode

BorderStyle

Gets or sets the border style for the SerializableDataGrid.

Declaration

public BorderStyle BorderStyle { get; set; }

Property Value

Type
System.Windows.Forms.BorderStyle

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

DataMember

Gets or sets a value indicates the table name that should be bound to the grid.

Declaration

public string DataMember { get; set; }

Property Value

Type
System.String

DetailsViewDefinitions

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

Declaration

public SerializableDetailsViewDefinitions DetailsViewDefinitions { get; set; }

Property Value

Type
SerializableDetailsViewDefinitions

EditMode

Gets or sets a value indicating the mode of editing in SerializableDataGrid.

Declaration

public EditMode EditMode { get; set; }

Property Value

Type
EditMode

EditorSelectionBehavior

Gets or sets a value indicating the selection behavior on edit mode in SerializableDataGrid.

Declaration

public EditorSelectionBehavior EditorSelectionBehavior { get; set; }

Property Value

Type
EditorSelectionBehavior

EnableDataVirtualization

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

Declaration

public bool EnableDataVirtualization { get; set; }

Property Value

Type
System.Boolean

FilterDelay

Gets or sets the filter delay in milliseconds for applying the immediate filtering using the filter row in SerializableDataGrid.

Declaration

public int FilterDelay { get; set; }

Property Value

Type
System.Int32

FilterPopupMode

Gets or sets the filter pop up mode of the UI filter in SerializableDataGrid.

Declaration

public FilterPopupMode FilterPopupMode { get; set; }

Property Value

Type
FilterPopupMode

FilterRowPosition

Gets or sets the position of the FilterRow in the SerializableDataGrid.

Declaration

public RowPosition FilterRowPosition { get; set; }

Property Value

Type
RowPosition

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 non-scrolling columns at the right side of SerializableDataGrid.

Declaration

public int FooterColumnCount { get; set; }

Property Value

Type
System.Int32

FooterRowCount

Gets or sets the number of non-scrolling rows at the bottom of SerializableDataGrid.

Declaration

public int FooterRowCount { get; set; }

Property Value

Type
System.Int32

FrozenColumnCount

Gets or sets the number of non-scrolling columns at the left side of SerializableDataGrid.

Declaration

public int FrozenColumnCount { get; set; }

Property Value

Type
System.Int32

FrozenRowCount

Gets or sets the number of non-scrolling rows at the top of SerializableDataGrid.

Declaration

public int FrozenRowCount { get; set; }

Property Value

Type
System.Int32

GridValidationMode

Gets or sets a value indicating the validation mode of the SerializableDataGrid.

Declaration

public GridValidationMode GridValidationMode { get; set; }

Property Value

Type
GridValidationMode

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

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

HeaderRowHeight

Gets or sets the height for the column header row of SerializableDataGrid.

Declaration

public int HeaderRowHeight { get; set; }

Property Value

Type
System.Int32

IndentColumnWidth

Gets or sets the indent column width of SerializableDataGrid.

Declaration

public double IndentColumnWidth { get; set; }

Property Value

Type
System.Double

IsDynamicDataSource

Gets or sets a value indicating whether the underlying data object type is dynamic.

Declaration

public bool IsDynamicDataSource { 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 value indicating how the navigation type of the SerializableDataGrid.

Declaration

public NavigationMode NavigationMode { get; set; }

Property Value

Type
NavigationMode

NewItemPlaceholderPosition

Gets or sets a value indicating the position of new record which is added using AddNewRow.

Declaration

public NewItemPlaceholderPosition NewItemPlaceholderPosition { get; set; }

Property Value

Type
NewItemPlaceholderPosition

PreviewRowHeight

Gets or sets the default height of the preview rows.

Declaration

public int PreviewRowHeight { get; set; }

Property Value

Type
System.Int32

PreviewRowHeightMode

Gets or sets the hight calculation mode of the preview row.

Declaration

public PreviewRowHeightMode PreviewRowHeightMode { get; set; }

Property Value

Type
PreviewRowHeightMode

PreviewRowMappingName

Gets or sets the mapping name for the preview row.

Declaration

public string PreviewRowMappingName { get; set; }

Property Value

Type
System.String

PreviewRowPadding

Gets or sets the padding of the preview data row.

Declaration

public Padding PreviewRowPadding { get; set; }

Property Value

Type
System.Windows.Forms.Padding

RightToLeft

Gets or sets a value indicating whether control's elements are aligned to support locales using right-to-left fonts.

Declaration

public RightToLeft RightToLeft { get; set; }

Property Value

Type
System.Windows.Forms.RightToLeft

RowHeaderWidth

Gets or sets a value indicates the width of the row header in SerializableDataGrid .

Declaration

public double RowHeaderWidth { get; set; }

Property Value

Type
System.Double

RowHeight

Gets or sets the height for the records row in SerializableDataGrid.

Declaration

public int RowHeight { get; set; }

Property Value

Type
System.Int32

SelectionMode

Gets or sets the value indicating how the rows can be selected in SerializableDataGrid.

Declaration

public GridSelectionMode SelectionMode { get; set; }

Property Value

Type
GridSelectionMode

SelectionMouseButtonsMask

Gets or sets a value indicating which mouse buttons can be used for selection in SerializableDataGrid.

Declaration

public MouseButtons SelectionMouseButtonsMask { get; set; }

Property Value

Type
System.Windows.Forms.MouseButtons

SelectionUnit

Gets or sets the value indicating the Selection type of the SerializableDataGrid.

Declaration

public SelectionUnit SelectionUnit { get; set; }

Property Value

Type
SelectionUnit

ShowErrorIcon

Gets or sets a value indicating whether the error icon should be drawn for the validation error cells in SerializableDataGrid.

Declaration

public bool ShowErrorIcon { get; set; }

Property Value

Type
System.Boolean

ShowGroupDropArea

Gets or sets a value indicating whether the GroupDropArea is enabled in SerializableDataGrid.

Declaration

public bool ShowGroupDropArea { get; set; }

Property Value

Type
System.Boolean

ShowHeaderToolTip

Gets or sets a value indicating whether the tooltip should be displayed when mouse hovered on the header cells of the SerializableDataGrid.

Declaration

public bool ShowHeaderToolTip { get; set; }

Property Value

Type
System.Boolean

ShowPreviewRow

Gets or sets a value indicating whether to show the preview rows or not.

Declaration

public bool ShowPreviewRow { get; set; }

Property Value

Type
System.Boolean

ShowRowHeader

Gets or sets a value indicating whether row headers should be displayed or not.

Declaration

public bool ShowRowHeader { get; set; }

Property Value

Type
System.Boolean

ShowRowHeaderErrorIcon

Gets or sets a value indicating whether the error icon should be drawn for the row header cells.

Declaration

public bool ShowRowHeaderErrorIcon { get; set; }

Property Value

Type
System.Boolean

ShowSortNumbers

Gets or sets a value indicating 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

ShowToolTip

Gets or sets a value indicating whether the tooltip should be displayed when mouse hovered on the cells of the SerializableDataGrid.

Declaration

public bool ShowToolTip { get; set; }

Property Value

Type
System.Boolean

ShowValidationErrorToolTip

Gets or sets a value indicating whether the validation error tooltip should be displayed when hovered on the error icons.

Declaration

public bool ShowValidationErrorToolTip { get; set; }

Property Value

Type
System.Boolean

SortClickAction

Gets or sets a value indicating 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

Style

Gets or sets the style for the SfDataGrid elements.

Declaration

public SerializableGridStyle Style { get; set; }

Property Value

Type
SerializableGridStyle

SummaryCalculationMode

Gets or sets the summary calculation mode for the caption and group summaries in SerializableDataGrid.

Declaration

public CalculationMode SummaryCalculationMode { get; set; }

Property Value

Type
CalculationMode

SummaryCalculationUnit

Gets or sets the value that specifies the mode for calculating summaries which decides whether to calculate summary for all records or selected records.

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 that displays the custom information in SerializableDataGrid.

Declaration

public SerializableGridUnboundRows UnboundRows { get; set; }

Property Value

Type
SerializableGridUnboundRows