Bluestep JS Documentation
    Preparing search index...

    Interface UpdateDocumentLinkNameFieldProperties

    Properties for updating a document link name field.

    interface UpdateDocumentLinkNameFieldProperties {
        autoCopy?: boolean;
        defaultValueType?: string;
        deleteRefrencedDocuments?: boolean;
        deprecated?: boolean;
        documentFormatType: "NAME";
        fieldControlType?:
            | "NORMAL"
            | "HIDDEN_DEFAULT"
            | "READONLY_DEFAULT"
            | "SMART_HIDE"
            | "READONLY_WHEN_COMPLETED"
            | "CUSTOM";
        fieldControlValue?: string;
        formula?: string;
        formulaId?: string;
        frozen?: boolean;
        helpText?: string;
        hiddenFromSupers?: boolean;
        label?: string;
        longLabel?: boolean;
        neverHideHelpText?: boolean;
        openInline?: boolean;
        popupHint?: boolean;
        reportLabel?: string;
        required?: boolean;
        styleClass?: string;
        useDocumentLibrary?: boolean;
        userUpdateable?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    autoCopy? defaultValueType? deleteRefrencedDocuments? deprecated? documentFormatType fieldControlType? fieldControlValue? formula? formulaId? frozen? helpText? hiddenFromSupers? label? longLabel? neverHideHelpText? openInline? popupHint? reportLabel? required? styleClass? useDocumentLibrary? userUpdateable?

    Properties

    autoCopy?: boolean

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

    defaultValueType?: string

    Default document source type

    deleteRefrencedDocuments?: boolean

    Whether to delete uploaded documents when the record is deleted

    deprecated?: boolean

    Whether this field is deprecated and hidden from new configurations

    documentFormatType: "NAME"

    Format type discriminant.

    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

    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)

    openInline?: boolean

    Whether to display the document inline instead of as a download link

    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

    useDocumentLibrary?: boolean

    Whether to allow selecting from the shared document library

    userUpdateable?: boolean

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

    Settings

    Member Visibility

    On This Page

    Properties