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

C++

Copy to Clipboard Print

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(
	array<String^>^ srcText, 
	CogOCVMaxParagraphIterator^ pNext
)

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

Parameters

srcText: Type: System String
An array of strings, each of which corresponds to a 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.
ObjectDisposedException	If this CogOCVMaxPattern object has already been disposed.
InvalidOperationException	If the paragraph iterator does not specify a valid position.
ArgumentNullException	If pNext argument is NULL.

Remarks

Each string in srcText array of strings corresponds to an individual line in this new paragraph. An empty string (length zero) is interpreted as a blank line.