NT8 Documentation Request - Attributes, Properties, NinjaScriptProperty

[ganamide]

It would be really helpful to have some documentation regarding all the annotations and syntax for indicator and strategy parameters. There is a big change in this area compared to NT7, yet I could not find any documentation, and it is coming down to looking at existing NinjaScript for examples and a lot of trial and error to reverse engineer this information.

In case I am not making myself clear, here are some examples of what I mean:

        [Range(0, 100)]
        [Display(ResourceType = typeof(Custom.Resource), Name = "NinjaScriptDrawingToolAreaOpacity", GroupName = "NinjaScriptGeneral")]
        public int AreaOpacity
        {
            get { return areaOpacity; }
            set
            {
                areaOpacity = Math.Max(0, Math.Min(100, value));
                if (areaBrush != null)
                {
                    Brush newBrush        = areaBrush.Clone();
                    newBrush.Opacity    = areaOpacity / 100d;
                    newBrush.Freeze();
                    areaBrush            = newBrush;
                }
            }
        }

        [XmlIgnore]
        [Display(ResourceType = typeof(Custom.Resource), Name = "Small area color", GroupName = "NinjaScriptGeneral")]
        public Brush SmallAreaBrush
        {
            get { return smallAreaBrush; }
            set { smallAreaBrush = value; }
        }

        [Browsable(false)]
        public string SmallAreaBrushSerialize
        {
            get { return Serialize.Brush2String(SmallAreaBrush); }
            set { SmallAreaBrush = Serialize.String2Brush(value); }
        }

        [Browsable(false)]
        [XmlIgnore]
        public Series<double> TestPlot
        {
            get { return Values[0]; }
        }

I still haven't found an example of a property description tag. Does NT8 support these? I no longer see a description box when looking at the parameters of an indicator in the UI. If yes, how do I define the description for a property?

Thanks!

[NinjaTrader_Brett]

Good call, yea don't disagree will add it to the list for us to look at improving documentation.

NT8 we dropped description, no longer is used on per property basis.

[ganamide]

NT8 we dropped description, no longer is used on per property basis.

That's too bad. I always give a description to my parameters. Maybe you guys could implement as a tooltip?

[NinjaTrader_Brett]

Thanks. Actually already on our list for review on the tooltip.

[koganam]

Good call, yea don't disagree will add it to the list for us to look at improving documentation.

NT8 we dropped description, no longer is used on per property basis.

Not sure of that one. I am sure that I have Descriptions on my properties, but I am rebuilding my Virtual Machine at this time. If I confirm it, I will post some pictures.

[NinjaTrader_Brett]

No need just tested and works. I guess it was already on my plate and I already handled Should be in the tooltip.

Let me know if your mileage varies.

[ganamide]

No need just tested and works. I guess it was already on my plate and I already handled Should be in the tooltip.

Let me know if your mileage varies.

Well, I'm not seeing my description show up in the tooltip of Strategy Analyzer. Not sure I am defining it correctly:

        [Description("Number of prior days used to calculate rolling statistics.")]
        [Range(1, int.MaxValue), NinjaScriptProperty]
        [Display(ResourceType = typeof(Custom.Resource), Name = "Days", GroupName = "NinjaScriptStrategyParameters", Order = 1)]
        public int Days
        { get; set; }

What I see in the tooltip in both Strategy Analyzer and Indicators Dialog is the value of Name.

[leoxander]

You should use the 'Description' public property of 'Display' attribute.
[Display(ResourceType = typeof(Custom.Resource), Name = "Name of property", GroupName = "NinjaScriptGeneral", Description = "Some description...")]
It just provides a tooltip to your property.

[NinjaTrader_Brett]

Thanks leoxander. If you guys see it not working after using correct description let me know could be a bug where one grid does not respect correctly.

[ganamide]

You should use the 'Description' public property of 'Display' attribute.
[Display(ResourceType = typeof(Custom.Resource), Name = "Name of property", GroupName = "NinjaScriptGeneral", Description = "Some description...")]
It just provides a tooltip to your property.

That works. Thanks!