Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
scrollbar

Exercise outline

The goal of this exercise is to add a Ribbon button for volume models. As a result, it should be possible to configure the input data of volume models in just a couple of clicks.

Create a new gui command

Add a new folder to the plugin project named Commands. In this folder, create a new class named AddInputDataToVolumeModelCommand.cs and adapt the contents as shown below.

Note

A reference to DeltaShell.Plugins.NetworkEditor needs to be added in order to successfully build the code below (right click the References folder of the project in the Solution Explorer | Add Reference... | Browse... | Select D:\VolumeModel\packages\DeltaShell.1.0.0\delta-shell\plugins\DeltaShell.Plugins.NetworkEditor\DeltaShell.Plugins.NetworkEditor.dll).

Code Block

using System.Collections.Generic;
using System.Drawing;
using System.Linq;
using System.Windows.Forms;
using DelftTools.Shell.Gui;
using DeltaShell.Plugins.VolumeModel.Importers;
using DeltaShell.Plugins.NetworkEditor.Import;
using SharpMap.Api;
using SharpMap.Data.Providers;

namespace DeltaShell.Plugins.VolumeModel.Commands
{
    internal class AddInputDataToVolumeModelCommand : IGuiCommand
    {
        /// <summary>

...

Panel
borderStylesolid

Contents

Page Tree
rootTOOLS:Tutorial
startDepth3

Exercise outline

Wiki Markup
*\[TODO\]*
Description of the exercise outline

Fixme

Wiki Markup
*\[TODO\]*
Fixme

Fixme

Wiki Markup
*\[TODO\]*
Fixme

Exercise results

...

Wiki Markup
*\[TODO\]*

...

Wiki Markup
2. Create a new class named "AddDemoDataToVolumeModelCommand" \[TODO: Image\]

3. Add the following contents to this class:

Code Block

using System.Collections.Generic;
using System.Drawing;
using System.Linq;
using DelftTools.Shell.Gui;
using DeltaShell.Plugin.DemoApp.Importers;
using DeltaShell.Plugin.DemoApp.Models;
using DeltaShell.Plugins.NetworkEditor.Import;
using SharpMap.Api;
using SharpMap.Data.Providers;

namespace DeltaShell.Plugin.DemoApp.Commands
{
    internal class AddDemoDataToVolumeModelCommand : IGuiCommand
    {
        public string Name
        {
            get/// {The returnname "Addof demothe data";gui }command
        }
/// </summary>
        public boolstring EnabledName
        {
            get { return Gui"Add != null && Gui.SelectedModel is VolumeModelinput data"; }
        }

        public Image Image { get; set; }

/// <summary>
        /// Ensures the gui command publicis boolenabled Checkedfor {volume get; set; }

models only
        public IGui Gui { get; set; }
/// </summary>
        public void Execute(params object[] arguments)bool Enabled
        {
            //get Obtain{ thereturn selectedGui volume!= model
null && Gui.Selection is Models.VolumeModel; }
       var }

  volumeModel = (VolumeModel) Gui.SelectedModel;

   /// <summary>
        /// CreateThe aimage WaterML2of timethe seriesgui importercommand
        /// </summary>
   var waterMl2TimeSeriesImporter = new WaterML2TimeSeriesImporter();

 public Image Image { get; set; }

        /// Import<summary>
   a WaterML2 file to the precipitation/// timeWhether seriesor ofnot the volumegui model
command is checked
          waterMl2TimeSeriesImporter.ImportItem(@"..\..\precipitation_waterml.XML", volumeModel.Precipitation);

/// </summary>
        /// <remarks>Not relevant in this tutorial<//remarks>
 Create a catchment importer
    public bool Checked { get; set; }

  var catchmentsImporter = new CatchmentFromGisImporter
  /// <summary>
        /// {
A reference to the Delta Shell gui (automatically set by Delta Shell logic)
    FileBasedFeatureProviders = new List<IFileBasedFeatureProvider>
 /// </summary>
        public IGui Gui { get; set; {}

        /// <summary>
        /// The action new ShapeFile()
       that should be performed while executing the gui command
         }/// </summary>
        public void Execute(params  };
object[] arguments)
        {
            // ConfigureObtain the selected catchmentvolume importermodel
            var catchmentImporterSettingsvolumeModel = catchmentsImporter.FeatureFromGisImporterSettings;(Models.VolumeModel) Gui.SelectedModel;

            catchmentImporterSettings.Path = @"D:\deltashell\Workshop\SoftwareDaysNov2013\Gemeenten.shp";
            catchmentImporterSettings.PropertiesMapping.First(property => property.PropertyName == "Name").MappingColumn.ColumnName = "GM_NAAM";

