DisplayName Override Issue

[TheTradingMantis]

There appears to be a bug when overriding DisplayName. I'm on the latest version of NinjaTrader, so not sure if this was occurring in prior versions.

I am overriding DisplayName as outlined in the Help Guide. http://ninjatrader.com/support/helpG...isplayname.htm

When the Label is blanked out in the Indicator Properties dialog, the Name of the indicator no longer shows in the Configured section of the dialog.

I am using the following undocumented code to work around the issue:

public override string DisplayName
{
  get
  {
    if (Name == string.Empty) return "My Custom Display " + DefaultName;
    else return "My Custom Display " + Name; ;
  }
}

[NinjaTrader_Jesse]

Hello TheTradingMantis,

You generally need to use the State in this override to return a value in various different states. Does it work if you make sure to return the name when the state is SetDefaults or Configure?

public override string DisplayName
{
    get {
        if (State == State.SetDefaults) return "StrategyName";
        else return "My Custom Display " + Name;
    } 
}​

[TheTradingMantis]

Hi Jesse,

Using State == State.SetDefaults works and is a better approach than checking the Name. Thanks for the recommendation!

Still need to use the undocumented DefautlName when returning a value in State.SetDefaults. Maybe the Help Guide can be updated to reflect this?

public override string DisplayName
{
  get
  {
    if (State == State.SetDefaults) return DefautlName;
    else return "My Custom Display " + Name;
  }
}​

If you don't use DefautlName, or a hardcoded string in your example, this happens when Label is blanked out:

[NinjaTrader_Jesse]

Hello TheTradingMantis,

I will make the recommendation to include that in the help guide sample. Just for clarification the DisplayName override its self is documented and supported, just the part about using the State is not described there.

https://ninjatrader.com/support/helpGuides/nt8/indicator_displayname.htm?zoom_highlightsub=DisplayName

[TheTradingMantis]

I have corrected my post above as I meant to use DefaultName, not DisplayName. Using DisplayName in the DisplayName override is recursive and will crash NinjaTrader.

[NinjaTrader_Jesse]

Hello TheTradingMantis,

Thanks for clarifying that, yes DefaultName is not documented. Generally you would just use the Name property in the DisplayName override and construct a custom result. I am not sure what specific use cases the DefaultName is used in so I couldn't really provide any insight on that property.

[TheTradingMantis]

Name appears to be tied to the Label in the Indicator Properties dialog. If Label is blanked out, Name will then be blank. This can be verified by

...
else if (State == State.Configure)
{
  Print(Name.ToString())
}

If one wants to avoid using the undocumented DefaultName, then a hardcoded string would need to be used as Jesse suggested in his sample code above.

public override string DisplayName
{
  get
  {
    if (State == State.SetDefaults) return "SomeIndicator";
    else return "My Custom Display " + Name;
  }
}​