Barcode Scan Mode: To Define the Required Properties

This activity will walk you through the implementation of the required properties of a scan mode.

Story

Suppose that you are creating a custom barcode-driven form. You have defined a barcode scan class for this form and created an instance of the descendant of the ScanMode class in the implementation of the CreateScanModes() method. Now you need to define this descendant itself. You also need to define the constants for the values of the required properties of the scan mode and add these properties.

Process Overview

You will define the class for the scan mode and define its required properties. For the Code property, you will provide both the string and the BQL constant. For the Description property, you will use a localizable message.

System Preparation

Before you begin creating a scan mode, do the following:

Prepare an MYOB Acumatica instance by performing the Test Instance: To Deploy an Instance prerequisite activity.
Create a barcode scan class by performing the Barcode Scan Class: To Create a Barcode Scan Class prerequisite activity.

Step: Defining the Required Properties of the Scan Mode

To define the required properties of the scan mode, do the following:

In the INScanCount class, define the class for the scan mode, as shown in the following code.
```
public class INScanCount : WMSBase
{
    ...

    public sealed class CountMode : ScanMode
    {
    }
}
```
In the INScanCount.cs file, add the using directives shown in the following code.
```
using PX.Common;
using PX.Data.BQL;
```

Define the string constant and the BQL constant for the scan mode identifier, as shown below.

public class INScanCount : WMSBase
{
    ...

    public sealed class CountMode : ScanMode
    {
        public const string Value = "INCO";
        public class value : BqlString.Constant<value> 
        { 
            public value() : base(CountMode.Value) { } 
        }

        public override string Code => Value;
    }
}

Define the localizable message for the name of the scan mode, as shown in the following code.

public class INScanCount : WMSBase
{
    ...

    public sealed class CountMode : ScanMode
    {
        ...
        public override string Description => Msg.Description;

        [PXLocalizable]
        new public abstract class Msg 
        {
            public const string Description = "Scan and Count";
        }
    }
}