Class APIPropertyType
Inheritance
System.Object
APIPropertyType
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 APIPropertyType
Constructors
APIPropertyType(Guid, AFPropertyType)
Constructor
Declaration
public APIPropertyType(Guid clientId, AFPropertyType propertyType)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | clientId | |
AntFarm.Kernel.AntFarmDocument.Globals.AFPropertyType | propertyType |
Exceptions
Type | Condition |
---|---|
APIException |
APIPropertyType(Guid, String, APIPropertyBaseType)
Constructor
Declaration
public APIPropertyType(Guid clientId, string name, APIPropertyBaseType baseType)
Parameters
Type | Name | Description |
---|---|---|
System.Guid | clientId | |
System.String | name | |
APIPropertyBaseType | baseType |
Properties
BaseType
Declaration
public APIPropertyBaseType BaseType { get; }
Property Value
Type | Description |
---|---|
APIPropertyBaseType | Property Type base-type |
Id
Declaration
public Guid Id { get; }
Property Value
Type | Description |
---|---|
System.Guid |
IsCheckedOut
Declaration
public bool IsCheckedOut { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Name
Declaration
public string Name { get; }
Property Value
Type | Description |
---|---|
System.String | Property Type name |
Methods
ChangeBaseType(APIPropertyBaseType)
Declaration
public void ChangeBaseType(APIPropertyBaseType baseType)
Parameters
Type | Name | Description |
---|---|---|
APIPropertyBaseType | baseType |
CommitUpdates(APIPropertyBaseType)
Commit to AntFarm - this is not saved into the .3dm file
APIException
Declaration
public void CommitUpdates(APIPropertyBaseType baseType)
Parameters
Type | Name | Description |
---|---|---|
APIPropertyBaseType | baseType |
Delete()
Deletes an APIPropertyType from the context
APIException
Declaration
public void Delete()