GridSerializer Members

  • Article

Include Protected Members
Include Inherited Members

Serializes configuration information and data for the Microsoft.SharePoint.JSGrid into a JavaScript Object Notation (JSON) string.

The GridSerializer type exposes the following members.

Constructors

  Name Description
Public method GridSerializer Initializes a GridSerializer object.

Top

Properties

  Name Description
Public property AdditionalParams Gets a collection of information for the consumer of the GridSerializer to populate with any additional information they want sent to the client.
Public property AutoFilterColumnKeys Gets or sets a collection of column keys identifying the columns to be computed when serialization mode is set to auto-filter. When EnableAutoFilterEntryGeneration is set to true, AutoFilterColumnKeys dictates in which columns auto-filter entries are generated.
Public property BottomRecordKey Gets or sets the bottom record key.
Public property CellStyles Gets a mapping of cell style IDs, represented as strings, to cell styles.
Public property DisableRecordKeyHash Gets or sets a value that indicates whether the record key has been disabled.
Public property EnableAutoFilterEntryGeneration Gets or sets a value to determine whether auto-filter entries are generated. AutoFilterColumnKeys dictates in which columns auto-filter entries are generated.
Public property GanttBarStyleIdsColumnName Gets or sets the GanttBarStyleIds column name.
Public property GanttDependentsColumnName Gets or sets the gamtt dependents column name.
Public property GanttStyleInfo Gets the gantt style information.
Public property GridColumnMap A map of strings representing column keys to the grid columns they uniquely identify. This map is populated based on the collection passed into the GridColumns property.
Public property GridColumns Gets or sets the collection of columns to be displayed in the grid.
Public property GridFieldMap A map of strings representing field keys to the GridField objects they uniquely identify. This map is populated based on the collection passed into the GridFields property.
Public property GridFields Gets or sets a collection of rich information about the data columns in the serializer’s data source.
Public property GridRowStyleIdColumnName Gets or sets a value specifying the ColumnName in the external source table that contains the style IDs for the cells in a given row. Must be specified if using grid row styles and the ColumnName for the DataColumn containing these values does not equal the value in the constant DefaultGridRowStyleIdColumnName.
Public property GroupingDescendantCountColumnName Gets or sets the grouping descendant count.
Public property GroupingOutlineLevelColumnName Gets or sets the grouping outline level.
Public property GroupingParentKeyColumnName
Public property GroupingRecordKeyPrefix Gets or sets the grouping record key prefix.
Public property HierarchyDescendantCountColumnName Gets or sets a ColumnName that is not present in the external source table. Only needs to be specified if there is or could be a DataColumn whose ColumnName equals the value in the constant DefaultGroupingDescendantCountColumnName. If a Microsoft.SharePoint.JSGrid instance is populated by multiple GridSerializer objects over its lifetime, this value must remain consistent.
Public property HierarchyOutlineLevelColumnName Gets or sets a ColumnName that is not present in the external source table. Only needs to be specified if there is or could be a DataColumn whose ColumnName equals the value in the constant DefaultHierarchyOutlineLevelColumnName. If a Microsoft.SharePoint.JSGrid instance is populated by multiple GridSerializer objects over its lifetime, this value must remain consistent.
Public property HierarchyOutlineTextColumnName Gets the hierarchy outline of text.
Public property HierarchyParentKeyColumnName Gets or sets the hierarchy parent key column.
Public property IncludeNonGridFields Gets or sets a property indicating whether data columns present in the data source, but not in the grid fields collection, will be serialized.
Protected property Index Gets the index value.
Public property IsGanttJavaScriptRequired
Public property JsonEncoders
Public property KeyColumnName Gets or sets a string that corresponds to the column name of the data column in the external source table that contains values that uniquely identify records. This value was specified in the constructor.
Public property KeyDeserializer Gets or sets a delegate that takes a string representing a JavaScript Object Notation (JSON) serialized key, and returns a corresponding object. For instance, this delegate might take a string “4” and return a Int32 with the value 4.
Public property LocaleCulture Gets or sets the locale.
Public property Mode Gets or sets the grid serializer mode.
Public property MultiValueSeparator Gets or sets the string used to separate localized values in multi-valued grid fields.
Public property PagingFilter Gets or sets a paging filter which indicates the row view indices of the rows that will be serialized.
Public property PaneLayout Gets or sets the pane layout.
Public property PivotedGridColumns Gets the pivoted grid columns.
Public property PostProcess Gets or sets a delegate to be called after the serialization dataset is fully populated, but before it is actually serialized.
Public property PostSliceFieldAppender Gets or sets a delegate that will be called after slicing the data. It provides the opportunity to add more fields to the grid after it is known which records will be present.
Public property RecordEditModeColumnName Gets or sets the column name of the record to enable editing on.
Public property RememberedRecordKeyHash Disables the computation of a hash of the ordered record key view sent to the client.
Public property RowAutoFilter Gets or sets a map of column keys to serialized data values.
Public property RowFilter Gets or sets an XML string specifying how a row is filtered.
Public property SortedColumns Gets or sets the sorted columns associated with the grid.
Public propertyStatic member StringPropTypeId Gets the string representing the strong property type ID.

