@mendix/extensions-api - v0.2.4
    Preparing search index...

    Interface SearchBar

    See: relevant section in reference guide

    interface SearchBar {
        $CreationOptions?: unknown;
        $ID: string;
        $Type: "Pages$SearchBar";
        items: ControlBarItem[];
        type: SearchBarTypeEnum;
        waitForSearch: boolean;
        addComparisonSearchField(
            options: ComparisonSearchFieldCreationOptions,
        ): Promise<ComparisonSearchField>;
        addDataGridAddButton(
            options: DataGridAddButtonCreationOptions,
        ): Promise<DataGridAddButton>;
        addDataGridExportToCSVButton(
            options: DataGridExportToCSVButtonCreationOptions,
        ): Promise<DataGridExportToCSVButton>;
        addDataGridExportToExcelButton(
            options: DataGridExportToExcelButtonCreationOptions,
        ): Promise<DataGridExportToExcelButton>;
        addDataGridRemoveButton(
            options: DataGridRemoveButtonCreationOptions,
        ): Promise<DataGridRemoveButton>;
        addDropDownSearchField(
            options: DropDownSearchFieldCreationOptions,
        ): Promise<DropDownSearchField>;
        addGridActionButton(
            options: GridActionButtonCreationOptions,
        ): Promise<GridActionButton>;
        addGridDeselectAllButton(
            options: GridDeselectAllButtonCreationOptions,
        ): Promise<GridDeselectAllButton>;
        addGridNewButton(
            options: GridNewButtonCreationOptions,
        ): Promise<GridNewButton>;
        addGridSearchButton(
            options: GridSearchButtonCreationOptions,
        ): Promise<GridSearchButton>;
        addGridSelectAllButton(
            options: GridSelectAllButtonCreationOptions,
        ): Promise<GridSelectAllButton>;
        addRangeSearchField(
            options: RangeSearchFieldCreationOptions,
        ): Promise<RangeSearchField>;
        addSelectButton(
            options: SelectButtonCreationOptions,
        ): Promise<SelectButton>;
        getComparisonSearchField(name: string): undefined | ComparisonSearchField;
        getDataGridAddButton(name: string): undefined | DataGridAddButton;
        getDataGridExportToCSVButton(
            name: string,
        ): undefined | DataGridExportToCSVButton;
        getDataGridExportToExcelButton(
            name: string,
        ): undefined | DataGridExportToExcelButton;
        getDataGridRemoveButton(name: string): undefined | DataGridRemoveButton;
        getDropDownSearchField(name: string): undefined | DropDownSearchField;
        getGridActionButton(name: string): undefined | GridActionButton;
        getGridDeselectAllButton(name: string): undefined | GridDeselectAllButton;
        getGridNewButton(name: string): undefined | GridNewButton;
        getGridSearchButton(name: string): undefined | GridSearchButton;
        getGridSelectAllButton(name: string): undefined | GridSelectAllButton;
        getRangeSearchField(name: string): undefined | RangeSearchField;
        getSelectButton(name: string): undefined | SelectButton;
    }

    Hierarchy (View Summary)

    Index

    Properties

    $CreationOptions? $ID $Type items type waitForSearch

    Methods

    addComparisonSearchField addDataGridAddButton addDataGridExportToCSVButton addDataGridExportToExcelButton addDataGridRemoveButton addDropDownSearchField addGridActionButton addGridDeselectAllButton addGridNewButton addGridSearchButton addGridSelectAllButton addRangeSearchField addSelectButton getComparisonSearchField getDataGridAddButton getDataGridExportToCSVButton getDataGridExportToExcelButton getDataGridRemoveButton getDropDownSearchField getGridActionButton getGridDeselectAllButton getGridNewButton getGridSearchButton getGridSelectAllButton getRangeSearchField getSelectButton

    Properties

    $CreationOptions?: unknown

    Options to pass during the element creation

    $ID: string

    The unique id of the element.

    $Type: "Pages$SearchBar"

    The type of the element.

    items: ControlBarItem[]
    type: SearchBarTypeEnum
    waitForSearch: boolean

    Methods

    Settings

    On This Page

    Properties
    Methods