Class RibbonItem

Inheritance

System.Object

SfBaseComponent

RibbonItem

Inherited Members

SfBaseComponent.Dispose()

SfBaseComponent.GetEffectivePlatform()

SfBaseComponent.GetMainComponentPlatform()

SfBaseComponent.IsMainLicenseComponent()

SfBaseComponent.LicenseContext

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

SfBaseComponent.ValidateLicense()

Namespace: Syncfusion.Blazor.Ribbon

Assembly: Syncfusion.Blazor.dll

Syntax

public class RibbonItem : SfBaseComponent

Constructors

RibbonItem()

Declaration

public RibbonItem()

Properties

ActiveSize

Gets or sets the active size of the Ribbon item.

Declaration

public RibbonItemSize ActiveSize { get; set; }

Property Value

Type	Description
RibbonItemSize	A RibbonItemSize value that represents the active size of the Ribbon item. The RibbonItemSize enumeration includes the following sizes: Large - A large size that provides more visual prominence. Medium - A medium size that balances prominence with space usage. Small - A small size that minimizes space usage. The default value is Medium.

Remarks

This property determines the size of the Ribbon item as it appears in the Ribbon interface.
Adjusting the active size can help tailor the Ribbon interface to fit different screen sizes or design requirements, ensuring that items are displayed in an appropriate size.

AllowedSizes

Gets or sets the sizes that are allowed for the Ribbon item on ribbon resize.

Declaration

public RibbonItemSize AllowedSizes { get; set; }

Property Value

Type

Description

RibbonItemSize

A RibbonItemSize value that specifies the allowed sizes for the Ribbon item. The RibbonItemSize enumeration provides the following options: Large - Displays the Ribbon item in a large size, usually including more detailed content or controls. Medium - Displays the Ribbon item in a medium size, which balances between large and small sizes. Small - Displays the Ribbon item in a small size, often showing only essential content or an icon.

Remarks

This property specifies which sizes the Ribbon item can adopt when the Ribbon control is resized.
By setting this property, you can control how the Ribbon item adapts to different Ribbon sizes, improving user experience by providing appropriate visibility and space usage.

ButtonSettings

Defines the settings for button item within the SfRibbon component.

Declaration

public RibbonButtonSettings ButtonSettings { get; set; }

Property Value

Type
RibbonButtonSettings

Remarks

Use this class to customize appearance, behavior, and functionality of buttons.

CheckBoxSettings

Specifies settings for checkbox item within the the SfRibbon component.

Declaration

public RibbonCheckBoxSettings CheckBoxSettings { get; set; }

Property Value

Type
RibbonCheckBoxSettings

Remarks

Control the appearance and state behaviors including checked state, label visibility, and tri-state logic for complex Boolean operations. Frequently used where options or settings need toggling in the user interface.

ChildContent

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.RenderFragment

ColorPickerSettings

Configures settings for color picker item in the the SfRibbon component.

Declaration

public RibbonColorPickerSettings ColorPickerSettings { get; set; }

Property Value

Type
RibbonColorPickerSettings

Remarks

Adjust palettes, recent color selections, and advanced customization of color selection tools. Suitable for design and formatting tools where precise color selection is required.

ComboBoxSettings

Defines settings for ComboBox item in the the SfRibbon component.

Declaration

public RibbonComboBoxSettings ComboBoxSettings { get; set; }

Property Value

Type
RibbonComboBoxSettings

Remarks

Settings include customization of display templates, filtering logic, and item behaviors. Essential for scenarios where user input needs to be selected from a list or is filterable on-the-fly.

CssClass

Gets or sets one or more CSS classes to customize the appearance of the RibbonItem.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	Accepts a string of CSS classes separated by spaces to customize the appearance of the RibbonItem. The default value is String.Empty.

Remarks

This property allows you to apply custom CSS classes to a RibbonItem to modify its appearance according to your design requirements.
Customizing the appearance of Ribbon items using CSS classes helps ensure that the items align with your application's overall theme and visual style.

Disabled

Gets or sets a value indicating whether the RibbonItem is disabled.

Declaration

