Can also be considered an annotation style since it is used for more than just dimensions

Constructors

DimensionStyle

#Since v5.0
Create a new non-document controlled annotation style
public DimensionStyle()

DimensionStyle

#
protected DimensionStyle()

Properties

AlternateBelowLine

#Since v6.0
public bool AlternateBelowLine { get; set; }

AlternateDimensionLengthDisplay

#Since v6.0
public DimensionStyle.LengthDisplay AlternateDimensionLengthDisplay { get; set; }

AlternateLengthFactor

#Since v5.0
public double AlternateLengthFactor { get; set; }

AlternateLengthResolution

#Since v6.0
public int AlternateLengthResolution { get; set; }

AlternatePrefix

#Since v6.0
public string AlternatePrefix { get; set; }

AlternateRoundoff

#Since v6.0
public double AlternateRoundoff { get; set; }

AlternateSuffix

#Since v6.0
public string AlternateSuffix { get; set; }

AlternateToleranceResolution

#Since v6.0
public int AlternateToleranceResolution { get; set; }

AlternateUnitsDisplay

#Since v6.0
public bool AlternateUnitsDisplay { get; set; }

AlternateZeroSuppress

#Since v6.0
public DimensionStyle.ZeroSuppression AlternateZeroSuppress { get; set; }

AngleFormat

#Since v6.0
public DimensionStyle.AngleDisplayFormat AngleFormat { get; set; }

AngleResolution

#Since v5.0
public int AngleResolution { get; set; }

AngleZeroSuppress

#Since v6.0
public DimensionStyle.ZeroSuppression AngleZeroSuppress { get; set; }

AngularRoundoff

#Since v6.0
public double AngularRoundoff { get; set; }

ArcLengthSymbol

#Since v6.0
public int ArcLengthSymbol { get; set; }

ArrowBlockId1

#Since v6.0
public Guid ArrowBlockId1 { get; set; }

ArrowBlockId2

#Since v6.0
public Guid ArrowBlockId2 { get; set; }

ArrowLength

#Since v5.0
public double ArrowLength { get; set; }

ArrowType1

#Since v6.0
public DimensionStyle.ArrowType ArrowType1 { get; set; }

ArrowType2

#Since v6.0
public DimensionStyle.ArrowType ArrowType2 { get; set; }

BaselineSpacing

#Since v6.0
public double BaselineSpacing { get; set; }

CentermarkSize

#Since v5.0
public double CentermarkSize { get; set; }

CenterMarkType

#Since v6.0
public DimensionStyle.CenterMarkStyle CenterMarkType { get; set; }

ClippingArrowLength

#Since v9.0
public double ClippingArrowLength { get; set; }

ClippingArrowType1

#Since v9.0
public DimensionStyle.ClippingArrowType ClippingArrowType1 { get; set; }

ClippingArrowType2

#Since v9.0
public DimensionStyle.ClippingArrowType ClippingArrowType2 { get; set; }

ComponentStatus

Gets or sets the component status of the model component.
public virtual ComponentStatus ComponentStatus { get; set; }
inherited fromModelComponent

ComponentType

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

DecimalSeparator

#Since v7.0
public char DecimalSeparator { get; set; }

DeletedName

Gets the name of a component that is deleted.
public string DeletedName { get; }
inherited fromModelComponent

DimensionLengthDisplay

#Since v6.0
public DimensionStyle.LengthDisplay DimensionLengthDisplay { get; set; }

DimensionLineExtension

#Since v6.0
public double DimensionLineExtension { get; set; }

DimensionScale

#Since v6.0
public double DimensionScale { get; set; }

DimensionScaleValue

#Since v6.0
public ScaleValue DimensionScaleValue { get; set; }

DimRadialTextAngleType

#Since v6.0
public DimensionStyle.LeaderContentAngleStyle DimRadialTextAngleType { get; set; }

DimRadialTextLocation

#Since v6.0
public DimensionStyle.TextLocation DimRadialTextLocation { get; set; }

DimRadialTextOrientation

#Since v6.0
public TextOrientation DimRadialTextOrientation { get; set; }

DimTextAngleType

