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
IgbToggleButton
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
public class IgbToggleButton : BaseRendererControl, RefSink, JsonSerializable, IDisposable
Constructors
Declaration
Properties
Declaration
protected override ControlEventBehavior DefaultEventBehavior { get; }
Property Value
Overrides
Declaration
protected override string DirectRenderElementName { get; }
Property Value
| Type |
Description |
| System.String |
|
Overrides
Determines whether the button is disabled.
Declaration
public bool Disabled { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Determines whether the button is selected.
Declaration
public bool Selected { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Declaration
protected override bool SupportsVisualChildren { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
Overrides
Declaration
public override string Type { get; }
Property Value
| Type |
Description |
| System.String |
|
Overrides
Declaration
protected override bool UseDirectRender { get; }
Property Value
| Type |
Description |
| System.Boolean |
|
Overrides
The value attribute of the control.
Declaration
public string Value { get; set; }
Property Value
| Type |
Description |
| System.String |
|
Methods
Declaration
[WCWidgetMemberName("Blur")]
public void BlurComponent()
Removes focus from the button.
Declaration
[WCWidgetMemberName("Blur")]
public Task BlurComponentAsync()
Returns
| Type |
Description |
| System.Threading.Tasks.Task |
|
Declaration
Simulates a mouse click on the element.
Declaration
Returns
| Type |
Description |
| System.Threading.Tasks.Task |
|
Declaration
protected override void EnsureModulesLoaded()
Overrides
Declaration
public override object FindByName(string name)
Parameters
| Type |
Name |
Description |
| System.String |
name |
|
Returns
| Type |
Description |
| System.Object |
|
Overrides
Declaration
[WCWidgetMemberName("Focus")]
public void FocusComponent(IgbFocusOptions options)
Parameters
Sets focus on the button.
Declaration
[WCWidgetMemberName("Focus")]
public Task FocusComponentAsync(IgbFocusOptions options)
Parameters
Returns
| Type |
Description |
| System.Threading.Tasks.Task |
|
Declaration
protected override string ResolveDisplay()
Returns
| Type |
Description |
| System.String |
|
Overrides
Declaration
public void SetNativeElement(object element)
Parameters
| Type |
Name |
Description |
| System.Object |
element |
|
Declaration
public Task SetNativeElementAsync(object element)
Parameters
| Type |
Name |
Description |
| System.Object |
element |
|
Returns
| Type |
Description |
| System.Threading.Tasks.Task |
|
Implements
System.IDisposable