TypeConverterAttribute()

<< Click to Display Table of Contents >>

Navigation:  NinjaScript > Language Reference > Common > Attribute >

TypeConverterAttribute()

Previous page Return to chapter overview Next page

Definition

Binds an object or property to a specific TypeConverter implementation.  This is commonly used to customize property descriptors on the NinjaTrader property grid.

 

Notes:  

If you are looking to extend behavior of an Indicator or Strategy (e.g., values of one property influence another), you must implement either an IndicatorBaseTypeConverter or StrategyBaseTypeConveter.  This is to ensure default property descriptor behavior works as intended.

For converting types of a specific property, implementing a standard TypeConverter is sufficient

A working NinjaScript demo can be found through the reference sample on "Using a TypeConverter to Customize Property Grid Behavior"

The TypeConverterAttribute object is a general purpose attribute made available from the .NET Framework. The information on this page is written to demonstrate how you may use this object within NinjaScript conventions used with the NinjaTrader UI's property grid (e.g., an indicator dialog).  There are more methods and properties that you can learn about from MSDN's TypeConverterAttribute Class which are NOT covered in this topic; as such there is NO guarantee they will work with the NinjaTrader UI's property grids.

 

 

Syntax

TypeConverterAttribute(string)
TypeConverterAttribute(type)

 

Examples

ns

// Only applied to this property: can just implement a general TypeConveter
[TypeConverter(typeof(MyCustomBoolConveter))]
public bool CustomBool

 

// Applied to the entire indicator: must implement an IndicatorBaseTypeConveter
[TypeConverter("NinjaTrader.NinjaScript.Indicators.MyConverter")]
public class MyCustomIndicator : Indicator
{
 
}
 
// Applied to the entire strategy: must implement a StrategyBaseTypeConveter
[TypeConverter("NinjaTrader.NinjaScript.Strategies.MyCustomConveter")]
public class MyCustomStrategy : Strategy
{
 
}