Bluestep JS Documentation
    Preparing search index...

    Interface UpdateHtmlMemoFieldProperties

    Properties for updating a html memo field.

    interface UpdateHtmlMemoFieldProperties {
        autoCopy?: boolean;
        columnSpan?: number;
        defaultValue?: any;
        defaultValueAsString?: string;
        deprecated?: boolean;
        expectedVersion?: number;
        fieldControlFieldTopId?: string;
        fieldControlType?:
            | "NORMAL"
            | "HIDDEN_DEFAULT"
            | "READONLY_DEFAULT"
            | "SMART_HIDE"
            | "READONLY_WHEN_COMPLETED"
            | "CUSTOM";
        fieldControlValue?: string;
        fieldControlView?: "READONLY"
        | "HIDDEN";
        formula?: string;
        formulaId?: string;
        frozen?: boolean;
        height?: number;
        helpText?: string;
        hiddenFromSupers?: boolean;
        jsonType?: string;
        label?: string;
        longLabel?: boolean;
        maxLength?: string;
        memoFormatType: "HTML";
        name?: string;
        neverHideHelpText?: boolean;
        parameters?: string;
        placeholder?: string;
        popupHint?: boolean;
        reportLabel?: string;
        required?: boolean;
        styleClass?: string;
        typeScriptDeclarations?: string;
        userUpdateable?: boolean;
        width?: number;
    }

    Hierarchy (View Summary)

    Index
    autoCopy?: boolean

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

    columnSpan?: number

    How many of its row's columns this field spans: 0 for the whole row, 1-4 for that many columns. An explicit null clears it, leaving the field type's default placement. Read by layout clients; legacy form pages do not apply it.

    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

    expectedVersion?: number

    The field's rowVersion this write was decided against. At that version the write applies and bumps it; one past it with a payload that changes nothing — a replay of a write that already landed — answers success without another bump; anything else is refused with CONCURRENT_MODIFICATION and extensions.currentVersion. Omit to write unconditionally.

    fieldControlFieldTopId?: string

    ID of the field a CUSTOM fieldControlType watches: another checkbox, radio, signature or single-select field on the same form. Null or an empty ID removes it.

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

    Visibility/editability control mode for this field

    fieldControlValue?: string

    The watched field's value at which a CUSTOM fieldControlType applies: true or false for a checkbox or radio, signed or unsigned for a signature, one of its option IDs for a single-select (an empty string, accepted for legacy compatibility, stores no value).

    fieldControlView?: "READONLY" | "HIDDEN"

    What a CUSTOM fieldControlType does to this field while its condition holds. A header, spacer, static content or merge report field can only be HIDDEN, which writing its condition stores.

    formula?: string

    BlueStep formula expression for computed field values

    formulaId?: string

    Optional script/merge variable name (the 'Field Identifier' in the admin UI) used to reference this field from formula, endpoint, and merge-report code. Leave unset for a data-entry-only field that is not referenced from code — like the UI, it is not required.

    frozen?: boolean

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

    height?: number

    Display height, in whichever unit the field type measures height in: text rows for the text-like types, pixels for SPACER. An explicit null clears the stored height: a text field then takes the browser's default rows, and a spacer collapses to no height.

    helpText?: string

    Help text displayed below or beside the field

    hiddenFromSupers?: boolean

    Whether this field is hidden from parent/supervisor unit views

    jsonType?: string

    JSON Schema type for validation of the field contents

    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

    maxLength?: string

    Maximum length in characters; blank for no limit. Enforced by the server on every write that changes the memo's value: a longer value is refused with a PRECONDITION error carrying extensions.maxLength. A stored value already longer is left alone and never blocks a save that does not change it.

    memoFormatType: "HTML"

    Format type discriminant.

    name?: string

    Field name.

    neverHideHelpText?: boolean

    Whether to always show help text (never collapse it)

    parameters?: string

    Configuration parameters for the HTML editor

    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

    typeScriptDeclarations?: string

    Type script declarations

    userUpdateable?: boolean

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

    width?: number

    Display width in columns. An explicit null clears the stored width.