All Frameworks  Object Hierarchy  This Framework  Previous  Next  Indexes  

DrawingDimValue (Object)

IUnknown
  |
  +---IDispatch
    |
    +---CATBaseUnknown
      |
      +---CATBaseDispatch
        |
        +---AnyObject
          |
          +---DrawingDimValue
 


Manages dimension value of a dimension in drawing view.

This interface is obtained from DrawingDimension.GetValue method.


Property Index

FakeDimType
Returns or sets fake dimension type of value.
ScoringMode
Get dimension scoring mode.
Value
Returns value of dimension.
ValueFramedElement
Get dimension framed element.
ValueFramedGroup
Returns or sets dimension framed group.

Method Index

GetBaultText
Get bault text of dimension value.
GetDisplayUnit
Get display unit of dimension value.
GetFakeDimValue
Get fake value of dimension.
GetFormatDisplayFactor
Get format display factor of dimension value.
GetFormatName
Get format name of dimension value.
GetFormatPrecision
Get format precision of dimension value.
GetFormatType
Get format type of dimension value.
GetFormatUnit
Get format unit of dimension value.
GetPSText
Get PS text to dimension value.
GetScoredElement
Get dimension scored element.
SetBaultText
Set bault text to dimension value.
SetFakeDimValue
Set fake value of dimension value.
SetFormatDisplayFactor
Set format display factor of dimension value.
SetFormatName
Set format name of dimension value.
SetFormatPrecision
Set format precision of dimension value.
SetFormatType
Set format type of dimension value.
SetFormatUnit
Set format unit of dimension value.
SetPSText
Set PS text to dimension value.
SetScoredElement
Set dimension scored element.

Properties


o Property FakeDimType() As CatDimFake
Returns or sets fake dimension type of value.
Example:
This example retrieves fake dimension type of value MyDimValue drawing dimension.
 oFakeType = MyDimValue.FakeDimType
 
o Property ScoringMode() As CatDimScore
Get dimension scoring mode.
Example:
This example gets dimension scoring mode of MyValue path.
 ValueScoreType = MyValue.ScoringMode
 
o Property Value() As double (Read Only)
Returns value of dimension.
Example:
This example retrieves value of dimension MyDimValue drawing dimension.
 oValue = MyDimValue.Value
 
o Property ValueFramedElement() As CatDimFramedElement
Get dimension framed element.
Example:
This example gets dimension framed element of MyValue path.
 ValueFramedElement = MyValue.ValueFramedElement
 
o Property ValueFramedGroup() As CatDimFramedGroup
Returns or sets dimension framed group.
Example:
This example retrieves dimension framed group MyDimValue drawing dimension.
 oValueFramedGroup = MyDimValue.FakeDimType
 

Methods


o Sub GetBaultText(long iIndex,
CATBSTR oBefore,
CATBSTR oAfter,
CATBSTR oUpper,
CATBSTR oLower)
Get bault text of dimension value.
Parameters:
iIndex
1: main value 2: dual value
oBefore
before text.
oAfter
after text
oUpper
upper text
oLower
lower text
Example:
This example gets bault text of MyValue path.
 MyValue.GetBaultText(iIndex, oBefore, oAfter, oUpper, oLower)
 
o Func GetDisplayUnit(long iIndex) As long
Get display unit of dimension value.
Parameters:
Index
1: main value 2: dual value
oDisplUnit
before text.
Example:
This example gets format unit of MyValue path.
 FrmUnit = MyValue.GetDisplayUnit(iIndex)
 
o Func GetFakeDimValue(long iIndex) As CATBSTR
Get fake value of dimension.
Parameters:
iIndex
1: main value 2: dual value
oFakeDimValue
before text.
Example:
This example gets fake value of MyValue path.
 FakeDimValue = MyValue.GetFakeDimValue(iIndex)
 
o Func GetFormatDisplayFactor(long iIndex) As long
Get format display factor of dimension value.
Parameters:
iIndex
1: main value 2: dual value
oFrmDspFact
before text.
Example:
This example gets format display factor of MyValue path.
 FrmDspFact = MyValue.GetFormatDisplayFactor(iIndex)
 
o Func GetFormatName(long iIndex) As CATBSTR
Get format name of dimension value.
Parameters:
iIndex
1: main value 2: dual value
oFmName
before text.
Example:
This example gets format name of MyValue path.
 FmName = MyValue.GetFormatName(iIndex)
 
o Func GetFormatPrecision(long Index) As double
Get format precision of dimension value.
Parameters:
iIndex
1: main value 2: dual value
oFrmPrecision
before text.
Example:
This example gets format precision of MyValue path.
 FrmPrecision = MyValue.GetFormatPrecision(iIndex)
 
