Back to Devexpress

DxRibbonApplicationTab Class

blazor-devexpress-dot-blazor-0242abfa.md

latest6.7 KB
Original Source

DxRibbonApplicationTab Class

Defines the ribbon application tab.

Namespace : DevExpress.Blazor

Assembly : DevExpress.Blazor.v25.2.dll

NuGet Package : DevExpress.Blazor

Declaration

csharp
public class DxRibbonApplicationTab :
    DxRibbonElementBase,
    IRibbonApplicationTab,
    IRibbonTabBase<RibbonApplicationTabClickEventArgs>,
    IRibbonElement,
    IRibbonNode,
    IRibbonIconSource,
    IRibbonClickableItem<RibbonApplicationTabClickEventArgs>,
    IRibbonInteractiveElement

Remarks

The DxRibbonApplicationTab class implements the functionality of the ribbon application tab. This tab allows you to display a drop-down menu or perform custom actions when a user clicks the tab. The DxRibbon component can contain only one application tab and displays it at the first position. Use Text, IconCssClass, and IconUrl properties to specify the tab appearance.

Application Tab with Drop-Down Menu

Populate the application tab’s child content with DxRibbonApplicationTabItem objects to display a drop-down menu when a user clicks the tab.

razor
<DxRibbon>
    <DxRibbonApplicationTab Text="File">
        <DxRibbonApplicationTabItem Text="New" 
                                    IconCssClass="rb-icon rb-icon-document-blank" 
                                    Click="@(() => ClickItem("New tab item"))" />
        <DxRibbonApplicationTabItem Text="Open" 
                                    IconCssClass="rb-icon rb-icon-folder-open" 
                                    Click="@(() => ClickItem("Open tab item"))" />
        <DxRibbonApplicationTabItem Text="Save as" 
                                    IconCssClass="rb-icon rb-icon-save" 
                                    Click="@(() => ClickItem("Save as tab item"))">
            <DxRibbonApplicationTabItem Text="Text file" 
                                        Click="@(() => ClickItem("Text file tab item"))"/>
            <DxRibbonApplicationTabItem Text="Word document" 
                                        Click="@(() => ClickItem("Word document tab item"))"/>
            <DxRibbonApplicationTabItem Text="Pdf file" 
                                        Click="@(() => ClickItem("Pdf file tab item"))"/>
        </DxRibbonApplicationTabItem>
        <DxRibbonApplicationTabItem Text="Share" 
                                    IconCssClass="rb-icon rb-icon-share" 
                                    Click="@(() => ClickItem("Share tab item"))" />
        <DxRibbonApplicationTabItem Text="Print" 
                                    IconCssClass="rb-icon rb-icon-print" 
                                    Click="@(() => ClickItem("Print tab item"))" />
    </DxRibbonApplicationTab>
    <DxRibbonTab Text="Home">...</DxRibbonTab>
    <DxRibbonTab Text="Insert">...</DxRibbonTab>
</DxRibbon>
css
.rb-icon {
    width: 1.25rem;
    height: 1.25rem;
    background-size: contain;
    -webkit-mask-repeat: no-repeat;
    mask-repeat: no-repeat;
    background-position: center center;
    background-color: currentColor;
}
.rb-icon-document-blank {
    -webkit-mask-image: url("../images/icons/ribbon/berry/document-blank.svg");
    mask-image: url("../images/icons/ribbon/berry/document-blank.svg");
}
.rb-icon-folder-open {
    -webkit-mask-image: url("../images/icons/ribbon/berry/folder-open.svg");
    mask-image: url("../images/icons/ribbon/berry/folder-open.svg");
}
.rb-icon-save {
    -webkit-mask-image: url("../images/icons/ribbon/berry/save.svg");
    mask-image: url("../images/icons/ribbon/berry/save.svg");
}
.rb-icon-print {
    -webkit-mask-image: url("../images/icons/ribbon/berry/print.svg");
    mask-image: url("../images/icons/ribbon/berry/print.svg");
}
.rb-icon-share {
    -webkit-mask-image: url("../images/icons/ribbon/berry/share.svg");
    mask-image: url("../images/icons/ribbon/berry/share.svg");
}

Run Demo

Handle Application Tab Click

Handle the Click event to perform custom actions when a user clicks the tab. The following code sample shows a DxDrawer component on the tab click.

razor
<DxDrawer @bind-IsOpen="IsFileMenuOpen" PanelWidth="100px" >
    <BodyTemplate>
        <DxMenu Orientation="Orientation.Vertical">
            <Items>
                <DxMenuItem Text="🢀" Click="@(() => IsFileMenuOpen = false)" />
                <DxMenuItem Text="New" Click="@(() => ClickNew())"/>
                <DxMenuItem Text="Open" Click="@(() => ClickOpen())"/>
                <DxMenuItem Text="Save as" Click="@(() => ClickSaveAs())"/>
                <DxMenuItem Text="Contacts" Click="@(() => ClickContacts())"/>
                <DxMenuItem Text="About" Click="@(() => ClickAbout())"/>
            </Items>
        </DxMenu>
    </BodyTemplate>
    <TargetContent>
        <DxRibbon >
            <DxRibbonApplicationTab Text="File" Click="@(() => IsFileMenuOpen = true)" />
            <DxRibbonTab Text="Home">...</DxRibbonTab>
            <DxRibbonTab Text="Insert">...</DxRibbonTab>
        </DxRibbon>
    </TargetContent>
</DxDrawer>

@code {
    bool IsFileMenuOpen { get; set; } = false;
}

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

IRibbonApplicationTab

Inheritance

Object ComponentBase DevExpress.Blazor.Ribbon.Internal.DxRibbonNodeBase DxRibbonElementBase DxRibbonApplicationTab

See Also

DxRibbonApplicationTab Members

DevExpress.Blazor Namespace