All Frameworks  Object Hierarchy  This Framework  Indexes

DrawingLeader (Object)

Represents a drawing leader in a drawing view.

Property Index

AllAround
Returns or sets the status of all around.
AnchorPoint
Returns or sets anchor point.
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 leader path.
NbPoint
Returns the number of points of leader path.

Method Index

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

Properties


o Property AllAround() As
Returns or sets the status of all around.
Example:
This example retrieves the status of all around on MyLeader drawing leader. 
 oSymbol = MyLeader.AllAround
o Property AnchorPoint() As
Returns or sets anchor point.
Example:
This example retrieves the anchor point on MyLeader drawing leader. 
 oAnchorPoint = MyLeader.AnchorPoint
o Property HeadSymbol() As
Returns or sets symbol type of head side.
Example:
This example retrieves the symbol type of head side on MyLeader drawing leader. 
 oSymbol = MyLeader.HeadSymbol
o Property HeadTarget() As
Returns or sets target element of head side.
Example:
This example retrieves the target element of head side on MyLeader drawing leader. 
 oTarget = MyLeader.HeadTarget
o Property NbInterruption() As (Read Only)
Returns the number of interruptions of leader path.
Example:
This example retrieves the number of interruptions on MyLeader drawing leader. 
 oNbInterruption = MyLeader.NbInterruption
o Property NbPoint() As (Read Only)
Returns the number of points of leader path.
Example:
This example retrieves the number of points on MyLeader drawing leader. 
 oNbPoint = MyLeader.NbPoint

Methods


o Sub AddInterruption( iFirstPointX,
iFirstPointY,
iSecondPointX,
iSecondPointY)
Add an interruption to an leader.
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 MyLeader. 
 iFirstPointX = 10.
 iFirstPointY = 20.
 iSecondPointX = 20.
 iSecondPointY = 20.
 MyLeader.AddInterruption iFirstPointX, iFirstPointY, iSecondPointX, iSecondPointY
o Sub AddPoint( iNum,
iX,
iY)
Add a point to an leader.
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 MyLeader. 
 iNum = 1
 iX = 10.
 iY = 20.
 MyLeader.AddPoint iNum, iX, iY
o Func GetInterruptions( oInterruptions) As
Get leader path.
Parameters:
oInterruptions
List of interruptions coordinates (X1,Y1,X2,Y2,.....Xn,Yn).
Returns:
oNbInterruptions Number of interruptions.
Example:
This example gets interruptions of MyLeader path. 
 oNbInterruptions = MyLeader.GetInterruptions(oInterruptions)
o Sub GetPoint( iNum,
oX,
oY)
Get leader point coordinates.
Parameters:
iNum
Point number.
oX
X coordinates of point.
oY
Y coordinates of point.
Example:
This example gets a point to MyLeader. 
 iNum = 1
 MyLeader.GetPoint(iNum, oX, oY)
o Func GetPoints( oPoints) As
Get leader path.
Parameters:
oPoints
List of points coordinates (X1,Y1,X2,Y2,.....Xn,Yn).
Returns:
oNbPoints Number of points.
Example:
This example gets points of MyLeader path. 
 oNbPoints = MyLeader.GetPoints(oPoints)
o Sub ModifyPoint( iNum,
iX,
iY)
Modify a point of an leader.
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 MyLeader. 
 iNum = 1
 iX = -10.
 iY = -20.
 MyLeader.ModifyPoint iNum, iX, iY
o Sub RemoveInterruption( iNum)
Remove an interruption to an leader.
Parameters:
iNum
Interruption number to delete.
- If iNum equals to 0, all interruptions will be removed.
Example:
This example removes an interruption from MyLeader. 
 iNum = 2
 MyLeader.RemoveInterruption iNum
o Sub RemovePoint( iNum)
Remove a point from an leader.
Parameters:
iNum
Point number to delete.
Example:
This example removes a point from MyLeader. 
 iNum = 2
 MyLeader.RemovePoint iNum

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