Represents a template field definition.

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

Hierarchy (view full)

Implemented by

Properties

constraint?: string

The constraint for values stored in the represented field.

constraintError?: string

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

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.

defaultValue?: string

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

description?: string

The description of the field.

displayName?: string

The localized name of the field.

fieldType?: FieldType

The type of the field.

format?: FieldFormat

The display format of the represented field.

formatPattern?: string

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

groupId?: number

The group id of the field in the template.

groupName?: string

The name of field group.

id?: number

The ID of the field.

isMultiValue?: boolean

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

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.

length?: number

The length of the field for variable length data types.

listValues?: string[]

The list of items assigned to the represented field.

name?: string

The name of the field.

rule?: Rule

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