CogOCVMaxPattern.CreateCharacterIterator Method (Int32, Int32, Int32)

CogOCVMaxPattern CreateCharacterIterator Method (Int32, Int32, Int32)

Cognex VisionPro

Creates a character iterator corresponding to the specified character in the specified line in the specified paragraph of the arrangement.

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

Syntax

C++

Copy to Clipboard Print

public CogOCVMaxCharacterIterator CreateCharacterIterator(
	int paragraphPosition,
	int linePosition,
	int characterPosition
)

public CogOCVMaxCharacterIterator CreateCharacterIterator(
	int paragraphPosition,
	int linePosition,
	int characterPosition
)

Public Function CreateCharacterIterator ( 
	paragraphPosition As Integer,
	linePosition As Integer,
	characterPosition As Integer
) As CogOCVMaxCharacterIterator

Public Function CreateCharacterIterator ( 
	paragraphPosition As Integer,
	linePosition As Integer,
	characterPosition As Integer
) As CogOCVMaxCharacterIterator

public:
CogOCVMaxCharacterIterator^ CreateCharacterIterator(
	int paragraphPosition, 
	int linePosition, 
	int characterPosition
)

public:
CogOCVMaxCharacterIterator^ CreateCharacterIterator(
	int paragraphPosition, 
	int linePosition, 
	int characterPosition
)

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.

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

Return Value

Type: CogOCVMaxCharacterIterator
A character iterator that corresponds to the specified character.

Exceptions

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

Remarks

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