Top

Methods

  Name Description
Public method ApplyIncrementalChanges Informs the grid of changes made on the client. Allows the GridSerializer object to consider local changes when sorting, grouping and slicing.
Public method ApplyPostViewIncrementalInsertsAndDeletes(IEnumerable<Change>) Applies relevant record insert and delete changes to the input data table before slicing occurs.
Public method ApplyPostViewIncrementalInsertsAndDeletes(IEnumerable<Change>, Func<Object, Dictionary<String, Object>>) Applies relevant record insert and delete changes to the input data table before slicing occurs.
Public methodStatic member DefaultCompare Implements a default comparison of two objects by using their IComparable implementations.
Public method EnableGantt Configures the grid to display a Gantt chart in the right pane. In cases where a GridSerializer instance is populated by multiple GridSerializer objects over its lifetime, this function can only be called if ReserveGantt(String) or EnableGantt was called on the initial GridSerializer object.
Public method EnableGridRowStyles Provides a delegate that will populate row styles.
Public method EnableGrouping Configures the grid to display grouping.
Public method EnableHierarchy Configures the grid to display its rows in a hierarchy.
Public method EnableIncrementalChanges Prepares the GridSerializer object for accepting incremental changes.
Public method EnablePivotedGridPane Configures the grid to display a second pane on right pane. This pane can be a fixed multiple of rows for each row in the left pane.
Public method EnableRecordEditMode Provides a delegate to apply the record edit mode after slicing has occurred.
Public method EnableReservedHierarchy Configures the grid to display its rows in a hierarchy.
Public method EnableRowFiltering Configures the grid to hide records based on the specified criteria. This must be called if the RowFilter or RowAutoFilter property is specified.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public methodStatic member GetChangesFromJson<KeyType> Extracts a collection of Change objects from the passed-in JavaScript Object Notation (JSON).
Public methodStatic member GetFilterFields Parses the specified rowFilterXML for GridField references, and returns their field keys.
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method LocalizeField Uses the grid’s process (including calling out to the GridField) to localize a data value in a given cell. Useful for populating grouping rows.
Protected method MemberwiseClone (Inherited from Object.)
Public method RegisterPropLookupType Registers a lookup property type with the serializer.
Public method ReserveGantt Reserves Gantt information in case it will be used.
Public method ReserveGrouping For use when a GridSerializer instance is populated by multiple GridSerializer objects over its lifetime, this method notifies the GridSerializer object that grouping could be enabled later in the lifetime of the Microsoft.SharePoint.JSGrid instance being configured. Must be called on the initial GridSerializer object for that Microsoft.SharePoint.JSGrid instance.
Public method ReserveHierarchy For use when a Microsoft.SharePoint.JSGrid instance is populated by multiple GridSerializer objects over its lifetime, this method notifies the GridSerializer object that hierarchy could be enabled later in the lifetime of the Microsoft.SharePoint.JSGrid instance being configured. Must be called on the initial GridSerializer object for that Microsoft.SharePoint.JSGrid instance.
Public method RestoreHierarchyState Restores hierarchy from a hierarchy state stored as a JavaScript Object Notation (JSON) string.
Public method SetHierarchyStateExpandedToLevel Specifies how many levels to expand the hierarchy
Public method ToJson Convert to Json.
Public method ToString (Inherited from Object.)

Top

Fields

  Name Description
Public fieldStatic member DefaultGanttBarStyleIdsColumnName A string representing the default gantt bar style column name.
Public fieldStatic member DefaultGridRowStyleIdColumnName A string representing the default grid row style ID column name.
Public fieldStatic member DefaultGroupingDescendantCountColumnName A string representing the default grouping descendant count.
Public fieldStatic member DefaultGroupingOutlineLevelColumnName A string representing the default outline level.
Public fieldStatic member DefaultGroupingParentKeyColumnName A string representing the default grouping parent key.
Public fieldStatic member DefaultGroupingRecordKeyPrefix A string representing the default grouping record key prefix.
Public fieldStatic member DefaultHierarchyDescendantCountColumnName A string representing the default hierarchy descendant count.
Public fieldStatic member DefaultHierarchyOutlineLevelColumnName A string representing the default hierarchy outline level.
Public fieldStatic member DefaultRecordEditModeColumnName A string representing the default record edit mode.

Top

See Also

Reference

GridSerializer Class

Microsoft.SharePoint.JSGrid Namespace