Events in Blazor Ribbon component
16 Dec 20244 minutes to read
This section describes the Ribbon events that will be triggered when appropriate actions are performed. The following events are available in the Ribbon component.
Name | Args | Description |
---|---|---|
Created | EventCallback | Triggers when the Ribbon component’s rendering is fully completed |
TabSelecting | TabSelectingEventArgs | Triggers before a tab is selected in the Ribbon component |
TabSelected | TabSelectedEventArgs | Triggers after a tab is successfully selected in the Ribbon component |
RibbonExpanding | ExpandEventArgs | Triggers before the Ribbon component is expanded |
RibbonCollapsing | CollapseEventArgs | Triggers before the Ribbon component is collapsed |
LauncherIconClick | LauncherClickEventArgs | Triggers when the launcher icon in a Ribbon group is clicked |
OverflowPopupOpening | OverflowPopupEventArgs | before the overflow popup in the Ribbon component opens |
OverflowPopupClosing | OverflowPopupEventArgs | before the overflow popup in the Ribbon component closes |
How to configure Ribbon events
Above defined events are available on the SfRibbon tag directive. Here, we have explained about the sample code snippets of Ribbon events.
@using Syncfusion.Blazor.Ribbon
<div style="width:25%">
<SfRibbon Created="Created" TabSelecting="TabSelecting" TabSelected="TabSelected" RibbonExpanding="RibbonExpanding" RibbonCollapsing="RibbonCollapsing" LauncherIconClick="LauncherIconClick" OverflowPopupOpening="OverflowPopupOpening" OverflowPopupClosing="OverflowPopupClosing">
<RibbonTabs>
<RibbonTab HeaderText="Home">
<RibbonGroups>
<RibbonGroup HeaderText="Clipboard">
<RibbonCollections>
<RibbonCollection>
<RibbonItems>
<RibbonItem Type=RibbonItemType.Button AllowedSizes="RibbonItemSize.Large">
<RibbonButtonSettings Content="Cut" IconCss="e-icons e-cut"></RibbonButtonSettings>
</RibbonItem>
</RibbonItems>
</RibbonCollection>
</RibbonCollections>
</RibbonGroup>
</RibbonGroups>
</RibbonTab>
</RibbonTabs>
</SfRibbon>
</div>
@code {
private void Created() { /* your actions here */ }
private void TabSelecting(TabSelectingEventArgs args) { /* your actions here */ }
private void TabSelected(TabSelectedEventArgs args) { /* your actions here */ }
private void RibbonExpanding(ExpandEventArgs args) { /* your actions here */ }
private void RibbonCollapsing(CollapseEventArgs args) { /* your actions here */ }
private void LauncherIconClick(LauncherClickEventArgs args) { /* your actions here */ }
private void OverflowPopupOpening(OverflowPopupEventArgs args) { /* your actions here */ }
private void OverflowPopupClosing(OverflowPopupEventArgs args) { /* your actions here */ }
}
To know about the built-in Ribbon items supported events, please refer to the corresponding item section in Ribbon Items.