Class APIAttribute

Attributes define the data in a DataSet. Attributes are of single types.

The APIAttribute class does not provide public constructors. Please refer to:

• NewAttribute(Guid, String, APIAttributeType),
• NewAttribute(Guid, String, APIGeometricAttributeType),
• NewAttribute(Guid, String, APICategory)

in class AntFarmAPI.

// Create Attribute of type String
APIAttribute attribute = AntFarmAPI.NewAttribute(yourClientId, "yourAttributeName", APIAttributeType.String);

Inheritance

System.Object

APIAttribute

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: AntFarm.API

Assembly: AntFarm.dll

Syntax

[Serializable]
public class APIAttribute

Properties

AttributeType

Declaration

public APIAttributeType AttributeType { get; }

Property Value

Type	Description
APIAttributeType	Stores the AntFarm Attribute Type

Category

Declaration

public APICategory Category { get; }

Property Value

Type	Description
APICategory	If Attribute is of type Category (see APIAttributeType), Category stores the APICategory.

DefaultForBoolean

Declaration

public bool? DefaultForBoolean { get; }

Property Value

Type	Description
System.Nullable<System.Boolean>	Attributes of type bool can have a predefined default value (default is set to null).

GeometricAttribute

Declaration

public APIGeometricAttributeType GeometricAttribute { get; }

Property Value

Type	Description
APIGeometricAttributeType	If Attribute is of type Geometric, set APIGeometricAttributeType.

Id

Declaration

public Guid Id { get; }

Property Value

Type	Description
System.Guid	Id assigned to the APIAttribute.

IsAutoIncrement

Declaration

public bool IsAutoIncrement { get; }

Property Value

Type	Description
System.Boolean	Attributes of type Integer can be set to auto-increment (default is set to false).

IsVirtual

Declaration

public bool IsVirtual { get; }

Property Value

Type	Description
System.Boolean	default = true.

Name

Declaration

public string Name { get; }

Property Value

Type	Description
System.String	Name of the Attribute