Class vdDimstyle

Namespace: VectorDraw.Professional.vdPrimaries

Assembly: VectorDraw.Professional.dll

Contains the information necessary to generate a specific appearance (such as, text position, arrow blocks at the end of the dimension line, etc.) for a vdDimension entitity that reference it.

public sealed class vdDimstyle : vdPrimary, IDisposable, IVDSerialise, IBaseObject, IComparable

Inheritance: object

BaseObject

vdBaseObject

vdObject

vdPrimary

vdDimstyle

Implements: IDisposable

IVDSerialise

IBaseObject

IComparable

Inherited Members: vdPrimary.Dispose()

vdPrimary.IsTableObjectDependOn(vdPrimary)

vdPrimary.InternalDeleteNoCheck()

vdPrimary.RaiseOnEraseObject()

vdPrimary.OnCloneFinish(vdPrimary, byte)

vdPrimary.Clone(vdDocument)

vdPrimary.setDocumentDefaults()

vdPrimary.InternalSetOwner(vdBaseObject)

vdPrimary.Update()

vdPrimary.PrimaryFlag

vdPrimary.Label

vdPrimary.XProperties

vdPrimary.XPropertiesRef

vdObject.ModifyHandle(vdHandle, vdDocument)

vdObject.Handle

vdObject.HandleId

vdBaseObject.Register()

vdBaseObject.SetUnRegisterDocument(vdDocument)

vdBaseObject.RaiseOnAfterModify(string)

vdBaseObject.RaiseOnBeforeModify(string, object)

vdBaseObject.AddHistory(string, object)

vdBaseObject.AddHistoryEx(string, object)

vdBaseObject.IsDocumentRegister

vdBaseObject._TypeName

vdBaseObject.Document

vdBaseObject.Owner

vdBaseObject.lunits

vdBaseObject.aunits

vdBaseObject.UndoHistory

vdBaseObject.SupportUndoWrite

vdBaseObject.DocProperties

vdBaseObject.OnAfterModifyObjectEx

vdBaseObject.OnBeforeModifyObjectEx

BaseObject.GetHashCode()

BaseObject.Id

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

Examples

Example: Create a dimstyle, adjust main appearance settings and assign it to a dimension:

var dimStyle = new vdDimstyle(document) { Name = "MyDimStyle" };
dimStyle.ArrowSize = 0.25;
dimStyle.TextHeight = 2.0;
dimStyle.PostString = " mm";
// register and use
document.DimStyles.Add(dimStyle);
var dim = new vdDimension(document) { Style = dimStyle };
dim.dimType = VdConstDimType.dim_Aligned;
dim.DefPoint1 = new VectorDraw.Geometry.gPoint(0, 0);
dim.DefPoint2 = new VectorDraw.Geometry.gPoint(5, 0);
dim.LinePosition = new VectorDraw.Geometry.gPoint(0, 1);
document.Model.Entities.AddItem(dim);

Remarks

All vdDimension objects have a dimstyle from which they get default drawing values. The dimension can have ovewrite values to suppress th dimension's style value.

Constructors

vdDimstyle(): Initializes the vdDimstyle object.

vdDimstyle(vdDocument): Initializes the vdDimstyle object and registers it to the passed Document.

vdDimstyle(vdDocument, string): Initializes the vdDimstyle object and registers it to the passed Document.

Properties

ArrowBlock: Get/Set the vdBlock object of the dimension style.

ArrowBlock2: Get/Set the second vdBlock object of the dimension style. If set to null the ArrowBlock object will be used.

ArrowSize: Get/Set the arrow size of the dimension style.

DecimalPrecision: Get/Set the number of decimal places displayed in default dimension text.

Deleted: Get/Set a property that marks the object as Deleted or not.

DiameterSymbol: Specifies a text prefix symbol for a diameter dimension.

DimAdec: Get/Set the number of decimal places for angular dimensions.

DimAunit: Get/Set the units mode for angular dimensions.

DimLineColor: Represents the color of dimension lines and arrowheads.

DimLineLineType: Get/Set the Linetype of the Dimension Line.

