CogStaticGraphicsContainer.Add Method

CogStaticGraphicsContainer Add Method

Cognex VisionPro 9.22

Adds a static graphic to the display.

Namespace: Cognex.VisionPro.Display
Assembly: Cognex.VisionPro.Display.Controls (in Cognex.VisionPro.Display.Controls.dll) Version: 87.0.0.0 (87.0.0.0)

Syntax

C++

Copy to Clipboard Print

public virtual void Add(
	ICogGraphic graphic,
	string groupName
)

public virtual void Add(
	ICogGraphic graphic,
	string groupName
)

Public Overridable Sub Add ( 
	graphic As ICogGraphic,
	groupName As String
)

Public Overridable Sub Add ( 
	graphic As ICogGraphic,
	groupName As String
)

public:
virtual void Add(
	ICogGraphic^ graphic, 
	String^ groupName
)

public:
virtual void Add(
	ICogGraphic^ graphic, 
	String^ groupName
)

Parameters

graphic: Type: Cognex.VisionPro ICogGraphic
The static graphic to add to the display.

groupName: Type: System String
The name of the graphics group to which to add graphic.

Exceptions

Exception	Condition
ObjectDisposedException	Thrown when the object is already disposed.
CogException	Thrown when any of the arguments are invalid.

Remarks

Once added to the static graphics container, the graphics object cannot be changed.

The graphic object's location properties and its SelectedSpaceName determine where the graphic is drawn.

If the display control cannot resolve the graphic's selected space name (as described in GetTransform(String, String)) then the graphic is added without error to the LostAndFound collection until its space name is resolvable.

Set checkForDuplicates to false for better performance. However, if you add the same graphic to this container more than once, the behavior is undefined and errors may occur.

Examples