TX Text Control .NET for Windows Forms

IsTextValid Method

Method|Introduced in 29.0
Namespace
TXTextControl.Barcode
Package
TXTextControl.TextControl.WinForms.SDK as TXBarcode.Windows.Forms.dll from the private NuGet feed or Text Control Offline Packages

Description

Returns a value indicating whether the specified text is valid for a specific barcode type. In case of an invalid text, an exception message is saved into the specified string.

Syntax

public static bool IsTextValid(BarcodeType barcodeType, string text, out string errorMessage);

Parameters

ParameterDescription
barcodeType

Specifies the barcode type whose text is checked.

text

Specifies the text to check.

errorMessage

Specifies the string, an appropriate exception message is saved to, if the checked text is not valid for a specific barcode type.

Return Value

True, if the specified text is valid for a specific barcode type. Otherwise false.

Examples

The following example checks whether text valid applies to the txbarcode control.

string errorMessage = "Quarterly report";
if (TXTextControl.Barcode.TXBarcodeControl.IsTextValid(TXTextControl.Barcode.BarcodeType.QRCode, "Quarterly results", out errorMessage))
{
    Console.WriteLine("Is Text Valid completed successfully.");
}