Table of Contents

Interface IItemScannerNumber

Namespace
Acuit.Pinpoint.Workstation
Assembly
Acuit.Pinpoint.Workstation.Interfaces.dll

A number being collected by an IItemScanner.

public interface IItemScannerNumber : INotifyPropertyChanged
Inherited Members

Properties

Id

Gets the number identifer.

string Id { get; }

Property Value

string

IsRejected

Gets or sets whether this particular number was rejected by the server (e.g., from the component verification check at the server).

bool IsRejected { get; set; }

Property Value

bool

Remarks

When this is true, the user interface will indicate that the number is bad (in some way different from when IsValid is false). Note that this should only be set to true when we know this particular number is rejected (it's possible to get a rejection from the server but not know which number specifically is bad).

IsSelected

Gets or sets whether this number is selected in the user interface.

bool IsSelected { get; set; }

Property Value

bool

Remarks

The selected number takes precedence when a bar code is received.

Setting this to true for one number in an item scanner causes IsSelected for all other numbers to be set to false.

IsValid

Gets whether the number is scanned and valid per the number pattern (i.e., not per the component verification check at the server).

bool IsValid { get; }

Property Value

bool

Remarks

Note that this does not reflect the result of component verification (at the server). When this is false, the user interface will indicate that the entry is invalid, similar to indicating on a form that a required field has not been supplied.

Name

Gets the number name.

string Name { get; }

Property Value

string

Number

Gets the number value.

string Number { get; }

Property Value

string

Remarks

This may reflect an invalid number (i.e., the scan pattern was correct, but the number pattern didn't match).

Methods

Clear()

Clears the number.

void Clear()

SubmitNumber(string)

Submits an entire number (e.g., extracted from a bar code scan or received from the Type dialog).

void SubmitNumber(string number)

Parameters

number string

The number to submit.

Remarks

This will cause the ValidNumberReceived event to fire if the number is valid, even if the number did not change.

Exceptions

ArgumentNullException

number is null.

Events

ValidNumberReceived

Occurs when a valid number is received.

event EventHandler ValidNumberReceived

Event Type

EventHandler

Remarks

This event can be used to change the selection to the next number.