FieldDescription Class

Member Function Documentation

FieldDescription::FieldDescription(const QString &name, Esri::ArcGISRuntime::FieldType fieldType, QObject *parent = nullptr)

Creates a new field description object with the specified name and type.

• name - The field's name.
• fieldType - The field's data type.
• parent - The optional parent QObject.

[override virtual noexcept] FieldDescription::~FieldDescription()

Destructor.

QString FieldDescription::alias() const

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

See also setAlias().

QString FieldDescription::domainName() const

Returns the name of the domain to use on this field.

The domain must already exist in the geodatabase (see Geodatabase::createDomainAsync(Esri::ArcGISRuntime::DomainDescription*)). The default value of an empty string indicates that no domain should be used.

See also setDomainName().

Esri::ArcGISRuntime::FieldType FieldDescription::fieldType() const

Returns the field's data type. The default is FieldType::Unknown, and must be set to a valid type.

See also setFieldType().

bool FieldDescription::isEditable() const

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

bool FieldDescription::isNullable() const

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

int FieldDescription::length() const

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

See also setLength().

QString FieldDescription::name() const

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

See also setName().

void FieldDescription::setAlias(const QString &alias)

Sets the alias to alias.

See also alias.

void FieldDescription::setDomainName(const QString &domainName)

Sets the domainName to domainName.

See also domainName.

void FieldDescription::setEditable(bool editable)

Sets the editable to editable.

See also isEditable.

void FieldDescription::setFieldType(Esri::ArcGISRuntime::FieldType fieldType)

Sets the fieldType to fieldType.

See also fieldType.

void FieldDescription::setLength(int length)

Sets the length to length.

See also length.

void FieldDescription::setName(const QString &name)

Sets the name to name.

See also name.

void FieldDescription::setNullable(bool nullable)

Sets the nullable to nullable.

See also isNullable.