MFGS Terminal

MFGSTerminal Public interface

Description

Describes methods and properties available on the static instance object MFGS.Terminal

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph VGWWCoreIEx
  VGWWCoreIEx.IExMFGSTerminal[[IExMFGSTerminal]]
  class VGWWCoreIEx.IExMFGSTerminal interfaceStyle;
  end

Members

Properties

Public properties

Type	Name	Methods
string	ID The ID of the terminal.	get
int	Lines The number of text lines the terminal supports.	get
IExMFGSTerminalOptions	Options Used to manage options for the terminal.	get
int	Width The number of characters accross the terminal supports.	get

Methods

Public methods

Returns	Name
void	Beep(int count) Cause the terminal to “beep”.
string	Get(int timeout) Get a string response from the terminal.
byte``[]	GetPic(string headerPrompt, bool allowCancel) Get a picture from the terminal.
bool	HasFeature(MFGSTerminalFeature feature) Gets a value that indicates if a specific feature is supported.
void	Prompt(object``[] lines) Display text on the terminal.

Details

Summary

Describes methods and properties available on the static instance object MFGS.Terminal

Methods

Prompt

public void Prompt(object[] lines)

Arguments

Type	Name	Description
object``[]	lines	Each parameter passed in is a line of text.

Summary

Display text on the terminal.

Remarks

An IMFGSList object, typically obtained via the MFGS.Misc.TextWrap method, can be passed in as a parameter and each object in the list will be displayed as a line of text.

Get

public string Get(int timeout)

Arguments

Type	Name	Description
int	timeout

Summary

Get a string response from the terminal.

Returns

The response

GetPic

public byte GetPic(string headerPrompt, bool allowCancel)

Arguments

Type	Name	Description
string	headerPrompt	The text to display to the user while they take the picture.
bool	allowCancel	Determines if a ‘Cancel’ button is displayed to the user.

Summary

Get a picture from the terminal.

Remarks

This method is only availble on terminals where the camera has been configured. Use the HasFeature() method to determine if this method can be called.

Returns

A byte array of the picture in PNG format, or an empty arrary if the user clicks ‘Cancel’

Beep

public void Beep(int count)

Arguments

Type	Name	Description
int	count	The number of times to “beep”

Summary

Cause the terminal to “beep”.

Remarks

Depending on hardware and configuration, a “beep” can consist of an audible noise and/or a visual indicator.

HasFeature

public bool HasFeature(MFGSTerminalFeature feature)

Arguments

Type	Name	Description
MFGSTerminalFeature	feature	The feature to check for.

Summary

Gets a value that indicates if a specific feature is supported.

Returns

true if the feature is supported; otherwise false.

Properties

ID

public string ID { get; }

Summary

The ID of the terminal.

Lines

public int Lines { get; }

Summary

The number of text lines the terminal supports.

Width

public int Width { get; }

Summary

The number of characters accross the terminal supports.

Options

public IExMFGSTerminalOptions Options { get; }

Summary

Used to manage options for the terminal.

Generated with ModularDoc