Show / Hide Table of Contents

Class IgbIconButton

Inheritance
System.Object
BaseRendererControl
IgbButtonBase
IgbIconButton
Implements
JsonSerializable
System.IDisposable
Inherited Members
IgbButtonBase.FocusComponentAsync(IgbFocusOptions)
IgbButtonBase.FocusComponent(IgbFocusOptions)
IgbButtonBase.BlurComponentAsync()
IgbButtonBase.BlurComponent()
IgbButtonBase.DisplayType
IgbButtonBase.Href
IgbButtonBase.Download
IgbButtonBase.Target
IgbButtonBase.Rel
IgbButtonBase.Disabled
IgbButtonBase.AriaLabel
IgbButtonBase.Size
IgbButtonBase.FocusScript
IgbButtonBase.Focus
IgbButtonBase.BlurScript
IgbButtonBase.Blur
BaseRendererControl._cachedSerializedContent
BaseRendererControl.ToSpinal(String)
BaseRendererControl.TransformSimpleKey(String)
BaseRendererControl.IsTransformedEnumValue(String)
BaseRendererControl.TransformPotentialEnumValue(String, Object)
BaseRendererControl.BuildSequenceInfo(Int32)
BaseRendererControl.BuildRenderTree(RenderTreeBuilder)
BaseRendererControl.TemplateContentType(String)
BaseRendererControl.OnAfterRenderAsync(Boolean)
BaseRendererControl.EnsureReady()
BaseRendererControl.MarkPropDirty(String)
BaseRendererControl.IsPropDirty(String)
BaseRendererControl.Serialize(SerializationContext, String)
BaseRendererControl.Serialize()
BaseRendererControl.InvokeMethod(String, Object[], String[], ElementReference[])
BaseRendererControl.InvokeMethodSync(String, Object[], String[], ElementReference[])
BaseRendererControl.SuspendNotifications(Object)
BaseRendererControl.ResumeNotifications(Object)
BaseRendererControl.NotifyInsertItem(Object, Int32, Object)
BaseRendererControl.NotifyRemoveItem(Object, Int32, Object)
BaseRendererControl.NotifyClearItems(Object)
BaseRendererControl.NotifySetItem(Object, Int32, Object, Object)
BaseRendererControl.NotifyUpdateItem(Object, Int32, Object, Boolean)
BaseRendererControl.OnRefChanged(String, Object)
BaseRendererControl.OnInvokeReturn(Int64, Object)
BaseRendererControl.Camelize(String)
BaseRendererControl.ToPascal(String)
BaseRendererControl.OnElementNameChanged(BaseRendererElement, String, String)
BaseRendererControl.Dispose(Boolean)
BaseRendererControl.SetResourceStringAsync(String, String, String)
BaseRendererControl.SetResourceStringAsync(String, String)
BaseRendererControl.SetPropertyValue(Object, PropertyInfo, JsonElement)
BaseRendererControl.SetPropertyValue(Object, PropertyInfo, Object)
BaseRendererControl.Finalize()
BaseRendererControl.Dispose()
BaseRendererControl.IgBlazor
BaseRendererControl.Height
BaseRendererControl.Width
BaseRendererControl.Class
BaseRendererControl.AdditionalAttributes
BaseRendererControl.ParentTypeName
BaseRendererControl.ChildContent
BaseRendererControl.NeedsDynamicContent
BaseRendererControl.UseCamelEnumValues
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbIconButton : IgbButtonBase, RefSink, JsonSerializable, IDisposable

Constructors

IgbIconButton()

Declaration
public IgbIconButton()

Properties

Collection

The name of the icon 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
IgbButtonBase.DirectRenderElementName

IconName

The name of the icon.

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

Mirrored

Whether to flip the icon button. 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
IgbButtonBase.SupportsVisualChildren

Type

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

UseDirectRender

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

Variant

The visual variant of the icon button.

Declaration
public IconButtonVariant Variant { get; set; }
Property Value
Type Description
IconButtonVariant

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides
BaseRendererControl.EnsureModulesLoaded()

FindByName(String)

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

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
IgbButtonBase.ResolveDisplay()

Implements

JsonSerializable
System.IDisposable