#Since v6.0
public DimensionStyle.LeaderContentAngleStyle DimTextAngleType { get; set; }

DimTextLocation

#Since v6.0
public DimensionStyle.TextLocation DimTextLocation { get; set; }

DimTextOrientation

#Since v6.0
public TextOrientation DimTextOrientation { get; set; }

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.
public bool Disposed { get; }
inherited fromCommonObject

DrawForward

#Since v6.0
public bool DrawForward { get; set; }

DrawTextMask

#Since v6.0
public bool DrawTextMask { get; set; }

ExtensionLineExtension

#Since v5.0
public double ExtensionLineExtension { get; set; }

ExtensionLineOffset

#Since v5.0
public double ExtensionLineOffset { get; set; }

FitArrow

#Since v6.20
public DimensionStyle.ArrowFit FitArrow { get; set; }

FitText

#Since v6.20
public DimensionStyle.TextFit FitText { get; set; }

FixedExtensionLength

#Since v6.0
public double FixedExtensionLength { get; set; }

FixedExtensionOn

#Since v6.0
public bool FixedExtensionOn { get; set; }

Font

#Since v6.0
public Font Font { get; set; }

ForceDimensionLineBetweenExtensionLines

#Since v6.20
public bool ForceDimensionLineBetweenExtensionLines { get; set; }

HasFieldOverrides

#Since v6.0
Checks if any fields in this DimensionStyle are overrides
public bool HasFieldOverrides { get; }
True if any fields are overrides False is no fields are overrides

HasId

Returns a value indicating whether the component has an ID.
public bool HasId { get; }
inherited fromModelComponent

HasIndex

Returns a value indicating whether the component has an Index.
public bool HasIndex { get; }
inherited fromModelComponent

HasName

Returns a value indicating whether the component has a Name.
public bool HasName { get; }
inherited fromModelComponent

HasUserData

Gets true if this class has any custom information attached to it through UserData.
public bool HasUserData { get; }
inherited fromCommonObject

Id

Gets or sets the ID of the current instance.
public virtual Guid Id { get; set; }
inherited fromModelComponent
InvalidOperationExceptionWhen setting the ID failed. This usually happened because the instance ID is already locked.

IdIsLocked

Returns a value indicating whether the component ID is already locked.
public bool IdIsLocked { get; }
inherited fromModelComponent

Index

Gets or sets the model component index attribute.
public virtual int Index { get; set; }
inherited fromModelComponent
InvalidOperationExceptionWhen setting the Index failed. This usually happens because the instance Index is already locked.

IndexIsLocked

Returns a value indicating whether the component Index is already locked.
public bool IndexIsLocked { get; }
inherited fromModelComponent

InstanceDefinitionModelSerialNumber

When a component is in a model as part of the information required for a linked instance definition, this value identifies the linked instance definition reference model.
[CLSCompliant(false)] public virtual uint InstanceDefinitionModelSerialNumber { get; }
inherited fromModelComponent
Remarks: Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.

IsChild

#Since v6.0
Tests if this DimensionStyle is a child of any other DimensionStyle
public bool IsChild { get; }
True if this is a child DimensionStyle, False otherwise.

IsComponentStatusLocked

The component status itself can be locked. This returns an indication.
public bool IsComponentStatusLocked { get; }
inherited fromModelComponent

IsDeleted

#Since v6.0
public override bool IsDeleted { get; }

IsDocumentControlled

If true this object may not be modified. Any properties or functions that attempt to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException.
public virtual bool IsDocumentControlled { get; }
inherited fromCommonObject

IsReference

#Since v5.0
public override bool IsReference { get; }

IsSystemComponent

True if this model component is a system constant.

An incomplete list of system constant model components is below:

  • ON_ModelComponent::Unset

  • ON_InstanceDefinition::Empty

  • ON_Linetype::Unset
  • ON_Linetype::Continuous
  • ON_Linetype::ByLayer
  • ON_Linetype::ByParent

  • ON_Layer::Unset
  • ON_Layer::Default

  • ON_TextStyle::Unset
  • ON_TextStyle::Default
  • ON_TextStyle::ByLayer
  • ON_TextStyle::ByParent

  • ON_DimStyle::Unset
  • ON_DimStyle::Default
  • ON_DimStyle::DefaultInchDecimal
  • ON_DimStyle::DefaultInchFractional
  • ON_DimStyle::DefaultFootInchArchitecture
  • ON_DimStyle::DefaultMillimeterSmall
  • ON_DimStyle::DefaultMillimeterLarge
  • ON_DimStyle::DefaultMillimeterArchitecture
