Hierarchy

Hierarchy

Constructors

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<IIgrCheckboxListProps> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get actualRowHeight(): number
  • Returns number

  • get actualSelectAllCaptionTextColor(): string
  • Gets or sets the color to use for the actual header selectAllCaption text.

    Returns string

  • set actualSelectAllCaptionTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get backgroundColor(): string
  • Gets or sets the color to use for the background of the component.

    Returns string

  • set backgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get baseTheme(): BaseControlTheme
  • Gets or Sets the property name that contains the values.

    Returns BaseControlTheme

  • set baseTheme(v): void
  • Parameters

    • v: BaseControlTheme

    Returns void

  • get cellTextStyle(): string
  • Gets or Sets the property name that contains the values.

    Returns string

  • set cellTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get checkboxCheckedBackgroundColor(): string
  • Gets or sets the checkbox background color when checked.

    Returns string

  • set checkboxCheckedBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get checkboxCheckedBorderColor(): string
  • Gets or sets the checkbox border color when checked.

    Returns string

  • set checkboxCheckedBorderColor(v): void
  • Parameters

    • v: string

    Returns void

  • get checkboxTickColor(): string
  • Gets or sets the checkbox tick color.

    Returns string

  • set checkboxTickColor(v): void
  • Parameters

    • v: string

    Returns void

  • get checkboxUncheckedBackgroundColor(): string
  • Gets or sets the checkbox background color when unchecked.

    Returns string

  • set checkboxUncheckedBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get checkboxUncheckedBorderColor(): string
  • Gets or sets the checkbox border color when unchecked.

    Returns string

  • set checkboxUncheckedBorderColor(v): void
  • Parameters

    • v: string

    Returns void

  • get checkedChanged(): ((s, e) => void)
  • Called when a checkbox is checked or unchecked.

    Returns ((s, e) => void)

  • set checkedChanged(ev): void
  • Parameters

    Returns void

  • get dataMemberPath(): string
  • Gets or Sets the property name that contains the values.

    Returns string

  • set dataMemberPath(v): void
  • Parameters

    • v: string

    Returns void

  • get dataSource(): any
  • Returns any

  • set dataSource(value): void
  • Parameters

    • value: any

    Returns void

  • get density(): ControlDisplayDensity
  • Gets or Sets the property name that contains the values.

    Returns ControlDisplayDensity

  • set density(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get filterPlaceholderText(): string
  • Gets or Sets the property name that contains the values.

    Returns string

  • set filterPlaceholderText(v): void
  • Parameters

    • v: string

    Returns void

  • get height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: string

    Returns void

  • get i(): CheckboxList
  • Returns CheckboxList

  • get indexType(): CheckboxListIndexType
  • Gets or Sets the property name that contains the values.

    Returns CheckboxListIndexType

  • set indexType(v): void
  • Parameters

    Returns void

  • get isRowHoverEnabled(): boolean
  • Gets or sets whether row hover highlighting is enabled.

    Returns boolean

  • set isRowHoverEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get keys(): IgrGridSelectedKeysCollection
  • 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.

    Returns IgrGridSelectedKeysCollection

  • set keys(v): void
  • Parameters

    Returns void

  • get primaryKey(): string[]
  • Gets or sets the primary key to use for the CheckboxList.

    Returns string[]

  • set primaryKey(v): void
  • Parameters

    • v: string[]

    Returns void

  • get rowHeight(): number
  • Gets or Sets the property name that contains the values.

    Returns number

  • set rowHeight(v): void
  • Parameters

    • v: number

    Returns void

  • get rowHoverBackgroundColor(): string
  • Gets or sets the color to use when hovering over a grid row.

    Returns string

  • set rowHoverBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get scrollbarBackground(): string
  • Gets or sets the scrollbar background color.

    Returns string

  • set scrollbarBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get scrollbarStyle(): ScrollbarStyle
  • Gets or sets the style of scrollbar.

    Returns ScrollbarStyle

  • set scrollbarStyle(v): void
  • Parameters

    • v: ScrollbarStyle

    Returns void

  • get searchBackgroundColor(): string
  • Gets or sets the search background color.

    Returns string

  • set searchBackgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get searchBorderColor(): string
  • Gets or sets the search border color.

    Returns string

  • set searchBorderColor(v): void
  • Parameters

    • v: string

    Returns void

  • get searchIconColor(): string
  • Gets or sets the search icon color.

    Returns string

  • set searchIconColor(v): void
  • Parameters

    • v: string

    Returns void

  • get searchInputType(): InputGroupDisplayType
  • Gets or Sets the property name that contains the values.

    Returns InputGroupDisplayType

  • set searchInputType(v): void
  • Parameters

    • v: InputGroupDisplayType

    Returns void

  • get searchTextColor(): string
  • Gets or sets the search text color.

    Returns string

  • set searchTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get searchTextStyle(): string
  • Gets or sets the text style.

    Returns string

  • set searchTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get selectAllCaption(): string
  • Gets / sets the caption of the "Select All" checkbox.

    Returns string

  • set selectAllCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get selectAllCaptionTextColor(): string
  • Gets or sets the color to use for the "Select All" label.

    Returns string

  • set selectAllCaptionTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get selectAllCheckboxChanged(): ((s, e) => void)
  • Called when the SelectAll checkbox is checked or unchecked.

    Returns ((s, e) => void)

  • set selectAllCheckboxChanged(ev): void
  • Parameters

    Returns void

  • get selectedKeyAdded(): ((s, e) => void)
  • Called when an item is added.

    Returns ((s, e) => void)

  • set selectedKeyAdded(ev): void
  • Parameters

    Returns void

  • get selectedKeyRemoved(): ((s, e) => void)
  • Called when an item is removed.

    Returns ((s, e) => void)

  • set selectedKeyRemoved(ev): void
  • Parameters

    Returns void

  • get selectedMemberPath(): string
  • Gets or Sets the property name that contains the values.

    Returns string

  • set selectedMemberPath(v): void
  • Parameters

    • v: string

    Returns void

  • get showFilter(): boolean
  • Gets or sets whether the filter input is visible.

    Returns boolean

  • set showFilter(v): void
  • Parameters

    • v: boolean

    Returns void

  • get showSelectAll(): boolean
  • Gets / sets whether the "Select all" checkbox is visible.

    Returns boolean

  • set showSelectAll(v): void
  • Parameters

    • v: boolean

    Returns void

  • get textColor(): string
  • Gets or sets the color to use for the text of the component.

    Returns string

  • set textColor(v): void
  • Parameters

    • v: string

    Returns void

  • get width(): string
  • Returns string

  • set width(value): void
  • Parameters

    • value: string

    Returns void

Methods

  • Parameters

    • value: any[]

    Returns void

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

  • Returns void

  • Deselects all the items in the checkbox list.

    Returns void

  • Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Returns IgSize

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns any

  • Returns void

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

    Returns boolean

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

    Returns boolean

  • 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.

    Returns void

  • Parameters

    • index: number
    • newItem: any

    Returns void

  • Parameters

    • index: number
    • oldItem: any

    Returns void

  • Parameters

    • index: number
    • oldItem: any
    • newItem: any

    Returns void

  • Parameters

    • value: any[]

    Returns void

  • Returns DetailedReactHTMLElement<{
        children: any[];
        className: string;
        ref: ((ref) => void);
    }, any>

  • selects all the items in the checkbox list.

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

  • Returns void