CogOCVMaxPattern.CreateLineIterator Method (Int32, Int32)

CogOCVMaxPattern CreateLineIterator Method (Int32, Int32)

Cognex VisionPro 9.5

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

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

Syntax

C++

Copy to Clipboard Print

public CogOCVMaxLineIterator CreateLineIterator(
	int paragraphPosition,
	int linePosition
)

public CogOCVMaxLineIterator CreateLineIterator(
	int paragraphPosition,
	int linePosition
)

Public Function CreateLineIterator ( 
	paragraphPosition As Integer,
	linePosition As Integer
) As CogOCVMaxLineIterator

Public Function CreateLineIterator ( 
	paragraphPosition As Integer,
	linePosition As Integer
) As CogOCVMaxLineIterator

public:
CogOCVMaxLineIterator^ CreateLineIterator(
	int paragraphPosition, 
	int linePosition
)

public:
CogOCVMaxLineIterator^ CreateLineIterator(
	int paragraphPosition, 
	int linePosition
)

Parameters

paragraphPosition: Type: System Int32
A zero-based index that specifies the paragraph.

linePosition: Type: System Int32
A zero-based index that specifies the line. The special value -1 is interpreted to mean the end of the paragraph.

Return Value

Type: CogOCVMaxLineIterator
A line iterator that corresponds to the specified line.

Exceptions

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

Remarks

It is legal to call this method with the index of a paragraph that contains no lines and with a linePosition 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.