Inheritance

object
Implements
  • IComponent
  • IHandleEvent
  • IHandleAfterRender
  • JsonSerializable
  • IDisposable

constructor

public IgbCheckboxList()

Returns IgbCheckboxList

Inherited from: BaseRendererControl

[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Height { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Width { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public string Class { get; set; }

Inherited from: BaseRendererControl

[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }

Inherited from: BaseRendererControl

protected virtual string ParentTypeName { get; }

Inherited from: BaseRendererControl

Gets or sets how events are bubbled up from JavaScript to Blazor.

[Parameter]
public ControlEventBehavior EventBehavior { get; set; }

Inherited from: BaseRendererControl

[Parameter]
public RenderFragment ChildContent { get; set; }

Inherited from: BaseRendererControl

Gets or sets what type of date conversion to make when round tripping dates.

[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }

Inherited from: BaseRendererControl

protected virtual bool SupportsVisualChildren { get; }

Inherited from: BaseRendererControl

protected virtual bool UseDirectRender { get; }

Inherited from: BaseRendererControl

protected virtual string DirectRenderElementName { get; }

Inherited from: BaseRendererControl

protected virtual bool NeedsDynamicContent { get; }

Inherited from: BaseRendererControl

protected virtual bool UseCamelEnumValues { get; }

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

[Parameter]
public string ActualSelectAllCaptionTextColor { get; set; }

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

[Parameter]
public string BackgroundColor { get; set; }

Gets or Sets the property name that contains the values.

[Parameter]
public BaseControlTheme BaseTheme { get; set; }
[Parameter]
public string CellFontFamily { get; set; }
[Parameter]
public double CellFontSize { get; set; }
[Parameter]
public string CellFontStyle { get; set; }
[Parameter]
public string CellFontWeight { get; set; }

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

[Parameter]
public bool CheckboxAlignedRight { get; set; }

Gets or sets the checkbox background color when checked.

[Parameter]
public string CheckboxCheckedBackgroundColor { get; set; }

Gets or sets the checkbox border color when checked.

[Parameter]
public string CheckboxCheckedBorderColor { get; set; }

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

[Parameter]
public double CheckboxCornerRadius { get; set; }

Gets or sets the checkbox tick color.

[Parameter]
public string CheckboxTickColor { get; set; }

Gets or sets the checkbox background color when unchecked.

[Parameter]
public string CheckboxUncheckedBackgroundColor { get; set; }

Gets or sets the checkbox border color when unchecked.

[Parameter]
public string CheckboxUncheckedBorderColor { get; set; }
[Parameter]
public Action<IgbCheckedChangedEventArgs> CheckedChanged { get; set; }
[Parameter]
public string CheckedChangedScript { get; set; }
[Parameter]
public object DataLegendTarget { get; set; }

Provides a means of setting DataLegendTarget in the JavaScript environment.

[Parameter]
public string DataLegendTargetScript { get; set; }

Gets or Sets the property name that contains the values.

[Parameter]
public string DataMemberPath { get; set; }

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

[Parameter]
public object DataSource { get; set; }

Provides a means of setting DataSource in the JavaScript environment.

[Parameter]
public string DataSourceScript { get; set; }

Gets the components default event behavior.

protected override ControlEventBehavior DefaultEventBehavior { get; }

Gets or Sets the property name that contains the values.

[Parameter]
public ControlDisplayDensity Density { get; set; }

Gets or Sets the property name that contains the values.

[Parameter]
public string FilterPlaceholderText { get; set; }

Gets or Sets the property name that contains the values.

[Parameter]
public CheckboxListIndexType IndexType { get; set; }

Gets or sets whether row hover highlighting is enabled.

[Parameter]
public bool IsRowHoverEnabled { get; set; }

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.

public IgbGridSelectedKeysCollection Keys { get; protected set; }

Gets or sets the search background color.

[Parameter]
public bool LabelClickTriggersChange { get; set; }
[Parameter]
public Action<IgbCheckedChangedEventArgs> LabelClicked { get; set; }
[Parameter]
public string LabelClickedScript { get; set; }

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

[Parameter]
public string[] PrimaryKey { get; set; }
[Parameter]
public string PropertyTypeMemberPath { get; set; }

Gets or Sets the property name that contains the values.

[Parameter]
public int RowHeight { get; set; }

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

[Parameter]
public string RowHoverBackgroundColor { get; set; }

Gets or sets the scrollbar thumb background color when the user is dragging it.

[Parameter]
public string ScrollbarActiveBackground { get; set; }

Gets or sets the scrollbar background color.

[Parameter]
public string ScrollbarBackground { get; set; }

Gets or sets the scrollbar thumb background color when the pointer is over it.

[Parameter]
public string ScrollbarHoverBackground { get; set; }

Gets or sets the style of scrollbar.

[Parameter]
public ScrollbarStyle ScrollbarStyle { get; set; }

Gets or sets the search background color.

[Parameter]
public string SearchBackgroundColor { get; set; }

Gets or sets the search border color.

[Parameter]
public string SearchBorderColor { get; set; }

Gets or sets the search focus border color.

[Parameter]
public string SearchFocusBorderColor { get; set; }
[Parameter]
public string SearchFontFamily { get; set; }
[Parameter]
public double SearchFontSize { get; set; }
[Parameter]
public string SearchFontStyle { get; set; }
[Parameter]
public string SearchFontWeight { get; set; }

Gets or sets the search icon color.

[Parameter]
public string SearchIconColor { get; set; }

Gets or Sets the property name that contains the values.

[Parameter]
public InputGroupDisplayType SearchInputType { get; set; }

Gets or sets the search text color.

[Parameter]
public string SearchTextColor { get; set; }

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

[Parameter]
public string SelectAllCaption { get; set; }

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

[Parameter]
public string SelectAllCaptionTextColor { get; set; }
[Parameter]
public Action<IgbSelectAllCheckboxChangedEventArgs> SelectAllCheckboxChanged { get; set; }
[Parameter]
public string SelectAllCheckboxChangedScript { get; set; }
[Parameter]
public Action<IgbCheckedChangedEventArgs> SelectedKeyAdded { get; set; }
[Parameter]
public string SelectedKeyAddedScript { get; set; }
[Parameter]
public Action<IgbCheckedChangedEventArgs> SelectedKeyRemoved { get; set; }
[Parameter]
public string SelectedKeyRemovedScript { get; set; }

Gets or Sets the property name that contains the values.

[Parameter]
public string SelectedMemberPath { get; set; }

Gets or sets whether the filter input is visible.

[Parameter]
public bool ShowFilter { get; set; }

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

[Parameter]
public bool ShowSelectAll { get; set; }

Gets or Sets the property name that contains the values.

[Parameter]
public string SubtitleMemberPath { get; set; }

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

[Parameter]
public string TextColor { get; set; }
public override string Type { get; }

Inherited from: BaseRendererControl

protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache

Inherited from: BaseRendererControl

protected string _cachedSerializedContent

Inherited from: BaseRendererControl

Resolves the components event behavior if Auto is selected.

protected ControlEventBehavior ResolveEventBehavior()

Returns any

Inherited from: BaseRendererControl

protected virtual string ResolveDisplay()

Returns any

Inherited from: BaseRendererControl

protected string ToSpinal(string value)

Parameters

  • value: string

Returns any

Inherited from: BaseRendererControl

protected virtual string TransformSimpleKey(string key)

Parameters

  • key: string

Returns any

Inherited from: BaseRendererControl

protected virtual bool IsTransformedEnumValue(string key)

Parameters

  • key: string

Returns any

TransformPotentialEnumValue(string, object)

Section titled "TransformPotentialEnumValue(string, object)"

Inherited from: BaseRendererControl

protected virtual object TransformPotentialEnumValue(string key, object value)

Parameters

  • key: string
  • value: object

Returns any

Inherited from: BaseRendererControl

protected virtual SequenceInfo BuildSequenceInfo(int startSequence)

Parameters

  • startSequence: int

Returns any

Inherited from: BaseRendererControl

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

  • builder: RenderTreeBuilder

Returns any

Inherited from: BaseRendererControl

protected Type TemplateContentType(string templateId)

Parameters

  • templateId: string

Returns any

Inherited from: BaseRendererControl

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

  • firstRender: bool

Returns any

Inherited from: BaseRendererControl

public Task EnsureReady()

Returns any

Inherited from: BaseRendererControl

protected void MarkPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Inherited from: BaseRendererControl

protected bool IsPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Serialize(SerializationContext, string)

Section titled "Serialize(SerializationContext, string)"

Inherited from: BaseRendererControl

public void Serialize(SerializationContext context, string propertyName = null)

Parameters

  • context: SerializationContext
  • propertyName: string

Returns any

Inherited from: BaseRendererControl

public string Serialize()

Returns any

InvokeMethod(string, object[], string[], ElementReference[])

Section titled "InvokeMethod(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererControl

protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodSync(string, object[], string[], ElementReference[])

Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererControl

protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

Inherited from: BaseRendererControl

Prevents data change notifications from be propagated to the component.

public void SuspendNotifications(object dataSource)

Parameters

  • dataSource: object

Returns any

Inherited from: BaseRendererControl

Resumes data change notifications.

public void ResumeNotifications(object dataSource, bool notify = true)

Parameters

  • dataSource: object
  • notify: bool

Returns any

NotifyInsertItem(object, int, object)

Section titled "NotifyInsertItem(object, int, object)"

Inherited from: BaseRendererControl

public void NotifyInsertItem(object dataSource, int index, object refItem)

Parameters

  • dataSource: object
  • index: int
  • refItem: object

Returns any

NotifyRemoveItem(object, int, object)

Section titled "NotifyRemoveItem(object, int, object)"

Inherited from: BaseRendererControl

public void NotifyRemoveItem(object dataSource, int index, object oldItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object

Returns any

Inherited from: BaseRendererControl

public void NotifyClearItems(object dataSource)

Parameters

  • dataSource: object

Returns any

NotifySetItem(object, int, object, object)

Section titled "NotifySetItem(object, int, object, object)"

Inherited from: BaseRendererControl

public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)

Parameters

  • dataSource: object
  • index: int
  • oldItem: object
  • newItem: object

Returns any

NotifyUpdateItem(object, int, object, bool)

Section titled "NotifyUpdateItem(object, int, object, bool)"

Inherited from: BaseRendererControl

public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)

Parameters

  • dataSource: object
  • index: int
  • refItem: object
  • syncDataOnly: bool

Returns any

Inherited from: BaseRendererControl

public void OnRefChanged(string refName, object refValue)

Parameters

  • refName: string
  • refValue: object

Returns any

Inherited from: BaseRendererControl

public void OnInvokeReturn(long invokeId, object returnValue)

Parameters

  • invokeId: long
  • returnValue: object

Returns any

Inherited from: BaseRendererControl

protected string Camelize(string value)

Parameters

  • value: string

Returns any

Inherited from: BaseRendererControl

protected string ToPascal(string value)

Parameters

  • value: string

Returns any

OnElementNameChanged(BaseRendererElement, string, string)

Section titled "OnElementNameChanged(BaseRendererElement, string, string)"

Inherited from: BaseRendererControl

protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)

Parameters

  • element: BaseRendererElement
  • oldName: string
  • newName: string

Returns any

Inherited from: BaseRendererControl

protected virtual void Dispose(bool disposing)

Parameters

  • disposing: bool

Returns any

SetResourceStringAsync(string, string, string)

Section titled "SetResourceStringAsync(string, string, string)"

Inherited from: BaseRendererControl

public Task<object> SetResourceStringAsync(string grouping, string id, string value)

Parameters

  • grouping: string
  • id: string
  • value: string

Returns any

SetResourceStringAsync(string, string)

Section titled "SetResourceStringAsync(string, string)"

Inherited from: BaseRendererControl

public Task<object> SetResourceStringAsync(string grouping, string json)

Parameters

  • grouping: string
  • json: string

Returns any

SetPropertyValue(object, PropertyInfo, JsonElement)

Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"

Inherited from: BaseRendererControl

protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)

