Class IgbIcon

Icon component

Inheritance
System.Object
BaseRendererControl
IgbIcon
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbIcon : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbIcon()

Declaration
public IgbIcon()

Properties

Collection

Declaration
public string Collection { get; set; }
Property Value
Type Description
System.String

DirectRenderElementName

Declaration
protected override string DirectRenderElementName { get; }
Property Value
Type Description
System.String
Overrides

IconName

Declaration
[WCWidgetMemberName("Name")]
public string IconName { get; set; }
Property Value
Type Description
System.String

Mirrored

Whether to flip the icon. Useful for RTL layouts.

Declaration
public bool Mirrored { get; set; }
Property Value
Type Description
System.Boolean

SupportsVisualChildren

Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
Type Description
System.Boolean
Overrides

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides

UseDirectRender

Declaration
protected override bool UseDirectRender { get; }
Property Value
Type Description
System.Boolean
Overrides

Methods

ConnectedCallback()

Declaration
public void ConnectedCallback()

ConnectedCallbackAsync()

Declaration
public Task ConnectedCallbackAsync()
Returns
Type Description
System.Threading.Tasks.Task

DisconnectedCallback()

Declaration
public void DisconnectedCallback()

DisconnectedCallbackAsync()

Declaration
public Task DisconnectedCallbackAsync()
Returns
Type Description
System.Threading.Tasks.Task

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides

RegisterIcon(String, String, String)

Declaration
public void RegisterIcon(string name, string url, string collection)
Parameters
Type Name Description
System.String name
System.String url
System.String collection

RegisterIconAsync(String, String, String)

Declaration
public Task RegisterIconAsync(string name, string url, string collection)
Parameters
Type Name Description
System.String name
System.String url
System.String collection
Returns
Type Description
System.Threading.Tasks.Task

RegisterIconFromText(String, String, String)

Declaration
public void RegisterIconFromText(string name, string iconText, string collection)
Parameters
Type Name Description
System.String name
System.String iconText
System.String collection

RegisterIconFromTextAsync(String, String, String)

Declaration
public Task RegisterIconFromTextAsync(string name, string iconText, string collection)
Parameters
Type Name Description
System.String name
System.String iconText
System.String collection
Returns
Type Description
System.Threading.Tasks.Task

ResolveDisplay()

Declaration
protected override string ResolveDisplay()
Returns
Type Description
System.String
Overrides

SetIconRef(String, String, IgbIconMeta)

Declaration
public void SetIconRef(string name, string collection, IgbIconMeta icon)
Parameters
Type Name Description
System.String name
System.String collection
IgbIconMeta icon

SetIconRefAsync(String, String, IgbIconMeta)

Declaration
public Task SetIconRefAsync(string name, string collection, IgbIconMeta icon)
Parameters
Type Name Description
System.String name
System.String collection
IgbIconMeta icon
Returns
Type Description
System.Threading.Tasks.Task

SetNativeElement(Object)

Declaration
public void SetNativeElement(object element)
Parameters
Type Name Description
System.Object element

SetNativeElementAsync(Object)

Declaration
public Task SetNativeElementAsync(object element)
Parameters
Type Name Description
System.Object element
Returns
Type Description
System.Threading.Tasks.Task

Implements

System.IDisposable