CogInteractiveGraphicsContainer.AddList Method

CogInteractiveGraphicsContainer AddList Method

Cognex VisionPro 9.24

Adds a list of interactive graphics to the display.

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

Syntax

C++

Copy to Clipboard Print

public virtual void AddList(
	CogGraphicInteractiveCollection graphics,
	string groupName,
	bool checkForDuplicates
)

public virtual void AddList(
	CogGraphicInteractiveCollection graphics,
	string groupName,
	bool checkForDuplicates
)

Public Overridable Sub AddList ( 
	graphics As CogGraphicInteractiveCollection,
	groupName As String,
	checkForDuplicates As Boolean
)

Public Overridable Sub AddList ( 
	graphics As CogGraphicInteractiveCollection,
	groupName As String,
	checkForDuplicates As Boolean
)

public:
virtual void AddList(
	CogGraphicInteractiveCollection^ graphics, 
	String^ groupName, 
	bool checkForDuplicates
)

public:
virtual void AddList(
	CogGraphicInteractiveCollection^ graphics, 
	String^ groupName, 
	bool checkForDuplicates
)

Parameters

graphics: Type: Cognex.VisionPro CogGraphicInteractiveCollection
The list of interactive graphics to add to the display.

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

checkForDuplicates: Type: System Boolean
If true checks whether graphics 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 location properties and SelectedSpaceName of each graphic in the list determine where it is drawn.

If the display control cannot resolve a 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