FormatPrice()

<< Click to Display Table of Contents >>

Navigation:  NinjaScript > Language Reference > Common > Instruments > Instrument > MasterInstrument >

FormatPrice()

Previous page Return to chapter overview Next page

Definition

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

 

Note:  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.

 

Parameters

price

A double value representing a price

round

An optional bool when true will round the price value to the nearest tick size

 

 

Syntax

Bars.Instrument.MasterInstrument.FormatPrice(double price)

 

Examples

ns


protected override void OnBarUpdate()
{
  Print(Bars.Instrument.MasterInstrument.FormatPrice(Close[0]));    
}

 

ns


protected override void OnMarketData(MarketDataEventArgs marketDataUpdate)
{
  Print(marketDataUpdate.Instrument.MasterInstrument.FormatPrice(marketDataUpdate.Price));
}