public bool IsSystemComponent { get; }
inherited fromModelComponent

IsValid

Tests an object to see if it is valid.
public virtual bool IsValid { get; }
inherited fromCommonObject

LeaderArrowBlockId

#Since v6.0
public Guid LeaderArrowBlockId { get; set; }

LeaderArrowLength

#Since v5.0
public double LeaderArrowLength { get; set; }

LeaderArrowType

#Since v5.6
public DimensionStyle.ArrowType LeaderArrowType { get; set; }

LeaderContentAngleType

#Since v6.0
Style of leader content angle Horizontal Aligned Rotated
public DimensionStyle.LeaderContentAngleStyle LeaderContentAngleType { get; set; }

LeaderCurveType

#Since v6.0
public DimensionStyle.LeaderCurveStyle LeaderCurveType { get; set; }

LeaderHasLanding

#Since v6.0
public bool LeaderHasLanding { get; set; }

LeaderLandingLength

#Since v6.0
public double LeaderLandingLength { get; set; }

LeaderTextHorizontalAlignment

#Since v6.0
public TextHorizontalAlignment LeaderTextHorizontalAlignment { get; set; }

LeaderTextOrientation

#Since v6.0
public TextOrientation LeaderTextOrientation { get; set; }

LeaderTextRotationDegrees

#Since v6.0
public double LeaderTextRotationDegrees { get; set; }

LeaderTextRotationRadians

#Since v6.0
Angle of leader text for Rotated style
public double LeaderTextRotationRadians { get; set; }

LeaderTextVerticalAlignment

#Since v6.0
public TextVerticalAlignment LeaderTextVerticalAlignment { get; set; }

LengthFactor

#Since v5.0
public double LengthFactor { get; set; }

LengthResolution

#Since v5.0
public int LengthResolution { get; set; }

LineSpaceScale

#Since v9.0
public double LineSpaceScale { get; set; }

MaskColor

#Since v6.0
public Color MaskColor { get; set; }

MaskColorSource

#Since v6.0
public DimensionStyle.MaskType MaskColorSource { get; set; }

MaskFrameType

#Since v7.0
public DimensionStyle.MaskFrame MaskFrameType { get; set; }

MaskOffset

#Since v6.0
public double MaskOffset { get; set; }

ModelSerialNumber

A value identifying the model that manages this component.
[CLSCompliant(false)] public virtual uint ModelSerialNumber { get; }
inherited fromModelComponent
Remarks: If the component is being managed by a model, this value identifies the model. In Rhino, this value is the document runtime serial number. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.

Name

Gets or sets the name
public virtual string Name { get; set; }
inherited fromModelComponent
InvalidOperationExceptionWhen setting the Name failed. This usually happens because the instance Name is already locked.

NameIsLocked

Returns a value indicating whether the component Name is already locked.
public bool NameIsLocked { get; }
inherited fromModelComponent

ParentId

#Since v6.0
Get or Set the Id of this DimensionStyle's parent. If ParentId is Guid.Empty, this DimensionStyle has no parent
public Guid ParentId { get; set; }

Prefix

#Since v5.0
public string Prefix { get; set; }

ReferenceModelSerialNumber

When a component is in a model for reference, this value identifies the reference model.
[CLSCompliant(false)] public virtual uint ReferenceModelSerialNumber { get; }
inherited fromModelComponent
Remarks: Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.

Roundoff

#Since v6.0
public double Roundoff { get; set; }

ScaleLeftLengthMillimeters

#Since v6.0
public double ScaleLeftLengthMillimeters { get; set; }

ScaleRightLengthMillimeters

#Since v6.0
public double ScaleRightLengthMillimeters { get; set; }

StackFractionFormat

#Since v6.0
public DimensionStyle.StackDisplayFormat StackFractionFormat { get; set; }

