GPTaskInfo

This sample demonstrates the GeoprocessingTaskInfo and GeoprocessingTaskParameters functionality provided by the ArcGIS Runtime. This sample allows you to browse to a .gpk and view task and parameter information. Useful information such as the Name property are required for the execution of geoprocessing tasks. You can also confirm that the parameters that you specify for executing a geoprocessing task are correct. A url to the GeoprocessingTask is useful for viewing the tools and parameters of the GeoprocessingTask in the ArcGISRuntime REST Services Directory by copying and pasting the url in the browser.

XAML

<UserControl x:Class="ArcGISWPFSDK.GPTaskInfo"
             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">
    <Grid x:Name="LayoutRoot" Background="#FFE3E3E3">
        <Grid.Resources>
            <BooleanToVisibilityConverter x:Key="BooleanToVisibilityConverter"/>
            <LinearGradientBrush x:Key="PanelGradient" EndPoint="0.5,1" StartPoint="0.5,0">
                <LinearGradientBrush.RelativeTransform>
                    <TransformGroup>
                        <ScaleTransform CenterY="0.5" CenterX="0.5"/>
                        <SkewTransform CenterY="0.5" CenterX="0.5"/>
                        <RotateTransform Angle="176" CenterY="0.5" CenterX="0.5"/>
                        <TranslateTransform/>
                    </TransformGroup>
                </LinearGradientBrush.RelativeTransform>
                <GradientStop Color="#FF145787" Offset="0.16"/>
                <GradientStop Color="#FF3D7FAC" Offset="0.502"/>
                <GradientStop Color="#FF88C5EF" Offset="0.984"/>
            </LinearGradientBrush>
        </Grid.Resources>
            <Grid x:Name="mainGrid" Margin="10,10,10,10">
                <Rectangle Fill="{StaticResource PanelGradient}" Stroke="Black" StrokeThickness="1"  RadiusX="5" RadiusY="5" >
                    <Rectangle.Effect>
                        <DropShadowEffect/>
                    </Rectangle.Effect>
                </Rectangle>
                <StackPanel Orientation="Horizontal">
                <Label  Content="Path/URL:" Margin="10,10,0,10" Foreground="Black" Width="auto" FontWeight="Bold" HorizontalAlignment="Left" VerticalAlignment="Top"/>
                <TextBox x:Name="txtBoxPath" Text="..\\Data\\GPKs\\SimpleBuffer\\SimpleBuffer.gpk" Background="White" Height="26" VerticalAlignment="Top" HorizontalAlignment="Left" MaxWidth="570" Margin="10,10,0,10" />
                <Button Click="btnBrowseFile_Click" Content="..." Name="btnBrowseFile" Width="20" Height="26" HorizontalAlignment="Left" Margin="5,10,10,10" VerticalAlignment="Top"/>
                </StackPanel>
                <Rectangle x:Name="_rectangle" RadiusX="5" RadiusY="5" Fill="#DDFFFFFF" Stroke="DarkGray" Margin="10,40,10,10" Visibility="Hidden"/>
            </Grid>
        <ProgressBar x:Name="MyProgressBar" IsIndeterminate="True" VerticalAlignment="Bottom" Width="200" Height="20" Margin="15" Visibility="{Binding Path=IsBusy, Converter={StaticResource BooleanToVisibilityConverter}}"></ProgressBar>
    </Grid>
</UserControl>

C#

using System;
using System.Diagnostics;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Documents;
using System.Windows.Media;
using System.Windows.Navigation;
using ESRI.ArcGIS.Client.Local;
using System.ComponentModel;

namespace ArcGISWPFSDK
{

    public partial class GPTaskInfo : UserControl, INotifyPropertyChanged
    {
        public event PropertyChangedEventHandler PropertyChanged;

        private bool _isBusy = true;

        public bool IsBusy
        {
            get
            {
                return _isBusy;
            }
            set
            {
                _isBusy = value;

                if (PropertyChanged != null)
                {

                    PropertyChanged(this, new PropertyChangedEventArgs("IsBusy"));
                }
            }
        }  
    
        LocalGeoprocessingService _gpService;
        ScrollViewer _scrollViewer;
        string _gpk;

        public GPTaskInfo()
        {
            InitializeComponent();
            _gpk = "..\\Data\\GPKs\\SimpleBuffer\\SimpleBuffer.gpk";
            OpenGPK(_gpk);
            DataContext = this;
        }

