CustomTextMaskInputArgs.Cancel() Method

Cancels an edit a user attempts to perform.

Namespace: DevExpress.Data.Mask

Assembly: DevExpress.Data.v23.2.dll

NuGet Package: DevExpress.Data

Declaration

C#

public void Cancel()

VB.NET

Public Sub Cancel

Remarks

The Cancel method cannot be called if the ActionType returns “Init”.

The code sample below illustrates how to limit the maximum number of characters to 5.

C#

protected override void ProcessCustomTextMaskInput(CustomTextMaskInputArgs args) {
    if (args.IsCanceled || args.ResultEditText.Length < args.CurrentEditText.Length ||
        args.ActionType == CustomTextMaskInputAction.Init || args.ResultEditText.Length <= 5)
        return;
    if (args.CurrentEditText.Length == 5 && args.CurrentSelectedText == String.Empty) {
        args.Cancel();
        return;
    }
    var maxInsertLength = 5 - args.CurrentHead.Length - args.CurrentTail.Length;
    args.SetResult(args.CurrentHead + args.InsertedText.Substring(0, maxInsertLength), args.CurrentTail);
}

VB.NET

Protected Overrides Sub ProcessCustomTextMaskInput(ByVal args As CustomTextMaskInputArgs)
    If args.IsCanceled OrElse args.ResultEditText.Length < args.CurrentEditText.Length OrElse args.ActionType = CustomTextMaskInputAction.Init OrElse args.ResultEditText.Length <= 5 Then
        Return
    End If
    If args.CurrentEditText.Length = 5 AndAlso args.CurrentSelectedText = String.Empty Then
        args.Cancel()
        Return
    End If
    Dim maxInsertLength = 5 - args.CurrentHead.Length - args.CurrentTail.Length
    args.SetResult(args.CurrentHead + args.InsertedText.Substring(0, maxInsertLength), args.CurrentTail)
End Sub