Creating User Defined Input Parameters

<< Click to Display Table of Contents >>

Navigation:  NinjaScript > Educational Resources > Tips >

Creating User Defined Input Parameters

Previous page Return to chapter overview Next page

You can create user defined input parameters for both NinjaScript Indicators and Strategies. Although user defined input parameters can be specified as part of the initial set up of NinjaScript Indicator or Strategies using the Wizard you may have a requirement to add new parameters at a later point in your development process. To create these parameters you will need to edit your NinjaScript code and follow these steps.

1.Open your NinjaScript file
2.Inside of the if (State == State.SetDefaults) statement, assign a value to the variable for your parameter

 

ns


Period = 5;

 

 

Note: This is also where you set the default value for your parameter.

 

 

3.Scroll down to the bottom of the editor and expand the minimized "Properties" section by clicking on the + sign on the left.
4.Use the following template code for each parameter you wish to create. Please note that the type (int, double, etc) will differ depending on what type of variable you wish to create

ns


[Range(1, int.MaxValue)]

[NinjaScriptProperty]

[Display(Name="Period", Description="Numbers of bars used for calculations", Order=1, GroupName="Parameters")]

public int Period

{ get; set; }

 

5.To specify lower and upper bounds, you would modify [Range(1, int.MaxValue)]. For example:

ns


// No upper bound, lower bound of 1

[Range(1, int.MaxValue)]

// No lower bound, upper bound of 100

[Range(int.MinValue, 100)]

// No lower or upper bound

[Range(int.MinValue, int.MaxValue)]

 

6.Use the "Description" field to provide a brief description of what the parameter does.
7.Pay attention to this line as the object type will vary depending on the type of parameter you wish to make:

ns


public int Period

 

8.Now, wherever in your code you want to call the user-definable parameter, just use "Period".

ns


if (SMA(Period)[0] > SMA(Period)[1])

  // Do something