AGSFieldDescription Class Reference

Description

An object that describes an AGSField to be created.

Creation of fields and tables is currently only supported on mobile geodatabases, either created in ArcGIS Pro or via createWithFileURL:completion: (AGSGeodatabase).

Since

100.14

Inheritance diagram for AGSFieldDescription:

Instance Methods
(instancetype)	- initWithName:fieldType:

Class Methods
(instancetype)	+ fieldDescriptionWithName:fieldType:

Properties
NSString *	alias
BOOL	allowNull
NSString *	domainName
BOOL	editable
AGSFieldType	fieldType
NSInteger	length
NSString *	name

Method Documentation

fieldDescriptionWithName:fieldType:

+ (instancetype) fieldDescriptionWithName:		(NSString *)	name
fieldType:		(AGSFieldType)	fieldType

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

Parameters

name	The field's name.
fieldType	The field's data type.

Since

100.14

initWithName:fieldType:

- (instancetype) initWithName:		(NSString *)	name
fieldType:		(AGSFieldType)	fieldType

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

Parameters

name	The field's name.
fieldType	The field's data type.

Since

100.14

Property Documentation

alias

- (NSString*) alias

readwritenonatomiccopy

The field's alias.

Since

100.14

allowNull

- (BOOL) allowNull

readwritenonatomicassign

YES if the field is nullable.

The default value is YES.

Since

100.14

domainName

- (NSString*) domainName

readwritenonatomiccopy

The name of the domain to use on this field.

The domain must already exist in the geodatabase (see createDomainWithDomainDescription:completion: (AGSGeodatabase)). The default value of an empty string indicates that no domain should be used.

Since

100.14

editable

- (BOOL) editable

readwritenonatomicassign

YES if the field is editable.

The default value is YES.

Since

100.14

fieldType

- (AGSFieldType) fieldType

readwritenonatomicassign

The field's data type.

Since

100.14

length

- (NSInteger) length

readwritenonatomicassign

The length of the field. This only applies to text fields.

Since

100.14

name

- (NSString*) name

readwritenonatomiccopy

The field's name.

Field names must be non-empty, consist only of alphanumeric characters and underscores, and cannot start with a number or an underscore.

Since

100.14