All Frameworks  Object Hierarchy  This Framework  Indexes

DrawingDimension (Object)

Represents a drawing dimension in a Drawing view.

Returns sub parts of dimension: Extension lines, dimension line and dimension value.

Property Index

CumulateMode
Returns cumulate mode or not.
DimStatus
Returns or sets status of dimension.
DimType
Returns dimension type.
DualValue
Returns or sets dual value type of dimension value.
Forshortened
Returns or sets foreshortened mode or not.
HalfDimMode
Returns or sets half dimension mode or not.
IsClipped
Returns the clipping status of the dimension.
NbExtLine
Returns numbers of extension line of dimension.
NbSymb
Returns numbers of symbol of dimension.
Parameters
Returns the collection of parameters of the dimension.
SymbolsSide
Returns or sets symbol side of dimension line.
TrueDimMode
Returns or sets true dimension mode or not.
ValueAngle
Returns or sets angle of dimension value.
ValueAutoMode
Returns or sets auto mode of dimension value or not.
ValueDisplay
Returns or sets display of dimension value state.
ValueFrame
Returns or sets frame type of dimension value.
ValueInOut
Returns or sets in/out mode of dimension value or not.
ValueOrientation
Returns or sets orientation of dimension value.
ValueReference
Returns or sets reference of dimension value.

Method Index

GetBoundaryBox
Get boundary box coordinates of dimension value.
GetClip
Gets informations of the dimension clipping.
GetDimExtLine
Returns the drawing extension line of the drawing dimension.
GetDimLine
Returns the drawing dimension line of the drawing dimension.
GetTolerances
Get tolerance infomation of dimension value.
GetValue
Returns the drawing value of the drawing dimension.
MoveValue
Move dimension value.
RestoreValuePosition
Restore dimension value position.
SetClip
Creates a clip on the dimension at the given point, with respect to the side given by iKeptSide.
SetTolerances
Set tolerance infomation of dimension value.
Unclip
Unclip the dimension if it is clipped.

Properties


o Property CumulateMode() As (Read Only)
Returns cumulate mode or not.
Example:
This example retrieves cumulate mode or not MyDimension drawing dimension. 
 oCumulateMode = MyDimension.CumulateMode
o Property DimStatus() As (Read Only)
Returns or sets status of dimension.
Example:
This example retrieves status of dimension MyDimension drawing dimension. 
 oIsStatus = MyDimension.DimStatus
o Property DimType() As (Read Only)
Returns dimension type.
Example:
This example retrieves the dimension type MyDimension drawing dimension. 
 oTypeDim = MyDimension.DimType
o Property DualValue() As
Returns or sets dual value type of dimension value.
Example:
This example retrieves dual value type of dimension value MyDimension drawing dimension. 
 oDualValue = MyDimension.DualValue
o Property Forshortened() As
Returns or sets foreshortened mode or not.
Example:
This example retrieves foreshortened mode or not MyDimension drawing dimension. 
 oForsh = MyDimension.Forshortened
o Property HalfDimMode() As
Returns or sets half dimension mode or not.
Example:
This example retrieves half dimension mode or not MyDimension drawing dimension. 
 oHalfDimMode = MyDimension.HalfDimMode
o Property IsClipped() As (Read Only)
Returns the clipping status of the dimension. Returns TRUE if the dimension si clipped
Example:
This example gets clipping status of MyDimension path. 
 myDimmensionClippingStatus=MyDimension.IsClipped
o Property NbExtLine() As (Read Only)
Returns numbers of extension line of dimension.
Example:
This example retrieves numbers of extension line of dimension MyDimension drawing dimension. 
 oNbExtline = MyDimension.NbExtLine
o Property NbSymb() As (Read Only)
Returns numbers of symbol of dimension.
Example:
This example retrieves numbers of symbol of dimension MyDimension drawing dimension. 
 oNbSymb = MyDimension.NbSymb
o Property Parameters() As (Read Only)
Returns the collection of parameters of the dimension.
Warning: The returned parameters collection does not support adding parameters, it is mainly provided to access dimension value.
Example:
This example retrieves in DimensionParameters the collection of parameters currently managed by a dimension. 
 Dim DimensionParameters As Parameters
 Set DimensionParameters = MyDimension.Parameters
 Dim DimValueParameter As Parameter
 Set DimValueParameter = DimensionParameters.Item("Measured length")
o Property SymbolsSide() As
Returns or sets symbol side of dimension line. Legal values: 0 : Automatic positioning (Inside or Outside). 1 : Symbols are inside. 2 : Symbols are outside. 3 : First symbol inside , second symbol outside. 4 : First symbol outsise, second symbol inside.
Example:
This example retrieves symbol side of dimension line MyDimension drawing dimension. 
 oSymbSide = MyDimension.SymbolsSide
o Property TrueDimMode() As (Read Only)
Returns or sets true dimension mode or not.
Example:
This example retrieves true dimension mode or not MyDimension drawing dimension. 
 oTrueDimMode = MyDimension.TrueDimMode
o Property ValueAngle() As
Returns or sets angle of dimension value.
Example:
This example retrieves angle of dimension value MyDimension drawing dimension. 
 oValueAng = MyDimension.ValueAngle
o Property ValueAutoMode() As
Returns or sets auto mode of dimension value or not.
Example:
This example retrieves auto mode of dimension value or not MyDimension drawing dimension. 
 oValueAutoMode = MyDimension.ValueAutoMode
o Property ValueDisplay() As
Returns or sets display of dimension value state.
Example:
This example retrieves display of dimension value state MyDimension drawing dimension. 
 oValueDisplay = MyDimension.ValueDisplay
