Class RibbonCheckBoxSettings
Inheritance
Namespace: Syncfusion.Blazor.Ribbon
Assembly: Syncfusion.Blazor.dll
Syntax
public class RibbonCheckBoxSettings : OwningComponentBase
Constructors
RibbonCheckBoxSettings()
Declaration
public RibbonCheckBoxSettings()
Properties
Checked
Gets or sets whether the checkbox is checked or not.
Declaration
public bool Checked { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | A boolean value indicating whether the checkbox is checked. The default value is |
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.
Created
Gets or sets an event callback that is raised when the Checkbox rendering is completed.
Declaration
public EventCallback Created { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback | An event handler that is invoked after the checkbox has been rendered. The default value is |
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
public string CssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String | A string representing one or more CSS classes to apply to the checkbox. The default value is |
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.
HtmlAttributes
Gets or sets the HTML attributes for the element.
Declaration
public Dictionary<string, object> HtmlAttributes { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.Dictionary<System.String, System.Object> | A dictionary representing the HTML attributes to be applied to the element. The default value is |
Remarks
This property allows you to specify custom HTML attributes for the element, such as id
, class
, style
, data-*
attributes, and more. By setting HTML attributes, you can enhance the element's functionality, style, or behavior.
Label
Gets or sets the label for the checkbox.
Declaration
public string Label { get; set; }
Property Value
Type | Description |
---|---|
System.String | A string that represents the label to be displayed for the checkbox. The default value is |
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
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:
ValueChange
Gets or sets an event callback that is raised when the checked state of the checkbox is changed.
Declaration
public EventCallback<ChangeEventArgs<bool>> ValueChange { get; set; }
Property Value
Type | Description |
---|---|
Microsoft.AspNetCore.Components.EventCallback<ChangeEventArgs<System.Boolean>> | An Microsoft.AspNetCore.Components.EventCallback<> that is invoked when the checked state of the checkbox changes. The callback receives a ChangeEventArgs<TChecked> of type System.Boolean. |
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(Boolean)
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing |
OnInitializedAsync()
Declaration
protected override Task OnInitializedAsync()
Returns
Type |
---|
System.Threading.Tasks.Task |