MFGS Terminal Options

MFGSTerminalOptions Public interface

Description

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

Diagram

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

Members

Methods

Public methods

Returns	Name
void	Clear() Reset options to default.
object``[]	Get(MFGSTerminalOptions value) Gets an array of values related to the option.
bool	Has(MFGSTerminalOptions value) Checks if the option is set.
void	Set(MFGSTerminalOptions value, object``[] args) Sets a terminal option.

Details

Summary

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

Methods

Clear

public void Clear()

Summary

Reset options to default.

Set

public void Set(MFGSTerminalOptions value, object[] args)

Arguments

Type	Name	Description
MFGSTerminalOptions	value	The option to set.
object``[]	args	Any additional parameters as determined by the option being set.

Summary

Sets a terminal option.

Get

public object Get(MFGSTerminalOptions value)

Arguments

Type	Name	Description
MFGSTerminalOptions	value	The option to get.

Summary

Gets an array of values related to the option.

Returns

The first element of the returned array will always have a bool denoting if the option is set or not. If additional parameters were passed in when the option was set, those parameter are returned as subsequent elements of the array.

Has

public bool Has(MFGSTerminalOptions value)

Arguments

Type	Name	Description
MFGSTerminalOptions	value	The option to check.

Summary

Checks if the option is set.

Remarks

This method is functionally identical to calling the Get(MFGSTerminalOptions) method and evaluating the first array element.

Returns

true is the option is set; otherwise false.

Generated with ModularDoc