      // Try to obtain a precipitation file via a file dialog
            var fileDialog = new OpenFileDialog
      // Import a shape file to the basin of the volume model{
            catchmentsImporter.ImportItem(null, volumeModel.Basin);
       Title }

= "Choose precipitation time series",
    public void Unexecute()
        {

      Filter  }= "WaterML2 files|*.XML",
    }
}

Wiki Markup
4. Create a new WPF user control named "DemoAppRibbon"&nbsp;\[TODO: Image\]

5. Add the following xaml code:

Code Block

<UserControl x:Class="DeltaShell.Plugin.DemoApp.DemoAppRibbon"
                Multiselect = false
      xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
          };

   xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
         if (fileDialog.ShowDialog()   xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"!= DialogResult.OK)
             xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
{
                xmlns:fluent="clr-namespace:Fluent;assembly=Fluent"return;
             mc:Ignorable="d"
}

            //  d:DesignHeight="300" d:DesignWidth="300">
Create a WaterML2 time series importer
      <!--Create a ribbon control-->
   var <fluent:RibbonwaterML2TimeSeriesImporter Name="DemoAppRibbonControl" x:FieldModifier="private"> new WaterML2TimeSeriesImporter();

        <!--Create a ribbon tab-->
 // Import the data from the  <fluent:RibbonTabItem Header="Volume model" fluent:KeyTip.Keys="E">
precipitation file
            waterML2TimeSeriesImporter.ImportItem(fileDialog.FileName, volumeModel.Precipitation);

   <!--Create a ribbon group box-->
     // Try to obtain a shape file via a <fluent:RibbonGroupBox Header="Demo">file dialog
            fileDialog = new OpenFileDialog
 <!--Create a ribbon button-->
            {
    <fluent:Button x:Name="ButtonAddDemoDataToVolumeModel"
               Title = "Choose basin shape file",
           Header="Add demo data"
       Filter = "Shape files|*.shp",
                    Multiselect ToolTip="Add demofalse
 data to the selected volume model"
          };

            if (fileDialog.ShowDialog() != DialogResult.OK)
      Click="ButtonAddDemoDataToVolumeModel_OnClick"
      {
                return;
         Size="Middle"
   }

            // Create a catchment importer
            SizeDefinition="Middle,Small,Small"/>
    var catchmentsImporter = new CatchmentFromGisImporter
        </fluent:RibbonGroupBox>
        </fluent:RibbonTabItem>{
    </fluent:Ribbon>
</UserControl>

6. Additionally, add the following interaction logic in DemoAppRibbon.xaml.cs:

Code Block

using System.Collections.Generic;
using System.Windows;
using DelftTools.Controls;
using DelftTools.Shell.Gui;
using DelftTools.Shell.Gui.Forms;
using DeltaShell.Plugin.DemoApp.Commands;

namespace DeltaShell.Plugin.DemoApp
{
    /// <summary>
    /// Interaction logic for DemoAppRibbon.xaml
    /// </summary>
    public partial class DemoAppRibbon : IRibbonCommandHandler
                FileBasedFeatureProviders = new List<IFileBasedFeatureProvider>
                    {
          private readonly IGuiCommand addDemoDataCommand = new AddDemoDataToVolumeModelCommand();

        publicnew DemoAppRibbonShapeFile()
        {
            InitializeComponent();}
        }

        public};

 object GetRibbonControl()
        {
  // Configure the catchment importer
      return DemoAppRibbonControl;
     var catchmentImporterSettings  }
= catchmentsImporter.FeatureFromGisImporterSettings;
        public void ValidateItems()
  catchmentImporterSettings.Path      {= fileDialog.FileName;
            ButtonAddDemoDataToVolumeModel.IsEnabledcatchmentImporterSettings.PropertiesMapping.First(property => addDemoDataCommandproperty.Enabled;
PropertyName == "Name").MappingColumn.ColumnName      }= "GM_NAAM";

        public bool IsConextualTabVisible(string tabGroupName, string tabName)
 // Import the data from the shape {file
            return falsecatchmentsImporter.ImportItem(null, volumeModel.Basin);
        }

        public IEnumerable<ICommand> Commands/// <summary>
        {
/// The action that should be performed in order to undo execute getactions {of yieldthe return addDemoDataCommand; }gui command
        }

/// </summary>
        private/// void ButtonAddDemoDataToVolumeModel_OnClick(object sender, RoutedEventArgs e)<remarks>Not relevant in this tutorial</remarks>
        {
public void Unexecute()
          addDemoDataCommand.Execute();{

        }
    }
}

...

Info

The command is derived from the IGuiCommand interface in order to obtain a reference to the Delta Shell gui (which is automatically set by the Delta Shell framework).

The comments in the code explain the different parts of the gui command implementation.

Create a new Ribbon control

Add a new folder to the plugin project named Ribbon. In this folder, create a new WPF user control named VolumeModelRibbon.xaml and adapt the contents (in the designer) as shown below:

