Controls Support
27 Sep 201724 minutes to read
Button, SplitButton, DropDownList, ToggleButton, Gallery and Custom controls can be added to each groups. You can set Type property in group to define the controls. Default Type is Button.
Built in Controls
The following table describes about the built in controls Type and their corresponding control settings.
| Type | Control Settings | Example |
|---|---|---|
| Button | Button - ButtonSettings | ButtonSettings: { Width: 70, ContentType: ej.ContentType.ImageOnly, PrefixIcon: "e-icon e-ribbon e-new" } |
| SplitButton | SplitButton - SplitButtonSettings | SplitButtonSettings: { ContentType: ej.ContentType.ImageOnly, TargetID: "pasteSplit", ButtonMode: "dropdown", ArrowPosition: ej.ArrowPosition.Bottom } |
| ToggleButton | ToggleButton - ToggleButtonSettings | ToggleButtonSettings: { ContentType: ej.ContentType.ImageOnly, DefaultText: "Italic", ActiveText: "Italic" } |
| DropDownList | DropDownList - DropDownSettings | DropDownSettings: { DataSource: size, Text: "1pt", Width: 65 } |
NOTE
- You can specify type either to group’s collection or to each group.
- For
Typeproperty you can assign either string value (“SplitButton”) or enum value (RibbonButtonType.SplitButton).
@(Html.EJ().Ribbon("defaultRibbon")
.Width("100%")
.ApplicationTab(app =>
{
app.Type(ApplicationTabType.Menu).MenuItemID("ribbon").MenuSettings(new MenuProperties()
{
OpenOnClick = false
});
})
.RibbonTabs(tab =>
{
tab.Id("home").Text("HOME").TabGroups(tabgroup =>
{
tabgroup.Text("New").AlignType(RibbonAlignType.Rows).Content(ctn =>
{
ctn.ContentGroups(contentTab =>
{
contentTab.Id("new").Text("New").ToolTip("New").ButtonSettings(new ButtonProperties()
{
ContentType = ContentType.ImageOnly,
ImagePosition = ImagePosition.ImageTop,
PrefixIcon = "e-icon e-ribbon e-new",
}).Add();
}).ContentDefaults(df => df.Type(RibbonButtonType.Button).Width("60px").Height("70px")).Add();
}).Add();
tabgroup.Text("Clipboard").AlignType(RibbonAlignType.Columns).Content(ctn =>
{
ctn.ContentGroups(contentTab =>
{
contentTab.Id("paste").Text("Paste").ToolTip("Paste").SplitButtonSettings(new SplitButtonProperties()
{
ContentType = ContentType.ImageOnly,
PrefixIcon = "e-icon e-ribbon e-ribbonpaste",
TargetID = "pasteSplit",
ButtonMode= ButtonMode.Dropdown,
ArrowPosition = ArrowPosition.Bottom,
}).Add();
}).ContentDefaults(df => df.Type(RibbonButtonType.SplitButton).Width("50px").Height("70px")).Add();
}).Add();
tabgroup.Text("Font").AlignType(RibbonAlignType.Rows).Content(ctn =>
{
ctn.ContentGroups(contentTab =>
{
contentTab.Id("fontFamily").ToolTip("Font").DropdownSettings(new DropDownListProperties()
{
DataSource = (IEnumerable<FontFamily>)ViewBag.datasource,
Text = "Segoe UI",
Width = "150px"
}).Add();
contentTab.Id("fontsize").ToolTip("FontSize").DropdownSettings(new DropDownListProperties()
{
DataSource = (IEnumerable<FontPoint>)ViewBag.datasource1,
Text = "1pt",
Width = "65px"
}).Add();
}).ContentDefaults(df => df.Type(RibbonButtonType.DropDownList).Height("28px")).Add();
ctn.ContentGroups(contentTab =>
{
contentTab.Id("bold").ToolTip("Bold").Type(RibbonButtonType.ToggleButton).ToggleButtonSettings(new ToggleButtonProperties()
{
ContentType = ContentType.ImageOnly,
DefaultText = "Bold",
ActiveText = "Bold",
DefaultPrefixIcon = "e-icon e-ribbon bold",
ActivePrefixIcon = "e-icon e-ribbon bold",
}).Add();
contentTab.Id("italic").ToolTip("Italic").Type(RibbonButtonType.ToggleButton).ToggleButtonSettings(new ToggleButtonProperties()
{
ContentType = ContentType.ImageOnly,
DefaultText = "Italic",
ActiveText = "Italic",
DefaultPrefixIcon = "e-icon e-ribbon e-ribbonitalic",
ActivePrefixIcon = "e-icon e-ribbon e-ribbonitalic",
}).Add();
}).ContentDefaults(df => df.IsBig(false)).Add();
}).Add();
}).Add();
})
)
<ul id="ribbon">
<li>
<a>FILE</a>
<ul>
<li>
<a>New</a>
</li>
</ul>
</li>
</ul>
<ul id="pasteSplit">
<li>
<a>Paste</a>
</li>
</ul>public partial class RibbonController: Controller
{
List<FontFamily> fontFamily1 = new List<FontFamily>();
List<FontPoint> fontPoint1 = new List<FontPoint>();
public ActionResult RibbonFeatures()
{
fontFamily1.Add(new FontFamily { text = "Segoe UI" });
fontFamily1.Add(new FontFamily { text = "Arial" });
fontFamily1.Add(new FontFamily { text = "Times New Roman" });
fontFamily1.Add(new FontFamily { text = "Tahoma" });
fontFamily1.Add(new FontFamily { text = "Helvetica" });
ViewBag.datasource = fontFamily1;
fontPoint1.Add(new FontPoint { text = "1pt" });
fontPoint1.Add(new FontPoint { text = "2pt" });
fontPoint1.Add(new FontPoint { text = "3pt" });
fontPoint1.Add(new FontPoint { text = "4pt" });
fontPoint1.Add(new FontPoint { text = "5pt" });
ViewBag.datasource1 = fontPoint1;
return View();
}
}
Custom
You can set Type as custom to render custom controls and Custom element id has to be specified as ContentID.You can change the element defined in the custom template to appropriate Syncfusion control in the event of Ribbon Create.
@(Html.EJ().Ribbon("defaultRibbon")
.Width("600")
.ApplicationTab(app =>
{
app.Type(ApplicationTabType.Menu).MenuItemID("ribbon");
})
.RibbonTabs(tab =>
{
tab.Id("home").Text("HOME").TabGroups(tabgroup =>
{
tabgroup.Text("Font").Content(ctn =>
{
ctn.ContentGroups(contentTab =>
{
contentTab.Id("fontColor").ToolTip("Font Color").ContentID("fontColor").Add();
}).ContentDefaults(df => df.Type(RibbonButtonType.Custom).Height("30px")).Add();
}).Add();
tabgroup.Text("Operators").Type("custom").ContentID("design").Add();
}).Add();
})
.ClientSideEvents(event => event.Create("createControl")) )
<ul id="ribbon">
<li>
<a>FILE</a>
<ul>
<li><a>New</a></li>
<li><a>Print</a></li>
</ul>
</li>
</ul>
<input id="fontColor" />
<table id="design" class="e-designtablestyle">
<tr>
<td><input type="checkbox" id="check1" /><label for="check1">Header Row</label></td>
<td><input type="checkbox" id="Check2" checked="checked" /><label for="Check2">First Column</label></td>
</tr>
<tr><td><input type="checkbox" id="check4" checked="checked" /><label for="check4">Total Row</label></td>
<td><input type="checkbox" id="Check5" /><label for="Check5">Last Column</label></td>
</tr>
</table>
<script>
function createControl(args) {
$("#fontColor").ejColorPicker({ value: "#FFFF00", modelType: "palette", cssClass: "e-ribbon", toolIcon: "e-fontcoloricon" });
}
</script>