drafting_interfaces¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property CreateNewSheetFrom() As CatDrwNewSheetFrom

Returns the CreateNewSheetFrom parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DisplayResetButton() As boolean

Returns the DisplayResetButton parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetCreateNewSheetFromInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the CreateNewSheetFrom

parameter.

Role:Retrieves the state of the CreateNewSheetFrom parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetDisplayResetButtonInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the DisplayResetButton

parameter.

Role:Retrieves the state of the DisplayResetButton parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetLockUserDefaultInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the LockUserDefault

parameter.

Role:Retrieves the state of the LockUserDefault parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetPreventBackgroundAccessInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventBackgroundAccess

parameter.

Role:Retrieves the state of the PreventBackgroundAccess parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetPreventDimDriving3DCstrInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventDimDriving3DCstr

parameter.

Role:Retrieves the state of the PreventDimDriving3DCstr parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetPreventFileNewInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked,

boolean oModified)

Retrieves environment informations for the PreventFileNew

parameter.

Role:Retrieves the state of the PreventFileNew parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetPreventGenViewStyleInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventGenViewStyle

parameter.

Role:Retrieves the state of the PreventGenViewStyle parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetPreventSetAsDefaultInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventSetAsDefault

parameter.

Role:Retrieves the state of the PreventSetAsDefault parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetPreventSwitchStandardInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventSwitchStandard

parameter.

