Class IgbCheckboxList
Inheritance
System.Object
IgbCheckboxList
Implements
System.IDisposable
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbCheckboxList : BaseRendererControl, JsonSerializable
Constructors
IgbCheckboxList()
Declaration
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
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 |
|
CheckboxCheckedBackgroundColor
Declaration
public string CheckboxCheckedBackgroundColor { get; set; }
Property Value
Type |
Description |
System.String |
|
CheckboxCheckedBorderColor
Declaration
public string CheckboxCheckedBorderColor { get; set; }
Property Value
Type |
Description |
System.String |
|
CheckboxTickColor
Declaration
public string CheckboxTickColor { get; set; }
Property Value
Type |
Description |
System.String |
|
CheckboxUncheckedBackgroundColor
Declaration
public string CheckboxUncheckedBackgroundColor { get; set; }
Property Value
Type |
Description |
System.String |
|
CheckboxUncheckedBorderColor
Declaration
public string CheckboxUncheckedBorderColor { get; set; }
Property Value
Type |
Description |
System.String |
|
CheckedChanged
Declaration
public Action<IgbCheckedChangedEventArgs> CheckedChanged { get; set; }
Property Value
CheckedChangedScript
Declaration
public string CheckedChangedScript { 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 |
|
Density
Gets or Sets the property name that contains the values.
Declaration
public ControlDisplayDensity Density { get; set; }
Property Value
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
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
PrimaryKey
Gets or sets the primary key to use for the CheckboxList.
Declaration
public string[] PrimaryKey { 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 |
|
Gets or sets the scrollbar background color.
Declaration
public string ScrollbarBackground { get; set; }
Property Value
Type |
Description |
System.String |
|
Gets or sets the style of scrollbar.
Declaration
public ScrollbarStyle ScrollbarStyle { get; set; }
Property Value
SearchBackgroundColor
Declaration
public string SearchBackgroundColor { get; set; }
Property Value
Type |
Description |
System.String |
|
SearchBorderColor
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
Declaration
public string SearchIconColor { get; set; }
Property Value
Type |
Description |
System.String |
|
Gets or Sets the property name that contains the values.
Declaration
public InputGroupDisplayType SearchInputType { get; set; }
Property Value
SearchTextColor
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
SelectAllCheckboxChangedScript
Declaration
public string SelectAllCheckboxChangedScript { 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 |
|
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
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 |
|
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
SelectAllAsync()
selects all the items in the checkbox list.
Declaration
public Task SelectAllAsync()
Returns
Type |
Description |
System.Threading.Tasks.Task |
|
Implements
System.IDisposable