Query Related Records

This sample demonstrates using the ArcGIS Runtime SDK for WPF to perform a relationship query to display information from a related table for selected features. Click on the map to highlight a State. Select a State from the list to display related features (cities). The object id of the State is used in the relationship query to return 0 or many related records displayed in the data grid.

Note that the code requires a relationshipId. Local feature layers can have more than one relationship and each relationship is identified by a unique identifier.

XAML

<UserControl x:Class="ArcGISWPFSDK.LocalQueryRelatedRecords"
             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:common="clr-namespace:System.Windows;assembly=System.Windows.Controls"
             xmlns:d="http://schemas.microsoft.com/expression/blend/2008" 
             xmlns:esri="http://schemas.esri.com/arcgis/client/2009">
    <Grid x:Name="LayoutRoot" Background="White">
        <Grid.Resources>
            <BooleanToVisibilityConverter x:Key="BooleanToVisibilityConverter"/>
            <esri:FillSymbol x:Key="SelectFillSymbol">
                <esri:FillSymbol.ControlTemplate>
                    <ControlTemplate>
                        <Path x:Name="Element"
                            Stroke="Black"
                            StrokeStartLineCap="Round"
                            StrokeThickness="2"
                            StrokeLineJoin="Round"
                            StrokeEndLineCap="Round" Fill="Red">
                            <VisualStateManager.VisualStateGroups>
                                <VisualStateGroup x:Name="SelectionStates">
                                    <VisualState x:Name="Unselected" >
                                        <Storyboard>
                                            <ColorAnimation Storyboard.TargetName="Element" 
                                            Storyboard.TargetProperty="(Path.Fill).Color"
                                            To="Red"  Duration="00:00:00.25"/>
                                        </Storyboard>
                                    </VisualState>
                                    <VisualState x:Name="Selected">
                                        <Storyboard>
                                            <ColorAnimation Storyboard.TargetName="Element" 
                                            Storyboard.TargetProperty="(Path.Fill).Color"
                                            To="Cyan" Duration="00:00:00.25"/>
                                            <ObjectAnimationUsingKeyFrames Storyboard.TargetName="Element" Storyboard.TargetProperty="StrokeDashArray">
                                                <DiscreteObjectKeyFrame KeyTime="0:0:0">
                                                    <DiscreteObjectKeyFrame.Value>
                                                        <DoubleCollection>2,1</DoubleCollection>
                                                    </DiscreteObjectKeyFrame.Value>
                                                </DiscreteObjectKeyFrame>
                                            </ObjectAnimationUsingKeyFrames>
                                        </Storyboard>
                                    </VisualState>
                                </VisualStateGroup>
                            </VisualStateManager.VisualStateGroups>
                        </Path>
                    </ControlTemplate>
                </esri:FillSymbol.ControlTemplate>
            </esri:FillSymbol>
            <HierarchicalDataTemplate x:Key="TreeViewItemTemplate">
                <StackPanel Orientation="Horizontal">
                    <Ellipse Fill="Transparent" Height="6" Width="6" StrokeThickness="2" Stroke="Black" Margin="0,0,10,0"/>
                    <TextBlock Text="{Binding Attributes[STATE_NAME]}" FontWeight="Bold" HorizontalAlignment="Left" FontSize="10" Foreground="Black"/>
                </StackPanel>
            </HierarchicalDataTemplate>
            <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>
            <esri:SimpleRenderer x:Key="MySimplePolygonRenderer">
                <esri:SimpleRenderer.Symbol>
                    <esri:SimpleFillSymbol Fill="#440000FF"/>
                </esri:SimpleRenderer.Symbol>
            </esri:SimpleRenderer>
        </Grid.Resources>
        <esri:Map x:Name="MyMap" Extent="-15000000,2000000,-7000000,8000000" Background="#FFE3E3E3" MinimumResolution="2445.98490512499"
                  MouseClick="MyMap_MouseClick" IsEnabled="False">
            <esri:ArcGISLocalTiledLayer ID="BaseMap" Path="..\\Data\\TPKs\\Topographic.tpk"/>
            <esri:ArcGISLocalFeatureLayer ID="States" LayerName="States" Path="..\\Data\\MPKs\\RelationshipID.mpk"
                    Renderer="{StaticResource MySimplePolygonRenderer}"/>
            <esri:GraphicsLayer ID="GraphicsStatesLayer" />
        </esri:Map>
        <Border x:Name="ResultsDisplay" Background="{StaticResource PanelGradient}" BorderThickness="1" CornerRadius="5"
                HorizontalAlignment="Right"  VerticalAlignment="Bottom" Visibility="Collapsed" 
                Margin="5" Padding="5" BorderBrush="Black">
            <Border.Effect>
                <DropShadowEffect/>
            </Border.Effect>
            <Grid x:Name="RelatedRowsGrid" HorizontalAlignment="Right" Background="White" 
              VerticalAlignment="Top" MinHeight="200" Margin="10" MaxWidth="650">
                <Grid.RowDefinitions>
                    <RowDefinition Height="Auto"/>
                    <RowDefinition MaxHeight="170" Height="*" />
                </Grid.RowDefinitions>
                <Grid.ColumnDefinitions>
                    <ColumnDefinition Width="120" />
                    <ColumnDefinition Width="Auto" />
                </Grid.ColumnDefinitions>
                <TextBlock Text="States: " Margin="4,10,10,6" Foreground="Black" TextWrapping="Wrap" 
                       FontWeight="Bold" FontSize="10"/>
                <TreeView x:Name="SelectedStatesTreeView" Grid.Row="1" Grid.Column="0" Margin="2"
                                 BorderBrush="Black" BorderThickness="1" ItemsSource="{Binding}"   
                                 SelectedItemChanged="SelectedStatesTreeView_SelectedItemChanged" 
                                 ItemTemplate="{StaticResource TreeViewItemTemplate}" />
                <TextBlock Margin="4,10,60,6" TextWrapping="Wrap" Grid.Column="1" Foreground="Black"
                           Text="Cities related to the selected State: " 
                           FontSize="10" FontWeight="Bold" />
                <DataGrid x:Name="RelatedRowsDataGrid" AutoGenerateColumns="False" HeadersVisibility="All" 
                             BorderThickness="1" HorizontalScrollBarVisibility="Hidden" Grid.Row="1" Grid.Column="1"
                             IsReadOnly="True" VerticalAlignment="Stretch" HorizontalAlignment="Stretch" 
                             Margin="2">
                    <DataGrid.Columns>
                        <DataGridTextColumn CanUserSort="False"  Binding="{Binding Attributes[OBJECTID]}" Header="ID" FontWeight="Bold"/>
                        <DataGridTextColumn CanUserSort="False" Binding="{Binding Attributes[NAME]}" Header="City Name"/>
                        <DataGridTextColumn CanUserSort="False" Binding="{Binding Attributes[POP2000]}" Header="Population"/>
                    </DataGrid.Columns>
                </DataGrid>
            </Grid>
        </Border>
        <Grid HorizontalAlignment="Right" VerticalAlignment="Top" Margin="0,15,15,0" >
            <Rectangle Fill="{StaticResource PanelGradient}" Stroke="Gray" RadiusX="10" RadiusY="10"  Margin="0,0,0,5" >
                <Rectangle.Effect>
                    <DropShadowEffect/>
                </Rectangle.Effect>
            </Rectangle>
            <Rectangle Fill="#FFFFFFFF" Stroke="DarkGray" RadiusX="5" RadiusY="5" Margin="10,10,10,15" />
            <TextBlock x:Name="InformationTextBlock" 
                 Text="Click on map to highlight State.  Select State in the panel below to view related records." 
                 Width="200" Margin="30,20,30,25" HorizontalAlignment="Left" TextWrapping="Wrap" Foreground="Black"/>
        </Grid>
        <ProgressBar x:Name="MyProgressBar" IsIndeterminate="True" VerticalAlignment="Bottom" Width="200" Height="20" Margin="10" Visibility="{Binding Path=IsBusy, Converter={StaticResource BooleanToVisibilityConverter}}"></ProgressBar>
    </Grid>