Parameters

  • item: object
  • property: PropertyInfo
  • jsonElement: JsonElement

Returns any

SetPropertyValue(object, PropertyInfo, object)

Section titled "SetPropertyValue(object, PropertyInfo, object)"

Inherited from: BaseRendererControl

protected void SetPropertyValue(object item, PropertyInfo property, object value)

Parameters

  • item: object
  • property: PropertyInfo
  • value: object

Returns any

Inherited from: BaseRendererControl

public void Dispose()

Returns any

public void AddKeyValue(object[] value)

Parameters

  • value: object[]

Returns any

public Task AddKeyValueAsync(object[] value)

Parameters

  • value: object[]

Returns any

public void DeselectAll()

Returns any

Deselects all the items in the checkbox list.

public Task DeselectAllAsync()

Returns any

protected override void EnsureModulesLoaded()

Returns any

public string ExportSerializedVisualModel()

Returns any

Returns a serialized copy of the exported visual model

public Task<string> ExportSerializedVisualModelAsync()

Returns any

public object ExportVisualModel()

Returns any

Exports visual information about the current state of the grid.

public Task<object> ExportVisualModelAsync()

Returns any

public override object FindByName(string name)

Parameters

  • name: string

Returns any

public bool IsEverythingSelected()

Returns any

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

