Open this page in the API Guide

IMetadataService.FormatNumber 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 (25.1.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.BI.Number
The value.
format
Type: System.String
The format.
symbol
Type: System.String
The possible symbol to be used when formatting the value.
symbolPlacement
Type: Dundas.BI.Data.Metadata.NumericSymbolPlacement
The symbol placement.
isLargeNumberFormattingPerValue
Type: System.Boolean
If set to true, then large numbers are formatted separately.
thousandsFormat
Type: System.String
The thousands format.
millionsFormat
Type: System.String
The millions format.
billionsFormat
Type: System.String
The billions format.
trillionsFormat
Type: System.String
The trillions format.
rangeOverrides
Type: System.Collections.Generic.ICollection<RangeFormatInfo>
The possible range overrides.

Return Value

Type: IReadOnlyList<String>
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 null.
ArgumentExceptionformat is either null or Empty.
InvalidSessionExceptionThe caller context is not associated with a valid session.
See Also