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 (24.3.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
Type: Dundas.BINumber
The value.
format
Type: SystemString
The format.
symbol
Type: SystemString
The possible symbol to be used when formatting the value.
symbolPlacement
Type: Dundas.BI.Data.MetadataNumericSymbolPlacement
The symbol placement.
isLargeNumberFormattingPerValue
Type: SystemBoolean
If set to , then large numbers are formatted separately.
thousandsFormat
Type: SystemString
The thousands format.
millionsFormat
Type: SystemString
The millions format.
billionsFormat
Type: SystemString
The billions format.
trillionsFormat
Type: SystemString
The trillions format.
rangeOverrides
Type: System.Collections.GenericICollectionRangeFormatInfo
The possible range overrides.

Return Value

Type: 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