public Task<bool> IsEverythingSelectedAsync()

Returns any

public bool IsNothingSelected()

Returns any

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

public Task<bool> IsNothingSelectedAsync()

Returns any

public void NotifyClearItems()

Returns any

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.

public Task NotifyClearItemsAsync()

Returns any

public void NotifyInsertItem(int index, object newItem)

Parameters

  • index: int
  • newItem: object

Returns any

public Task NotifyInsertItemAsync(int index, object newItem)

Parameters

  • index: int
  • newItem: object

Returns any

public void NotifyRemoveItem(int index, object oldItem)

Parameters

  • index: int
  • oldItem: object

Returns any

public Task NotifyRemoveItemAsync(int index, object oldItem)

Parameters

  • index: int
  • oldItem: object

Returns any

public void NotifySetItem(int index, object oldItem, object newItem)

Parameters

  • index: int
  • oldItem: object
  • newItem: object

Returns any

NotifySetItemAsync(int, object, object)

Section titled "NotifySetItemAsync(int, object, object)"
public Task NotifySetItemAsync(int index, object oldItem, object newItem)

Parameters

  • index: int
  • oldItem: object
  • newItem: object

Returns any

public void Refresh()

Returns any

public Task RefreshAsync()

Returns any

public void RemoveKeyValue(object[] value)

Parameters

  • value: object[]

Returns any

public Task RemoveKeyValueAsync(object[] value)

Parameters

  • value: object[]

Returns any

public void SelectAll()

Returns any

selects all the items in the checkbox list.

public Task SelectAllAsync()

Returns any

[Parameter]
public EventCallback<IgbCheckboxListIndexTypeChangedEventArgs> IndexTypeChanged { get; set; }
[Parameter]
public EventCallback<IgbCheckboxListKeysClearedEventArgs> KeysCleared { get; set; }
[Parameter]
public string IndexTypeChangedScript { get; set; }
[Parameter]
public string KeysClearedScript { get; set; }