IMetadataServiceFormatNumber Method

Formats the specified value for display purposes.

Namespace: Dundas.BI.Data.Metadata
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (26.2.0.1000)
Syntax
IReadOnlyList<string> FormatNumber(
	Number value,
	string format,
	string symbol,
	NumericSymbolPlacement symbolPlacement,
	bool isLargeNumberFormattingPerValue,
	string thousandsFormat,
	string millionsFormat,
	string billionsFormat,
	string trillionsFormat,
	ICollection<RangeFormatInfo> rangeOverrides
)

Parameters

value  Number
The value.
format  String
The format.
symbol  String
The possible symbol to be used when formatting the value.
symbolPlacement  NumericSymbolPlacement
The symbol placement.
isLargeNumberFormattingPerValue  Boolean
If set to , then large numbers are formatted separately.
thousandsFormat  String
The thousands format.
millionsFormat  String
The millions format.
billionsFormat  String
The billions format.
trillionsFormat  String
The trillions format.
rangeOverrides  ICollectionRangeFormatInfo
The possible range overrides.

Return Value

IReadOnlyListString
A list of string values, for the specified number and its multiples.

The first string is the formatted value of the specified number.

The second string is the formatted value of the inverted specified number.

The third string is the formatted value of the specified number, modified in the thousands range.

The fourth string is the formatted value of the inverted specified number, modified in the millions range.

The fifth string is the formatted value of the inverted specified number, modified in the billions range.

The sixth string is the formatted value of the inverted specified number, modified in the trillions range.

Exceptions
ExceptionCondition
ArgumentNullExceptionvalue is .
ArgumentExceptionformat is either or Empty.
InvalidSessionExceptionThe caller context is not associated with a valid session.
See Also