ApplyMask Method (XamMaskedInput)

Applies the specified mask to the specified text and returns the result.

Syntax

Visual Basic

'Declaration
 
Public Shared Function ApplyMask( _
   ByVal text As String, _
   ByVal mask As String, _
   ByVal formatProvider As IFormatProvider, _
   ByVal promptCharacter As Char, _
   ByVal padCharacter As Char, _
   ByVal maskMode As InputMaskMode _
) As String

C#

public static string ApplyMask( 
   string text,
   string mask,
   IFormatProvider formatProvider,
   char promptCharacter,
   char padCharacter,
   InputMaskMode maskMode
)

Parameters

text

Text to apply the mask to.

mask

The mask to apply.

formatProvider

Provides culture specific symbols in the mask. This may not be applicable to all masks - only the masks that have characters (like currency symbol) that need to be represented by culture specific version of the symbol.

promptCharacter

The prompt character - only applicable with certain mask modes.

padCharacter

The pad character - only applicable with certain mask modes.

maskMode

Specifies the mask mode.

Return Value

The result of applying the specified mask to the specified text.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2