Class IgbCheckboxList

Inheritance
System.Object
BaseRendererControl
IgbCheckboxList
Implements
System.IDisposable
Inherited Members
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbCheckboxList : BaseRendererControl, RefSink, JsonSerializable, IDisposable

Constructors

IgbCheckboxList()

Declaration
public IgbCheckboxList()

Properties

ActualSelectAllCaptionTextColor

Gets or sets the color to use for the actual header selectAllCaption text.

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

BackgroundColor

Gets or sets the color to use for the background of the component.

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

BaseTheme

Gets or Sets the property name that contains the values.

Declaration
public BaseControlTheme BaseTheme { get; set; }
Property Value
Type Description
BaseControlTheme

CellFontFamily

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

CellFontSize

Declaration
public double CellFontSize { get; set; }
Property Value
Type Description
System.Double

CellFontStyle

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

CellFontWeight

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

CheckboxAlignedRight

Gets or sets whether checkbox should be displayed to the right.

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

CheckboxCheckedBackgroundColor

Gets or sets the checkbox background color when checked.

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

CheckboxCheckedBorderColor

Gets or sets the checkbox border color when checked.

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

CheckboxCornerRadius

Gets or sets the corner radius to use for the checkbox.

Declaration
public double CheckboxCornerRadius { get; set; }
Property Value
Type Description
System.Double

CheckboxTickColor

Gets or sets the checkbox tick color.

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

CheckboxUncheckedBackgroundColor

Gets or sets the checkbox background color when unchecked.

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

CheckboxUncheckedBorderColor

Gets or sets the checkbox border color when unchecked.

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

CheckedChanged

Declaration
public Action<IgbCheckedChangedEventArgs> CheckedChanged { get; set; }
Property Value
Type Description
System.Action<IgbCheckedChangedEventArgs>

CheckedChangedScript

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

DataLegendTarget

Declaration
public object DataLegendTarget { get; set; }
Property Value
Type Description
System.Object

DataLegendTargetScript

Provides a means of setting DataLegendTarget in the JavaScript environment.

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

DataMemberPath

Gets or Sets the property name that contains the values.

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

DataSource

Gets or sets the data or data source instance to which to bind the grid.

Declaration
public object DataSource { get; set; }
Property Value
Type Description
System.Object

DataSourceScript

Provides a means of setting DataSource in the JavaScript environment.

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

DefaultEventBehavior

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

Density

Gets or Sets the property name that contains the values.

Declaration
public ControlDisplayDensity Density { get; set; }
Property Value
Type Description
ControlDisplayDensity

FilterPlaceholderText

Gets or Sets the property name that contains the values.

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

IndexType

Gets or Sets the property name that contains the values.

Declaration
public CheckboxListIndexType IndexType { get; set; }
Property Value
Type Description
CheckboxListIndexType

IndexTypeChanged

