FieldDescription QML Type

An object that describes a Field to be created. Creation of fields and tables is currently only supported on mobile geodatabases, either created in ArcGIS Pro or via GeodatabaseUtility::create(). More...

Import Statement: import Esri.ArcGISRuntime 100.15
Since: Esri.ArcGISRuntime 100.14
Inherits:

Object

Properties

Signals

Detailed Description

Property Documentation

alias : string

The field's alias. The default value is an empty string.


domainName : string

The name of the domain to use on this field. The domain must already exist in the geodatabase (see Geodatabase::createDomain(DomainDescription)). The default value of an empty string indicates that no domain should be used.


editable : bool

true if the field is editable. The default value is true.


fieldType : Enums.FieldType

The field's data type. The default is Enums.FieldTypeUnknown, and must be set to a valid type.


length : int

The length of the field. The default value is 0. This only applies to text fields.


name : string

The field's name. Field names must consist only of alphanumeric characters and underscores, and cannot start with a number or an underscore.


nullable : bool

true if the field is nullable. The default value is true.


Signal Documentation

aliasChanged()

Emitted when the alias property changes.

Note: The corresponding handler is onAliasChanged.


domainNameChanged()

Emitted when the domainName property changes.

Note: The corresponding handler is onDomainNameChanged.


editableChanged()

Emitted when the editable property changes.

Note: The corresponding handler is onEditableChanged.


fieldTypeChanged()

Emitted when the fieldType property changes.

Note: The corresponding handler is onFieldTypeChanged.


lengthChanged()

Emitted when the length property changes.

Note: The corresponding handler is onLengthChanged.


nameChanged()

Emitted when the name property changes.

Note: The corresponding handler is onNameChanged.


nullableChanged()

Emitted when the nullable property changes.

Note: The corresponding handler is onNullableChanged.


Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close