All Frameworks  Object Hierarchy  This Framework  Indexes   

SchArrowDisplay (Object)

Manage the graphical representation of a schematic route.

Method Index

IsArrowShown
Query whether flow arrows are shown (arrow attributes exist).
SetArrow
Add arrow display attributes on the route.
UnsetArrow
Remove arrow display attributes on the route.

Methods


o Sub IsArrowShown( oBYes)
Query whether flow arrows are shown (arrow attributes exist).
Parameters:
oBYes
If TRUE, then Flow arrows are shown (arrow attributes exist). If FALSE, then Flow arrows are not shown (arrow attributes do not exist).
Example:
 Dim objThisIntf As SchArrowDisplay
 Dim bVar1 As boolean
  ...
 objThisIntf.IsArrowShownbVar1
 
o Sub SetArrow( iGRR,
iSegNum)
Add arrow display attributes on the route.
Parameters:
iGRR
iGRR means apply only to segments of iGRR. (if iGRR = NULL, apply to segments of all GRR's of the route, and ignore iSegNum)
iSegNum
iSegNum = 0 means apply to all segments of iGRR. iSegnum > 0 means apply to only to segment number iSegNum iGRR.
Example:
 Dim objThisIntf As SchArrowDisplay
 Dim objArg1 As SchGRRRoute
 Dim intVar2 As Integer
  ...
 objThisIntf.SetArrowobjArg1,intVar2
 
o Sub UnsetArrow( iGRR,
iSegNum)
Remove arrow display attributes on the route.
Parameters:
iGRR
iGRR means apply only to segments of iGRR. (if iGRR = NULL, apply to segments of all GRR's of the route, and ignore iSegNum)
iSegNum
iSegNum = 0 means apply to all segments of iGRR. iSegnum > 0 means apply to only to segment number iSegNum iGRR.
Example:
 Dim objThisIntf As SchArrowDisplay
 Dim objArg1 As SchGRRRoute
 Dim intVar2 As Integer
  ...
 objThisIntf.UnsetArrowobjArg1,intVar2
 

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