Class HeaderToolbarItem

Inheritance

System.Object

HeaderToolbarItem

ChatToolbarItem

Namespace: Syncfusion.Blazor.InteractiveChat

Assembly: Syncfusion.Blazor.dll

Syntax

public class HeaderToolbarItem : OwningComponentBase

Constructors

HeaderToolbarItem()

Declaration

public HeaderToolbarItem()

Properties

CssClass

Gets or sets the CSS class of the toolbar item in the SfChatUI component.

Declaration

public string CssClass { get; set; }

Property Value

Type	Description
System.String	The CSS class of the toolbar item. The default is an empty string.

Remarks

This property specifies the CSS class for the SfChatUI in the SfChatUI component.

Disabled

Gets or sets a value indicating whether the toolbar item is disabled in the SfChatUI component.

Declaration

public bool Disabled { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value indicating whether the toolbar item is disabled. The default is false.

Remarks

This property specifies whether the HeaderToolbarItem is disabled in the SfChatUI component.

IconCss

Gets or sets the icon CSS for the HeaderToolbarItem in the SfChatUI component.

Declaration

public string IconCss { get; set; }

Property Value

Type	Description
System.String	The CSS class for the icon. The default is String.Empty.

Remarks

This property specifies the CSS class for the icon used in the HeaderToolbarItem.

TabIndex

Gets or sets the tab order of the toolbar items in the SfChatUI component. When assigned positive values, it allows switching focus to the next/previous toolbar items using the Tab/Shift+Tab keys. If the value is set to 0 for all toolbar items, the tab order switches based on the element's order in the DOM.

Declaration

public int TabIndex { get; set; }

Property Value

Type	Description
System.Int32	The tab index of the toolbar item. The default value is -1.

Template

Gets or sets a template that defines the appearance of the toolbar item in the SfChatUI component.

Declaration

public RenderFragment Template { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A Microsoft.AspNetCore.Components.RenderFragment representing the template for the toolbar item. The default is null.

Remarks

This property specifies the template used to render the appearance of the HeaderToolbarItem in the SfChatUI component.

Text

Gets or sets the text of the toolbar item in the SfChatUI component.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	The text of the toolbar item. The default is null.

Remarks

This property specifies the text for the HeaderToolbarItem in the SfChatUI component.

Tooltip

Gets or sets the tooltip of the toolbar item in the SfChatUI component.

Declaration

public string Tooltip { get; set; }

Property Value

Type	Description
System.String	The tooltip of the toolbar item. The default is an empty string.

Remarks

This property specifies the tooltip for the HeaderToolbarItem in the SfChatUI component.

Type

Gets or sets the type of the toolbar item in the SfChatUI component.

Declaration

public ItemType Type { get; set; }

Property Value

Type	Description
ItemType	The type of the toolbar item. The default is ItemType.Button.

Remarks

This property specifies the type for the HeaderToolbarItem in the SfChatUI component.

Visible

Gets or sets a value indicating whether the toolbar item is visible in the SfChatUI component.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value indicating whether the toolbar item is visible. The default is true.

Remarks

This property specifies whether the HeaderToolbarItem is visible in the SfChatUI component.

Methods

Dispose(Boolean)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type
System.Threading.Tasks.Task