Class RibbonGroupBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
RibbonGroupBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class RibbonGroupBuilder : ControlBuilder
Constructors
RibbonGroupBuilder()
Declaration
public RibbonGroupBuilder()
RibbonGroupBuilder(List<RibbonGroup>)
Declaration
public RibbonGroupBuilder(List<RibbonGroup> collection)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<RibbonGroup> |
collection |
|
Methods
Add()
Declaration
Collections(Action<RibbonCollectionBuilder>)
Declaration
public RibbonGroupBuilder Collections(Action<RibbonCollectionBuilder> collections)
Parameters
Returns
Collections(List<RibbonCollection>)
Defines the list of ribbon collections.
Declaration
public RibbonGroupBuilder Collections(List<RibbonCollection> collections)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<RibbonCollection> |
collections |
|
Returns
ContentTemplate(Action<Object>)
Declaration
public RibbonGroupBuilder ContentTemplate(Action<object> template)
Parameters
| Type |
Name |
Description |
| System.Action<System.Object> |
template |
|
Returns
ContentTemplate(Func<Object, Object>)
Declaration
public RibbonGroupBuilder ContentTemplate(Func<object, object> template)
Parameters
| Type |
Name |
Description |
| System.Func<System.Object, System.Object> |
template |
|
Returns
CssClass(String)
Defines one or more CSS classes to customize the appearance of group.
Declaration
public RibbonGroupBuilder CssClass(string cssClass)
Parameters
| Type |
Name |
Description |
| System.String |
cssClass |
|
Returns
EnableGroupOverflow(Boolean)
Defines whether to add a separate popup for the overflow items in the group.
If it is set to false, the overflow items will be shown in the common overflow popup present at the right end of the tab content.
Declaration
public RibbonGroupBuilder EnableGroupOverflow(bool enableGroupOverflow)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableGroupOverflow |
|
Returns
GroupIconCss(String)
Defines the CSS class for the icons to be shown in the group overflow dropdown button in classic mode.
During overflow, the entire group will be shown in a popup of a dropdown button which appears in the place of the group in ribbon tab.
Declaration
public RibbonGroupBuilder GroupIconCss(string groupIconCss)
Parameters
| Type |
Name |
Description |
| System.String |
groupIconCss |
|
Returns
Defines the content of group header.
Declaration
public RibbonGroupBuilder Header(string header)
Parameters
| Type |
Name |
Description |
| System.String |
header |
|
Returns
Id(String)
Defines a unique identifier for the group.
Declaration
public RibbonGroupBuilder Id(string id)
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
Returns
IsCollapsed(Boolean)
Defines whether the group is in collapsed state or not during classic mode.
Declaration
public RibbonGroupBuilder IsCollapsed(bool isCollapsed)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isCollapsed |
|
Returns
IsCollapsible(Boolean)
Defines whether the group can be collapsed on resize during classic mode.
Declaration
public RibbonGroupBuilder IsCollapsible(bool isCollapsible)
Parameters
| Type |
Name |
Description |
| System.Boolean |
isCollapsible |
|
Returns
KeyTip(String)
Specifies the keytip content.
Declaration
public RibbonGroupBuilder KeyTip(string keyTip)
Parameters
| Type |
Name |
Description |
| System.String |
keyTip |
|
Returns
LauncherIconKeyTip(String)
Specifies the keytip content for launcher icon.
Declaration
public RibbonGroupBuilder LauncherIconKeyTip(string launcherIconKeyTip)
Parameters
| Type |
Name |
Description |
| System.String |
launcherIconKeyTip |
|
Returns
Orientation(ItemOrientation)
Defines whether to orientation in which the items of the group should be arranged.
Declaration
public RibbonGroupBuilder Orientation(ItemOrientation orientation)
Parameters
Returns
Defines the header shown in overflow popup of Ribbon group.
Declaration
public RibbonGroupBuilder OverflowHeader(string overflowHeader)
Parameters
| Type |
Name |
Description |
| System.String |
overflowHeader |
|
Returns
Priority(Double)
Defines the priority order at which the group should be collapsed or expanded.
For collapsing value is fetched in ascending order and for expanding value is fetched in descending order.
Declaration
public RibbonGroupBuilder Priority(double priority)
Parameters
| Type |
Name |
Description |
| System.Double |
priority |
|
Returns
ShowLauncherIcon(Boolean)
Defines whether to show or hide the launcher icon for the group.
Declaration
public RibbonGroupBuilder ShowLauncherIcon(bool showLauncherIcon)
Parameters
| Type |
Name |
Description |
| System.Boolean |
showLauncherIcon |
|
Returns
