Getting rid of the DSL model explorer

Tags: , , ,
Add comments

Every DSL you create with DSL Tools has a model explorer. This model explorer is a tool window in Visual Studio displaying the elements of your model in a hierarchical way. This is often a nice feature but sometimes a hierarchical view of your data is not appropriate. So I came to the question: How to remove the explorer from the generated code?

I could not find any option in the DSL design to remove the model explorer, but if you look at some of the .tt files you will find somewhere a query for this.Dsl.Explorer != null. For example in the file that generates the package.cs which is responsible for registering the tool window for the model explorer:

    if(this.Dsl.Explorer != null)
    [VSShell::ProvideToolWindow(         typeof(<#= dslName #>ExplorerToolWindow),          MultiInstances = false,          Style = VSShell::VsDockStyle.Tabbed,          Orientation = VSShell::ToolWindowOrientation.Right,          Window = "{3AE79031-E1BC-11D0-8F78-00A0C9110057}")]
    [VSShell::ProvideToolWindowVisibility(         typeof(<#= dslName #>ExplorerToolWindow),          Constants.<#= dslName #>EditorFactoryId)]

Even if I did not find any option to set the Dsl.Explorer property of the model to null (you did not see the Explorer property anywhere in the DSL diagram) it seems that the developers of the DSL Tools had this use case in mind.

To remove the Dsl.Explorer from your DSL model open the .dsl file with a text editor and go to the end. There you will find some XML tags like the following:

<Explorer ExplorerGuid="6c276297-6acd-4e9a-8740-b61ba834004b"  Title="HardwareDescription Explorer">
    <ExplorerBehaviorMoniker      Name="HardwareDescription/HardwareDescriptionExplorer" />

Just delete these three lines and generate your code once again. Maybe you should reset your Experimental Hive, too.

I tested a DSL with a removed Model Explorer without any problems. It seems the developers of the DSL Tools did a very good job on the code generation templates . The generated ModelExplorer.cs file contains only a single line:

// This source file is empty because    this DSL does not define a model explorer.

That should be a good proof that a DSL can run without the model explorer even if it might be not supported by the DSL Tools. :-)

3 Responses to “Getting rid of the DSL model explorer”

  1. jreq Says:

    Thank you, I was wondering this myself ;-)

    Just one question if you happen to read this. Might there be any circumstance under which those lines might be automatically regenerated by DSL Tools?

  2. Benjamin Schröter Says:

    I cant say it for sure, but I don’t think the DSL tools will generate the three lines of XML again.
    For me it seems that the DSL Tools support a missing Explorer everywhere but in the editor itself. All generated code will be generated in a way that is working with proper comments if the explorer is missing, so I think everything will be fine.

  3. jreq Says:

    It certainly seems to be working perfectly for me. Well, thanks again.

Leave a Reply

WP Theme & Icons by N.Design Studio
Entries RSS Comments RSS Log in