Class RibbonCheckBoxSettings

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
RibbonCheckBoxSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Ribbon
Assembly: Syncfusion.Blazor.dll
Syntax
public class RibbonCheckBoxSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

RibbonCheckBoxSettings()

Declaration
public RibbonCheckBoxSettings()

Properties

Checked

Gets or sets whether the checkbox is checked or not.

Declaration
[Parameter]
public bool Checked { get; set; }
Property Value
Type Description
bool

A boolean value indicating whether the checkbox is checked. The default value is false, meaning the checkbox is not checked by default.
Remarks

This property controls the checked state of the checkbox. When set to true, the checkbox appears checked, indicating that the option it represents is selected. When set to false, the checkbox appears unchecked, indicating that the option is not selected.

CheckedChanged

Event callback triggered when the checked state of the checkbox changes.

Declaration
[Parameter]
public EventCallback<bool> CheckedChanged { get; set; }
Property Value
Type Description
EventCallback<bool>

An event callback function that is invoked when the Checked property changes.
Remarks

It enables two-way binding, allowing parent components to react to changes in the checkbox state.

Created

Gets or sets an event callback that is raised when the Checkbox rendering is completed.

Declaration
[Parameter]
public EventCallback Created { get; set; }
Property Value
Type Description
EventCallback

An event handler that is invoked after the checkbox has been rendered. The default value is null, meaning no event handler is set by default.
Remarks

This event callback is triggered after the checkbox has been fully rendered and is ready for interaction. It can be used to perform additional setup or customizations once the checkbox is displayed on the page.

CssClass

Gets or sets one or more CSS classes to customize the appearance of the checkbox.

Declaration
[Parameter]
public string CssClass { get; set; }
Property Value
Type Description
string

A string representing one or more CSS classes to apply to the checkbox. The default value is String.Empty, meaning no additional CSS classes are applied by default.
Remarks

This property allows you to specify CSS classes that will be applied to the checkbox, enabling you to customize its appearance according to your design requirements. By providing a string of CSS class names separated by spaces, you can apply various styles to the checkbox, such as color, size, or layout adjustments.

Label

Gets or sets the label for the checkbox.

Declaration
[Parameter]
public string Label { get; set; }
Property Value
Type Description
string

A string that represents the label to be displayed for the checkbox. The default value is String.Empty, meaning no label is set by default.
Remarks

This property allows you to specify the text that will be displayed alongside the checkbox, providing users with a description or identifier for the checkbox's purpose. The label is typically shown to the right of the checkbox, helping users understand what selecting or deselecting the checkbox will do.

LabelPosition

Gets or sets the position of the label relative to the checkbox.

Declaration
[Parameter]
public LabelPosition LabelPosition { get; set; }
Property Value
Type Description
LabelPosition

A LabelPosition value that specifies where the label is positioned in relation to the checkbox. The default value is After.
Remarks

This property determines the positioning of the label relative to the checkbox. The label can be placed:

  • After: To the right of the checkbox.
  • Before: To the left of the checkbox. The positioning of the label can affect the layout and alignment of form elements. The choice between placing the label before or after the checkbox may be influenced by design considerations or user experience guidelines.

ValueChange

Gets or sets an event callback that is raised when the checked state of the checkbox is changed.

Declaration
[Parameter]
public EventCallback<ChangeEventArgs<bool>> ValueChange { get; set; }
Property Value
Type Description
EventCallback<ChangeEventArgs<bool>>

An EventCallback<TValue> that is invoked when the checked state of the checkbox changes. The callback receives a ChangeEventArgs<TChecked> of type bool.
Remarks

This event is triggered whenever the user changes the checked state of the checkbox, either by clicking the checkbox or through programmatic changes. You can use this event to perform actions or update other components in response to the checkbox state change.

Methods

Dispose(bool)

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing
Overrides

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

Implements