MaskedTextProvider.FindUnassignedEditPositionFrom Method (Int32, Boolean)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

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

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

public int FindUnassignedEditPositionFrom(
	int position,
	bool direction


Type: System.Int32

The zero-based position in the formatted string to start the search.

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 FindUnassignedEditPositionFrom method is used to search for the first unassigned character after a specified position and search direction. The prompt character should occupy this position.

The FindNonEditPositionFrom and FindAssignedEditPositionFrom methods are complements of this method.

.NET Framework
Available since 2.0
Return to top