EditCode class | QSYS API Reference Guide

Estimated reading time: 3 minutes

Provides methods for applying and manipulating edit codes, which define output formatting patterns for business numeric data.

Namespace: ASNA.QSys.Runtime Assembly: ASNA.QSys.Runtime.dll

Inheritance: Object

Methods

Signature	Description
Apply(Decimal, Int32, Int32, EditCodes, Int32)	Applies Edit Code parameters.
Apply(Decimal, Int32, Int32, EditCodes, String)	Applies Edit Code parameters.
ApplyEditCode(EditCodes, Int32, Int32, String, Char, Char, Char, Boolean)	Applies Edit Code.
GetEditCodeEnumFromChar(Char)	Get EditCode enumeration member from input char.
UsesThousandsSeparator(EditCodes)	Determines if Edit Code uses thousands separator symbol.

string Apply(decimal numeric, int decimals, int length, EditCodes editCode, int isAsteriskFill)

Applies Edit Code parameters.

string Apply(decimal numeric, int decimals, int length, EditCodes editCode, int isAsteriskFill)

Parameters

Type	Parameter name	Description
Decimal	numeric	Numeric input value.
Int32	decimals	Number of decimals.
Int32	length	Fixed length.
EditCodes	editCode	Edit Code.
Int32	isAsteriskFill	True if value should be filled with asterisks, false otherwise.

Returns

Type	Description
String	Formatted value as string.

string Apply(decimal numeric, int decimals, int length, EditCodes editCode, string currencySymbol)

Applies Edit Code parameters.

string Apply(decimal numeric, int decimals, int length, EditCodes editCode, string currencySymbol)

Parameters

Type	Parameter name	Description
Decimal	numeric	Numeric input value.
Int32	decimals	Number of decimals.
Int32	length	Fixed length.
EditCodes	editCode	Edit Code.
String	currencySymbol	Currency symbol.

Returns

Type	Description
String	Formatted value as string.

string ApplyEditCode(EditCodes editCode, int decimals, int length, string inputString, char decimalPoint, char thousandSeparator, char currencySymbol, bool isAsteriskFill)

Applies Edit Code.

string ApplyEditCode(EditCodes editCode, int decimals, int length, string inputString, char decimalPoint, char thousandSeparator, char currencySymbol, bool isAsteriskFill)

Parameters

Type	Parameter name	Description
EditCodes	editCode	Edit Code.
Int32	decimals	Number of decimals.
Int32	length	Fixed length.
String	inputString	Input string.
Char	decimalPoint	Decimal point symbol.
Char	thousandSeparator	Thousands separator symbol.
Char	currencySymbol	Currency symbol.
Boolean	isAsteriskFill	True if value should be filled with asterisks, false otherwise.

Returns

Type	Description
String	Formatted value as string.

EditCodes GetEditCodeEnumFromChar(char editCode)

Get EditCode enumeration member from input char.

EditCodes GetEditCodeEnumFromChar(char editCode)

Parameters

Type	Parameter name	Description
Char	editCode	Edit code char.

Returns

Type	Description
EditCodes	Edit Codes enumeration member.

bool UsesThousandsSeparator(EditCodes editCode)

Determines if Edit Code uses thousands separator symbol.

bool UsesThousandsSeparator(EditCodes editCode)

Parameters

Type	Parameter name	Description
EditCodes	editCode	Edit code input.

Returns

Type	Description
Boolean	true if Edit Code uses thousands separator, false otherwise.