Code Block

<UserControl x:Class="DeltaShell.Plugins.VolumeModel.Ribbon.VolumeModelRibbon"
             xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
             xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
             xmlns:fluent="clr-namespace:Fluent;assembly=Fluent"
    mc:Ignorable="d" Height="145" Width="632">
    <!--Create a ribbon control-->
    <fluent:Ribbon Name="VolumeModelRibbonControl" x:FieldModifier="private">
        <!--Create a ribbon tab-->
        <fluent:RibbonTabItem Header="Volume model" fluent:KeyTip.Keys="E">
            <!--Create a ribbon group box-->
            <fluent:RibbonGroupBox Header="Input">
                <!--Create a ribbon button-->
                <fluent:Button x:Name="ButtonAddInputDataToVolumeModel"
                               Header="Add input data"
                               ToolTip="Add input data to the selected volume model"
                               Click="ButtonAddInputDataToVolumeModel_OnClick"
                               Size="Middle"
                               SizeDefinition="Middle,Small,Small"/>
            </fluent:RibbonGroupBox>
        </fluent:RibbonTabItem>
    </fluent:Ribbon>
</UserControl>

Additionally, adapt the contents of VolumeModelRibbon.xaml.cs as shown below (right click the class | View Code).

Note

A reference to System.Xaml needs to be added in order to successfully build the code below (right click the References folder of the project in the Solution Explorer | Add Reference... | Assemblies | Framework | Select System.Xaml).

Code Block

using System.Collections.Generic;
using System.Windows;
using DelftTools.Controls;
using DelftTools.Shell.Gui;
using DelftTools.Shell.Gui.Forms;
using DeltaShell.Plugins.VolumeModel.Commands;

namespace DeltaShell.Plugins.VolumeModel.Ribbon
{
    /// <summary>
    /// Interaction logic for VolumeModelRibbon.xaml
    /// </summary>
    public partial class VolumeModelRibbon : IRibbonCommandHandler
    {
        private readonly IGuiCommand addInputDataToVolumeModelCommand = new AddInputDataToVolumeModelCommand(); // Instance of the implemented gui command

        /// <summary>
        /// Creates the Ribbon control
        /// </summary>
        public VolumeModelRibbon()
        {
            // Initialize the control (standard user control logic)
            InitializeComponent();
        }

        /// <summary>
        /// Returns the volume model Ribbon control
        /// </summary>
        public object GetRibbonControl()
        {
            return VolumeModelRibbonControl;
        }

        /// <summary>
        /// Enabling/disabling actions to be performed while validating the Ribbon items (triggered by Delta Shell logic)
        /// </summary>
        public void ValidateItems()
        {
            ButtonAddInputDataToVolumeModel.IsEnabled = addInputDataToVolumeModelCommand.Enabled;
        }

        /// <summary>
        /// Whether or not the contextual tab should be visible
        /// </summary>
        public bool IsConextualTabVisible(string tabGroupName, string tabName)
        {
            return false;
        }

        /// <summary>
        /// The (gui) commands of the Ribbon control
        /// </summary>
        public IEnumerable<ICommand> Commands
        {
            get { yield return addInputDataToVolumeModelCommand; }
        }

        /// <summary>
        /// Actions to be performed after clicking the AddInputDataToVolumeModel button
        /// </summary>
        private void ButtonAddInputDataToVolumeModel_OnClick(object sender, RoutedEventArgs e)
        {
            addInputDataToVolumeModelCommand.Execute();
        }
    }
}
Info

The Ribbon control is derived from the IRibbonCommandHandler interface so that it can be registered in the gui plugin.

The comments in the code should explain the different parts of the Ribbon control implementation.

Register the Ribbon control in the gui plugin class

Register the Ribbon control in the gui plugin by adding the following code to VolumeModelGuiPlugin.cs:

Code Block

using DelftTools.Shell.Gui.Forms;
using DeltaShell.Plugins.VolumeModel.Ribbon;

and

Code Block

        public override IRibbonCommandHandler RibbonCommandHandler
        {
            get { return new VolumeModelRibbon(); }
        }

Delta Shell should now automatically add the new Ribbon control to its Ribbon bar during the application startup.

Exercise results

First of all, download the following WaterML2 XML file: WaterML2_precipitation_data.XML. Also download and unzip the shape files contained in the following archive: Gemeenten.zip. You will use all these data along the exercise.

Next, run the application and check that a volume Ribbon button has been added to the Ribbon bar:

Image Added

Then create a new volume model item (right click on project | Add | New Model ...), click the volume Ribbon button and, sequentially, select the previously downloaded WaterML2 XML file and shape files in the file selection dialogs.

Afterwards, verify that the input data has been correctly added to the volume model by opening the data views or by running the model:

Image Added


scrollbar

...