Class GroupSettings
Gets or sets an object that indicates whether to customize the grouping behavior of the grid.
Inherited Members
Namespace: Syncfusion.JavaScript.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class GroupSettings : EJTagHelper
Constructors
GroupSettings()
Declaration
public GroupSettings()
Properties
CaptionFormat
Gets or sets a value that customize the group caption format.
Declaration
[JsonProperty("captionFormat")]
public string CaptionFormat { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EnableDropAreaAnimation
Gets or sets a value that indicates whether to enable the group drop area animation of the grid.
Declaration
[Obsolete("EnableDropAreaAnimation property has been deprecated.")]
[JsonProperty("enableDropAreaAnimation")]
public bool EnableDropAreaAnimation { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableDropAreaAutoSizing
Gets or sets a value that indicates whether to enable animation button option in the group drop area of the grid.
Declaration
[JsonProperty("enableDropAreaAutoSizing")]
public bool EnableDropAreaAutoSizing { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
GroupedColumns
Gets or sets a value that indicates whether to add grouped columns programmatically at initial load.
Declaration
[JsonProperty("groupedColumns")]
public List<string> GroupedColumns { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<System.String> |
ShowDropArea
Gets or sets a value that indicates whether to show the group drop area just above the column header. It can be used to avoid ungrouping the already grouped column using groupSettings.
Declaration
[JsonProperty("showDropArea")]
public bool ShowDropArea { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ShowGroupedColumn
Gets or sets a value that indicates whether to hide the grouped columns from the grid.
Declaration
[JsonProperty("showGroupedColumn")]
public bool ShowGroupedColumn { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ShowToggleButton
Gets or sets a value that indicates whether to show the group button image(toggle button)in the column header and also in the grouped column in the group drop area . It can be used to group/ungroup the columns by click on the toggle button.
Declaration
[JsonProperty("showToggleButton")]
public bool ShowToggleButton { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ShowUngroupButton
Gets or sets a value that indicates whether to enable the close button in the grouped column which is in the group drop area to ungroup the grouped column
Declaration
[JsonProperty("showUngroupButton")]
public bool ShowUngroupButton { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Methods
ShouldSerializeGroupedColumn()
Gets or sets a value that indicates whether the grouped column should serialize.
Declaration
public bool ShouldSerializeGroupedColumn()
Returns
Type | Description |
---|---|
System.Boolean | It returns the Boolean |