Skip to main content

Class FieldInfoBase

Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for FieldInfoBase. Abstract basic information about database fields. May be custom or user-defined fields. The information can be used to build a user interface.

Inheritance

objectFieldInfoBase

Derived

FieldInfoAttachment, FieldInfoBlob, FieldInfoBool, FieldInfoDate, FieldInfoDateTime, FieldInfoDecimal, FieldInfoDynamicLink, FieldInfoInt, FieldInfoListText, FieldInfoLongText, FieldInfoMdoList, FieldInfoRelation, FieldInfoShortText, FieldInfoTime, FieldInfoTimeSpan

Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Constructors

FieldInfoBase()

Default constructor - defaults any enum props to 0.

Properties

Description

Optional tooltip text for this field

Property Value

string

DisplayName

Label for field. May be multi-lang string encoded.

Property Value

string

FieldName

Database name or prog-id: ‘x_foobar’ or ‘SuperOffice:2’.

Property Value

string

FieldType

What sort of data does this field contain. 1 = int, 2 = short text, … NULL if unknown enum value.

Property Value

CustomFieldType?

See Also

FieldInfoBase.FieldType_String

FieldType_String

What sort of data does this field contain. 1 = int, 2 = short text, … Raw string enum value.

Property Value

string

See Also

FieldInfoBase.FieldType

HideField

Hide the field from the UI. Only allow API access.

Property Value

bool

HideLabel

Hide the label if 1

Property Value

bool

IsDisplayField

Flag indicating that this field is chosen as DisplayField for a table it belongs

Property Value

bool

IsExternal

Should this field be shown to external users via customer center?

Property Value

bool

IsIndexed

Is this field indexed? 0 if no, index no. if yes

Property Value

bool

IsMandatory

0 = no, 1 = yes (field must be filled out)

Property Value

bool

IsReadOnly

0 = read/write, 1 = readonly (don’t combine with mandatory 8-) )

Property Value

bool

Rank

Tab order, ranking within the custom fields.

Property Value

int

ShortLabel

Short name to be used in Archive headings and on page 1. If blank, the fieldLabel will be used everywhere.

Property Value

string

TemplateVariableName

Template variable name: ‘cs01’, ‘cl02’ etc. Null for extra fields.

Property Value

string

See Also

UserDefinedFieldInfoAgent