CogOCVMaxPattern.CreateParagraphIterator Method (Int32)

CogOCVMaxPattern CreateParagraphIterator Method (Int32)

Cognex VisionPro 9.8 SR1

Creates a paragraph iterator that corresponds to the specified paragraph of the arrangement.

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 CogOCVMaxParagraphIterator CreateParagraphIterator(
	int paragraphPosition
)

public CogOCVMaxParagraphIterator CreateParagraphIterator(
	int paragraphPosition
)

Public Function CreateParagraphIterator ( 
	paragraphPosition As Integer
) As CogOCVMaxParagraphIterator

Public Function CreateParagraphIterator ( 
	paragraphPosition As Integer
) As CogOCVMaxParagraphIterator

public:
CogOCVMaxParagraphIterator^ CreateParagraphIterator(
	int paragraphPosition
)

public:
CogOCVMaxParagraphIterator^ CreateParagraphIterator(
	int paragraphPosition
)

Parameters

paragraphPosition: Type: System Int32
A System::Int32 zero-based index that specifies which paragraph. The special value -1 is interpreted to mean "at the end of this arrangement".

Return Value

Type: CogOCVMaxParagraphIterator
A paragraph iterator that corresponds to the specified paragraph.

Exceptions

Exception	Condition
ObjectDisposedException	If this CogOCVMaxPattern object has already been disposed.
ArgumentOutOfRangeException	If the suppled paragraphPosition argument does not reference a valid paragraph position.

Remarks

It is legal to call this method on a pattern that contains no paragraphs with a paragraphPosition argument of either 0 or -1. The IsInvalid, IsEnd, and IsFirst properties of the resulting iterator will all be True. Attempts to access any other property on this iterator will cause an exception to be thrown. This iterator may be supplied as an argument in a subsequent call to AddText.