StackHeightScale

#Since v6.0
public double StackHeightScale { get; set; }

Suffix

#Since v5.0
public string Suffix { get; set; }

SuppressArrow1

#Since v6.0
public bool SuppressArrow1 { get; set; }

SuppressArrow2

#Since v6.0
public bool SuppressArrow2 { get; set; }

SuppressDimensionLine1

#Since v9.0
Suppresses the dimension line and arrowhead between the first extension line and the dimension text.
public bool SuppressDimensionLine1 { get; set; }

SuppressDimensionLine2

#Since v9.0
Suppresses the dimension line and arrowhead between the second extension line and the dimension text.
public bool SuppressDimensionLine2 { get; set; }

SuppressExtension1

#Since v6.0
public bool SuppressExtension1 { get; set; }

SuppressExtension2

#Since v6.0
public bool SuppressExtension2 { get; set; }

TextGap

#Since v5.0
public double TextGap { get; set; }

TextHeight

#Since v5.0
public double TextHeight { get; set; }

TextHorizontalAlignment

#Since v6.0
public TextHorizontalAlignment TextHorizontalAlignment { get; set; }

TextMoveLeader

#Since v6.0
public int TextMoveLeader { get; set; }

TextOrientation

#Since v6.0
public TextOrientation TextOrientation { get; set; }

TextRotation

#Since v6.0
public double TextRotation { get; set; }

TextUnderlined

#Since v6.0
public bool TextUnderlined { get; set; }

TextVerticalAlignment

#Since v6.0
public TextVerticalAlignment TextVerticalAlignment { get; set; }

ToleranceFormat

#Since v6.0
public DimensionStyle.ToleranceDisplayFormat ToleranceFormat { get; set; }

ToleranceHeightScale

#Since v6.0
public double ToleranceHeightScale { get; set; }

ToleranceLowerValue

#Since v6.0
public double ToleranceLowerValue { get; set; }

ToleranceResolution

#Since v6.0
public int ToleranceResolution { get; set; }

ToleranceUpperValue

#Since v6.0
public double ToleranceUpperValue { get; set; }

ToleranceZeroSuppress

#Since v6.0
public DimensionStyle.ZeroSuppression ToleranceZeroSuppress { get; set; }

UnitSystem

#Since v8.36
The dimension style's own unit system. This is what the style's lengths - text height, arrow size and so on - are expressed in, and openNURBS uses it internally to get scales right when annotation moves between model space, page space and instance definitions whose unit systems differ. A style that reports UnitSystem.None has no unit system of its own, and unknown scales resolve to 1.
public UnitSystem UnitSystem { get; set; }

UseKerning

#Since v9.0
public bool UseKerning { get; set; }

UserData

List of custom information that is attached to this class.
public UserDataList UserData { get; }
inherited fromCommonObject

UserDictionary

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.
public ArchivableDictionary UserDictionary { get; }
inherited fromCommonObject

UserStringCount

#Since v8.9
Gets the amount of user strings.
public int UserStringCount { get; }

ZeroSuppress

#Since v6.0
public DimensionStyle.ZeroSuppression ZeroSuppress { get; set; }

Methods

AlternateDimensionLengthDisplayUnit

#Since v6.0
[CLSCompliant(false)] public UnitSystem AlternateDimensionLengthDisplayUnit(
model_serial_number
)

ClearAllFieldOverrides

#Since v6.0
Sets all the fields in this DimensionStyle to be not overridden Does not change any dimstyle_id's or parent_id's
public void ClearAllFieldOverrides()

ClearFieldOverride

#Since v6.0
Set the field as not overridden
public void ClearFieldOverride(
Field
field
)

ClearId

Resets the HasId property of the model component to false, if possible.
public void ClearId()
inherited fromModelComponent
InvalidOperationExceptionIf the ID is locked.

ClearIndex

Resets the HasIndex property of the model component to false, if possible.
public void ClearIndex()
inherited fromModelComponent
InvalidOperationExceptionIf the index is locked.

ClearName

Resets the HasName property of the model component to false, if possible.
public void ClearName()
inherited fromModelComponent
InvalidOperationExceptionIf the name is locked.

ConstructConstObject

