Class EnterTypedNumberMessage

Namespace

Acuit.Pinpoint.Workstation.Messaging

Assembly

Acuit.Pinpoint.Workstation.Abstractions.dll

The message raised by the IMessenger service to enter a typed number (e.g., a serial number or model number) when a scan prompt is active.

public class EnterTypedNumberMessage : WorkstationRequestMessage<bool>, IWorkstationRequestMessage

Inheritance

object

RequestMessage<bool>

WorkstationRequestMessage<bool>

EnterTypedNumberMessage

Implements

IWorkstationRequestMessage

Inherited Members

RequestMessage<bool>.Reply(bool)

RequestMessage<bool>.Response

RequestMessage<bool>.HasReceivedResponse

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

By default, Acuit Pinpoint Workstation will handle this message when a scan prompt is active by setting the selected number to Number, as if the operator had clicked the "Type..." button and entered the number manually.

If the scan prompt had a selected number that was set to Number, the message Response will contain true; if the scan prompt had no number selected, it will contain false.

A plug-in can customize the default behavior by registering a recipient for this message. To suppress the default behavior, the plug-in should use Reply(T) to set the response to the message.

A plug-in can emulate the operator action that this message represents by sending this message.

Constructors

EnterTypedNumberMessage(string)

Initializes a new instance of the EnterTypedNumberMessage class.

public EnterTypedNumberMessage(string number)

Parameters

number string

The number.

Exceptions

ArgumentNullException

number is null.

Properties

Number

Gets the number.

public string Number { get; }

Property Value

string