Show / Hide Table of Contents

Class APIDataSetSettings

Use this class to interact with the DataSet Settings.

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

  • NewDataSetSettings(Guid, ObjectType, Boolean, APIColour, Double),
in class AntFarmAPI.

// settings as APIDataSetSettings (see APIDataSetSettings)
APIDataSet dataSet = AntFarmAPI.NewDataSet(yourClientId, "yourDataSetName", settings);

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

Properties

Colour

Declaration
public APIColour Colour { get; }
Property Value
Type Description
APIColour

DataSet display colour in AntFarm UI

IsClosed

Declaration
public bool IsClosed { get; }
Property Value
Type Description
System.Boolean

Flag if DataSet is shown in AntFarm UI

ObjectFilter

Declaration
public ObjectType ObjectFilter { get; }
Property Value
Type Description
Rhino.DocObjects.ObjectType

DataSet object filter based on ObjectType. If filter is not set to Rhino.DocObjects.ObjectType.None only RhinoObjects of that ObjectType can be added to DataSet.

RowHeight

Declaration
public double RowHeight { get; }
Property Value
Type Description
System.Double

Default row height of DataGrid in AntFarm UI

Methods

Default(Guid)

Declaration
public static APIDataSetSettings Default(Guid clientId)
Parameters
Type Name Description
System.Guid clientId
Returns
Type Description
APIDataSetSettings
In This Article
Back to top Generated by DocFX