Assigns a parent object and a sub-object index to this.
protected void ConstructConstObject(
parentObject,
The parent object.
subobjectIndex
The sub-object index.
)
inherited fromCommonObject

CopyFrom

#Since v6.0
Copy settings from source dimension style without changing the name, Id or index of this DimensionStyle.
public void CopyFrom(
source
DimensionStyle to copy settings from.
)

CreatePreviewBitmap

#Since v9.0
public Bitmap CreatePreviewBitmap(
width,
height,
transparent
)

CreatePreviewBitmap

#Since v6.0
public Bitmap CreatePreviewBitmap(
width,
height
)

DataCRC

Increments the Cyclic Redundancy Check value by this instance.
[CLSCompliant(false)] public uint DataCRC(
currentRemainder
The current remainder value.
)
inherited fromModelComponent
The updated remainder value.

DeleteAllUserStrings

#Since v8.9
public void DeleteAllUserStrings()

DeleteUserString

#Since v8.9
public bool DeleteUserString(
key
)

DimensionLengthDisplayUnit

#Since v6.0
[CLSCompliant(false)] public UnitSystem DimensionLengthDisplayUnit(
model_serial_number
)

Dispose

Actively reclaims unmanaged resources that this instance uses.
public void Dispose()
inherited fromCommonObject

Dispose

For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

protected virtual void Dispose(
disposing
true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.
)
inherited fromCommonObject

Duplicate

#Since v6.0
Construct a deep (full) copy of this object.
public DimensionStyle Duplicate()
An object of the same type as this, with the same properties and behavior.

Duplicate

#Since v6.0
Construct a deep (full) copy of this object.
public DimensionStyle Duplicate(
newName,
newId,
newParentId
)
An object of the same type as this, with the same properties and behavior.

EnsurePrivateCopy

If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want.
public void EnsurePrivateCopy()
inherited fromCommonObject

GetObjectData

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)] public virtual void GetObjectData(
info,
The System.Runtime.Serialization.SerializationInfo to populate with data.
context
The destination (see System.Runtime.Serialization.StreamingContext) for this serialization.
)
inherited fromCommonObject

GetUserString

#Since v8.9
Gets user string from this geometry.
public string GetUserString(
key
id used to retrieve the string.
)
string associated with the key if successful. null if no key was found.

GetUserStrings

#Since v8.9
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
public NameValueCollection GetUserStrings()
A new collection.

IsChildOf

#Since v6.0
Tests if this DimensionStyle is a child of a specific DimensionStyle
public bool IsChildOf(
parentId
)
True if this is a child of the DimensionStyle with Parent False otherwise.

IsFieldOverriden

#
public bool IsFieldOverriden(
Field
field
)

IsValidWithLog

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
public bool IsValidWithLog(
out string
log
A textual log. This out parameter is assigned during this call.
)
inherited fromCommonObject
true if this object is valid; false otherwise.

LockId

Locks the component Id property.
public void LockId()
inherited fromModelComponent

LockIndex

Locks the component Index property.
public void LockIndex()
inherited fromModelComponent

LockName

Locks the component Name property.
public void LockName()
inherited fromModelComponent

NonConstOperation

For derived classes implementers.

Defines the necessary implementation to free the instance from being constant.

protected virtual void NonConstOperation()
inherited fromCommonObject

OnSwitchToNonConst

Is called when a non-constant operation first occurs.
protected virtual void OnSwitchToNonConst()
inherited fromCommonObject

ScaleLengthValues

#Since v6.0
Scales all length values by 'scale'
public void ScaleLengthValues(
scale
)

SetFieldOverride

#Since v6.0
Set a field as overridden
public void SetFieldOverride(
Field
field
)

SetUserString

#Since v8.9
Attach a user string (key,value combination) to this geometry.
public bool SetUserString(
key,
id used to retrieve this string.
value
string associated with key.
)
true on success.

ToJSON

Create a JSON string representation of this object
public string ToJSON()
inherited fromCommonObject

ToString

Returns the name of the model component type, and then its name and index.
public override string ToString()
inherited fromModelComponent
Remarks: This is provided as a visual aid. Do not rely on this for serialization.
Object.ToString