Role:Retrieves the state of the PreventSwitchStandard parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetPreventTrueDimensionCreationInfo(CATBSTR

ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventTrueDimensionCreation

parameter.

Role:Retrieves the state of the PreventTrueDimensionCreation parameter in

the current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetPreventUpdateStandardInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventUpdateStandard

parameter.

Role:Retrieves the state of the PreventUpdateStandard parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetPreventViewGeomUpgradeInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the PreventViewGeomUpgrade

parameter.

Role:Retrieves the state of the PreventViewGeomUpgrade parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetUseStyleCreateObjectsInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the UseStyleCreateObjects

parameter.

Role:Retrieves the state of the UseStyleCreateObjects parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property LockUserDefault() As boolean

Returns the LockUserDefault parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property PreventBackgroundAccess() As boolean

Returns the PreventBackgroundAccess parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property PreventDimDriving3DCstr() As boolean

Returns the PreventDimDriving3DCstr parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property PreventFileNew() As boolean

Returns the PreventFileNew parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property PreventGenViewStyle() As boolean

Returns the PreventGenViewStyle parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property PreventSetAsDefault() As boolean

Returns the PreventSetAsDefault parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property PreventSwitchStandard() As boolean

Returns the PreventSwitchStandard parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property PreventTrueDimensionCreation() As boolean

Returns the PreventTrueDimensionCreation parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property PreventUpdateStandard() As boolean

Returns the PreventUpdateStandard parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property PreventViewGeomUpgrade() As boolean

Returns the PreventViewGeomUpgrade parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetCreateNewSheetFromLock(boolean iLocked)

Locks or unlocks the CreateNewSheetFrom parameter.

Role:Locks or unlocks the CreateNewSheetFrom parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetDisplayResetButtonLock(boolean iLocked)

Locks or unlocks the DisplayResetButton parameter.

Role:Locks or unlocks the DisplayResetButton parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetLockUserDefaultLock(boolean iLocked)

Locks or unlocks the LockUserDefault parameter.

Role:Locks or unlocks the LockUserDefault parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetPreventBackgroundAccessLock(boolean iLocked)

Locks or unlocks the PreventBackgroundAccess parameter.

Role:Locks or unlocks the PreventBackgroundAccess parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetPreventDimDriving3DCstrLock(boolean iLocked)

Locks or unlocks the PreventDimDriving3DCstr parameter.

Role:Locks or unlocks the PreventDimDriving3DCstr parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetPreventFileNewLock(boolean iLocked)

Locks or unlocks the PreventFileNew parameter.

Role:Locks or unlocks the PreventFileNew parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetPreventGenViewStyleLock(boolean iLocked)

Locks or unlocks the PreventGenViewStyle parameter.

Role:Locks or unlocks the PreventGenViewStyle parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetPreventSetAsDefaultLock(boolean iLocked)

Locks or unlocks the PreventSetAsDefault parameter.

Role:Locks or unlocks the PreventSetAsDefault parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetPreventSwitchStandardLock(boolean iLocked)

Locks or unlocks the PreventSwitchStandard parameter.

Role:Locks or unlocks the PreventSwitchStandard parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetPreventTrueDimensionCreationLock(boolean iLocked)

Locks or unlocks the PreventTrueDimensionCreation

parameter.

Role:Locks or unlocks the PreventTrueDimensionCreation parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetPreventUpdateStandardLock(boolean iLocked)

Locks or unlocks the PreventUpdateStandard parameter.

Role:Locks or unlocks the PreventUpdateStandard parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetPreventViewGeomUpgradeLock(boolean iLocked)

Locks or unlocks the PreventViewGeomUpgrade parameter.

Role:Locks or unlocks the PreventViewGeomUpgrade parameter if it is

possible in the current administrative context. In user mode this method will

always return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetUseStyleCreateObjectsLock(boolean iLocked)

Locks or unlocks the UseStyleCreateObjects parameter.

Role:Locks or unlocks the UseStyleCreateObjects parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property UseStyleCreateObjects() As boolean

Returns the UseStyleCreateObjects parameter.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub AddInterruption(double iFirstPointX,

double iFirstPointY,

double iSecondPointX,

double iSecondPointY)

Add an interruption to an arrow.

Parameters:

iFirstPointX

X coordinates of first point.

iFirstPointY

Y coordinates of first point.

iSecondPointX

X coordinates of second point.

iSecondPointY

Y coordinates of second point.

Example:

This example adds an interruption to MyArrow.

iFirstPointX = 10.

iFirstPointY = 20.

iSecondPointX = 20.

iSecondPointY = 20.

MyArrow.AddInterruption iFirstPointX, iFirstPointY, iSecondPointX,

iSecondPointY

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub AddPoint(long iNum,

double iX,

double iY)

Add a point to an arrow.

Parameters:

iNum

Point number. Point will be inserted at iNum+1 position.

iX

X coordinates of point to add.

iY

Y coordinates of point to add.

Example:

This example adds a point to MyArrow.

iNum = 1

iX = 10.

iY = 20.

MyArrow.AddPoint iNum, iX, iY

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetInterruptions(CATSafeArrayVariant oInterruptions) As

long

Get arrow path.

Parameters:

oInterruptions

List of interruptions coordinates (X1,Y1,X2,Y2,…..Xn,Yn).

Returns:

oNbInterruptions Number of interruptions.

Example:

This example gets interruptions of MyArrow path.

oNbInterruptions = MyArrow.GetInterruptions(oInterruptions)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetPoint(long iNum,

double oX,

double oY)

Get arrow point coordinates.

Parameters:

iNum

Point number.

oX

X coordinates of point.

oY

Y coordinates of point.

Example:

This example gets a point to MyArrow.

iNum = 1

MyArrow.GetPoint(iNum, oX, oY)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetPoints(CATSafeArrayVariant oPoints) As long

Get arrow path.

Parameters:

oPoints

List of points coordinates (X1,Y1,X2,Y2,…..Xn,Yn).

Returns:

oNbPoints Number of points.

Example:

This example gets points of MyArrow path.

oNbPoints = MyArrow.GetPoints(oPoints)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property HeadSymbol() As CatSymbolType

Returns or sets symbol type of head side.

Example:

This example retrieves the symbol type of head side on MyArrow drawing

arrow.

oSymbol = MyArrow.HeadSymbol

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property HeadTarget() As CATBaseDispatch

Returns or sets target element of head side.

Example:

This example retrieves the target element of head side on MyArrow

drawing arrow.

oTarget = MyArrow.HeadTarget

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub ModifyPoint(long iNum,

double iX,

double iY)

Modify a point of an Arrow.

Parameters:

iNum

Point number to modify.

iX

X coordinates of new point.

iY

Y coordinates of new point.

Example:

This example modifies a point to MyArrow.

iNum = 1

iX = -10.

iY = -20.

MyArrow.ModifyPoint iNum, iX, iY

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property NbInterruption() As long (Read Only)

Returns the number of interruptions of arrow path.

Example:

This example retrieves the number of interruptions on MyArrow drawing

arrow.

oNbInterruption = MyArrow.NbInterruption

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property NbPoint() As long (Read Only)

Returns the number of points of arrow path.

Example:

This example retrieves the number of points on MyArrow drawing

arrow.

oNbPoint = MyArrow.NbPoint

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub RemoveInterruption(long iNum)

Remove an interruption to an arrow.

Parameters:

iNum

Interruption number to delete.

- If iNum equals to 0, all interruptions will be removed.

Example:

This example removes an interruption from MyArrow.

iNum = 2

MyArrow.RemoveInterruption iNum

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub RemovePoint(long iNum)

Remove a point from an arrow.

Parameters:

iNum

Point number to delete.

Example:

This example removes a point from MyArrow.

iNum = 2

MyArrow.RemovePoint iNum

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TailSymbol() As CatSymbolType

Returns or sets symbol type of tail side.

Example:

This example retrieves the symbol type of tail side on MyArrow drawing

arrow.

oSymbol = MyArrow.TailSymbol

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TailTarget() As CATBaseDispatch

Returns or sets target element of tail side.

Example:

This example retrieves the target element of tail side on MyArrow

drawing arrow.

oTarget = MyArrow.TailTarget

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add(double iHeadPointX,

double iHeadPointY,

double iTailPointX,

double iTailPointY) As DrawingArrow

Creates a drawing arrow and adds it to the DrawingArrows

collection.

Parameters:

iHeadPointX,iHeadPointY

The x and y coordinates of head side of drawing arrow

iTailPointX,iTailPointY

The x and y coordinates of tail side of drawing arrow

Returns:

The created drawing arrow

Example:

The following example creates a drawing arrow and retrieved in MyArrow in

the drawing view collection of the MyView drawing view. This view belongs to

the drawing view collection of the drawing sheet

Dim MyView As DrawingView

Set MyView = MySheet.Views.ActiveView

Dim MyArrow As DrawingArrow

Set MyArrow = MyView.Arrows.Add(0., 0., 20., 50)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Item(long iIndex) As DrawingArrow

Returns a drawing arrow using its index from the DrawingArrows

collection.

Parameters:

iIndex

The index of the drawing arrow to retrieve from the collection of

drawing arrows. As a numerics, this index is the rank of the drawing arrow in

the collection. The index of the first drawing arrow in the collection is 1,

and the index of the last drawing arrow is Count.

Returns:

The retrieved drawing view

Example:

This example retrieves in ThisDrawingArrow the second drawing arrow, in

the drawing view collection of the active view in the active sheet, in the

active document supposed to be a drawing document.

Dim MyView As DrawingView

Set MyView = MySheet.Views.ActiveView

Dim ThisDrawingArrow As DrawingArrow

Set ThisDrawingArrow = MyView.Arrows.Item(2)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Remove(long iIndex)

Removes a drawing arrow from the DrawingArrows collection.

Parameters:

iIndex

The index of the drawing arrow to remove from the collection of

drawing arrows. As a numerics, this index is the rank of the drawing arrow in

the collection. The index of the first drawing arrow in the collection is 1,

and the index of the last drawing arrow is Count.

Example:

The following example removes the third drawing arrow in the drawing

arrow collection of the active view of the active document, supposed to be a

drawing document.

Dim MyView As DrawingView

Set MyView = MySheet.Views.ActiveView

MyView.DrawingArrows.Remove(3)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Angle() As double

Returns or sets the angle of the drawing component instance. The angle is

given in the axis system of the drawing view The angle is measured in radians

and is counted counterclockwise.

Example:

This example sets the angle of the MyComponent drawing component

instance to 90 degrees clockwise. You first need to compute the angle in

radians and set the minus sign to indicate the rotation is

clockwise.

PI = 3.1415926535

Angle90Clockwise = -PI/2

MyComponent.Angle = Angle90Clockwise

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property CompRef() As DrawingView (Read Only)

Returns the component reference of this drawing component instance. this is

a CATIADrawingView

Example:

This example gets the drawing component reference of the MyComponent

drawing component instance.

Dim ComponentRef As DrawingView

Set ComponentRef = MyComponent.CompRef

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Explode()

Explodes the drawing component instance (every sub elements of the drawing

component are created). Note: The drawing component is not removed by Explode

method

Example:

This example Explodes the MyComponent drawing component instance and

removes it.

MyComponent.Explode

Set MySelection = CATIA.ActiveDocument.Selection

MySelection.clear

MySelection.add MyComponent

MySelection.delete

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub ExplodeAndSelect()

Explodes the drawing component instance (every sub elements of the drawing

component are created) and put created sub elements in selection

set.

Example:

This example Explodes the MyComponent drawing component

instance.

MyComponent.ExplodeAndSelect

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub ExposeCompRef()

Exposes the component reference of this drawing component instance in a new

detail sheet.

Example:

This example exposes the component reference of the MyComponent drawing

component instance in a new detail sheet.

MyComponent.ExposeCompRef

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub ExposeCompRefInSheet(DrawingSheet iSheet)

Exposes the component reference of this drawing component instance in a

specific detail sheet.

Parameters:

iSheet

The drawing sheet where the reference component has to be exposed.

This sheet has to be a detail sheet, if not the component reference will be

placed in a new detail sheet.

Example:

This example exposes the component reference of the MyComponent

drawing component instance in the MyDetailSheet drawing

sheet.

MyComponent.ExposeCompRefInSheet

MyDetailSheet

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Flip()

Flips the drawing component instance around X axis To flip around Y axis

you have to flip the component around X and to add a rotation of 180

degrees.

Example:

This example Flips the MyComponent drawing component

instance.

MyComponent.Flip

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetFlip() As boolean

Returns the flip state of a drawing component instance around X

axis.

Example:

This example Get the flip info of the MyComponent drawing component

instance.

IsFlipped = MyComponent.GetFlip

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetMatrix(CATSafeArrayVariant ioMatrix)

Gets the matrix of the drawing component instance. This matrix enables you

to define the position (index 4 and 5 of the matrix) and the scale, the angle

and the flip (index 0,1,2 and 3) of the drawing component instance at the same

time.

Parameters:

ioMatrix[0]

The 1st coordinate of the first vector

ioMatrix[1]

The 2nd coordinate of the first vector

ioMatrix[2]

The 1st coordinate of the second vector

ioMatrix[3]

The 2nd coordinate of the second vector

ioMatrix[4]

The x value of the translation vector

ioMatrix[5]

The y value of the translation vector

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetModifiableObject(CATVariant iIndex) As AnyObject

Gets a modifiable object by index or name in this drawing component

instance.

Example:

This example Gets the first modifiable object in the MyComponent

drawing component instance.

Object = MyComponent.GetModifiableObject(1)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetModifiableObjectsCount() As long

Gets the number of modifiable objects in this drawing component

instance.

Example:

This example Gets the number of modifiable objects in MyComponent

drawing component instance.

Count = MyComponent.GetModifiableObjectsCount

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Scale2() As double

Returns or sets the scale of the drawing component instance (Workaround for

VBA keyword).

Example:

This example sets the scale of the MyComponent drawing component

instance to 0.5.

MyComponent.Scale2 = 0.5

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetMatrix(CATSafeArrayVariant iMatrix)

Sets the matrix of the drawing component instance. This matrix enables you

to define the position (index 4 and 5 of the matrix) and the scale, the angle

and the flip (index 0,1,2 and 3) of the drawing component instance at the same

time.

Parameters:

ioMatrix[0]

The 1st coordinate of the first vector

ioMatrix[1]

The 2nd coordinate of the first vector

ioMatrix[2]

The 1st coordinate of the second vector

ioMatrix[3]

The 2nd coordinate of the second vector

ioMatrix[4]

The x value of the translation vector

ioMatrix[5]

The y value of the translation vector

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property x() As double

Returns or sets the x coordinate of the drawing component instance

position. It is expressed with respect to the view coordinate system. This

coordinate, like any length, is measured in millimeters.

Example:

This example sets the x coordinate of the position of the MyComponent

drawing component instance to 5 inches. You need first to convert the 5 inches

into millimeters.

NewXCoordinate = 5*25.4

MyComponent.x = NewXCoordinate

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property y() As double

Returns or sets the y coordinate of the drawing component instance

position. It is expressed with respect to the view coordinate system. This

coordinate, like any length, is measured in millimeters.

Example:

This example sets the y coordinate of the position of the MyComponent

drawing component instance to 5 inches. You need first to convert the 5 inches

into millimeters.

NewYCoordinate = 5*25.4

MyComponent.y = NewYCoordinate

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add(DrawingView iDrawingComponentRef,

double iPositionX,

double iPositionY) As DrawingComponent

Creates a drawing component instance and adds it to the DrawingComponents

collection.

Parameters:

iDrawingComponentRef

The view (i.e. the detail) that is the component reference . This

view also called a detail MUST belong to a sheet of component references (i.e.

details)

iPositionX,iPositionY

The drawing component x and y coordinates, expressed in

millimeters, with respect to the drawing view coordinate system

Returns:

The created drawing component instance

Example:

The following example creates a drawing component instance with a given

component reference MyComponentRef coming from a Sheet of component references

(i.e. details) SheetComponentRef and retrieved in MyComponentInst in the

drawing view collection of the MyView drawing view. This view belongs to the

drawing view collection of the drawing sheet

Dim MyComponentRef As DrawingView

Set MyComponentRef = SheetComponentRef.Views.Item(1)

Dim MyView As DrawingView

Set MyView = MySheet.Views.ActiveView

Dim MyComponentInst As DrawingComponent

Set MyComponentInst = MyView.Components.Add(MyComponentRef, 100., 50.)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Item(CATVariant iIndex) As DrawingComponent

Returns a drawing component instance using its index or its name from the

DrawingComponents collection.

Parameters:

iIndex

The index or the name of the drawing component instance to retrieve

from the collection of drawing components. As a numerics, this index is the

rank of the drawing component instance in the collection. The index of the

first drawing component instance in the collection is 1, and the index of the

last drawing component instance is Count. As a string, it is the name you

assigned to the drawing component instance using the

AnyObject.Name property

Returns:

The retrieved drawing component instance

Example:

This example retrieves in ThisDrawingComponent the second drawing component

instance, MyView in the drawing view collection of the active sheet in the

active document, supposed to be a drawing document.

Dim MySheet As DrawingSheet

Set MySheet = CATIA.ActiveDocument.Sheets.ActiveSheet

Dim MyView As DrawingView

Set MyView = MySheet.Views.ActiveView

Dim ThisDrawingComponent As DrawingComponent

Set ThisDrawingComponent = MyView.Components.Item(2)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Remove(CATVariant iIndex)

Removes a drawing component from the DrawingComponents

collection.

Parameters:

iIndex

The index of the drawing component to remove from the collection of

drawing components. As a numerics, this index is the rank of the drawing

component in the collection. The index of the first drawing component instance

in the collection is 1, and the index of the last drawing component instance is

Count. As a string, it is the name you assigned to the drawing component using

the

AnyObject.Name property

Example:

The following example removes the third drawing component instance in the

drawing component collection of the active view of the active document,

supposed to be a drawing document.

Dim MyView As DrawingView

Set MyView = MySheet.Views.ActiveView

MyView.Components.Remove(3)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub AddInterrupt(long iIndex,

CATSafeArrayVariant iTwoPoints)

Add an interrupt to an extension line.

Parameters:

iIndex

1: first extension line 2: second extension line

iTwoPoints

Defines the first and second point of the gap to create.

Example:

This example adds an interrupt to MyExtLine path.

MyExtLine.AddInterrupt(iIndex, iTwoPoints)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Color() As long

Returns or sets color of extension line.

Example:

This example retrieves color of extension line MyExtLine drawing

dimension.

oColorExtLine = MyExtLine.Color

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ExtLineSlant() As double

Returns or sets slant angle of extension line.

Example:

This example retrieves slant angle of extension line MyExtLine drawing

dimension.

oExtLineSlant = MyExtLine.ExtLineSlant

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ExtLineType() As long (Read Only)

Returns extension line type of dimension.

Example:

This example retrieves extension line type of dimension MyExtLine

drawing dimension.

oExtLineType = MyExtLine.ExtLineType

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetFunnel(long iIndex,

long oMode,

double oAngle,

double oHeight,

double oWidth)

Get funnel information of dimension extension line.

Parameters:

iIndex

1: first extension line 2: second extension line

oMode

funnel inside/outside mode.

oAngle

funnel angle.

oHeight

funnel height.

oWidth

funnel width.

Example:

This example gets funnel information of MyExtLine

path.

MyExtLine.GetFunnel(iIndex, oMode, oAngle, oHeight,

oWidth)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetGap(long iIndex) As double

Get gap of dimension extension line.

Parameters:

iIndex

1: first extension line 2: second extension line

oGap

Gap.

Example:

This example gets gap of MyExtLine path.

Gap = MyExtLine.GetGap(iIndex)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetGeomInfo(long iIndex,

CATSafeArrayVariant oGeomInfos)

Get geometrical information of dimension extension line.

Parameters:

iIndex

1: first extension line 2: second extension line

oGeomInfos

List of geometric coordinates (X1,Y1,X2,Y2,X3,Y3).

Example:

This example gets geometrical information of MyExtLine

path.

MyExtLine.GetGeomInfo(iIndex, oGeomInfos)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetInterrupt(long iIndex) As long

Get the number of interruptions stored in each extension

lines.

Parameters:

iIndex

1: first extension line 2: second extension line

oNbIntOnExtLine

The number of interruptions.

Example:

This example gets the number of interruptions of MyExtLine

path.

NbIntOnExtLine = MyExtLine.GetInterrupt(iIndex)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetOverrun(long iIndex) As double

Get overrun of dimension extension line.

Parameters:

iIndex

1: first extension line 2: second extension line

oOverrun

Overrun

Example:

This example gets overrun of MyExtLine path.

Overrun = MyExtLine.GetOverrun(iIndex)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetVisibility(long iIndex) As long

Get visibility of dimension extension line.

Parameters:

iIndex

1: first extension line 2: second extension line

oGap

Gap.

Example:

This example gets visibility of MyExtLine path.

ExtlineVisibility = MyExtLine.GetVisibility(iIndex)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub RemoveInterrupt(long iIndex)

Remove interruption on extension lines.

Parameters:

iIndex

1: first extension line 2: second extension line

Example:

This example Remove interruption on MyExtLine

path.

MyExtLine.RemoveInterrupt(iIndex)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetFunnel(long iIndex,

long iMode,

double iAngle,

double iHeight,

double iWidth)

Set funnel information of dimension extension line.

Parameters:

iIndex

1: first extension line 2: second extension line

iMode

funnel inside/outside mode.

iAngle

funnel angle.

iHeight

funnel height.

iWidth

funnel width.

Example:

This example sets funnel information of MyExtLine

path.

MyExtLine.SetFunnel(iIndex, iMode, iAngle, iHeight,

iWidth)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetGap(long iIndex,

double iGap)

Set gap of dimension extension line.

Parameters:

iIndex

1: first extension line 2: second extension line

iGap

gap

Example:

This example sets gap of MyExtLine path.

MyExtLine.SetGap(iIndex, iGap)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetOverrun(long iIndex,

double iOverrun)

Set overrun of dimension extension line.

Parameters:

iIndex

1: first extension line 2: second extension line

iOverrun

Overrun

Example:

This example sets overrun of MyExtLine path.

MyExtLine.SetOverrun(iIndex, iOverrun)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetVisibility(long iIndex,

long iExtlineVisibility)

Set visibility of dimension extension line.

Parameters:

iIndex

1: first extension line 2: second extension line

iExtlineVisibility

visibility

Example:

This example sets visibility of MyExtLine path.

MyExtLine.SetVisibility(iIndex,

iExtlineVisibility)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Thickness() As double

Returns or sets thickness of extension line.

Example:

This example retrieves thickness of extension line MyExtLine drawing

dimension.

oThickExtLine = MyExtLine.Thickness

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Color() As long

Returns or sets color of dimension line.

Example:

This example retrieves color of dimension line MyDimLine drawing

dimension.

oColorDimLine = MyDimLine.Color

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DimLineGraphRep() As CatDimLineGraphRep

Returns or graphic representation of dimension line.

Example:

This example retrieves graphic representation of dimension line

MyDimLine drawing dimension.

odimLineGraphRep = MyDimLine.DimLineGraphRep

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DimLineOrientation() As CatDimOrientation

Returns or orientation of dimension line.

Example:

This example retrieves orientation of dimension line MyDimLine drawing

dimension.

odimLineOrient = MyDimLine.DimLineOrientation

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DimLineReference() As CatDimReference

Returns or reference of dimension line.

Example:

This example retrieves reference of dimension line MyDimLine drawing

dimension.

odimLineRef = MyDimLine.DimLineReference

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DimLineRep() As CatDimLineRep (Read Only)

Returns or representation of dimension line.

Example:

This example retrieves representation of dimension line MyDimLine

drawing dimension.

odimLineRep = MyDimLine.DimLineRep

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DimLineType() As long (Read Only)

Returns type of dimension line.

Example:

This example retrieves type of dimension line MyDimLine drawing

dimension.

odimLineType = MyDimLine.DimLineType

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetDimLineDir(double oDirX,

double oDirY)

Returns direction of a dimension line in case of a catDimUserDefined

representation mode. To retrieve the representation mode:

DrawingDimLine.get_DimLineRep.

Parameters:

oDirX,oDirY

The components of the direction vector

Example:

This example retrieves the direction vector of a dimension line

MyDimLine drawing dimension.

MyDimLine.GetDimLineDir oDirX, oDirY

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetGeomInfo(CATSafeArrayVariant oGeomInfos)

Get geometrical information of dimension line.

Parameters:

oGeomInfos

geometrical information.

Example:

This example gets geometrical information of MyDimLine

path.

MyDimLine.GetGeomInfo(oGeomInfos)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetSymbColor(long Index) As long

Get symbol color of dimension line.

Parameters:

Index

1:first symbol 2:second symbol 3:leader symbol

oColorSymb

symbol color.

Example:

This example gets symbol color of MyDimLine path.

ColorSymb = MyDimLine.GetSymbColor(Index)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetSymbThickness(long Index) As double

Get symbol thickness of dimension line.

Parameters:

Index

1:first symbol 2:second symbol 3:leader symbol

oThickSymb

symbol thickness.

Example:

This example gets symbol thickness of MyDimLine

path.

ThickSymb = MyDimLine.GetSymbThickness(Index)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetSymbType(long Index) As CatDimSymbols

Get symbol type of dimension line.

Parameters:

Index

1:first symbol 2:second symbol 3:leader symbol

oTypeSymb

symbol type.

Example:

This example gets symbol type of MyDimLine path.

typeSymb = MyDimLine.GetSymbType(Index)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetSymbColor(long Index,

long iColorSymb)

Set symbol color of dimension line.

Parameters:

Index

1:first symbol 2:second symbol 3:leader symbol

oColorSymb

symbol color.

Example:

This example sets symbol color of MyDimLine path.

MyDimLine.SetSymbColor(Index, iColorSymb)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetSymbThickness(long Index,

double iThickSymb)

Set symbol thickness of dimension line.

Parameters:

Index

1:first symbol 2:second symbol 3:leader symbol

oThickSymb

symbol thickness.

Example:

This example sets symbol thickness of MyDimLine

path.

MyDimLine.GetSymbThickness(Index, iThickSymb)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetSymbType(long Index,

CatDimSymbols iSymbType)

Set symbol type of dimension line.

Parameters:

Index

1:first symbol 2:second symbol 3:leader symbol

iSymbType

symbol type.

Example:

This example sets symbol type of MyDimLine path.

MyDimLine.SetSymbType(Index, iSymbType)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Thickness() As double

Returns or sets thickness of dimension line.

Example:

This example retrieves thickness of dimension line MyDimLine drawing

dimension.

oThickDimLine = MyDimLine.Thickness

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ScoringMode() As CatDimScore

Get dimension scoring mode.

Example:

This example gets dimension scoring mode of MyValue path.

ValueScoreType = MyValue.ScoringMode

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Value() As double (Read Only)

Returns value of dimension.

Example:

This example retrieves value of dimension MyDimValue drawing

dimension.

oValue = MyDimValue.Value

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ValueFramedElement() As CatDimFramedElement

Get dimension framed element.

Example:

This example gets dimension framed element of MyValue

path.

ValueFramedElement = MyValue.ValueFramedElement

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ValueFramedGroup() As CatDimFramedGroup

Returns or sets dimension framed group.

Example:

This example retrieves dimension framed group MyDimValue drawing

dimension.

oValueFramedGroup = MyDimValue.FakeDimType

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property CumulateMode() As boolean (Read Only)

Returns cumulate mode or not.

Example:

This example retrieves cumulate mode or not MyDimension drawing

dimension.

oCumulateMode = MyDimension.CumulateMode

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DimStatus() As CatDimAnalyse (Read Only)

Returns or sets status of dimension.

Example:

This example retrieves status of dimension MyDimension drawing

dimension.

oIsStatus = MyDimension.DimStatus

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DimType() As CatDimType (Read Only)

Returns dimension type.

Example:

This example retrieves the dimension type MyDimension drawing

dimension.

oTypeDim = MyDimension.DimType

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DualValue() As CatDimDualDisplay

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Forshortened() As boolean

Returns or sets foreshortened mode or not.

Example:

This example retrieves foreshortened mode or not MyDimension drawing

dimension.

oForsh = MyDimension.Forshortened

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetBoundaryBox(CATSafeArrayVariant 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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetClip(double X,

double Y,

long 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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetDimExtLine() As DrawingDimExtLine

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetDimLine() As DrawingDimLine

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub GetTolerances(long oTolType,

CATBSTR oTolName,

CATBSTR oUpTol,

CATBSTR oLowTol,

double odUpTol,

double odLowTol,

long oDisplayMode)

Get tolerance information 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 information of MyDimension

path.

MyDimension.GetTolerances(oTolType, oTolName, oUpTol, oLowTol,

odUpTol, odLowTol, oDisplayMode)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetValue() As DrawingDimValue

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property HalfDimMode() As boolean

Returns or sets half dimension mode or not.

Example:

This example retrieves half dimension mode or not MyDimension drawing

dimension.

oHalfDimMode = MyDimension.HalfDimMode

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property IsClipped() As boolean (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.

myDimensionClippingStatus=MyDimension.IsClipped

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub MoveValue(double X,

double Y,

long SubPart,

long 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.

-1 = Value (vertical move is take account according ptPos coordinates)

0 = Both dimension line and value

1 = Value

2 = Dimension line

3 = Secondary part

4 = Secondary part and value

5 = Secondary part and dimension line

6 = Secondary part, dimension line and value

7 = Value leader (for dimension line with leader one part or two parts)

DimAngleBehavior

Defines angle dimension line behavior.

0 = Sector angle is switched when ptPos is in opposite sector (Default)

1 = Sector angle is kept what ever ptPos placement

Example:

This example move dimension value MyDimension

path.

MyDimension.MoveValue(X, Y, SubPart,

DimAngleBehavior)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property NbExtLine() As long (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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property NbSymb() As long (Read Only)

Returns numbers of symbol of dimension.

Example:

This example retrieves numbers of symbol of dimension MyDimension

drawing dimension.

oNbSymb = MyDimension.NbSymb

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Parameters() As Parameters (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”)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub RestoreValuePosition()

Restore dimension value position.

Example:

This example gets Restore dimension value position of MyDimension

path.

MyDimension.RestoreValuePosition()

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetClip(double X,

double Y,

long 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)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetTolerances(long iTolType,

CATBSTR itolName,

CATBSTR iUpTol,

CATBSTR iLowTol,

double idUpTol,

double idLowTol,

long DisplayMode)

Set tolerance information 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 information of MyDimension

path.

MyDimension.SetTolerances(iTolType, itolName, iUpTol, iLowTol,

idUpTol, idLowTol, DisplayMode)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property SymbolsSide() As long

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 outside, second symbol inside.

Example:

This example retrieves symbol side of dimension line MyDimension

drawing dimension.

oSymbSide = MyDimension.SymbolsSide

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TrueDimMode() As boolean (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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Unclip()

Unclip the dimension if it is clipped.

Example:

This example unclip MyDimension path.

if MyDimension.IsClipped then

MyDimension.Unclip

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ValueAngle() As double

Returns or sets angle of dimension value.

Example:

This example retrieves angle of dimension value MyDimension drawing

dimension.

oValueAng = MyDimension.ValueAngle

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ValueAutoMode() As long

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ValueDisplay() As long

Returns or sets display of dimension value state.

Example:

This example retrieves display of dimension value state MyDimension

drawing dimension.

oValueDisplay = MyDimension.ValueDisplay

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ValueFrame() As CatDimFrame

Returns or sets frame type of dimension value.

Example:

This example retrieves frame type of dimension value MyDimension

drawing dimension.

oValueFrame = MyDimension.ValueFrame

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ValueInOut() As long

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

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ValueOrientation() As CatDimOrientation

Returns or sets orientation of dimension value.

Example:

This example retrieves orientation of dimension value MyDimension

drawing dimension.

oValueOrient = MyDimension.ValueOrientation

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ValueReference() As CatDimReference

Returns or sets reference of dimension value.

Example:

This example retrieves reference of dimension value MyDimension drawing

dimension.

oValueRef = MyDimension.ValueReference

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add(CatDimType iTypeDim,

CATSafeArrayVariant iGeomElem,

CATSafeArrayVariant iPtCoordElem,

CatDimLineRep iLineRep) As DrawingDimension

Creates a drawing dimension and adds it to the DrawingDimensions

collection.

Parameters:

iTypeDim

Dimension type

iGeomElem

Parent geometrical element(s) of dimension

iPtCoordElem

Array of pointers on the selection points of each element of

iGeomElem

iLineRep

Basic representation mode

Returns:

The created drawing dimension

Example:

The following example creates a drawing angle dimension between two lines

and a partial curvilinear length dimension on an ellipse and retrieved in

MyDimension1 and MyDimension2 in the drawing view collection of the MyView

drawing view. This view belongs to the drawing view collection of the drawing

sheet

Dim MyView As DrawingView

Set MyView = MySheet.Views.ActiveView

Dim Fact2D As Factory2D

Set Fact2D = MyView.Factory2D

Dim Line1 As Line2D

Dim Line2 As Line2D

Set Line1 = Fact2D.CreateLine(50, 10, 150, 10)

Set Line2 = Fact2D.CreateLine(50, 10, 120, 100)

Dim Ellipse1 As Ellipse2D

Set Ellipse1 = Fact2D.CreateEllipse(-40, 100, 120, 180,120,90,0, 3)

Dim Point1 As Point2D

Dim Point2 As Point2D

Set Point1 = Fact2D.CreatePoint(-10,190)

Set Point2 = Fact2D.CreatePoint(-120,90)

Dim iType As catDimType

iType = catDimAngle

Dim myElements1(1)

myElements1(1) = Array(Line1,Line2)

Dim selpoints(3)

selpoints(3) = Array(150, 10, 120, 100)

Dim MyDimension1 As DrawingDimension

Set MyDimension1 = MyView.Dimensions.Add(iType, myElements1(1), selpoints(3),catDimAuto)

iType = catDimLengthCurvilinear

Dim myElements2(2)

myElements2(2) = Array(Point1,Point2,Ellipse1)

selpoints(3) = Array(0, 0, 0, 0)

Dim MyDimension2 As DrawingDimension

Set MyDimension2 = MyView.Dimensions.Add(iType, myElements2(1), selpoints(3),catDimOffset)