Declaration
public EventCallback<IgbCheckboxListIndexTypeChangedEventArgs> IndexTypeChanged { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbCheckboxListIndexTypeChangedEventArgs>

IndexTypeChangedScript

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

IsRowHoverEnabled

Gets or sets whether row hover highlighting is enabled.

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

Keys

Gets the collection responsible for selection in the CheckboxList. Selection is determined by two factors: whether everything is selected or deselected and the values present in this collection. If everything is selected then any items in this collection will be deselected. If everything is deselected then any items in this collection will be selected. The CheckboxList defaults all items as deselected. This state can change when you use the SelectAll and DeselectAll methods.

Declaration
public IgbGridSelectedKeysCollection Keys { get; protected set; }
Property Value
Type Description
IgbGridSelectedKeysCollection

KeysCleared

Declaration
public EventCallback<IgbCheckboxListKeysClearedEventArgs> KeysCleared { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbCheckboxListKeysClearedEventArgs>

KeysClearedScript

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

LabelClicked

Declaration
public Action<IgbCheckedChangedEventArgs> LabelClicked { get; set; }
Property Value
Type Description
System.Action<IgbCheckedChangedEventArgs>

LabelClickedScript

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

LabelClickTriggersChange

Gets or sets the search background color.

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

PrimaryKey

Gets or sets the primary key to use for the CheckboxList.

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

PropertyTypeMemberPath

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

RowHeight

Gets or Sets the property name that contains the values.

Declaration
public int RowHeight { get; set; }
Property Value
Type Description
System.Int32

RowHoverBackgroundColor

Gets or sets the color to use when hovering over a grid row.

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

ScrollbarBackground

Gets or sets the scrollbar background color.

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

ScrollbarStyle

Gets or sets the style of scrollbar.

Declaration
public ScrollbarStyle ScrollbarStyle { get; set; }
Property Value
Type Description
ScrollbarStyle

SearchBackgroundColor

Gets or sets the search background color.

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

SearchBorderColor

Gets or sets the search border color.

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

SearchFontFamily

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

SearchFontSize

Declaration
public double SearchFontSize { get; set; }
Property Value
Type Description
System.Double

SearchFontStyle

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

SearchFontWeight

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

SearchIconColor

Gets or sets the search icon color.

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

SearchInputType

Gets or Sets the property name that contains the values.

Declaration
public InputGroupDisplayType SearchInputType { get; set; }
Property Value
Type Description
InputGroupDisplayType

SearchTextColor

Gets or sets the search text color.

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

SelectAllCaption

Gets / sets the caption of the "Select All" checkbox.

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

SelectAllCaptionTextColor

Gets or sets the color to use for the "Select All" label.

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

SelectAllCheckboxChanged

Declaration
public Action<IgbSelectAllCheckboxChangedEventArgs> SelectAllCheckboxChanged { get; set; }
Property Value
Type Description
System.Action<IgbSelectAllCheckboxChangedEventArgs>

SelectAllCheckboxChangedScript

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

SelectedKeyAdded

Declaration
public Action<IgbCheckedChangedEventArgs> SelectedKeyAdded { get; set; }
Property Value
Type Description
System.Action<IgbCheckedChangedEventArgs>

SelectedKeyAddedScript

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

SelectedKeyRemoved

Declaration
public Action<IgbCheckedChangedEventArgs> SelectedKeyRemoved { get; set; }
Property Value
Type Description
System.Action<IgbCheckedChangedEventArgs>

SelectedKeyRemovedScript

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

SelectedMemberPath

Gets or Sets the property name that contains the values.

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

ShowFilter

Gets or sets whether the filter input is visible.

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

ShowSelectAll

Gets / sets whether the "Select all" checkbox is visible.

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

SubtitleMemberPath

Gets or Sets the property name that contains the values.

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

TextColor

Gets or sets the color to use for the text of the component.

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

Type

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

Methods

AddKeyValue(Object[])

Declaration
public void AddKeyValue(object[] value)
Parameters
Type Name Description
System.Object[] value

AddKeyValueAsync(Object[])

Declaration
public Task AddKeyValueAsync(object[] value)
Parameters
Type Name Description
System.Object[] value
Returns
Type Description
System.Threading.Tasks.Task

DeselectAll()

Declaration
public void DeselectAll()

DeselectAllAsync()

Deselects all the items in the checkbox list.

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

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides

ExportSerializedVisualModel()

Declaration
public string ExportSerializedVisualModel()
Returns
Type Description
System.String

ExportSerializedVisualModelAsync()

Returns a serialized copy of the exported visual model

Declaration
public Task<string> ExportSerializedVisualModelAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

ExportVisualModel()

Declaration
public object ExportVisualModel()
Returns
Type Description
System.Object

ExportVisualModelAsync()

Exports visual information about the current state of the grid.

Declaration
public Task<object> ExportVisualModelAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Object>

FindByName(String)

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

IsEverythingSelected()

Declaration
public bool IsEverythingSelected()
Returns
Type Description
System.Boolean

IsEverythingSelectedAsync()

Returns true if all of the items are selected / checked; otherwise false.

Declaration
public Task<bool> IsEverythingSelectedAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

IsNothingSelected()

Declaration
public bool IsNothingSelected()
Returns
Type Description
System.Boolean

IsNothingSelectedAsync()

Returns true if no items are selected / checked; otherwise false.

Declaration
public Task<bool> IsNothingSelectedAsync()
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

NotifyClearItems()

Declaration
public void NotifyClearItems()

NotifyClearItemsAsync()

Manually notifies the checkboxlist's grid that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the grid is bound to is already observable.

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

NotifyInsertItem(Int32, Object)

Declaration
public void NotifyInsertItem(int index, object newItem)
Parameters
Type Name Description
System.Int32 index
System.Object newItem

NotifyInsertItemAsync(Int32, Object)

Declaration
public Task NotifyInsertItemAsync(int index, object newItem)
Parameters
Type Name Description
System.Int32 index
System.Object newItem
Returns
Type Description
System.Threading.Tasks.Task

NotifyRemoveItem(Int32, Object)

Declaration
public void NotifyRemoveItem(int index, object oldItem)
Parameters
Type Name Description
System.Int32 index
System.Object oldItem

NotifyRemoveItemAsync(Int32, Object)

Declaration
public Task NotifyRemoveItemAsync(int index, object oldItem)
Parameters
Type Name Description
System.Int32 index
System.Object oldItem
Returns
Type Description
System.Threading.Tasks.Task

NotifySetItem(Int32, Object, Object)

Declaration
public void NotifySetItem(int index, object oldItem, object newItem)
Parameters
Type Name Description
System.Int32 index
System.Object oldItem
System.Object newItem

NotifySetItemAsync(Int32, Object, Object)

Declaration
public Task NotifySetItemAsync(int index, object oldItem, object newItem)
Parameters
Type Name Description
System.Int32 index
System.Object oldItem
System.Object newItem
Returns
Type Description
System.Threading.Tasks.Task

Refresh()

Declaration
public void Refresh()

RefreshAsync()

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

RemoveKeyValue(Object[])

Declaration
public void RemoveKeyValue(object[] value)
Parameters
Type Name Description
System.Object[] value

RemoveKeyValueAsync(Object[])

Declaration
public Task RemoveKeyValueAsync(object[] value)
Parameters
Type Name Description
System.Object[] value
Returns
Type Description
System.Threading.Tasks.Task

SelectAll()

Declaration
public void SelectAll()

SelectAllAsync()

selects all the items in the checkbox list.

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

Implements

System.IDisposable