CogGeneralContour.HighlightIndex Property

CogGeneralContour HighlightIndex Property

Cognex VisionPro

Get or set the index of the segment to be highlighted. If set to -1, no segment highlighting will occur.

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 65.1.0.0

Syntax

public virtual int HighlightIndex { get; set; }

public virtual int HighlightIndex { get; set; }

Public Overridable Property HighlightIndex As Integer 
	Get 
	Set

Public Overridable Property HighlightIndex As Integer 
	Get 
	Set

public:
virtual property int HighlightIndex {
	int get ();
	void set (int value);
}

public:
virtual property int HighlightIndex {
	int get ();
	void set (int value);
}

Type: Int32
The index of the segment to be highlighted.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	If you attempt to set HighlightIndex to a value less than -1.