CogOCVMaxPattern.AddText Method (String, CogOCVMaxLineIterator)

CogOCVMaxPattern AddText Method (String, CogOCVMaxLineIterator)

Cognex VisionPro 9.25 SR1

Creates a new line and inserts it at the line position specified by the line iterator.

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

Syntax

public void AddText(
	string srcText,
	CogOCVMaxLineIterator pNext
)

public void AddText(
	string srcText,
	CogOCVMaxLineIterator pNext
)

Public Sub AddText ( 
	srcText As String,
	pNext As CogOCVMaxLineIterator
)

Public Sub AddText ( 
	srcText As String,
	pNext As CogOCVMaxLineIterator
)

public:
void AddText(
	String^ srcText, 
	CogOCVMaxLineIterator^ pNext
)

public:
void AddText(
	String^ srcText, 
	CogOCVMaxLineIterator^ pNext
)

srcText: Type: System String
A single string corresponding to the single line to be inserted. May not be NULL. This assumes that the character keys in the associated font correspond to Unicode code point values.

pNext: Type: Cognex.VisionPro.OCVMax CogOCVMaxLineIterator
A CogOCVMaxLineIterator which specifies the line position at which the new line should be inserted. May not be NULL.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when the pattern object is modified.
CogOCVMaxPattern LineAdded	Fires when a line is added to the pattern object.

Exceptions

Exception	Condition
ArgumentNullException	If pNext argument is NULL.
ArgumentException	If the supplied line iterator does not reference this CogOCVMaxPattern object.
InvalidOperationException	If the line iterator does not specify a valid position.
ObjectDisposedException	If this CogOCVMaxPattern object has already been disposed.

Remarks

This new line contains characters specified by srcText. An empty string (length zero) is interpreted as a blank line.