MaskedTextProvider.FindUnassignedEditPositionInRange Method (Int32, Int32, Boolean)

 

Returns the position of the first unassigned editable position between the specified positions using the specified search direction.

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)

public int FindUnassignedEditPositionInRange(
	int startPosition,
	int endPosition,
	bool direction
)

Parameters

startPosition
Type: System.Int32

The zero-based position in the formatted string where the search starts.

endPosition
Type: System.Int32

The zero-based position in the formatted string where the search ends.

direction
Type: System.Boolean

A Boolean indicating the search direction; either true to search forward or false to search backward.

Return Value

Type: System.Int32

If successful, an Int32 representing the zero-based position of the first unassigned editable position encountered; otherwise InvalidIndex.

The formatted string is composed of editable characters and literals copied from the mask. The editable character positions will either be occupied by the prompt character copied from the mask if they are unassigned, or with a valid input character if they have been assigned an input.

The FindUnassignedEditPositionInRange method is used to search for the first unassigned character between two specified positions, inclusive, using the specified search direction. The prompt character should occupy this position.

The FindNonEditPositionInRange and FindAssignedEditPositionInRange methods are complements of this method.

.NET Framework
Available since 2.0
Return to top
Show: