...
The goal of this exercise is to add a Ribbon button for volume models . As a result, it should be possible to configure which helps configuring the input data of volume models in just a couple of clicksa faster way, automatically generating dialogs that prompt the users to select the input files required for a volume model.
Create a new
...
GUI command
Add a new folder named Commands to the plugin project. Inside this folder, create a new class named AddInputDataToVolumeModelCommand.cs and adapt the contents as shown below.
...
Start by downloading documents-stack.png and adding the file to the project resources. This image must be built as a resource in order for WPF to use it, so select the image in the Resources folder shown in the Solution Explorer panel of Visual Studio and change the Build actionAction property to Resource.
Now, add a new folder named Ribbon to the plugin project. Inside 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"
Icon="/DeltaShell.Plugins.VolumeModel;component\Resources\documents-stack.png"
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>
|
...
Next, adapt the contents of VolumeModelRibbon.xaml.cs as shown below (right click the class | View Code).
| 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 IsContextualTabVisible(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();
}
}
} |
...
Register the Ribbon control in the gui 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(); }
}
|
...
Then create a new volume model item (right click on project | Add | New Model ...), . Notice that the just created button can only be used when the the volume model is selected in the Project panel. If you select any other item, like the project, or any element inside the volume model, the button will be disabled. Select the added volume model, and then click the volume Ribbon button and. In the file selection dialogs that will be automatically prompted, select, sequentially, select the previously downloaded precipitation (WaterML2 XML file ) and basin (shape files in the file selection dialogs.
Afterwards, ) files. The model will be fully configured and ready to be run. You can verify that the input data has been correctly added to the volume model by opening the data views or by running the model:
...