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

    Interface BuildingBlock

    See: relevant section in reference guide

    interface BuildingBlock {
        $CreationOptions?: BuildingBlockCreationOptions;
        $ID: string;
        $Type: "Pages$BuildingBlock";
        canvasHeight: number;
        canvasWidth: number;
        displayName: string;
        documentation: string;
        documentationUrl: string;
        excluded: boolean;
        exportLevel: ExportLevel;
        imageData: any;
        name: string;
        platform: SnippetType;
        templateCategory: string;
        templateCategoryWeight: number;
        widgets: Widget[];
        addActionButton(
            options: ActionButtonCreationOptions,
        ): Promise<ActionButton>;
        addCheckBox(options: CheckBoxCreationOptions): Promise<CheckBox>;
        addDataGrid(options: DataGridCreationOptions): Promise<DataGrid>;
        addDataView(options: DataViewCreationOptions): Promise<DataView>;
        addDatePicker(options: DatePickerCreationOptions): Promise<DatePicker>;
        addDivContainer(
            options: DivContainerCreationOptions,
        ): Promise<DivContainer>;
        addDropDown(options: DropDownCreationOptions): Promise<DropDown>;
        addDropDownButton(
            options: DropDownButtonCreationOptions,
        ): Promise<DropDownButton>;
        addDynamicImageViewer(
            options: DynamicImageViewerCreationOptions,
        ): Promise<DynamicImageViewer>;
        addDynamicText(options: DynamicTextCreationOptions): Promise<DynamicText>;
        addFileManager(options: FileManagerCreationOptions): Promise<FileManager>;
        addGroupBox(options: GroupBoxCreationOptions): Promise<GroupBox>;
        addHeader(options: HeaderCreationOptions): Promise<Header>;
        addImageUploader(
            options: ImageUploaderCreationOptions,
        ): Promise<ImageUploader>;
        addInputReferenceSetSelector(
            options: InputReferenceSetSelectorCreationOptions,
        ): Promise<InputReferenceSetSelector>;
        addLabel(options: LabelCreationOptions): Promise<Label>;
        addLayoutGrid(options: LayoutGridCreationOptions): Promise<LayoutGrid>;
        addListView(options: ListViewCreationOptions): Promise<ListView>;
        addLoginButton(options: LoginButtonCreationOptions): Promise<LoginButton>;
        addLoginIdTextBox(
            options: LoginIdTextBoxCreationOptions,
        ): Promise<LoginIdTextBox>;
        addMenuBar(options: MenuBarCreationOptions): Promise<MenuBar>;
        addNavigationList(
            options: NavigationListCreationOptions,
        ): Promise<NavigationList>;
        addNavigationTree(
            options: NavigationTreeCreationOptions,
        ): Promise<NavigationTree>;
        addPasswordTextBox(
            options: PasswordTextBoxCreationOptions,
        ): Promise<PasswordTextBox>;
        addPlaceholder(options: PlaceholderCreationOptions): Promise<Placeholder>;
        addRadioButtonGroup(
            options: RadioButtonGroupCreationOptions,
        ): Promise<RadioButtonGroup>;
        addReferenceSelector(
            options: ReferenceSelectorCreationOptions,
        ): Promise<ReferenceSelector>;
        addReferenceSetSelector(
            options: ReferenceSetSelectorCreationOptions,
        ): Promise<ReferenceSetSelector>;
        addScrollContainer(
            options: ScrollContainerCreationOptions,
        ): Promise<ScrollContainer>;
        addSidebarToggleButton(
            options: SidebarToggleButtonCreationOptions,
        ): Promise<SidebarToggleButton>;
        addSimpleMenuBar(
            options: SimpleMenuBarCreationOptions,
        ): Promise<SimpleMenuBar>;
        addSnippetCallWidget(
            options: SnippetCallWidgetCreationOptions,
        ): Promise<SnippetCallWidget>;
        addStaticImageViewer(
            options: StaticImageViewerCreationOptions,
        ): Promise<StaticImageViewer>;
        addTabContainer(
            options: TabContainerCreationOptions,
        ): Promise<TabContainer>;
        addTable(options: TableCreationOptions): Promise<Table>;
        addTemplateGrid(
            options: TemplateGridCreationOptions,
        ): Promise<TemplateGrid>;
        addTemplatePlaceholder(
            options: TemplatePlaceholderCreationOptions,
        ): Promise<TemplatePlaceholder>;
        addTextArea(options: TextAreaCreationOptions): Promise<TextArea>;
        addTextBox(options: TextBoxCreationOptions): Promise<TextBox>;
        addTitle(options: TitleCreationOptions): Promise<Title>;
        addValidationMessage(
            options: ValidationMessageCreationOptions,
        ): Promise<ValidationMessage>;
        getActionButton(name: string): undefined | ActionButton;
        getCheckBox(name: string): undefined | CheckBox;
        getDataGrid(name: string): undefined | DataGrid;
        getDataView(name: string): undefined | DataView;
        getDatePicker(name: string): undefined | DatePicker;
        getDivContainer(name: string): undefined | DivContainer;
        getDropDown(name: string): undefined | DropDown;
        getDropDownButton(name: string): undefined | DropDownButton;
        getDynamicImageViewer(name: string): undefined | DynamicImageViewer;
        getDynamicText(name: string): undefined | DynamicText;
        getFileManager(name: string): undefined | FileManager;
        getGroupBox(name: string): undefined | GroupBox;
        getHeader(name: string): undefined | Header;
        getImageUploader(name: string): undefined | ImageUploader;
        getInputReferenceSetSelector(
            name: string,
        ): undefined | InputReferenceSetSelector;
        getLabel(name: string): undefined | Label;
        getLayoutGrid(name: string): undefined | LayoutGrid;
        getListView(name: string): undefined | ListView;
        getLoginButton(name: string): undefined | LoginButton;
        getLoginIdTextBox(name: string): undefined | LoginIdTextBox;
        getMenuBar(name: string): undefined | MenuBar;
        getNavigationList(name: string): undefined | NavigationList;
        getNavigationTree(name: string): undefined | NavigationTree;
        getPasswordTextBox(name: string): undefined | PasswordTextBox;
        getPlaceholder(name: string): undefined | Placeholder;
        getRadioButtonGroup(name: string): undefined | RadioButtonGroup;
        getReferenceSelector(name: string): undefined | ReferenceSelector;
        getReferenceSetSelector(name: string): undefined | ReferenceSetSelector;
        getScrollContainer(name: string): undefined | ScrollContainer;
        getSidebarToggleButton(name: string): undefined | SidebarToggleButton;
        getSimpleMenuBar(name: string): undefined | SimpleMenuBar;
        getSnippetCallWidget(name: string): undefined | SnippetCallWidget;
        getStaticImageViewer(name: string): undefined | StaticImageViewer;
        getTabContainer(name: string): undefined | TabContainer;
        getTable(name: string): undefined | Table;
        getTemplateGrid(name: string): undefined | TemplateGrid;
        getTemplatePlaceholder(name: string): undefined | TemplatePlaceholder;
        getTextArea(name: string): undefined | TextArea;
        getTextBox(name: string): undefined | TextBox;
        getTitle(name: string): undefined | Title;
        getValidationMessage(name: string): undefined | ValidationMessage;
    }

    Hierarchy (View Summary)

    Index

    Properties

    $CreationOptions? $ID $Type canvasHeight canvasWidth displayName documentation documentationUrl excluded exportLevel imageData name platform templateCategory templateCategoryWeight widgets

    Methods

    addActionButton addCheckBox addDataGrid addDataView addDatePicker addDivContainer addDropDown addDropDownButton addDynamicImageViewer addDynamicText addFileManager addGroupBox addHeader addImageUploader addInputReferenceSetSelector addLabel addLayoutGrid addListView addLoginButton addLoginIdTextBox addMenuBar addNavigationList addNavigationTree addPasswordTextBox addPlaceholder addRadioButtonGroup addReferenceSelector addReferenceSetSelector addScrollContainer addSidebarToggleButton addSimpleMenuBar addSnippetCallWidget addStaticImageViewer addTabContainer addTable addTemplateGrid addTemplatePlaceholder addTextArea addTextBox addTitle addValidationMessage getActionButton getCheckBox getDataGrid getDataView getDatePicker getDivContainer getDropDown getDropDownButton getDynamicImageViewer getDynamicText getFileManager getGroupBox getHeader getImageUploader getInputReferenceSetSelector getLabel getLayoutGrid getListView getLoginButton getLoginIdTextBox getMenuBar getNavigationList getNavigationTree getPasswordTextBox getPlaceholder getRadioButtonGroup getReferenceSelector getReferenceSetSelector getScrollContainer getSidebarToggleButton getSimpleMenuBar getSnippetCallWidget getStaticImageViewer getTabContainer getTable getTemplateGrid getTemplatePlaceholder getTextArea getTextBox getTitle getValidationMessage

    Properties

    $CreationOptions?: BuildingBlockCreationOptions

    Options to pass during the element creation

    $ID: string

    The unique id of the element.

    $Type: "Pages$BuildingBlock"

    The type of the element.

    canvasHeight: number
    canvasWidth: number
    displayName: string
    documentation: string
    documentationUrl: string
    excluded: boolean
    exportLevel: ExportLevel
    imageData: any
    name: string
    platform: SnippetType
    templateCategory: string
    templateCategoryWeight: number
    widgets: Widget[]

    Methods

    • Parameters

      • name: string

      Returns undefined | CheckBox

    • Parameters

      • name: string

      Returns undefined | DataGrid

    • Parameters

      • name: string

      Returns undefined | DataView

    • Parameters

      • name: string

      Returns undefined | DatePicker

    • Parameters

      • name: string

      Returns undefined | DropDown

    • Parameters

      • name: string

      Returns undefined | GroupBox

    • Parameters

      • name: string

      Returns undefined | Header

    • Parameters

      • name: string

      Returns undefined | Label

    • Parameters

      • name: string

      Returns undefined | LayoutGrid

    • Parameters

      • name: string

      Returns undefined | ListView

    • Parameters

      • name: string

      Returns undefined | MenuBar

    • Parameters

      • name: string

      Returns undefined | Table

    • Parameters

      • name: string

      Returns undefined | TextArea

    • Parameters

      • name: string

      Returns undefined | TextBox

    • Parameters

      • name: string

      Returns undefined | Title

    Settings

    On This Page

    Properties
    Methods
    addActionButtonaddCheckBoxaddDataGridaddDataViewaddDatePickeraddDivContaineraddDropDownaddDropDownButtonaddDynamicImageVieweraddDynamicTextaddFileManageraddGroupBoxaddHeaderaddImageUploaderaddInputReferenceSetSelectoraddLabeladdLayoutGridaddListViewaddLoginButtonaddLoginIdTextBoxaddMenuBaraddNavigationListaddNavigationTreeaddPasswordTextBoxaddPlaceholderaddRadioButtonGroupaddReferenceSelectoraddReferenceSetSelectoraddScrollContaineraddSidebarToggleButtonaddSimpleMenuBaraddSnippetCallWidgetaddStaticImageVieweraddTabContaineraddTableaddTemplateGridaddTemplatePlaceholderaddTextAreaaddTextBoxaddTitleaddValidationMessagegetActionButtongetCheckBoxgetDataGridgetDataViewgetDatePickergetDivContainergetDropDowngetDropDownButtongetDynamicImageViewergetDynamicTextgetFileManagergetGroupBoxgetHeadergetImageUploadergetInputReferenceSetSelectorgetLabelgetLayoutGridgetListViewgetLoginButtongetLoginIdTextBoxgetMenuBargetNavigationListgetNavigationTreegetPasswordTextBoxgetPlaceholdergetRadioButtonGroupgetReferenceSelectorgetReferenceSetSelectorgetScrollContainergetSidebarToggleButtongetSimpleMenuBargetSnippetCallWidgetgetStaticImageViewergetTabContainergetTablegetTemplateGridgetTemplatePlaceholdergetTextAreagetTextBoxgetTitlegetValidationMessage