DimLineLineWeight: Get/Set The LineWeight of the Dimension Line.

DimLunit: Get/Set the Units mode for linear dimensions.

DimTm: Specifies the tolerance lower limit for dimension text.

DimTol: Appends tolerances to dimension text.

DimTp: Specifies the tolerance limit for dimension text.

DimZin: Get/Set a value representing the suppression of zeros in the default dimension text value.

DimaZin: Controls the suppression of zeros in the default dimension text value for Angular dimensions.

EnableExtLineFixedLength: Get/Set if the ExtLineFixedLength will be used or not.

ExtLineColor: Get/Set the dimension's style extension lines color.

ExtLineDist1: Get/Set how far to extend the extension lines beyond the dimension line in drawing units.

ExtLineDist2: Get/Set how far extension lines are offset from origin points in drawing units.

ExtLineFixedLength: Get/Set the maximum length of the extension lines when EnableExtLineFixedLength is true.

ExtLineLineType1: Get/Set the Linetype of the Extension Line 1.

ExtLineLineType2: Get/Set the Linetype of the Extension Line 2.

ExtLineLineWeight: Get/Set The LineWeight of the Extension Lines.

ExtLineVisible: Get/Set a boolean value indicating the display of the extension lines.

FractionalType: Represents the way Fractional texts will be displayed.

LineForced: Get/Set the visibility of extension lines between extensions viable only for radial and diameter dimensions.

LineIsInvisible: Get/Set the visibility of dimension base line.

LinearScaleFactor: Get/Set the scale factor for dimensioning by which the default dimension Length is multiplyed.

Name: Represents the name of the vdDimstyle object.

PostString: Specifies a text prefix or suffix (or both) to the dimension measurement.

RadialSymbol: Specifies a text prefix symbol for a radial dimension.

ScaleFactor: Get/Set the scale factor of the dimension style.

TextBackGroundMask: Get/Set a boolean value that represents if the backgroundmask color will be used.

TextBackGroundMaskBorderColor: Get/Set the vdColor that the border of the mtext will be drawn.

TextBackGroundMaskBorderPenWidth: Get/Set the object's backgroundMaskBorder pen width in drawing units.

TextBackGroundMaskColor: Get/Set the vdColor that will fill the box of the mtext.

TextBackGroundMaskOffset: Get/Set the object's backgroundMask offset.

TextBackgroundMaskBorder: Get/Set a boolean value that represents if the BackgroundMaskBorder color will be used.

TextColor: Get/Set the dimension's text color of the dimension style.

TextDist: Get/Set the distance around the dimension's text using this dimension style.

TextHeight: Get/Set the Dimension's text height in drawing units using this dimension style.

TextHorRotation: Get/Set the position of dimension text inside the extension lines(aligned or horizontal).

TextMovement: Get/Set a value that represents how the dimension will change according to the dimension's text position change.

TextStyle: Get/Set the vdTextstyle object of the dimension style.

TextVerJust: Get/Set the vertical justification of the dimension style.

VisibleOnForms: Get/Set a boolean value representing if the vdDimstyle will be viewed in Vectordraw forms.

Methods

CompareTo(object): Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

DeSerialize(DeSerializer, string, object): This Function is called foreach field name of the vdDimstyle object when opening in vdml format.

GetCompareHashCode(): Returns a 32-bit signed integer hash code for this object instance.

GetTableDependecies(vdTableDependeciesArgs): Fills the passed vdTableDependeciesArgs args with all the table references of this object (vdLayer, vdBlock, vdDimstyle, vdLineType, vdTextstyle, vdImageDef, vdHatchPattern etc).

InitializeProperties(): Resets the properties of the vdDimstyle object to the Default values.

MatchProperties(vdPrimary, vdDocument): Matches all the common properties from an object and sets them to this object.

OnDocumentSelected(vdDocument): This method is called when the object is inserted in a Document for the first time.

OnOwnerChanged(): This method is called when the object's owner is changed.

Serialize(Serializer): This Function is called when saving the vdDimstyle object to vdml format.