Bluestep JS Documentation
    Preparing search index...

    Interface CreateEmailAddressFieldProperties

    Properties for creating a email address field.

    interface CreateEmailAddressFieldProperties {
        advancedOptions?: string;
        allowOther?: boolean;
        autoCopy?: boolean;
        columnName: string;
        defaultValue?: any;
        defaultValueAsString?: string;
        deprecated?: boolean;
        fieldControlType?:
            | "NORMAL"
            | "HIDDEN_DEFAULT"
            | "READONLY_DEFAULT"
            | "SMART_HIDE"
            | "READONLY_WHEN_COMPLETED"
            | "CUSTOM";
        fieldControlValue?: string;
        formula?: string;
        formulaId?: string;
        frozen?: boolean;
        helpText?: string;
        hiddenFromSupers?: boolean;
        keyStringFuzzyEquals?: boolean;
        label?: string;
        longLabel?: boolean;
        neverHideHelpText?: boolean;
        placeholder?: string;
        popupHint?: boolean;
        reportLabel?: string;
        required?: boolean;
        styleClass?: string;
        subFormatType?: string;
        textFormatType: "EMAIL";
        userUpdateable?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    advancedOptions? allowOther? autoCopy? columnName defaultValue? defaultValueAsString? deprecated? fieldControlType? fieldControlValue? formula? formulaId? frozen? helpText? hiddenFromSupers? keyStringFuzzyEquals? label? longLabel? neverHideHelpText? placeholder? popupHint? reportLabel? required? styleClass? subFormatType? textFormatType userUpdateable?

    Properties

    advancedOptions?: string

    Advanced configuration options as a key-value string

    allowOther?: boolean

    Whether to show an 'Other' option that allows free-text entry

    autoCopy?: boolean

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

    columnName: string

    Database column name.

    defaultValue?: any

    Default value pre-populated when creating new records

    defaultValueAsString?: string

    Default text value for 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

    helpText?: string

    Help text displayed below or beside the field

    hiddenFromSupers?: boolean

    Whether this field is hidden from parent/supervisor unit views

    keyStringFuzzyEquals?: boolean

    Whether to use fuzzy matching when comparing key string values

    label?: string

    Display label shown to users on the form

    longLabel?: boolean

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

    neverHideHelpText?: boolean

    Whether to always show help text (never collapse it)

    placeholder?: string

    Placeholder text shown in the empty input field

    popupHint?: boolean

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

    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

    subFormatType?: string

    Sub-format configuration for specialized text display

    textFormatType: "EMAIL"

    Format type discriminant.

    userUpdateable?: boolean

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

    Settings

    Member Visibility

    On This Page

    Properties