Class GroupOptionsBuilder<T>

Inheritance

System.Object

GroupOptionsBuilder<T>

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

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

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

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.JavaScript

Assembly: Syncfusion.EJ.dll

Syntax

public class GroupOptionsBuilder<T>
    where T : class

Type Parameters

Name	Description
T

Constructors

GroupOptionsBuilder(GroupSettings)

Initializes a new instance of the class.

Declaration

public GroupOptionsBuilder(GroupSettings group)

Parameters

Type	Name	Description
GroupSettings	group	It accepts the list of GroupSettings option

Methods

CaptionFormat(String)

It sets the value that customize the group caption format.

Declaration

public GroupOptionsBuilder<T> CaptionFormat(string captionFormat)

Parameters

Type	Name	Description
System.String	captionFormat	It accepts the string value and customize the group caption text

Returns

Type	Description
GroupOptionsBuilder<T>	GroupOptionsBuilder

EnableDropAreaAnimation()

Declaration

[Obsolete("EnableDropAreaAnimation property has been deprecated.")]
public GroupOptionsBuilder<T> EnableDropAreaAnimation()

Returns

Type	Description
GroupOptionsBuilder<T>

EnableDropAreaAnimation(Boolean)

Declaration

[Obsolete("EnableDropAreaAnimation property has been deprecated.")]
public GroupOptionsBuilder<T> EnableDropAreaAnimation(bool animation)

Parameters

Type	Name	Description
System.Boolean	animation

Returns

Type	Description
GroupOptionsBuilder<T>

EnableDropAreaAutoSizing()

It sets the value that indicates whether to enable animation button option in the group drop area of the grid.

Declaration

public GroupOptionsBuilder<T> EnableDropAreaAutoSizing()

Returns

Type	Description
GroupOptionsBuilder<T>	GroupOptionsBuilder

EnableDropAreaAutoSizing(Boolean)

It sets the value that indicates whether to enable animation button option in the group drop area of the grid.

Declaration

public GroupOptionsBuilder<T> EnableDropAreaAutoSizing(bool autoSizing)

Parameters

Type	Name	Description
System.Boolean	autoSizing	It accepts the boolean value and enables or disables the DropArea

Returns

Type	Description
GroupOptionsBuilder<T>	GroupOptionsBuilder

GroupedColumns(Action<GroupedColumnBuilder<T>>)

It sets the value that indicates whether to add grouped columns programmatically at initial load

Declaration

public GroupOptionsBuilder<T> GroupedColumns(Action<GroupedColumnBuilder<T>> groupedColumn)

Parameters

Type	Name	Description
System.Action<GroupedColumnBuilder<T>>	groupedColumn	It displays the list of groupedcolumns through lambda expression

Returns

Type	Description
GroupOptionsBuilder<T>	GroupOptionsBuilder

GroupedColumns(List<String>)

It sets the value that indicates whether to add grouped columns programmatically at initial load

Declaration

public GroupOptionsBuilder<T> GroupedColumns(List<string> groupedColumn)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	groupedColumn	It accepts the list of groupedcolumns

Returns

Type	Description
GroupOptionsBuilder<T>	GroupOptionsBuilder

ShowDropArea()

It sets the 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

public GroupOptionsBuilder<T> ShowDropArea()

Returns

Type	Description
GroupOptionsBuilder<T>	GroupOptionsBuilder

ShowDropArea(Boolean)

It sets the 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

public GroupOptionsBuilder<T> ShowDropArea(bool showdroparea)

Parameters

Type	Name	Description
System.Boolean	showdroparea	It accepts the boolean value and enables or disables the DropArea

Returns

Type	Description
GroupOptionsBuilder<T>	GroupOptionsBuilder

ShowGroupedColumn()

It sets the value that indicates whether to hide the grouped columns from the grid

Declaration

public GroupOptionsBuilder<T> ShowGroupedColumn()

Returns

Type	Description
GroupOptionsBuilder<T>	GroupOptionsBuilder

ShowGroupedColumn(Boolean)

It sets the value that indicates whether to hide the grouped columns from the grid

Declaration

public GroupOptionsBuilder<T> ShowGroupedColumn(bool groupedColumnShow)

Parameters

Type	Name	Description
System.Boolean	groupedColumnShow	It accepts the boolean value and shows or hides the grouped column

Returns

Type	Description
GroupOptionsBuilder<T>	GroupOptionsBuilder

ShowToggleButton()

It sets the 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

public GroupOptionsBuilder<T> ShowToggleButton()

Returns

Type	Description
GroupOptionsBuilder<T>	GroupOptionsBuilder

ShowToggleButton(Boolean)

Declaration

public GroupOptionsBuilder<T> ShowToggleButton(bool toogleGroup)

Parameters

Type	Name	Description
System.Boolean	toogleGroup

Returns

Type	Description
GroupOptionsBuilder<T>

ShowUngroupButton()

It sets the 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

public GroupOptionsBuilder<T> ShowUngroupButton()

Returns

Type	Description
GroupOptionsBuilder<T>	GroupOptionsBuilder

ShowUngroupButton(Boolean)

It sets the 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

public GroupOptionsBuilder<T> ShowUngroupButton(bool showUnGroupButton)

Parameters

Type	Name	Description
System.Boolean	showUnGroupButton	It accepts the boolean value and enables or disables the ungroupbutton

Returns

Type	Description
GroupOptionsBuilder<T>	GroupOptionsBuilder