All Frameworks  Object Hierarchy  This Framework  Indexes  Previous Next

SchCompGraphic (Object)

Manage the graphical representation of a schematic component.

Method Index

Activate
To add a new image to an existing object.
AddGraphicalRepresentation
Add a graphical representation to a component.
Deactivate
To remove an image to an existing object.
ListGraphicalImages
List all graphical images (instances of the rep) of a component.
ListGraphicalRepresentations
List all graphical representation of a component.
RemoveGraphicalRepresentation
Remove a graphical representation from a component.
SwitchAll
Replace all occurances of the images of this component with those of the graphical representation with the input name.
Switch
Replace the input image object with an image of the graphical representation with the input name.

Methods


o Sub Activate(CATBSTR iGRRName,
CATSafeArrayVariant iDb2WhereAt,
SchGRRComp oGRR)
To add a new image to an existing object. This new image is an instance of graphical representation with the input name.
Parameters:
iGRRName
The name of the graphic representation
iDb2WhereAt
The x-y coordinates of the image position. If NULL, the image will be positioned at the origin.
oGRR
Pointer to the new graphical image of the component.
Example: 
 Dim objThisIntf As SchCompGraphic
 Dim strVar1 As String
 Dim dbVar2(2) As CATSafeArrayVariant
 Dim objArg3 As SchGRRComp
  ...
 objThisIntf.ActivatestrVar1,dbVar2,objArg3
o Sub AddGraphicalRepresentation(SchGRRComp iGRRToAdd)
Add a graphical representation to a component.
Parameters:
iGRRToAdd
The graphical representation to be added to the component.
Example: 
 Dim objThisIntf As SchCompGraphic
 Dim objArg1 As SchGRRComp
  ...
 objThisIntf.AddGraphicalRepresentationobjArg1
o Sub Deactivate(SchGRRComp iGRR)
To remove an image to an existing object.
Parameters:
iGRR
The graphical image to be removed from the component.
iDb2WhereAt
The x-y coordinates of the image position. If NULL, the image will be positioned at the origin.
Example: 
 Dim objThisIntf As SchCompGraphic
 Dim objArg1 As SchGRRComp
  ...
 objThisIntf.DeactivateobjArg1
o Func ListGraphicalImages() As SchListOfObjects
List all graphical images (instances of the rep) of a component.
Parameters:
oLGRR
A list of graphical images (members are CATISchGRRComp interface pointers).
Example: 
 Dim objThisIntf As SchCompGraphic
 Dim objArg1 As SchListOfObjects
  ...
 Set objArg1 = objThisIntf.ListGraphicalImages
o Func ListGraphicalRepresentations() As SchListOfObjects
List all graphical representation of a component.
Parameters:
oLGRR
A list of graphical representations (members are CATISchGRRComp interface pointers).
Example: 
 Dim objThisIntf As SchCompGraphic
 Dim objArg1 As SchListOfObjects
  ...
 Set objArg1 = objThisIntf.ListGraphicalRepresentations
o Sub RemoveGraphicalRepresentation(SchGRRComp iGRRToRemove)
Remove a graphical representation from a component.
Parameters:
iGRRToRemove
The graphical representation to be removed from the component.
Example: 
 Dim objThisIntf As SchCompGraphic
 Dim objArg1 As SchGRRComp
  ...
 objThisIntf.RemoveGraphicalRepresentationobjArg1
o Sub SwitchAll(CATBSTR iGRRName)
Replace all occurances of the images of this component with those of the graphical representation with the input name.
Parameters:
iGRRName
The name of the graphical representation
Example: 
 Dim objThisIntf As SchCompGraphic
 Dim strVar1 As String
  ...
 objThisIntf.SwitchAllstrVar1
o Sub Switch(SchGRRComp iGRR,
CATBSTR iGRRName,
SchGRRComp oGRR)
Replace the input image object with an image of the graphical representation with the input name.
Parameters:
iGRR
Pointer to the component graphical image to be switched.
oGRR
Pointer to the new graphical image of the component.
Example: 
 Dim objThisIntf As SchCompGraphic
 Dim objArg1 As SchGRRComp
 Dim strVar2 As String
 Dim objArg3 As SchGRRComp
  ...
 objThisIntf.SwitchobjArg1,strVar2,objArg3

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