NTTabPage.GetHeaderPart appending number to tab's

[ntbone]

I have created a new window for my Addon with tabs. I have done this before many times but this one instance is having unexpected behavior.

I have override GetHeaderPart to return the name of the tab I want. NinjaTrader is appending a number after the tab name. I can't figure out how the name of the tab is having a number appended to it.

protected override string MyTabPage.GetHeaderPart(string variable)
{
    if(string.IsNullOrEmpty(tabCaption))
    {
        return "No Name";
    }
    return tabCaption;
}

...

public void MyAddonWindow.AddTab(MyTabPage tabPage)
{
    tabControl.AddNTTabPage(tabPage);
}

The tab names are all unique in the window so its not a situation tabCaption is set to the same value. tabCaption is a member variable in my derived class that I assign in the constructor.

The tabs are being added in code after the window is created but before it is shown.

var myNewWindow = new MyAddonWindow();

myNewWindow.AddTab(new MyTabPage("Some Tab"));
myNewWindow.AddTab(new MyTabPage("A different Tab"));

myNewWindow.Show();

I'll get "Some Tab 11" and then "A different Tab 59" for the actual tab names.

[NinjaTrader_ChrisL]

Hello, thanks for writing in. The addon framework example overrides GetHeaderPart and does not do this. You will need to reference this example to see what your script is doing differently in this instance:

https://ninjatrader.com/support/helpGuides/nt8/NT%20HelpGuide%20English.html?addon_development_overview.htm

[ntbone]

I have already referenced that example, and the numerous other places in my own code where I override GetHeaderPart and return the name of the tab. I have debugged the string returned by GetHeaderPart and it definitely isn't adding any number to the string there. The only difference between this situation and the sample or my other addons is that this one adds tab pages in code as I pointed out above.

[NinjaTrader_ChrisL]

Hi, do you have a reduced test script that I can test on my PC?

[ntbone]

See attached. Needs to be put in the Addon's folder. Should be self contained. Demonstrates the problem.

[NinjaTrader_ChrisL]

Hi, thanks for posting this. There was something about how you were passing in the string that was causing the number to be appended. I was able to fix it by changing the constructor of TestAddTabTabPage to this:

public TestAddTabTabPage(string tabCaption)
{
TabName = tabCaption;
}

[ntbone]

That solution might fix it but that doesn't explain why returning it as my code provides appends a # to the name. The member variable "tabCaption" is readonly and is assigned the parameter passed in. It is then returned by "GetHeaderPart". NinjaTrader is adding a # when it calls GetHeaderPart. What is number and why is it adding it?

[NinjaTrader_ChrisL]

Hi, the Addon framework example is not doing this. Unfortunately, I am not going to be able to look through your code anymore to find the difference between your test script and the example that I linked in a previous post. You will need to compare and contrast your test code with the addon framework example to find the difference here. Additionally, your GetHeaderPart() is not using the "variable" to determine what the tab name should be so setting the tab name is a sound solution for this instance.

Kind regards,
-ChrisL

[ntbone]

The code I created is pretty simple. It stores the desired tab name as a member variable and uses it as a return to GetHeaderPart. If at some point I wanted to optionally use the variable, I wouldn't be able to. I don't have access to NinjaTrader's internal code and its NinjaTrader's internal code that is adding the number. The string is read only and being returned directly so there's no where anywhere in my code for a # to be added. The code I presented couldn't be any simpler, aside from the necessary code to add a menu item to launch the addon window.

[NinjaTrader_ChrisL]

Hi, the Addon Framework example I posted is not doing this. Please use this as an exemplar for all addons tab naming conventions going forward.

[ntbone]

For those who, like me, end up confused by the behavior of GetHeaderPart adding a number

• If you use the code I shared above, but only have 1 Tab, no number will be added.
• If you add more then one tab, the numbers will be added and its undetermined what number each will be assigned.
• GetHeaderPart is called for a list of predefined variables that can be swapped out. See Tab Name Variables
• If you only use "@FUNCTION" as seen here you will still get non-sequential numbers appended to all your tabs. You must add something after "@FUNCTION". A single space is sufficient but adding other things like "@INSTRUMENT" or any of the other variables will also work.

To get my code to work as expected

public MyTabPage()
{
    TabName = "@FUNCTION ";  // insert here whatever full pattern you'd like the tab name to have.  If you don't plan to use any variables
                            // at all, you could just assign the tab name here.  However, you can then have multiple tabs with the exact same
                            // name. If you want your tab names to increment for duplicates "My Tab", "My Tab 1", "My Tab 2" then use the  
                            // "@FUNCTION "
                            // ** The extra space is important. Without it your tabs will all get numbers and they won't be sequential.  **
}

protected override string MyTabPage.GetHeaderPart(string variable)
{
    if(variable == "@FUNCTION")
    {
        if(string.IsNullOrEmpty(tabCaption))
        {
            return "No Name";
        }
        return tabCaption;
    }
    return variable;
}

...

public void MyAddonWindow.AddTab(MyTabPage tabPage)
{
    tabControl.AddNTTabPage(tabPage);
}

BUG: Using "@FUNCTION" similar to the sample referenced in responses to my post still results in the numbers being appended to the tabs and not sequentially.