Click or drag to resize

DimensionStyle Class

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

Namespace:  Rhino.DocObjects
Assembly:  RhinoCommon (in RhinoCommon.dll)
public class DimensionStyle : ModelComponent

The DimensionStyle type exposes the following members.

Public methodDimensionStyle
Create a new non-document controlled annotation style
Protected methodDimensionStyle(SerializationInfo, StreamingContext)
Initializes a new instance of the DimensionStyle class
Public propertyAlternateBelowLine
Public propertyAlternateDimensionLengthDisplay
Public propertyAlternateLengthFactor
Public propertyAlternateLengthResolution
Public propertyAlternatePrefix
Public propertyAlternateRoundoff
Public propertyAlternateSuffix
Public propertyAlternateToleranceResolution
Public propertyAlternateUnitsDisplay
Public propertyAlternateZeroSuppress
Public propertyAngleFormat
Public propertyAngleResolution
Public propertyAngleZeroSuppress
Public propertyAngularRoundoff
Public propertyArcLengthSymbol
Public propertyArrowBlockId1
Public propertyArrowBlockId2
Public propertyArrowLength
Public propertyArrowType1
Public propertyArrowType2
Public propertyBaselineSpacing
Public propertyCentermarkSize
Public propertyCenterMarkType
Public propertyComponentStatus
Gets or sets the component status of the model component.
(Inherited from ModelComponent.)
Public propertyComponentType
Returns ModelGeometry.
(Overrides ModelComponentComponentType.)
Public propertyDecimalSeparator
Public propertyDeletedName
Gets the name of a component that is deleted.
(Inherited from ModelComponent.)
Public propertyDimensionLengthDisplay
Public propertyDimensionLineExtension
Public propertyDimensionScale
Public propertyDimensionScaleValue
Public propertyDimRadialTextAngleType
Public propertyDimRadialTextLocation
Public propertyDimRadialTextOrientation
Public propertyDimTextAngleType
Public propertyDimTextLocation
Public propertyDimTextOrientation
Public propertyDisposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
(Inherited from CommonObject.)
Public propertyDrawForward
Public propertyDrawTextMask
Public propertyExtensionLineExtension
Public propertyExtensionLineOffset
Public propertyFitArrow
Public propertyFitText
Public propertyFixedExtensionLength
Public propertyFixedExtensionOn
Public propertyFont
Public propertyForceDimensionLineBetweenExtensionLines
Public propertyHasFieldOverrides
Checks if any fields in this DimensionStyle are overrides
Public propertyHasId
Returns a value indicating whether the component has an ID.
(Inherited from ModelComponent.)
Public propertyHasIndex
Returns a value indicating whether the component has an Index.
(Inherited from ModelComponent.)
Public propertyHasName
Returns a value indicating whether the component has a Name.
(Inherited from ModelComponent.)
Public propertyHasUserData
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.)
Public propertyId
Gets or sets the ID of the current instance.
(Inherited from ModelComponent.)
Public propertyIdIsLocked
Returns a value indicating whether the component ID is already locked.
(Inherited from ModelComponent.)
Public propertyIndex
Gets or sets the model component index attribute.
(Inherited from ModelComponent.)
Public propertyIndexIsLocked
Returns a value indicating whether the component Index is already locked.
(Inherited from ModelComponent.)
Public propertyInstanceDefinitionModelSerialNumber
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 propertyIsChild
Tests if this DimensionStyle is a child of any other DimensionStyle
Public propertyIsComponentStatusLocked
The component status itself can be locked. This returns an indication.
(Inherited from ModelComponent.)
Public propertyIsDeleted
Public propertyIsDocumentControlled
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 propertyIsReference
Public propertyIsSystemComponent
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 propertyIsValid
Tests an object to see if it is valid.
(Inherited from CommonObject.)
Public propertyLeaderArrowBlockId
Public propertyLeaderArrowLength
Public propertyLeaderArrowType
Public propertyLeaderContentAngleType
Style of leader content angle Horizontal Aligned Rotated
Public propertyLeaderCurveType
Public propertyLeaderHasLanding
Public propertyLeaderLandingLength
Public propertyLeaderTextHorizontalAlignment
Public propertyLeaderTextOrientation
Public propertyLeaderTextRotationDegrees
Public propertyLeaderTextRotationRadians
Angle of leader text for Rotated style
Public propertyLeaderTextVerticalAlignment
Public propertyLengthFactor
Public propertyLengthResolution
Public propertyMaskColor
Public propertyMaskColorSource
Public propertyMaskFrameType
Public propertyMaskOffset
Public propertyModelSerialNumber
A value identifying the model that manages this component.
(Inherited from ModelComponent.)
Public propertyCode exampleName
Gets or sets the name
(Inherited from ModelComponent.)
Public propertyNameIsLocked
Returns a value indicating whether the component Name is already locked.
(Inherited from ModelComponent.)
Public propertyParentId
Get or Set the Id of this DimensionStyle's parent. If ParentId is Guid.Empty, this DimensionStyle has no parent
Public propertyPrefix
Public propertyReferenceModelSerialNumber
When a component is in a model for reference, this value identifies the reference model.
(Inherited from ModelComponent.)
Public propertyRoundoff
Public propertyScaleLeftLengthMillimeters
Public propertyScaleRightLengthMillimeters
Public propertyStackFractionFormat
Public propertyStackHeightScale
Public propertySuffix
Public propertySuppressArrow1
Public propertySuppressArrow2
Public propertySuppressExtension1
Public propertySuppressExtension2
Public propertyTextGap
Public propertyTextHeight
Public propertyTextHorizontalAlignment
Public propertyTextMoveLeader
Public propertyTextOrientation
Public propertyTextRotation
Public propertyTextUnderlined
Public propertyTextVerticalAlignment
Public propertyToleranceFormat
Public propertyToleranceHeightScale
Public propertyToleranceLowerValue
Public propertyToleranceResolution
Public propertyToleranceUpperValue
Public propertyToleranceZeroSuppress
Public propertyUserData
List of custom information that is attached to this class.
(Inherited from CommonObject.)
Public propertyUserDictionary
Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use sharable set of information.
(Inherited from CommonObject.)
Public propertyZeroSuppress
Public methodAlternateDimensionLengthDisplayUnit
Public methodClearAllFieldOverrides
Sets all the fields in this DimensionStyle to be not overridden Does not change any dimstyle_id's or parent_id's
Public methodClearFieldOverride
Set the field as not overridden
Public methodClearId
Resets the HasId property of the model component to false, if possible.
(Inherited from ModelComponent.)
Public methodClearIndex
Resets the HasIndex property of the model component to false, if possible.
(Inherited from ModelComponent.)
Public methodClearName
Resets the HasName property of the model component to false, if possible.
(Inherited from ModelComponent.)
Protected methodConstructConstObject
Assigns a parent object and a sub-object index to this.
(Inherited from CommonObject.)
Public methodCopyFrom
Copy settings from source dimension style without changing the name, Id or index of this DimensionStyle.
Public methodCreatePreviewBitmap
Public methodDataCRC
Increments the Cyclic Redundancy Check value by this instance.
(Inherited from ModelComponent.)
Public methodDimensionLengthDisplayUnit
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.)
Protected methodDispose(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 methodDuplicate
Construct a deep (full) copy of this object.
Public methodDuplicate(String, Guid, Guid)
Construct a deep (full) copy of this object.
Public methodEnsurePrivateCopy
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 methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Inherited from CommonObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsChildOf
Tests if this DimensionStyle is a child of a specific DimensionStyle
Public methodIsFieldOverriden
Public methodIsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
(Inherited from CommonObject.)
Public methodLockId
Locks the component Id property.
(Inherited from ModelComponent.)
Public methodLockIndex
Locks the component Index property.
(Inherited from ModelComponent.)
Public methodLockName
Locks the component Name property.
(Inherited from ModelComponent.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodNonConstOperation
For derived classes implementers.

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

(Inherited from CommonObject.)
Protected methodOnSwitchToNonConst
Is called when a non-constant operation first occurs.
(Inherited from CommonObject.)
Public methodScaleLengthValues
Scales all length values by 'scale'
Public methodSetFieldOverride
Set a field as overridden
Public methodToJSON
Create a JSON string representation of this object
(Inherited from CommonObject.)
Public methodToString
Returns the name of the model component type, and then its name and index.
(Inherited from ModelComponent.)
See Also