o Func GetFormatType(long iIndex) As long
Get format type of dimension value.
Parameters:
iIndex
1: main value 2: dual value
oFrmType
before text.
Example:
This example gets format type of MyValue path.
 FrmType = MyValue.GetFormatType(iIndex)
 
o Func GetFormatUnit(long iIndex) As long
Get format unit of dimension value.
Parameters:
Index
1: main value 2: dual value
oFrmUnit
before text.
Example:
This example gets format unit of MyValue path.
 FrmUnit = MyValue.GetFormatUnit(iIndex)
 
o Sub GetPSText(long iIndex,
CATBSTR oPrefix,
CATBSTR oSuffix)
Get PS text to dimension value.
Parameters:
iIndex
1: main value 2: dual value
oPrefix
prefix text.
oSuffix
suffix text
Example:
This example gets PS text of MyValue path.
 MyValue.GetBaultText(iIndex, oPrefix, oSuffix)
 
o Func GetScoredElement(long iIndex) As boolean
Get dimension scored element.
Parameters:
iIndex
1: main value 2: dual value
oScoredElement
TRUE: Scoring is applied to the all bloc text. FALSE: Scoring is only applied to the value.
Example:
This example gets dimension scored element of MyValue path.
 ScoredElement = MyValue.GetScoredElement(iIndex)
 
o Sub SetBaultText(long iIndex,
CATBSTR iBefore,
CATBSTR iAfter,
CATBSTR iUpper,
CATBSTR iLower)
Set bault text to dimension value.
Parameters:
iIndex
1: main value 2: dual value
iBefore
before text.
iAfter
after text
iUpper
upper text
iLower
lower text
Example:
This example sets bault text of MyValue path.
 MyValue.SetBaultText(iIndex, iBefore, iAfter, iUpper, iLower)
 
o Sub SetFakeDimValue(long iIndex,
CATBSTR iFakeDimValue)
Set fake value of dimension value.
Parameters:
iIndex
1: main value 2: dual value
iFakeDimValue
before text.
Example:
This example gets fake value of MyValue path.
 MyValue.SetFakeDimValue(iIndex, iFakeDimValue)
 
o Sub SetFormatDisplayFactor(long iIndex,
long iFrmDspFact)
Set format display factor of dimension value.
Parameters:
iIndex
1: main value 2: dual value
iFrmDspFact
before text.
Example:
This example gets format display factor of MyValue path.
 MyValue.SetFormatDisplayFactor(iIndex, iFrmDspFact)
 
o Sub SetFormatName(long iIndex,
CATBSTR iFrmName)
Set format name of dimension value.
Parameters:
iIndex
1: main value 2: dual value
iFrmName
before text.
Example:
This example gets format name of MyValue path.
 MyValue.SetFormatName(iIndex, iFrmName)
 
o Sub SetFormatPrecision(long iIndex,
double iFrmPrecision)
Set format precision of dimension value.
Parameters:
iIndex
1: main value 2: dual value
iFrmPrecision
before text.
Example:
This example gets format precision of MyValue path.
 MyValue.SetFormatPrecision(iIndex, iFrmPrecision)
 
o Sub SetFormatType(long iIndex,
long iFrmType)
Set format type of dimension value.
Parameters:
iIndex
1: main value 2: dual value
iFrmType
before text.
Example:
This example gets format type of MyValue path.
 MyValue.SetFormatType(iIndex, iFrmType)
 
o Sub SetFormatUnit(long iIndex,
long iFrmUnit)
Set format unit of dimension value.
Parameters:
iIndex
1: main value 2: dual value
iFrmUnit
before text.
Example:
This example gets format unit of MyValue path.
 MyValue.SetFormatUnit(iIndex, iFrmUnit)
 
o Sub SetPSText(long iIndex,
CATBSTR iPrefix,
CATBSTR iSuffix)
Set PS text to dimension value.
Parameters:
iIndex
1: main value 2: dual value
iPrefix
prefix text.
iSuffix
suffix text
Example:
This example sets PS text of MyValue path.
 MyValue.SetBaultText(iIndex, iPrefix, iSuffix)
 
o Sub SetScoredElement(long iIndex,
boolean iScoredElement)
Set dimension scored element.
Parameters:
iIndex
1: main value 2: dual value
iScoredElement
TRUE: Scoring is applied to the all bloc text. FALSE: Scoring is only applied to the value.
Example:
This example gets dimension scored element of MyValue path.
 MyValue.SetScoredElement(iIndex, iScoredElement)
 

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