</UserControl>

C#

using System;
using System.Windows;
using System.Windows.Controls;
using ESRI.ArcGIS.Client;
using ESRI.ArcGIS.Client.Geometry;
using ESRI.ArcGIS.Client.Symbols;
using ESRI.ArcGIS.Client.Tasks;
using ESRI.ArcGIS.Client.Local;
using System.ComponentModel;


namespace ArcGISWPFSDK
{
    public partial class LocalQueryRelatedRecords : 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"));
                }
            }
        }      
    
        GraphicsLayer graphicsLayer;
        QueryTask queryTask;
        LocalMapService _mapService;

        public LocalQueryRelatedRecords()
        {
            InitializeComponent();

            graphicsLayer = MyMap.Layers["GraphicsStatesLayer"] as GraphicsLayer;

            LocalMapService.GetServiceAsync("..\\Data\\MPKs\\RelationshipID.mpk", (localMapService) =>
            {
                _mapService = localMapService;
                queryTask = new QueryTask();
                queryTask.Url = _mapService.UrlMapService + "/0";
                queryTask.ExecuteCompleted += QueryTask_ExecuteCompleted;
                queryTask.ExecuteRelationshipQueryCompleted += QueryTask_ExecuteRelationshipQueryCompleted;
                queryTask.Failed += QueryTask_Failed;
                MyMap.IsEnabled = true;
                DataContext = this;
                IsBusy = false;
            });
        }

        void MyMap_MouseClick(object sender, ESRI.ArcGIS.Client.Map.MouseEventArgs e)
        {
            graphicsLayer.Graphics.Clear();
            SelectedStatesTreeView.ItemsSource = null;
            RelatedRowsDataGrid.ItemsSource = null;

            Query query = new Query()
            {
                Geometry = Expand(MyMap.Extent, e.MapPoint, 0.01),
                ReturnGeometry = true,
                OutSpatialReference = MyMap.SpatialReference
            };
            query.OutFields.Add("*");
            queryTask.ExecuteAsync(query);
        }

        private Envelope Expand(Envelope mapExtent, MapPoint point, double pct)
        {
            return new Envelope(
                    point.X - mapExtent.Width * (pct / 2), point.Y - mapExtent.Height * (pct / 2),
                    point.X + mapExtent.Width * (pct / 2), point.Y + mapExtent.Height * (pct / 2))
            {
                SpatialReference = mapExtent.SpatialReference
            };
        }

        void QueryTask_ExecuteCompleted(object sender, ESRI.ArcGIS.Client.Tasks.QueryEventArgs args)
        {
            FeatureSet featureSet = args.FeatureSet;
            if (featureSet != null && featureSet.Features.Count > 0)
            {
                SelectedStatesTreeView.Tag = featureSet.ObjectIdFieldName;
                SelectedStatesTreeView.ItemsSource = featureSet.Features;
                foreach (Graphic g in featureSet.Features)
                {
                    g.Symbol = LayoutRoot.Resources["SelectFillSymbol"] as FillSymbol;
                    graphicsLayer.Graphics.Add(g);
                }
                ResultsDisplay.Visibility = System.Windows.Visibility.Visible;
            }
            else
            {
                ResultsDisplay.Visibility = System.Windows.Visibility.Collapsed;
                MessageBox.Show("No States found here, please try another location.");
            }
        }

        private void QueryTask_Failed(object sender, TaskFailedEventArgs args)
        {
            MessageBox.Show("Query execute error: " + args.Error);
        }

        private void SelectedStatesTreeView_SelectedItemChanged(object sender, RoutedPropertyChangedEventArgs<object> e)
        {
            if (e.OldValue != null)
            {
                Graphic g = e.OldValue as Graphic;
                g.UnSelect();
                g.SetZIndex(0);
            }

            if (e.NewValue != null)
            {
                Graphic g = e.NewValue as Graphic;
                g.Select();
                g.SetZIndex(1);

                //Relationship query
                RelationshipParameter relationshipParameters = new RelationshipParameter()
                {
                    ObjectIds = new int[] { Convert.ToInt32(g.Attributes[SelectedStatesTreeView.Tag as string]) },
                    OutFields = new string[] { "OBJECTID, NAME, POP2000" },
                    RelationshipId = 0,
                    OutSpatialReference = MyMap.SpatialReference
                };

                queryTask.ExecuteRelationshipQueryAsync(relationshipParameters);
            }
        }

        void QueryTask_ExecuteRelationshipQueryCompleted(object sender, RelationshipEventArgs e)
        {
            RelationshipResult pr = e.Result;
            if (pr.RelatedRecordsGroup.Count == 0)
            {
                RelatedRowsDataGrid.ItemsSource = null;
            }
            else
            {
                foreach (var pair in pr.RelatedRecordsGroup)
                {
                    RelatedRowsDataGrid.ItemsSource = pair.Value;
                }
            }
        }

    }
}

