Properties

BuiltInStyles

#Since v6.0
Creates an array of default DimensionStyle objects
public DimensionStyle[] BuiltInStyles { get; }

ComponentType

#Since v6.0
public override ModelComponentType ComponentType { get; }

Count

Returns the count of all items, including deleted ones.
public virtual int Count { get; }
inherited fromCommonComponentTable<T>

Current

#Since v6.0
Returns an instance of the current DimensionStyle.
public DimensionStyle Current { get; }

CurrentDimensionStyle

#Since v5.0
Do not use. Use the Current property.
public DimensionStyle CurrentDimensionStyle { get; }
obsoleteUse the Current property.

CurrentId

#Since v6.0
public Guid CurrentId { get; }

CurrentIndex

#ExampleSince v6.0
public int CurrentIndex { get; }

Document

Document that owns this table.
public RhinoDoc Document { get; }
inherited fromRhinoDocCommonTable<T>

Indexers

this[]

#
public DimensionStyle this[
index
] { get; }

Methods

Add

#Since v6.0
Adds a new DimensionStyle to the document.
public int Add(
dimstyle,
The dimension style to add
reference
if true the dimstyle will not be saved in files.
)
index of new AnnotationStyle.

Add

#Since v5.0
Adds a new AnnotationStyle to the document. The new AnnotationStyle will be initialized with the current default AnnotationStyle properties.
public int Add(
name,
Name of the new AnnotationStyle. If null or empty, Rhino automatically generates the name.
reference
if true the dimstyle will not be saved in files.
)
index of new AnnotationStyle.

Add

#Since v5.0
Adds a new AnnotationStyle to the document. The new AnnotationStyle will be initialized with the current default AnnotationStyle properties.
public int Add(
name
Name of the new AnnotationStyle. If null or empty, Rhino automatically generates the name.
)
index of new AnnotationStyle.

Clear

Marks all items as deleted.
public void Clear()
inherited fromCommonComponentTable<T>

Delete

#Since v6.0
Removes an annotation style.
public override bool Delete(
item
The item to remove.
)
True if the item was removed; false otherwise.

Delete

#Since v6.0
public bool Delete(
index,
quiet
)

Find

#Since v6.0
public DimensionStyle Find(
styleId,
ignoreDeleted
)

Find

#Since v5.0 Obsolete v6.0
public DimensionStyle Find(
name,
ignoreDeleted
)
obsoleteignoreDeleted is always considered true now. Use FindName.

FindId

Uses the guid to find a model component. Deleted objects cannot be found by id. The guid is the value that is stored in the .Id property. In a single document, no two active objects have the same guid. If an object is replaced with a new object, then the guid persists. For example, if the _Move command moves an object, then the moved object inherits its guid from the starting object. If the Copy command copies an object, then the copy gets a new guid. This guid persists through file saving/opening operations. This function will not find grip objects.
public virtual T FindId(
id
ID of model component to search for.
)
inherited fromCommonComponentTable<T>
Reference to the rhino object with the objectId or null if no such object could be found.
FindId

FindIndex

#Since v6.0
Retrieves a DimensionStyle object based on Index. This search type of search is discouraged. We are moving towards using only IDs for all tables.
public DimensionStyle FindIndex(
index
The index to search for.
)
A DimensionStyle object, or null if none was found.

FindName

#Since v6.0
Finds the DimensionStyle with a given name and returns it. None is returned if no DimensionStyle is found.
public DimensionStyle FindName(
name
The string to search. Deleted styles are ignored.
)
The instance, or null.

FindRoot

#Since v6.0
public DimensionStyle FindRoot(
styleId,
ignoreDeleted
)

GetEnumerator

#Since v5.0
public override IEnumerator<DimensionStyle> GetEnumerator()

GetUnusedStyleName

#Since v6.0
Get a unique name for a style that does not already exist in the DimStyle table
public string GetUnusedStyleName()

GetUnusedStyleName

#Since v6.0
Get a unique name for a dimension style that does not already exist in the DimStyle table
public string GetUnusedStyleName(
rootName
prefix in name; typically the parent style name
)

Modify

#Since v6.0
Modifies dimension style settings.
public bool Modify(
newSettings,
This information is copied.
dimstyleId,
Id of dimension style
quiet
if true, information message boxes pop up when illegal changes are attempted.
)
true if successful. false if Id is not already in table

Modify

#Since v6.0
Modifies dimension style settings.
public bool Modify(
newSettings,
This information is copied.
dimstyleIndex,
zero based index of dimension to set. Must be in the range 0 <= dimstyleIndex < DimStyleTable.Count.
quiet
if true, information message boxes pop up when illegal changes are attempted.
)
true if successful. false if dimstyleIndex is out of range

Modify

#Since v6.0
public ModifyType Modify(
dimstyle,
annotation
)

PurgeUnused

#Since v9.0
Purges any unused dimension styles.
public int PurgeUnused()
The number of unused dimension styles that were purged.

SetCurrent

#Since v6.0
Sets the Current property.
public bool SetCurrent(
index,
The index of the current DimStyle.
quiet
true if error dialog boxes are disabled. False if they are enabled.
)
true if the method achieved its goal; otherwise false.

SetCurrentDimensionStyleIndex

#Since v5.0 Obsolete v6.0
Do not use. Use the SetCurrent(int, bool) method.
public bool SetCurrentDimensionStyleIndex(
index,
Do not use.
quiet
Do not use.
)
obsoleteUse the SetCurrent property.
Do not use.