o Property ValueFrame() As
Returns or sets frame type of dimension value.
Example:
This example retrieves frame type of dimension value MyDimension drawing dimension. 
 oValueFrame = MyDimension.ValueFrame
o Property ValueInOut() As
Returns or sets in/out mode of dimension value or not.
Example:
This example retrieves in/out mode of dimension value or not MyDimension drawing dimension. 
 oInOut = MyDimension.ValueInOut
o Property ValueOrientation() As
Returns or sets orientation of dimension value.
Example:
This example retrieves orientation of dimension value MyDimension drawing dimension. 
 oValueOrient = MyDimension.ValueOrientation
o Property ValueReference() As
Returns or sets reference of dimension value.
Example:
This example retrieves reference of dimension value MyDimension drawing dimension. 
 oValueRef = MyDimension.ValueReference

Methods


o Sub GetBoundaryBox( oValues)
Get boundary box coordinates of dimension value.
Parameters:
oValues
List of boundary box coordinates (X1,Y1,X2,Y2,.....X4,Y4).
Example:
This example gets boundary box coordinates of MyDimension path. 
 MyDimension.GetBoundaryBox(oValues)
o Sub GetClip( X,
Y,
oKeptSide)
Gets informations of the dimension clipping. The value of this parameter can be 1 or 2, and the kept side will be the one corresponding respectively to ptldc1 and ptldc2 from GetGeomInfo method defined in CATIADrawingDimensionLine idl interface. interface. If iKeptSide==0, there is no dimension clipping.
Parameters:
oX
X coordinate of position.
oY
Y coordinate of position.
oKeptSide
returns the part of the dimension line will be clipped.
Example: 
 if MyDimension.IsClipped then
   MyDimension.GetClip(X, Y, keptSide)
 end if
o Func GetDimExtLine() As
Returns the drawing extension line of the drawing dimension.
Example:
This example retrieves in DimExtLine extension line of the MyDimension drawing dimension. 
 Dim DimExtLine As DrawingDimExtLine
 Set DimExtLine = MyDimension.GetDimExtLine
See also:
DrawingDimLine
o Func GetDimLine() As
Returns the drawing dimension line of the drawing dimension.
Example:
This example retrieves in DimDimLine dimension line of the MyDimension drawing dimension. 
 Dim DimDimLine As DrawingDimLine
 Set DimDimLine = MyDimension.GetDimLine
See also:
DrawingDimLine
o Sub GetTolerances( oTolType,
oTolName,
oUpTol,
oLowTol,
odUpTol,
odLowTol,
oDisplayMode)
Get tolerance infomation of dimension value.
Parameters:
oTolType
Tolerance type
oTolName
Tolerance name
oUpTol
Upper tolerance value (alpha numerical type)
oLowTol
Lower tolerance value (alpha numerical type)
odUpTol
Upper tolerance value (numerical type)
odLowTol
Lower tolerance value (numerical type)
oDisplayMode
Tolerance display mode
Example:
This example gets tolerance infomation of MyDimension path. 
 MyDimension.GetTolerances(oTolType, oTolName, oUpTol, oLowTol, odUpTol, odLowTol, oDisplayMode)
o Func GetValue() As
Returns the drawing value of the drawing dimension.
Example:
This example retrieves in DimDimValue value of the MyDimension drawing dimension. 
 Dim DimDimValue As DrawingDimValue
 Set DimDimValue = MyDimension.GetValue
See also:
DrawingDimValue
o Sub MoveValue( X,
Y,
SubPart,
DimAngleBehavior)
Move dimension value.
Parameters:
X
X coordinate of position.
Y
Y coordinate of position.
SubPart
Defines which part of the dimension should be moved.
DimAngleBehavior
Defines angle dimension line behavior.
Example:
This example move dimension value MyDimension path. 
 MyDimension.MoveValue(X, Y, SubPart, DimAngleBehavior)
o Sub RestoreValuePosition()
Restore dimension value position.
Example:
This example gets Restore dimension value position of MyDimension path. 
 MyDimension.RestoreValuePosition()
o Sub SetClip( X,
Y,
iKeptSide)
Creates a clip on the dimension at the given point, with respect to the side given by iKeptSide. The value of this parameter can be 1 or 2, and the kept side will be the one corresponding respectively to ptldc1 and ptldc2 from GetGeomInfo method defined in CATIADrawingDimensionLine idl interface. interface.
Parameters:
iX
X coordinate of position.
iY
Y coordinate of position.
iKeptSide
Defines which part of the dimension should be kept.
Example:
This example clips dimension MyDimension path. 
 MyDimension.SetClip(X, Y, 1)
o Sub SetTolerances( iTolType,
itolName,
iUpTol,
iLowTol,
idUpTol,
idLowTol,
DisplayMode)
Set tolerance infomation of dimension value.
Parameters:
iTolType
Tolerance type
itolName
Tolerance name
iUpTol
Upper tolerance value (alpha numerical type)
iLowTol
Lower tolerance value (alpha numerical type)
idUpTol
Upper tolerance value (numerical type)
idLowTol
Lower tolerance value (numerical type)
DisplayMode
Tolerance display mode
Example:
This example sets tolerance infomation of MyDimension path. 
 MyDimension.SetTolerances(iTolType, itolName, iUpTol, iLowTol, idUpTol, idLowTol, DisplayMode)
o Sub Unclip()
Unclip the dimension if it is clipped.
Example:
This example unclip MyDimension path. 
 if MyDimension.IsClipped then
   MyDimension.Unclip

Copyright © 2003, Dassault Systèmes. All rights reserved.