VB.NET

Imports System.Windows
Imports System.Windows.Controls
Imports ESRI.ArcGIS.Client
Imports ESRI.ArcGIS.Client.Geometry
Imports ESRI.ArcGIS.Client.Symbols
Imports ESRI.ArcGIS.Client.Tasks
Imports ESRI.ArcGIS.Client.Local
Imports System.ComponentModel

Namespace ArcGISWPFSDK
    Partial Public Class LocalQueryRelatedRecords
        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 graphicsLayer As GraphicsLayer
        Private queryTask As QueryTask
        Private _mapService As LocalMapService

        Public Sub New()
            InitializeComponent()

            graphicsLayer = TryCast(MyMap.Layers("GraphicsStatesLayer"), GraphicsLayer)

            LocalMapService.GetServiceAsync("..\Data\MPKs\RelationshipID.mpk", Function(localMapService__1)
                                                                                   _mapService = localMapService__1
                                                                                   queryTask = New QueryTask()
                                                                                   queryTask.Url = _mapService.UrlMapService & "/0"
                                                                                   AddHandler queryTask.ExecuteCompleted, AddressOf QueryTask_ExecuteCompleted
                                                                                   AddHandler queryTask.ExecuteRelationshipQueryCompleted, AddressOf QueryTask_ExecuteRelationshipQueryCompleted
                                                                                   AddHandler queryTask.Failed, AddressOf QueryTask_Failed
                                                                                   MyMap.IsEnabled = True
                                                                                   DataContext = Me
                                                                                   IsBusy = False
                                                                               End Function)
        End Sub

        Private Sub MyMap_MouseClick(sender As Object, e As ESRI.ArcGIS.Client.Map.MouseEventArgs)
            graphicsLayer.Graphics.Clear()
            SelectedStatesTreeView.ItemsSource = Nothing
            RelatedRowsDataGrid.ItemsSource = Nothing

            Dim query As New Query() With { _
             .Geometry = Expand(MyMap.Extent, e.MapPoint, 0.01), _
             .ReturnGeometry = True, _
             .OutSpatialReference = MyMap.SpatialReference _
            }
            query.OutFields.Add("*")
            queryTask.ExecuteAsync(query)
        End Sub

        Private Function Expand(mapExtent As Envelope, point As MapPoint, pct As Double) As Envelope
            Return New Envelope(point.X - mapExtent.Width * (pct / 2), point.Y - mapExtent.Height * (pct / 2), point.X + mapExtent.Width * (pct / 2), point.Y + mapExtent.Height * (pct / 2)) With { _
             .SpatialReference = mapExtent.SpatialReference _
            }
        End Function

        Private Sub QueryTask_ExecuteCompleted(sender As Object, args As ESRI.ArcGIS.Client.Tasks.QueryEventArgs)
            Dim featureSet As FeatureSet = args.FeatureSet
            If featureSet IsNot Nothing AndAlso featureSet.Features.Count > 0 Then
                SelectedStatesTreeView.Tag = featureSet.ObjectIdFieldName
                SelectedStatesTreeView.ItemsSource = featureSet.Features
                For Each g As Graphic In featureSet.Features
                    g.Symbol = TryCast(LayoutRoot.Resources("SelectFillSymbol"), FillSymbol)
                    graphicsLayer.Graphics.Add(g)
                Next
                ResultsDisplay.Visibility = System.Windows.Visibility.Visible
            Else
                ResultsDisplay.Visibility = System.Windows.Visibility.Collapsed
                MessageBox.Show("No States found here, please try another location.")
            End If
        End Sub

        Private Sub QueryTask_Failed(sender As Object, args As TaskFailedEventArgs)
            MessageBox.Show("Query execute error: " & Convert.ToString(args.[Error]))
        End Sub

        Private Sub SelectedStatesTreeView_SelectedItemChanged(sender As Object, e As RoutedPropertyChangedEventArgs(Of Object))
            If e.OldValue IsNot Nothing Then
                Dim g As Graphic = TryCast(e.OldValue, Graphic)
                g.UnSelect()
                g.SetZIndex(0)
            End If

            If e.NewValue IsNot Nothing Then
                Dim g As Graphic = TryCast(e.NewValue, Graphic)
                g.[Select]()
                g.SetZIndex(1)

                'Relationship query
                Dim relationshipParameters As New RelationshipParameter() With { _
                 .ObjectIds = New Integer() {Convert.ToInt32(g.Attributes(TryCast(SelectedStatesTreeView.Tag, String)))}, _
                 .OutFields = New String() {"OBJECTID, NAME, POP2000"}, _
                 .RelationshipId = 0, _
                 .OutSpatialReference = MyMap.SpatialReference _
                }

                queryTask.ExecuteRelationshipQueryAsync(relationshipParameters)
            End If
        End Sub

        Private Sub QueryTask_ExecuteRelationshipQueryCompleted(sender As Object, e As RelationshipEventArgs)
            Dim pr As RelationshipResult = e.Result
            If pr.RelatedRecordsGroup.Count = 0 Then
                RelatedRowsDataGrid.ItemsSource = Nothing
            Else
                Dim pair As System.Collections.Generic.KeyValuePair(Of Integer, System.Collections.Generic.IEnumerable(Of ESRI.ArcGIS.Client.Graphic))
                For Each pair In pr.RelatedRecordsGroup
                    RelatedRowsDataGrid.ItemsSource = pair.Value
                Next pair
            End If
        End Sub

    End Class
End Namespace