Show / Hide Table of Contents

Class APIRecord

Use this class to interact with the AntFarm DataSet Records.

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

  • NewRecord(Guid, Dictionary<APIAttribute, Object>, Object),
in class AntFarmAPI.

// values as Dictionary<APIAttribute, object> - needs to match the Attributes in this DataSet
APIRecord record = AntFarmAPI.NewRecord(rhinoObjectId, values, rhinoObject);

Inheritance
System.Object
APIRecord
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 APIRecord

Properties

GeoObject

Declaration
public object GeoObject { get; }
Property Value
Type Description
System.Object

The rhino object / reference object

Id

Declaration
public Guid Id { get; }
Property Value
Type Description
System.Guid

Associated rhino object id

Values

Declaration
public Dictionary<APIAttribute, object> Values { get; }
Property Value
Type Description
System.Collections.Generic.Dictionary<APIAttribute, System.Object>

Values in this row referenced to the Attribute column

Methods

ChangeId(Guid)

Change id on the current record

Declaration
public void ChangeId(Guid newId)
Parameters
Type Name Description
System.Guid newId

New RhinoObject id to assign to record

In This Article
Back to top Generated by DocFX