MaskedTextProvider.Add Method (String)

Adds the characters in the specified input string to the end of the formatted string.

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

public bool Add(
	string input
)

Parameters

input
Type: System.String

A String containing character values to be appended to the formatted string.

Return Value

Type: System.Boolean
true if all the characters from the input string were added successfully; otherwise false to indicate that no characters were added.

ExceptionCondition
ArgumentNullException

The input parameter is null.

The Add(String) method adds the characters from the input string to the formatted string, starting with the first available position after LastAssignedPosition. This method will fail for any of the following reasons:

  • Any of the characters in the input value, input, are not printable, or the input value does not match its corresponding mask element.

  • There are not enough available edit positions in the formatted string after the last assigned position.

If this method fails, no additions are made and the method returns false.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft