Class RibbonItemBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
RibbonItemBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class RibbonItemBuilder : ControlBuilder
Constructors
RibbonItemBuilder()
Declaration
public RibbonItemBuilder()
RibbonItemBuilder(List<RibbonItem>)
Declaration
public RibbonItemBuilder(List<RibbonItem> collection)
Parameters
| Type |
Name |
Description |
| System.Collections.Generic.List<RibbonItem> |
collection |
|
Methods
ActiveSize(RibbonItemSize)
Defines the active size of the ribbon item.
Declaration
public RibbonItemBuilder ActiveSize(RibbonItemSize activeSize)
Parameters
Returns
Add()
Declaration
AllowedSizes(RibbonItemSize)
Defines the sizes that are allowed for the ribbon item on ribbon resize.
Declaration
public RibbonItemBuilder AllowedSizes(RibbonItemSize allowedSizes)
Parameters
Returns
Defines the settings for the ribbon button.
Declaration
public RibbonItemBuilder ButtonSettings(RibbonButtonSettings buttonSettings)
Parameters
Returns
Declaration
public RibbonItemBuilder ButtonSettings(Action<RibbonButtonSettingsBuilder> buttonSettings)
Parameters
Returns
CheckBoxSettings(RibbonCheckBoxSettings)
Defines the settings for the ribbon checkbox.
Declaration
public RibbonItemBuilder CheckBoxSettings(RibbonCheckBoxSettings checkBoxSettings)
Parameters
Returns
CheckBoxSettings(Action<RibbonCheckBoxSettingsBuilder>)
Declaration
public RibbonItemBuilder CheckBoxSettings(Action<RibbonCheckBoxSettingsBuilder> checkBoxSettings)
Parameters
Returns
ColorPickerSettings(RibbonColorPickerSettings)
Defines the settings for the ribbon color picker.
Declaration
public RibbonItemBuilder ColorPickerSettings(RibbonColorPickerSettings colorPickerSettings)
Parameters
Returns
ColorPickerSettings(Action<RibbonColorPickerSettingsBuilder>)
Declaration
public RibbonItemBuilder ColorPickerSettings(Action<RibbonColorPickerSettingsBuilder> colorPickerSettings)
Parameters
Returns
ComboBoxSettings(RibbonComboBoxSettings)
Defines the settings for the ribbon combobox.
Declaration
public RibbonItemBuilder ComboBoxSettings(RibbonComboBoxSettings comboBoxSettings)
Parameters
Returns
ComboBoxSettings(Action<RibbonComboBoxSettingsBuilder>)
Declaration
public RibbonItemBuilder ComboBoxSettings(Action<RibbonComboBoxSettingsBuilder> comboBoxSettings)
Parameters
Returns
ContentTemplate(Action<Object>)
Declaration
public RibbonItemBuilder ContentTemplate(Action<object> template)
Parameters
| Type |
Name |
Description |
| System.Action<System.Object> |
template |
|
Returns
ContentTemplate(Func<Object, Object>)
Declaration
public RibbonItemBuilder 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 item.
Declaration
public RibbonItemBuilder CssClass(string cssClass)
Parameters
| Type |
Name |
Description |
| System.String |
cssClass |
|
Returns
Disabled(Boolean)
Defines whether the item is disabled or not.
Declaration
public RibbonItemBuilder Disabled(bool disabled)
Parameters
| Type |
Name |
Description |
| System.Boolean |
disabled |
|
Returns
DisplayOptions(DisplayMode)
Defines the display options for the ribbon item.
Declaration
public RibbonItemBuilder DisplayOptions(DisplayMode displayOptions)
Parameters
Returns
DropDownSettings(RibbonDropDownSettings)
Defines the settings for the ribbon dropdown button.
Declaration
public RibbonItemBuilder DropDownSettings(RibbonDropDownSettings dropDownSettings)
Parameters
Returns
DropDownSettings(Action<RibbonDropDownSettingsBuilder>)
Declaration
public RibbonItemBuilder DropDownSettings(Action<RibbonDropDownSettingsBuilder> dropDownSettings)
Parameters
Returns
GallerySettings(RibbonGallerySettings)
Defines the properties of the gallery view in Ribbon.
Declaration
public RibbonItemBuilder GallerySettings(RibbonGallerySettings gallerySettings)
Parameters
Returns
GallerySettings(Action<RibbonGallerySettingsBuilder>)
Declaration
public RibbonItemBuilder GallerySettings(Action<RibbonGallerySettingsBuilder> gallerySettings)
Parameters
Returns
Defines the properties for group button in Ribbon
Declaration
public RibbonItemBuilder GroupButtonSettings(RibbonGroupButtonSettings groupButtonSettings)
Parameters
Returns
Declaration
public RibbonItemBuilder GroupButtonSettings(Action<RibbonGroupButtonSettingsBuilder> groupButtonSettings)
Parameters
Returns
Id(String)
Defines a unique identifier for the item.
Declaration
public RibbonItemBuilder Id(string id)
Parameters
| Type |
Name |
Description |
| System.String |
id |
|
Returns
ItemTemplate(String)
Defines the template content for the ribbon item.
ActiveSize property is passed as string in template context.
Declaration
public RibbonItemBuilder ItemTemplate(string itemTemplate)
Parameters
| Type |
Name |
Description |
| System.String |
itemTemplate |
|
Returns
KeyTip(String)
Defines the key tip text to be accessed for specified Ribbon item.
Declaration
public RibbonItemBuilder KeyTip(string keyTip)
Parameters
| Type |
Name |
Description |
| System.String |
keyTip |
|
Returns
Defines the settings for the tooltip of the item.
Declaration
public RibbonItemBuilder RibbonTooltipSettings(object ribbonTooltipSettings)
Parameters
| Type |
Name |
Description |
| System.Object |
ribbonTooltipSettings |
|
Returns
Defines the settings for the ribbon split button.
Declaration
public RibbonItemBuilder SplitButtonSettings(RibbonSplitButtonSettings splitButtonSettings)
Parameters
Returns
Declaration
public RibbonItemBuilder SplitButtonSettings(Action<RibbonSplitButtonSettingsBuilder> splitButtonSettings)
Parameters
Returns
Type(RibbonItemType)
Defines the type of control to be added as the Ribbon Item.
Declaration
public RibbonItemBuilder Type(RibbonItemType type)
Parameters
Returns
