Show / Hide Table of Contents

Class IgbToggleButton

The igc-toggle-button wraps a native button element and exposes additional value and selected properties. It is used in the context of an igc-button-group to facilitate the creation of group/toolbar like UX behaviors.

Inheritance
System.Object
BaseRendererControl
IgbToggleButton
Implements
JsonSerializable
System.IDisposable
Inherited Members
BaseRendererControl.eventCallbacksCache
BaseRendererControl._cachedSerializedContent
BaseRendererControl.ResolveEventBehavior()
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, Boolean)
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.CompareEventCallbacks<T>(T, T, Dictionary<Type, Dictionary<String, FieldInfo>>)
BaseRendererControl.Finalize()
BaseRendererControl.Dispose()
BaseRendererControl.IgBlazor
BaseRendererControl.Height
BaseRendererControl.Width
BaseRendererControl.Class
BaseRendererControl.AdditionalAttributes
BaseRendererControl.ParentTypeName
BaseRendererControl.EventBehavior
BaseRendererControl.ChildContent
BaseRendererControl.RoundTripDateConversion
BaseRendererControl.NeedsDynamicContent
BaseRendererControl.UseCamelEnumValues
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbToggleButton : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbToggleButton()

Declaration
public IgbToggleButton()

Properties

DefaultEventBehavior

Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Type Description
ControlEventBehavior
Overrides
BaseRendererControl.DefaultEventBehavior

DirectRenderElementName

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

Disabled

Determines whether the button is disabled.

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

Selected

Determines whether the button is selected.

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

SupportsVisualChildren

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

Type

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

UseDirectRender

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

Value

The value attribute of the control.

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

Methods

BlurComponent()

Declaration
[WCWidgetMemberName("Blur")]
public void BlurComponent()

BlurComponentAsync()

Removes focus from the button.

Declaration
[WCWidgetMemberName("Blur")]
public Task BlurComponentAsync()
Returns
Type Description
System.Threading.Tasks.Task

Click()

Declaration
public void Click()

ClickAsync()

Simulates a mouse click on the element.

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

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
BaseRendererControl.FindByName(String)

FocusComponent(IgbFocusOptions)

Declaration
[WCWidgetMemberName("Focus")]
public void FocusComponent(IgbFocusOptions options)
Parameters
Type Name Description
IgbFocusOptions options

FocusComponentAsync(IgbFocusOptions)

Sets focus on the button.

Declaration
[WCWidgetMemberName("Focus")]
public Task FocusComponentAsync(IgbFocusOptions options)
Parameters
Type Name Description
IgbFocusOptions options
Returns
Type Description
System.Threading.Tasks.Task

ResolveDisplay()

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

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

JsonSerializable
System.IDisposable