CodBi
    Preparing search index...

    Class MultiSelect

    A plain Editors.BaseEditor retrieving it's available options to display out of window.. CodbiPluginData.fileListing storing the made selections.

    Primarily intended to be used for selecting CodBi's standard configurations that shall be included into a form.

    Hierarchy

    Index

    Constructors

    Properties

    _idx: number
    afterAdd: () => void
    appearance: string
    className: string
    config: TEditorCfg<IMultiSelectDescriptor>
    depends: string

    Use config.IPropertyDescriptor.depends

    dependsEval: TDependEvalFn<
        "com.github.xima_formcycle_entwicklerkreis.fc.plugin:fc-plugin-codbi:MultiSelect",
    >

    Use config.IPropertyDescriptor.dependsEval

    designer: IFormDesigner

    Use IEditorCfgExtra this.config.designer.

    fcPlaceholderType: string
    i18n: Record<string, string>

    Use I18n and related methods.

    property: string

    Use config.IPropertyDescriptor.property

    Methods

    • Returns JQuery

      The panel box that contains this editor. Usually the element with the class xm-editor-panel. May return an empty JQuery instance when the editor is used outside an editor panel.

    • Returns number

      Always 0.

      Dynamic property editors are not supported anymore.

    • Returns JQuery

      The panel box that contains this editor. Usually the element with the class xm-panel-box. May return an empty JQuery instance when the editor is used without a panel box.

    • Returns JQuery

      The property row that contains this editor. Usually the element with the class xm-pe-row. May return an empty JQuery instance when the editor is used without a property row.

    • Returns TEditorPropertyType

      The type of property edited by this editor, i.e. whether this editor is used for editing a form element property, a default property, or a property of the entire form. undefined when the type is unknown, such as when the editor was only just created, but not yet added to a properties panel. May also return an empty JQuery instance when the editor is used outside the properties panel.

    • Generates a CSV of all selected standard configurations.

      Returns string

      A CSV of all selected standard configurations.

    • Hides this editor so that is it is not visible anymore to the user. This should hide the entire getPropertyRow.

      Returns void

    • Returns void

      Dynamic property editors are not supported anymore.

    • Clears all selections prior to setting the selected configurations according to the received data.

      Parameters

      • data: unknown

        See Editors.BaseEditor's setValue.

      Returns void

    • Sets the current value of this editor.

      Parameters

      • value: string

        The new value to set on this editor.

      Returns void

    • Unhides this editor so that it is visible again.

      Returns void