public bool Disabled { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value that defaults to false. If set to true, the RibbonItem will be disabled.

Remarks

When the Disabled property is set to true, the RibbonItem cannot be interacted with. This can be useful in scenarios where certain conditions in your application logic require the RibbonItem to be temporarily unusable.

DisabledChanged

Declaration

public EventCallback<bool> DisabledChanged { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.EventCallback<System.Boolean>

DisplayOptions

Gets or sets the display mode options for the Ribbon item.

Declaration

public DisplayMode DisplayOptions { get; set; }

Property Value

Type

Description

DisplayMode

A DisplayMode value that represents the display mode options for the Ribbon item. The default value is Auto. The possible values are: Classic: The item appears in the classic layout group. Simplified: The item appears in the simplified layout group. Overflow: The item appears in the overflow popup. Auto: The item appears in Classic, Simplified, and Overflow groups based on the ribbon overflow state.

Remarks

This property allows you to specify how the Ribbon item should be displayed within the Ribbon control.
You can adjust this property to enhance the usability and visual presentation of Ribbon items based on the design requirements.

DropDownSettings

Contains settings for dropdown item in the SfRibbon component.

Declaration

public RibbonDropDownSettings DropDownSettings { get; set; }

Property Value

Type
RibbonDropDownSettings

Remarks

Particularly useful when displaying a list of selectable items within a constrained space.

GallerySettings

Manages settings for gallery view within the the SfRibbon component, dealing with gallery item rendering and selection.

Declaration

public RibbonGallerySettings GallerySettings { get; set; }

Property Value

Type
RibbonGallerySettings

Remarks

Customize item presentation, selection logic, and template integration to serve diverse content needs. Ideal in restricted spaces where a choice of graphical elements or styles is available.

GroupButtonSettings

Defines settings for group button item within the SfRibbon component.

Declaration

public RibbonGroupButtonSettings GroupButtonSettings { get; set; }

Property Value

Type
RibbonGroupButtonSettings

Remarks

Settings allow configuration of selection behavior (e.g., single, multiple), visual grouping, and event handling for user interactions across grouped controls. Useful for presenting related commands that align with a specific area of functionality.

ID

Gets or sets the unique ID for the RibbonItem.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String	The ID of the RibbonItem. The default value is String.Empty.

Remarks

This property specifies a unique identifier for the RibbonItem. The unique ID can be used to reference the Ribbon item programmatically.

ItemTemplate

Gets or sets the template content for the Ribbon item.

Declaration

public RenderFragment<RibbonItemContext> ItemTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<RibbonItemContext>	A ItemTemplate that represents the template for the Ribbon item. The default value is null.

Remarks

If the ItemTemplate property is set to a specific template, this template will be used to render the Ribbon item. The ActiveSize property is passed as a string in the template context from the RibbonItemContext.

KeyTip

Gets or sets the key tip text for the ribbon item in the SfRibbon component.

Declaration

public string KeyTip { get; set; }

Property Value

Type	Description
System.String	A string representing the key tip text for the ribbon item. Defaults to an empty string.

Remarks

This property allows you to specify a keyboard shortcut (keytip) for a particular item within the SfRibbon component. When key tips are enabled, users can press the assigned key combination to quickly access the corresponding item.

SplitButtonSettings

Provides configuration options for split button item in the the SfRibbon component.

Declaration

public RibbonSplitButtonSettings SplitButtonSettings { get; set; }

Property Value

Type
RibbonSplitButtonSettings

Remarks

Useful for implementing a button with a dropdown menu that groups related functions.

TooltipSettings

Gets or sets the tooltip for the ribbon items.

Declaration

public RibbonTooltipSettings TooltipSettings { get; set; }

Property Value

Type	Description
RibbonTooltipSettings	An instance of RibbonTooltipSettings that represents the tooltip settings for the ribbon items. The default value is null.

Remarks

This property allows you to configure the tooltip settings for ribbon items. The RibbonTooltipSettings class provides options for customizing the appearance and behavior of tooltips, such as their content, title and iconCss.

Type

Gets or sets the type of the Ribbon item.

Declaration

public RibbonItemType Type { get; set; }

Property Value

Type

Description

RibbonItemType

A RibbonItemType value that represents the type of the Ribbon item. The default value is Button. The RibbonItemType enumeration includes the following types: Button - Renders button as ribbon item. CheckBox - Renders checkbox as ribbon item. ComboBox - Renders combobox as ribbon item. ColorPicker - Renders color picker as ribbon item. DropDown - Renders dropdown button as ribbon item. SplitButton - Renders split button as ribbon item. Gallery - Renders the gallery as ribbon item. GroupButton - Renders the group button content as ribbon item. Template - Renders the template content as ribbon item.

Remarks

This property determines the specific type of the Ribbon item, which influences its behavior and appearance within the ribbon.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

Overrides

SfBaseComponent.Dispose(Boolean)

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type
System.Threading.Tasks.Task

Overrides

SfBaseComponent.OnAfterRenderAsync(Boolean)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
System.Threading.Tasks.Task

Overrides

SfBaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type
System.Threading.Tasks.Task