ReferencesCommonInstrumentMasterInstrument

FormatPrice()

View as Markdown

Definition

Returns a price value as a string which will be formatted to the nearest tick size.

This is useful as the standard format specifier will only use the minimum number of digits for a decimal by default; however you can use this method to ensure that your data is always formatted per the instrument tick size for easier readability. For example, a value of 1985.50 would Print() as 1985.5, while using FormatPrice(), we can expect the value to be formatted as 1985.50.

Property Value

A string value which will ensure the price data is always formatted to the nearest tick size.

Syntax

Bars.Instrument.MasterInstrument.FormatPrice(double price, [bool round])

Parameters

ParameterDescription
priceA double value representing a price
roundAn optional bool when true (default) will round the price value to the nearest tick size

Examples

1protected override void OnBarUpdate()
2{
3   // called without setting the optional bool parameter, which is defaulted to true then
4   Print(Bars.Instrument.MasterInstrument.FormatPrice(Close[0]));
5}
6
7protected override void OnMarketData(MarketDataEventArgs marketDataUpdate)
8{
9   Print(marketDataUpdate.Instrument.MasterInstrument.FormatPrice(marketDataUpdate.Price));