DimensionStyle

Public Class

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

Inheritance Hierarchy

System.Object
Rhino.Runtime.CommonObject
Rhino.DocObjects.ModelComponent
Rhino.DocObjects.DimensionStyle

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

[SerializableAttribute]
public class DimensionStyle : ModelComponent

The DimensionStyle type exposes the following members.

Constructors

Name

Description

Public Method

DimensionStyle.

Create a new non-document controlled annotation style

Protected Method

DimensionStyle(SerializationInfo, StreamingContext)

Initializes a new instance of the DimensionStyle class

Properties

Name

Description

Public Property

AlternateBelowLine

Public Property

AlternateDimensionLengthDisplay

Public Property

AlternateLengthFactor

Public Property

AlternateLengthResolution

Public Property

AlternatePrefix

Public Property

AlternateRoundoff

Public Property

AlternateSuffix

Public Property

AlternateToleranceResolution

Public Property

AlternateUnitsDisplay

Public Property

AlternateZeroSuppress

Public Property

AngleFormat

Public Property

AngleResolution

Public Property

AngleZeroSuppress

Public Property

AngularRoundoff

Public Property

ArcLengthSymbol

Public Property

ArrowBlockId1

Public Property

ArrowBlockId2

Public Property

ArrowLength

Public Property

ArrowType1

Public Property

ArrowType2

Public Property

BaselineSpacing

Public Property

CentermarkSize

Public Property

CenterMarkType

Public Property

ComponentStatus

Gets or sets the component status of the model component.

(Inherited from ModelComponent.)

Public Property

ComponentType

Returns DimStyle.

