Help System

Other of the predefined windows that XRV offers is Help window. This window is intended to contain some text and images guidance for application users, to learn how to use it. It works in the same way as Settings System: you can associate a help section to your custom module, or you can add or remove items programmatically. To open Help window, just press button that you can find in hand menu.

This window is a TabbedWindow and you have two ways of adding new elements.

• Adding a help section to your custom module

public class MyModule : Module
{
    public override TabItem Settings { get; protected set; }

    public override void Initialize(Scene scene)
    {
        this.Help = new TabItem()
        {
            Name = () => "Module Name",
            Contents = this.CreateContents() // Entity with help item contents.
        };
    }
}

• Using HelpSystem API

var help = this.xrvService.HelpSystem;
var item = new TabItem
{
    Order = 1,
    Name = "My item",
    Contents = () => this.CreateContents(),
};
help.AddTabItem(item);

You can also remove an existing item using RemoveTabItem method.