Bluestep JS Documentation
    Preparing search index...

    Interface CreateMultiSelectCheckBoxesFieldProperties

    Properties for creating a multi select check boxes field.

    interface CreateMultiSelectCheckBoxesFieldProperties {
        autoCopy?: boolean;
        columnCount?: number;
        columnName: string;
        defaultValue?: any;
        deprecated?: boolean;
        fieldControlType?:
            | "NORMAL"
            | "HIDDEN_DEFAULT"
            | "READONLY_DEFAULT"
            | "SMART_HIDE"
            | "READONLY_WHEN_COMPLETED"
            | "CUSTOM";
        fieldControlValue?: string;
        formula?: string;
        formulaId?: string;
        frozen?: boolean;
        groupingOption?: | "BOOLEAN"
        | "HEADER"
        | "OFF"
        | "NORMAL"
        | "SPLIT"
        | "ADHOC"
        | "MERGE_REPORT";
        helpText?: string;
        hiddenFromSupers?: boolean;
        label?: string;
        listOptionsTopId: string;
        longLabel?: boolean;
        multiSelectFormatType: "CHECKBOX_GROUP";
        neverHideHelpText?: boolean;
        popupHint?: boolean;
        printFormatType?: string;
        reportLabel?: string;
        required?: boolean;
        styleClass?: string;
        userUpdateable?: boolean;
        width?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoCopy? columnCount? columnName defaultValue? deprecated? fieldControlType? fieldControlValue? formula? formulaId? frozen? groupingOption? helpText? hiddenFromSupers? label? listOptionsTopId longLabel? multiSelectFormatType neverHideHelpText? popupHint? printFormatType? reportLabel? required? styleClass? userUpdateable? width?

    Properties

    autoCopy?: boolean

    Whether to automatically copy this field's value when cloning a record

    columnCount?: number

    Number of columns for checkbox/radio layouts

    columnName: string

    Database column name.

    defaultValue?: any

    Default value pre-populated when creating new records

    deprecated?: boolean

    Whether this field is deprecated and hidden from new configurations

    fieldControlType?:
        | "NORMAL"
        | "HIDDEN_DEFAULT"
        | "READONLY_DEFAULT"
        | "SMART_HIDE"
        | "READONLY_WHEN_COMPLETED"
        | "CUSTOM"

    Visibility/editability control mode for this field

    fieldControlValue?: string

    Custom expression for CUSTOM field control type

    formula?: string

    BlueStep formula expression for computed field values

    formulaId?: string

    ID of a saved formula to use for computed values

    frozen?: boolean

    Whether this field is locked from editing by non-admin users

    groupingOption?:
        | "BOOLEAN"
        | "HEADER"
        | "OFF"
        | "NORMAL"
        | "SPLIT"
        | "ADHOC"
        | "MERGE_REPORT"

    How option list items are grouped in the display

    helpText?: string

    Help text displayed below or beside the field

    hiddenFromSupers?: boolean

    Whether this field is hidden from parent/supervisor unit views

    label?: string

    Display label shown to users on the form

    listOptionsTopId: string

    ID of the option list that provides selectable values

    longLabel?: boolean

    Whether the label spans the full width above the field instead of beside it

    multiSelectFormatType: "CHECKBOX_GROUP"

    Format type discriminant.

    neverHideHelpText?: boolean

    Whether to always show help text (never collapse it)

    popupHint?: boolean

    Whether to show help text as a popup tooltip instead of inline

    printFormatType?: string

    Format used when printing/exporting selected values

    reportLabel?: string

    Alternate label used in reports and exports

    required?: boolean

    Whether this field must have a value before the record can be saved

    styleClass?: string

    CSS class name(s) applied to the field for custom styling

    userUpdateable?: boolean

    Whether end users can edit this field value (false = system-managed)

    width?: number

    Display width in columns

    Settings

    Member Visibility

    On This Page

    Properties