CogOCVMaxRunParams.SetKeyset Method (Int32, Int32, Int32, String)

CogOCVMaxRunParams SetKeyset Method (Int32, Int32, Int32, String)

Cognex VisionPro

Sets the key set for the specified character position within the specified line within the specified paragraph.

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 void SetKeyset(
	int paragraphPosition,
	int linePosition,
	int characterPosition,
	string NewValue
)

public void SetKeyset(
	int paragraphPosition,
	int linePosition,
	int characterPosition,
	string NewValue
)

Public Sub SetKeyset ( 
	paragraphPosition As Integer,
	linePosition As Integer,
	characterPosition As Integer,
	NewValue As String
)

Public Sub SetKeyset ( 
	paragraphPosition As Integer,
	linePosition As Integer,
	characterPosition As Integer,
	NewValue As String
)

public:
void SetKeyset(
	int paragraphPosition, 
	int linePosition, 
	int characterPosition, 
	String^ NewValue
)

public:
void SetKeyset(
	int paragraphPosition, 
	int linePosition, 
	int characterPosition, 
	String^ NewValue
)

Parameters

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

linePosition: Type: System Int32
A zero-based index that specifies the position of the line of interest within the paragraph of interest.

characterPosition: Type: System Int32
A zero-based index that specifies the position of the character of interest within the line of interest within the paragraph of interest.

NewValue: Type: System String
A string in which each character corresponds to a member of the key set for this position.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this method changes the subject key set.

Exceptions

Exception	Condition
ArgumentOutOfRangeException	If the linePosition argument is less than zero or greater than or equal to the number of lines in the specified paragraph as described in this CogOCVMaxRunParams object.
ObjectDisposedException	If this CogOCVMaxRunParams object has already been disposed.

Remarks

The key values are passed in the NewValue string. Each character in this string is the key value of a character that may occur at the specified position. Note that this method assumes tht the character keys in this font correspond to Unicode code point values.