Interface ITemplateFieldDefinition

Represents a template field definition.

interface ITemplateFieldDefinition {
    autoExtract?: boolean;
    constraint?: string;
    constraintError?: string;
    currency?: string;
    defaultValue?: string;
    description?: string;
    displayName?: string;
    fieldType?: FieldType;
    format?: FieldFormat;
    formatPattern?: string;
    groupId?: number;
    groupName?: string;
    hideListValues?: boolean;
    id?: number;
    isIndexed?: boolean;
    isIndexedForReporting?: boolean;
    isMultiValue?: boolean;
    isRequired?: boolean;
    length?: number;
    listValues?: string[];
    localDescription?: string;
    name?: string;
    rule?: Rule;
    warnIfBlank?: boolean;
}

Hierarchy (View Summary)

Implemented by

Properties

autoExtract? constraint? constraintError? currency? defaultValue? description? displayName? fieldType? format? formatPattern? groupId? groupName? hideListValues? id? isIndexed? isIndexedForReporting? isMultiValue? isRequired? length? listValues? localDescription? name? rule? warnIfBlank?

Properties

OptionalautoExtract

autoExtract?: boolean

A boolean indicating whether values for this field can be automatically extracted by AI/OCR services.

Optionalconstraint

constraint?: string

The constraint for values stored in the represented field.

OptionalconstraintError

constraintError?: string

The error string that will be returned when the field constraint is violated when setting a value for this field.

Optionalcurrency

currency?: string

The name of the currency that will be using when formatting the represented field when the Format property is set to the Currency member of the WFieldFormat enumeration.

OptionaldefaultValue

defaultValue?: string

The default value of the field for new entries that are assigned to a template the represented field is a member of.

Optionaldescription

description?: string

The description of the field.

OptionaldisplayName

displayName?: string

The localized name of the field.

OptionalfieldType

fieldType?: FieldType

The type of the field.

Optionalformat

format?: FieldFormat

The display format of the represented field.

OptionalformatPattern

formatPattern?: string

The custom format pattern for fields that are configured to use a custom format.

OptionalgroupId

groupId?: number

The group id of the field in the template.

OptionalgroupName

groupName?: string

The name of field group.

OptionalhideListValues

hideListValues?: boolean

A boolean indicating whether the field's list values should be hidden in the UI. Applies only to list-backed fields.

Optionalid

id?: number

The ID of the field.

OptionalisIndexed

isIndexed?: boolean

A boolean indicating whether the field is indexed for searching.

OptionalisIndexedForReporting

isIndexedForReporting?: boolean

A boolean indicating whether the field is indexed for reporting.

OptionalisMultiValue

isMultiValue?: boolean

A boolean indicating if the represented template field supports multiple values.

OptionalisRequired

isRequired?: boolean

A boolean indicating if the represented field must have a value set on entries assigned to a template that the field is a member of.

Optionallength

length?: number

The length of the field for variable length data types.

OptionallistValues

listValues?: string[]

The list of items assigned to the represented field.

OptionallocalDescription

localDescription?: string

The per-template description for this field assignment. Distinct from the field definition's repository-level description; set via AddTemplateField / UpdateTemplateFieldProperties.

Optionalname

name?: string

The name of the field.

Optionalrule

rule?: Rule

A form logic rule associated with a Laserfiche template and field definition.

OptionalwarnIfBlank

warnIfBlank?: boolean

A boolean indicating whether the user should be warned when leaving the field blank.

Settings

Member Visibility

On This Page

Properties