GridSerializer methods

  • Article

The GridSerializer type exposes the following members.

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 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 EnableHierarchyWithExplicitFilter<TTag> Sets up the unfiltered hierarchy table. The DataTable should contain two columns, "Key" and "Parent". DBNull.Value is a valid value for the Parent column. The Parent column points to the index, not at the key. The two other strings represent the columns that will be used when interacting with the real data.
Public method EnableIncrementalChanges Prepares the GridSerializer object for accepting incremental changes.
Public method EnableMinimalMode
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(DataTable, String, String, Boolean) 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 ReserveHierarchy<TTag>(DataTable, String, String, Boolean, HierarchyValidationMode, DataTable) Sets up the unfiltered hierarchy table. The DataTable should contain two columns, "Key" and "Parent". DBNull.Value is a valid value for the Parent column. The two other strings represent the columns that will be used when interacting with the real data.
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

See also

Reference

GridSerializer class

Microsoft.SharePoint.JSGrid namespace