CogStaticGraphicsContainer.AddList Method

CogStaticGraphicsContainer AddList Method

Cognex VisionPro 9.25 SR1

Adds a list of static graphics 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 AddList(
	CogGraphicCollection graphics,
	string groupName
)

public virtual void AddList(
	CogGraphicCollection graphics,
	string groupName
)

Public Overridable Sub AddList ( 
	graphics As CogGraphicCollection,
	groupName As String
)

Public Overridable Sub AddList ( 
	graphics As CogGraphicCollection,
	groupName As String
)

public:
virtual void AddList(
	CogGraphicCollection^ graphics, 
	String^ groupName
)

public:
virtual void AddList(
	CogGraphicCollection^ graphics, 
	String^ groupName
)

Parameters

graphics: Type: Cognex.VisionPro CogGraphicCollection
The list of static graphics to add to the display.

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

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 objects in the list cannot be changed.

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.

Examples