(Overrides

ModelComponent.ComponentType

Public Property

DecimalSeparator

Public Property

DeletedName

Gets the name of a component that is deleted.

(Inherited from ModelComponent.)

Public Property

DimensionLengthDisplay

Public Property

DimensionLineExtension

Public Property

DimensionScale

Public Property

DimensionScaleValue

Public Property

DimRadialTextAngleType

Public Property

DimRadialTextLocation

Public Property

DimRadialTextOrientation

Public Property

DimTextAngleType

Public Property

DimTextLocation

Public Property

DimTextOrientation

Public Property

Disposed

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

(Inherited from CommonObject.)

Public Property

DrawForward

Public Property

DrawTextMask

Public Property

ExtensionLineExtension

Public Property

ExtensionLineOffset

Public Property

FitArrow

Public Property

FitText

Public Property

FixedExtensionLength

Public Property

FixedExtensionOn

Public Property

Font

Public Property

ForceDimensionLineBetweenExtensionLines

Public Property

HasFieldOverrides

Checks if any fields in this DimensionStyle are overrides

Public Property

HasId

Returns a value indicating whether the component has an ID.

(Inherited from ModelComponent.)

Public Property

HasIndex

Returns a value indicating whether the component has an Index.

(Inherited from ModelComponent.)

Public Property

HasName

Returns a value indicating whether the component has a Name.

(Inherited from ModelComponent.)

Public Property

HasUserData

Gets true if this class has any custom information attached to it through UserData.

(Inherited from CommonObject.)

Public Property

Gets or sets the ID of the current instance.

(Inherited from ModelComponent.)

Public Property

IdIsLocked

Returns a value indicating whether the component ID is already locked.

(Inherited from ModelComponent.)

Public Property

Index

Gets or sets the model component index attribute.

(Inherited from ModelComponent.)

Public Property

IndexIsLocked

Returns a value indicating whether the component Index is already locked.

(Inherited from ModelComponent.)

Public Property
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.

(Inherited from ModelComponent.)

Public Property

IsChild

Tests if this DimensionStyle is a child of any other DimensionStyle

Public Property

IsComponentStatusLocked

The component status itself can be locked. This returns an indication.

(Inherited from ModelComponent.)

Public Property

IsDeleted

(Overrides

ModelComponent.IsDeleted

Public Property

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.

(Inherited from CommonObject.)

Public Property

IsReference

(Overrides

ModelComponent.IsReference

Public Property

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

(Inherited from ModelComponent.)

Public Property

IsValid

Tests an object to see if it is valid.

(Inherited from CommonObject.)

Public Property

LeaderArrowBlockId

Public Property

LeaderArrowLength

Public Property

LeaderArrowType

Public Property

LeaderContentAngleType

Style of leader content angle Horizontal Aligned Rotated

Public Property

LeaderCurveType

Public Property

LeaderHasLanding

Public Property

LeaderLandingLength

Public Property

LeaderTextHorizontalAlignment

Public Property

LeaderTextOrientation

Public Property

LeaderTextRotationDegrees

Public Property

LeaderTextRotationRadians

Angle of leader text for Rotated style

Public Property

LeaderTextVerticalAlignment

Public Property

LengthFactor

Public Property

LengthResolution

Public Property

MaskColor

Public Property

MaskColorSource

Public Property

MaskFrameType

Public Property

MaskOffset

Public Property
ModelSerialNumber

A value identifying the model that manages this component.

(Inherited from ModelComponent.)

Public Property
Code Example

Name

Gets or sets the name

(Inherited from ModelComponent.)

Public Property

NameIsLocked

Returns a value indicating whether the component Name is already locked.

(Inherited from ModelComponent.)

Public Property

ParentId

Get or Set the Id of this DimensionStyle’s parent. If ParentId is Guid.Empty, this DimensionStyle has no parent

Public Property

Prefix

Public Property
ReferenceModelSerialNumber

When a component is in a model for reference, this value identifies the reference model.

(Inherited from ModelComponent.)

Public Property

Roundoff

Public Property

ScaleLeftLengthMillimeters

Public Property

ScaleRightLengthMillimeters

Public Property

StackFractionFormat

Public Property

StackHeightScale

Public Property

Suffix

Public Property

SuppressArrow1

Public Property

SuppressArrow2

Public Property

SuppressExtension1

Public Property

SuppressExtension2

Public Property

TextGap

Public Property

TextHeight

Public Property

TextHorizontalAlignment

Public Property

TextMoveLeader

Public Property

TextOrientation

Public Property

TextRotation

Public Property

TextUnderlined

Public Property

TextVerticalAlignment

Public Property

ToleranceFormat

Public Property

ToleranceHeightScale

Public Property

ToleranceLowerValue

Public Property

ToleranceResolution

Public Property

ToleranceUpperValue

Public Property

ToleranceZeroSuppress

Public Property

UserData

List of custom information that is attached to this class.

(Inherited from CommonObject.)

Public Property

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.

(Inherited from CommonObject.)

Public Property

UserStringCount

Gets the amount of user strings.

Public Property

ZeroSuppress

Methods

Name

Description

Public Method

AlternateDimensionLengthDisplayUnit

Public Method

ClearAllFieldOverrides

Sets all the fields in this DimensionStyle to be not overridden Does not change any dimstyle_id’s or parent_id’s

Public Method

ClearFieldOverride

Set the field as not overridden

Public Method

ClearId

Resets the HasId property of the model component to false, if possible.

(Inherited from ModelComponent.)

Public Method

ClearIndex

Resets the HasIndex property of the model component to false, if possible.

(Inherited from ModelComponent.)

Public Method

ClearName

Resets the HasName property of the model component to false, if possible.

(Inherited from ModelComponent.)

Protected Method

ConstructConstObject

Assigns a parent object and a sub-object index to this.

(Inherited from CommonObject.)

Public Method

CopyFrom

Copy settings from source dimension style without changing the name, Id or index of this DimensionStyle.

Public Method

CreatePreviewBitmap

Public Method

DataCRC

Increments the Cyclic Redundancy Check value by this instance.

(Inherited from ModelComponent.)

Public Method

DeleteAllUserStrings

Public Method

DeleteUserString

Public Method

DimensionLengthDisplayUnit

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

(Inherited from CommonObject.)

Protected Method

Dispose(Boolean)

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.

(Inherited from CommonObject.)

Public Method

Duplicate.

Construct a deep (full) copy of this object.

Public Method

Duplicate(String, Guid, Guid)

Construct a deep (full) copy of this object.

Public Method

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.

(Inherited from CommonObject.)

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

Protected Method

Finalize

Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

(Inherited from CommonObject.)

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

Public Method

GetObjectData

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

(Inherited from CommonObject.)

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

Public Method

GetUserString

Gets user string from this geometry.

Public Method

GetUserStrings

Gets a copy of all (user key string, user value string) pairs attached to this geometry.

Public Method

IsChildOf

Tests if this DimensionStyle is a child of a specific DimensionStyle

Public Method

IsFieldOverriden

Public Method

IsValidWithLog

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

(Inherited from CommonObject.)

Public Method

LockId

Locks the component Id property.

(Inherited from ModelComponent.)

Public Method

LockIndex

Locks the component Index property.

(Inherited from ModelComponent.)

Public Method

LockName

Locks the component Name property.

(Inherited from ModelComponent.)

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

Protected Method

NonConstOperation

For derived classes implementers.

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

(Inherited from CommonObject.)

Protected Method

OnSwitchToNonConst

Is called when a non-constant operation first occurs.

(Inherited from CommonObject.)

Public Method

ScaleLengthValues

Scales all length values by ‘scale’

Public Method

SetFieldOverride

Set a field as overridden

Public Method

SetUserString

Attach a user string (key,value combination) to this geometry.

Public Method

ToJSON

Create a JSON string representation of this object

(Inherited from CommonObject.)

Public Method
ToString

Returns the name of the model component type, and then its name and index.

(Inherited from ModelComponent.)