Edit

Share via


MaskedTextProvider.FindAssignedEditPositionFrom(Int32, Boolean) Method

Definition

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

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

Parameters

position
Int32

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

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 FindAssignedEditPositionFrom method is used to search for the first assigned character after a specified position and search direction. The result can subsequently be passed as a parameter to the Item[] indexer to obtain the assigned value at this position.

The FindNonEditPositionFrom and FindUnassignedEditPositionFrom methods are complements of this method.

Applies to

See also