Class InlineToolbarItemModel

Represents a toolbar item model in the SfBlockEditor component.

Inheritance

object

InlineToolbarItemModel

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.BlockEditor

Assembly: Syncfusion.Blazor.dll

Syntax

public class InlineToolbarItemModel

Remarks

Each toolbar item defines an action that can be performed in the editor's toolbar.

Toolbar items can be customized with various properties like text, icons, and behaviors.

Constructors

InlineToolbarItemModel()

Declaration

public InlineToolbarItemModel()

Properties

Command

Gets or sets the built-in toolbar item type.

Declaration

[JsonConverter(typeof(JsonStringEnumConverter))]
public CommandName Command { get; set; }

Property Value

Type	Description
CommandName	A CommandName specifying the toolbar item type.

CssClass

Gets or sets additional CSS classes for styling the item.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
string	A string containing CSS class names. The default value is "" (empty string).

Remarks

This allows for further customization of the toolbar item's appearance.

Disabled

Gets or sets whether the item is disabled.

Declaration

public bool Disabled { get; set; }

Property Value

Type	Description
bool	A bool indicating whether the item should be non-interactive. The default value is false.

Remarks

When set to true, the item will be visible but not interactive.

HtmlAttributes

Gets or sets custom HTML attributes for the toolbar item.

Declaration

public Dictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type	Description
Dictionary<string, object>	A Dictionary<TKey, TValue> of strings and objects representing HTML attributes. The default value is null.

Remarks

Supports HTML attributes such as style, class, etc. for additional customization.

ID

Gets or sets the unique identifier of the toolbar item.

Declaration

public string ID { get; set; }

Property Value

Type	Description
string	A string representing the unique identifier for referencing specific toolbar items programmatically. The default value is "" (empty string).

Remarks

This ID can be used for accessing and manipulating specific toolbar items via code.

IconCss

Gets or sets the CSS classes for the icon associated with the item.

Declaration

public string IconCss { get; set; }

Property Value

Type	Description
string	A string representing CSS classes for styling the icon. The default value is "" (empty string).

Remarks

Allows styling and representation of icons next to item headers.

TabIndex

Gets or sets the tab index of the item when it appears in a tabbing sequence.

Declaration

public int TabIndex { get; set; }

Property Value

Type	Description
int	An int representing the position in tab order. The default value is -1.

Remarks

This controls the keyboard focus order. A value of -1 indicates the item is not part of sequential keyboard navigation.

Template

Gets or sets the template used for rendering the item.

Declaration

public RenderFragment Template { get; set; }

Property Value

Type	Description
RenderFragment	A RenderFragment allowing for customized rendering of the toolbar item. The default value is null.

Remarks

Enables custom rendering of the toolbar item appearance and behavior.

Text

Gets or sets the text content associated with the item.

Declaration

public string Text { get; set; }

Property Value

Type	Description
string	A string representing the display text content. The default value is null.

Remarks

It can be used as a label or description for the toolbar item.

TooltipText

Gets or sets the tooltip text that appears when hovering over the item.

Declaration

public string TooltipText { get; set; }

Property Value

Type	Description
string	A string containing the tooltip text. The default value is "" (empty string).

Remarks

It provides additional information or context for the toolbar item.

Type

Gets or sets the type of the item, determining its function or category.

Declaration

public ItemType Type { get; set; }

Property Value

Type	Description
ItemType	An ItemType specifying the function type of the toolbar item. The default value is Button.

Visible

Gets or sets whether the item is visible.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
bool	A bool indicating whether the item should be displayed. The default value is true.

Remarks

This controls the visibility of the item in the UI without removing it from the model.