MaskedTextProvider.FindAssignedEditPositionInRange(Int32, Int32, Boolean) Method

Definition

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

public:
 int FindAssignedEditPositionInRange(int startPosition, int endPosition, bool direction);
public int FindAssignedEditPositionInRange (int startPosition, int endPosition, bool direction);
member this.FindAssignedEditPositionInRange : int * int * bool -> int
Public Function FindAssignedEditPositionInRange (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 assigned 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 FindAssignedEditPositionInRange method is used to search for the first assigned character between two specified positions, inclusive, using the specified search direction. The result can subsequently be passed as a parameter to the Item[Int32] indexer to obtain the assigned value at this position.

The FindNonEditPositionInRange and FindUnassignedEditPositionInRange methods are complements of this method.

Applies to

See also