IMetadataServiceFormatNumber Method |
Formats the specified value for display purposes.
Namespace: Dundas.BI.Data.MetadataAssembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (26.2.0.1000)
SyntaxIReadOnlyList<string> FormatNumber(
Number value,
string format,
string symbol,
NumericSymbolPlacement symbolPlacement,
bool isLargeNumberFormattingPerValue,
string thousandsFormat,
string millionsFormat,
string billionsFormat,
string trillionsFormat,
ICollection<RangeFormatInfo> rangeOverrides
)
Function FormatNumber (
value As Number,
format As String,
symbol As String,
symbolPlacement As NumericSymbolPlacement,
isLargeNumberFormattingPerValue As Boolean,
thousandsFormat As String,
millionsFormat As String,
billionsFormat As String,
trillionsFormat As String,
rangeOverrides As ICollection(Of RangeFormatInfo)
) As IReadOnlyList(Of String)
IReadOnlyList<String^>^ FormatNumber(
Number value,
String^ format,
String^ symbol,
NumericSymbolPlacement symbolPlacement,
bool isLargeNumberFormattingPerValue,
String^ thousandsFormat,
String^ millionsFormat,
String^ billionsFormat,
String^ trillionsFormat,
ICollection<RangeFormatInfo^>^ rangeOverrides
)
abstract FormatNumber :
value : Number *
format : string *
symbol : string *
symbolPlacement : NumericSymbolPlacement *
isLargeNumberFormattingPerValue : bool *
thousandsFormat : string *
millionsFormat : string *
billionsFormat : string *
trillionsFormat : string *
rangeOverrides : ICollection<RangeFormatInfo> -> IReadOnlyList<string> 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
IReadOnlyListStringA 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
See Also