Interface Barcode Font Encoder

App
System Application
Namespace
System.Text
Versions
18-28

Procedures, 2

Versions171819202122232425262728

Source242526272829

Source in 29

src/System Application/App/Barcode/src/Barcode Provider/Font/BarcodeFontEncoder.Interface.al29 lines, Copyright (c) Microsoft Corporation. MIT

// ------------------------------------------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for license information.
// ------------------------------------------------------------------------------------------------

namespace System.Text;

/// <summary>
/// Exposes common interface for barcode font encoder.
/// </summary>
interface "Barcode Font Encoder"
{
    /// <summary>
    /// Encodes a input text to a barcode font.
    /// </summary>
    /// <param name="InputText">The text to encode.</param>
    /// <param name="BarcodeEncodeSettings">Settings to use when encoding the input text.</param>
    /// <returns>The encoded barcode.</returns>
    procedure EncodeFont(InputText: Text; var BarcodeEncodeSettings: Record "Barcode Encode Settings"): Text;

    /// <summary>
    /// Validates whether a text can be encoded.
    /// The validation is based on a regular expression according to
    /// https://www.neodynamic.com/Products/Help/BarcodeWinControl2.5/working_barcode_symbologies.htm
    /// </summary>
    /// <param name="InputText">The text to validate.</param>
    /// <returns>True if the validation succeeds; otherwise - false.</returns>
    procedure IsValidInput(InputText: Text; var BarcodeEncodeSettings: Record "Barcode Encode Settings"): Boolean;
}