        private void btnBrowseFile_Click(object sender, RoutedEventArgs e)
        {
            Microsoft.Win32.OpenFileDialog dlg = new Microsoft.Win32.OpenFileDialog();
            dlg.DefaultExt = ".gpk";
            dlg.Filter = "Geoprocessing Package (.gpk)|*.gpk|All Files (*.*)|*.*";
            Nullable<bool> result = dlg.ShowDialog();
            if (result == true)
            {
                _gpk = dlg.FileName;

                txtBoxPath.Text = _gpk;
                OpenGPK(_gpk);
            }
        }

        public void OpenGPK(string gpk)
        {
            IsBusy = true;
            
            if (_scrollViewer != null)
            {
                mainGrid.Children.Remove(_scrollViewer);
                _rectangle.Visibility = System.Windows.Visibility.Hidden;
            }
                
            _scrollViewer = new ScrollViewer()
            {
                Margin = new Thickness(15, 60, 15, 15),
                HorizontalScrollBarVisibility = ScrollBarVisibility.Auto,
                VerticalScrollBarVisibility = ScrollBarVisibility.Auto,
            };

            _gpService = new LocalGeoprocessingService(_gpk, GPServiceType.Execute);
            _gpService.StartAsync(sl =>
            {
                if (_gpService.Error != null)
                {
                    MessageBox.Show("Error creating GP server: " + _gpService.Error);
                }
                StackPanel stckMain = new StackPanel();

                //Recurse through each task in the gp service
                foreach (var task in _gpService.Tasks)
                {
                    //GeoprocessingTaskInfo
                    Expander expanderTask = new Expander()
                    {
                        HorizontalAlignment= System.Windows.HorizontalAlignment.Left,
                        IsExpanded = false,
                        Header = "GeoprocessingTaskInfo : " + task.Name,
                        Margin = new Thickness(10, 0, 0, 0),
                        Foreground = new SolidColorBrush(Colors.Black),
                        Background = new SolidColorBrush(Colors.Transparent),
                        FontFamily = new FontFamily("Verdana"),
                        FontWeight = FontWeights.SemiBold,
                        FontSize = 13,
                    };
                    StackPanel spScroll = new StackPanel();
                    spScroll.Margin = new Thickness(10, 10, 10, 10);

                    Paragraph paragraph = new Paragraph();
                    paragraph.Inlines.Add(new Run("Name : " + task.DisplayName + Environment.NewLine));
                    paragraph.Inlines.Add(new Run("Category : " + task.Category + Environment.NewLine));
                    paragraph.Inlines.Add(new Run("URL : "));
                    Hyperlink link = new Hyperlink();
                    link.Inlines.Add(task.Url);
                    link.NavigateUri = new Uri(task.Url, UriKind.RelativeOrAbsolute);
                    link.RequestNavigate += new RequestNavigateEventHandler(link_RequestNavigate);
                    paragraph.Inlines.Add(link);
                    paragraph.Inlines.Add(new Run(Environment.NewLine + "ExecutionType : " + task.ExecutionType));
                    RichTextBox tbx = new RichTextBox()
                    {
                        Height = 82,
                        Width = mainGrid.ActualWidth,
                        FontFamily = new FontFamily("Verdana"),
                        FontWeight = FontWeights.Normal,
                        FontSize = 13,
                        BorderThickness = new Thickness(0),
                        IsReadOnly = true,
                        Background = new SolidColorBrush(Colors.Transparent),
                        IsDocumentEnabled = true,
                    };
                    FlowDocument doc = new FlowDocument();
                    doc.Blocks.Add(paragraph);
                    tbx.Document = doc;
                    spScroll.Children.Add(tbx);

                    //Recurse through each parameter in the task
                    foreach (var parameter in task.Parameters)
                    {
                        Expander expanderparameter = new Expander()
                        {
                            IsExpanded = false,
                            Header = "GeoprocessingTaskParameters : " + parameter.Name,
                            Margin = new Thickness(5, 0, 0, 0),
                            Foreground = new SolidColorBrush(Colors.Black),
                            Background = new SolidColorBrush(Colors.Transparent),
                            FontFamily = new FontFamily("Verdana"),
                            FontWeight = FontWeights.SemiBold,
                            FontSize = 13,
                        };

                        StackPanel spParam = new StackPanel();
                        TextBox tbxParam = new TextBox()
                            {
                                Height = 85,
                                FontFamily = new FontFamily("Verdana"),
                                FontWeight = FontWeights.Normal,
                                FontSize = 13,
                                Margin = new Thickness(10, 10, 10, 10),
                                BorderThickness = new Thickness(0),
                                IsReadOnly = true,
                                Background = new SolidColorBrush(Colors.Transparent),
                            };
                        tbxParam.Text = "Name : " + parameter.DisplayName + Environment.NewLine +
                            "Category : " + parameter.Category + Environment.NewLine +
                            "DataType : " + parameter.DataType + Environment.NewLine +
                            "Direction : " + parameter.Direction + Environment.NewLine +
                            "ParameterType : " + parameter.ParameterType;
                        spParam.Children.Add(tbxParam);

                        expanderparameter.Content = spParam;
                        spScroll.Children.Add(expanderparameter);
                        expanderparameter.IsExpanded = true;
                    }
                    expanderTask.Content = spScroll;
                    expanderTask.IsExpanded = true;
                    stckMain.Children.Add(expanderTask);
                }
                _scrollViewer.Content = stckMain;
                mainGrid.Children.Add(_scrollViewer);
                IsBusy = false;
                _rectangle.Visibility = System.Windows.Visibility.Visible;
            });
        }

