CogOCVMaxPattern.AddText Method (String, CogOCVMaxParagraphIterator)

CogOCVMaxPattern AddText Method (String, CogOCVMaxParagraphIterator)

Cognex VisionPro 9.8 SR1

Creates a new paragraph and inserts it in the arrangement at the position specified by the paragraph iterator.

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

Syntax

public void AddText(
	string srcText,
	CogOCVMaxParagraphIterator pNext
)

public void AddText(
	string srcText,
	CogOCVMaxParagraphIterator pNext
)

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

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

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

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

srcText: Type: System String
A single string corresponding to the single line in the new paragraph. 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 CogOCVMaxParagraphIterator
A CogOCVMaxParagraphIterator which specifies where in the current arrangement the new paragraph should be inserted. May not be NULL.

Events

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

Exceptions

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

Remarks

This new paragraph has a single line as supplied by srcText. An empty string (length zero) is interpreted as a blank line.