All Frameworks  Object Hierarchy  This Framework  Indexes  Previous Next

DrawingArrow (Object)

Represents a drawing arrow in a drawing view.

Property Index

HeadSymbol
Returns or sets symbol type of head side.
HeadTarget
Returns or sets target element of head side.
NbInterruption
Returns the number of interruptions of arrow path.
NbPoint
Returns the number of points of arrow path.
TailSymbol
Returns or sets symbol type of tail side.
TailTarget
Returns or sets target element of tail side.

Method Index

AddInterruption
Add an interruption to an arrow.
AddPoint
Add a point to an arrow.
GetInterruptions
Get arrow path.
GetPoint
Get arrow point coordinates.
GetPoints
Get arrow path.
ModifyPoint
Modify a point of an Arrow.
RemoveInterruption
Remove an interruption to an arrow.
RemovePoint
Remove a point from an arrow.

Properties


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

Methods


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
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
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)
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)
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)
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 modifys a point to MyArrow. 
 iNum = 1
 iX = -10.
 iY = -20.
 MyArrow.ModifyPoint iNum, iX, iY
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
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

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