CogInteractiveGraphicsContainer.Add Method

CogInteractiveGraphicsContainer Add Method

Cognex VisionPro 9.25 SR1

Adds an interactive graphic to the display.

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

Syntax

C++

Copy to Clipboard Print

public virtual void Add(
	ICogGraphicInteractive graphic,
	string groupName,
	bool checkForDuplicates
)

public virtual void Add(
	ICogGraphicInteractive graphic,
	string groupName,
	bool checkForDuplicates
)

Public Overridable Sub Add ( 
	graphic As ICogGraphicInteractive,
	groupName As String,
	checkForDuplicates As Boolean
)

Public Overridable Sub Add ( 
	graphic As ICogGraphicInteractive,
	groupName As String,
	checkForDuplicates As Boolean
)

public:
virtual void Add(
	ICogGraphicInteractive^ graphic, 
	String^ groupName, 
	bool checkForDuplicates
)

public:
virtual void Add(
	ICogGraphicInteractive^ graphic, 
	String^ groupName, 
	bool checkForDuplicates
)

Parameters

graphic: Type: Cognex.VisionPro ICogGraphicInteractive
The interactive graphic to add to the display.

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

checkForDuplicates: Type: System Boolean
If true checks whether graphic is already in the display container.

Exceptions

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

Remarks

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