Description

<< Click to Display Table of Contents >>

Navigation:  NinjaScript > Language Reference > Common >

Description

Previous page Return to chapter overview Next page

Definition

Text which is used on the UI's information box to be displayed to a user when configuration a NinjaScript object.

 

Method Return Value

A string value representing text used to describe the object.

 

Warning:  This property should ONLY bet set from the OnStateChange() method during State.SetDefaults or State.Configure

 

Syntax

Description

 

 

Examples

ns


protected override void OnStateChange()
{    
  if (State == State.SetDefaults)
  {
    Name = "Examples Indicator";  
    Description = @"An indicator used to demonstrate various NinjaScript methods and properties";
  }
}