        private void link_RequestNavigate(object sender, RequestNavigateEventArgs args) 
        {
            Process.Start(args.Uri.ToString());
        }
    }
}

VB.NET

Imports System.Diagnostics
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Documents
Imports System.Windows.Media
Imports System.Windows.Navigation
Imports ESRI.ArcGIS.Client.Local
Imports System.ComponentModel

Namespace ArcGISWPFSDK
    Partial Public Class GPTaskInfo
        Inherits UserControl
        Implements INotifyPropertyChanged
        Public Event PropertyChanged As PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged
        Private _isBusy As Boolean = True
        Public Property IsBusy() As Boolean
            Get
                Return _isBusy
            End Get
            Set(value As Boolean)
                _isBusy = value
                RaiseEvent PropertyChanged(Me, New PropertyChangedEventArgs("IsBusy"))
            End Set
        End Property
        Private _gpService As LocalGeoprocessingService
        Private _scrollViewer As ScrollViewer
        Private _gpk As String

        Public Sub New()
            InitializeComponent()
            _gpk = "..\Data\GPKs\SimpleBuffer\SimpleBuffer.gpk"
            OpenGPK(_gpk)
        End Sub

        Private Sub btnBrowseFile_Click(sender As Object, e As RoutedEventArgs)
            Dim dlg As New Microsoft.Win32.OpenFileDialog()
            dlg.DefaultExt = ".gpk"
            dlg.Filter = "Geoprocessing Package (.gpk)|*.gpk|All Files (*.*)|*.*"
            Dim result As Nullable(Of Boolean) = dlg.ShowDialog()
            If result = True Then
                _gpk = dlg.FileName

                txtBoxPath.Text = _gpk
                OpenGPK(_gpk)
                DataContext = Me
                IsBusy = False
            End If
        End Sub

        Public Sub OpenGPK(gpk As String)
            If _scrollViewer IsNot Nothing Then
                mainGrid.Children.Remove(_scrollViewer)
                _rectangle.Visibility = System.Windows.Visibility.Hidden
            End If
            _scrollViewer = New ScrollViewer() With { _
             .Margin = New Thickness(10, 60, 10, 10), _
             .HorizontalScrollBarVisibility = ScrollBarVisibility.Auto, _
             .VerticalScrollBarVisibility = ScrollBarVisibility.Auto, _
             .VerticalAlignment = System.Windows.VerticalAlignment.Stretch, _
             .HorizontalAlignment = System.Windows.HorizontalAlignment.Stretch, _
             .HorizontalContentAlignment = System.Windows.HorizontalAlignment.Stretch _
            }

            _gpService = New LocalGeoprocessingService(_gpk, GPServiceType.Execute)
            _gpService.StartAsync(Function(sl)
                                      If _gpService.[Error] IsNot Nothing Then
                                          MessageBox.Show("Error creating GP server: " & Convert.ToString(_gpService.[Error]))
                                      End If
                                      Dim stckMain As New StackPanel()

                                      'Recurse through each task in the gp service
                                      For Each task As GeoprocessingTaskInfo In _gpService.Tasks
                                          'GeoprocessingTaskInfo
                                          Dim expanderTask As New Expander() With { _
                                           .HorizontalAlignment = System.Windows.HorizontalAlignment.Left, _
                                           .IsExpanded = False, _
                                           .Header = "GeoprocessingTaskInfo : " & task.Name, _
                                           .Margin = New Thickness(10, 0, 0, 0), _
                                           .Foreground = New SolidColorBrush(Colors.Black), _
                                           .Background = New SolidColorBrush(Colors.Transparent), _
                                           .FontFamily = New FontFamily("Verdana"), _
                                           .FontWeight = FontWeights.SemiBold, _
                                           .FontSize = 13 _
                                          }
                                          Dim spScroll As New StackPanel()
                                          spScroll.Margin = New Thickness(10, 10, 10, 10)

                                          Dim paragraph As New Paragraph()
                                          paragraph.Inlines.Add(New Run("Name : " & task.DisplayName & Environment.NewLine))
                                          paragraph.Inlines.Add(New Run("Category : " & task.Category & Environment.NewLine))
                                          paragraph.Inlines.Add(New Run("URL : "))
                                          Dim link As New Hyperlink()
                                          link.Inlines.Add(task.Url)
                                          link.NavigateUri = New Uri(task.Url, UriKind.RelativeOrAbsolute)
                                          AddHandler link.RequestNavigate, New RequestNavigateEventHandler(AddressOf link_RequestNavigate)
                                          paragraph.Inlines.Add(link)
                                          paragraph.Inlines.Add(New Run(Environment.NewLine & "ExecutionType : " & Convert.ToString(task.ExecutionType)))
                                          Dim tbx As New RichTextBox() With { _
                                           .Height = 82, _
                                           .Width = mainGrid.ActualWidth, _
                                           .FontFamily = New FontFamily("Verdana"), _
                                           .FontWeight = FontWeights.Normal, _
                                           .FontSize = 13, _
                                           .BorderThickness = New Thickness(0), _
                                           .IsReadOnly = True, _
                                           .Background = New SolidColorBrush(Colors.Transparent), _
                                           .IsDocumentEnabled = True _
                                          }
                                          Dim doc As New FlowDocument()
                                          doc.Blocks.Add(paragraph)
                                          tbx.Document = doc
                                          spScroll.Children.Add(tbx)

                                          'Recurse through each parameter in the task
                                          For Each parameter As GeoprocessingTaskParameters In task.Parameters
                                              Dim expanderparameter As New Expander() With { _
                                               .IsExpanded = False, _
                                               .Header = "GeoprocessingTaskParameters : " & parameter.Name, _
                                               .Margin = New Thickness(5, 0, 0, 0), _
                                               .Foreground = New SolidColorBrush(Colors.Black), _
                                               .Background = New SolidColorBrush(Colors.Transparent), _
                                               .FontFamily = New FontFamily("Verdana"), _
                                               .FontWeight = FontWeights.SemiBold, _
                                               .FontSize = 13 _
                                              }

                                              Dim spParam As New StackPanel()
                                              Dim tbxParam As New TextBox() With { _
                                               .Height = 85, _
                                               .FontFamily = New FontFamily("Verdana"), _
                                               .FontWeight = FontWeights.Normal, _
                                               .FontSize = 13, _
                                               .Margin = New Thickness(10, 10, 10, 10), _
                                               .BorderThickness = New Thickness(0), _
                                               .IsReadOnly = True, _
                                               .Background = New SolidColorBrush(Colors.Transparent) _
                                              }
                                              tbxParam.Text = "Name : " & parameter.DisplayName & Environment.NewLine & "Category : " & parameter.Category & Environment.NewLine & "DataType : " & Convert.ToString(parameter.DataType) & Environment.NewLine & "Direction : " & Convert.ToString(parameter.Direction) & Environment.NewLine & "ParameterType : " & Convert.ToString(parameter.ParameterType)
                                              spParam.Children.Add(tbxParam)

                                              expanderparameter.Content = spParam
                                              spScroll.Children.Add(expanderparameter)
                                              expanderparameter.IsExpanded = True
                                          Next
                                          expanderTask.Content = spScroll
                                          expanderTask.IsExpanded = True
                                          stckMain.Children.Add(expanderTask)
                                      Next
                                      _scrollViewer.Content = stckMain
                                      mainGrid.Children.Add(_scrollViewer)
                                      DataContext = Me
                                      IsBusy = False
                                      _rectangle.Visibility = System.Windows.Visibility.Visible
                                  End Function)
        End Sub

        Private Sub link_RequestNavigate(sender As Object, args As RequestNavigateEventArgs)
            Process.Start(args.Uri.ToString())
        End Sub
    End Class
End Namespace