MaskedTextProvider.FindUnassignedEditPositionInRange Method

Definition

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

public:
 int FindUnassignedEditPositionInRange(int startPosition, int endPosition, bool direction);
public int FindUnassignedEditPositionInRange (int startPosition, int endPosition, bool direction);
member this.FindUnassignedEditPositionInRange : int * int * bool -> int
Public Function FindUnassignedEditPositionInRange (startPosition As Integer, endPosition As Integer, direction As Boolean) As Integer

Parameters

startPosition
Int32

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

endPosition
Int32

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

direction
Boolean

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

Returns

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

Remarks

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.

Applies to

See also