Query Related Records Online

This sample demonstrates how to use a relationship query to display information from a related table for the selected features. Clicking on the map highlight a set of wells near the clicked point. Select a well from the list to display related features (tops). The object id of the well 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. Feature layers can have more than one relationship and each relationship is identified by a unique identifier. You can use the Services Directory to find the relationship id.

XAML

<UserControl x:Class="ArcGISWPFSDK.QueryRelatedRecords"
             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>
            <esri:MarkerSymbol x:Key="SelectMarkerSymbol" OffsetX="7" OffsetY="7">
                <esri:MarkerSymbol.ControlTemplate>
                    <ControlTemplate>
                        <Ellipse x:Name="Element" Width="14" Height="14" Fill="Red" Stroke="Black" StrokeThickness="0.5" >
                            <VisualStateManager.VisualStateGroups>
                                <VisualStateGroup x:Name="SelectionStates">
                                    <VisualState x:Name="Unselected" />
                                    <VisualState x:Name="Selected">
                                        <Storyboard>
                                            <ColorAnimation Storyboard.TargetName="Element" 
                                                Storyboard.TargetProperty="(Ellipse.Fill).(SolidColorBrush.Color)"
                                                To="Cyan" Duration="00:00:0.25"/>
                                        </Storyboard>
                                    </VisualState>
                                </VisualStateGroup>
                            </VisualStateManager.VisualStateGroups>
                        </Ellipse>
                    </ControlTemplate>
                </esri:MarkerSymbol.ControlTemplate>
            </esri:MarkerSymbol>

            <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[OBJECTID]}" 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>

        </Grid.Resources>

        <esri:Map x:Name="MyMap" Extent="-10854000,4502000,-10829000,4524000" WrapAround="True"
                  MouseClick="MyMap_MouseClick">

            <esri:ArcGISTiledMapServiceLayer 
                Url="http://services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer" />

            <esri:ArcGISDynamicMapServiceLayer ID="DynamicMapWellsLayer" VisibleLayers="0,1"                                            
                Url="http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Petroleum/KSPetro/MapServer" />

            <esri:GraphicsLayer ID="GraphicsWellsLayer" />
        </esri:Map>

        <Border x:Name="ResultsDisplay" Background="#77919191" 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="140" />
                    <ColumnDefinition Width="Auto" />
                </Grid.ColumnDefinitions>

                <TextBlock Text="Wells: " Margin="4,10,10,6" Foreground="Black" TextWrapping="Wrap" 
                       FontWeight="Bold" FontSize="10"/>

                <TreeView x:Name="SelectedWellsTreeView" Grid.Row="1" Grid.Column="0" Margin="2"
                                 BorderBrush="Black" BorderThickness="1" ItemsSource="{Binding}"   
                                 SelectedItemChanged="SelectedWellsTreeView_SelectedItemChanged" 
                                 ItemTemplate="{StaticResource TreeViewItemTemplate}" />

                <TextBlock Margin="4,10,60,6" TextWrapping="Wrap" Grid.Column="1" Foreground="Black"
                           Text="Tops related to the selected well: " 
                           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[API_NUMBER]}" Header="API Number"/>
                        <DataGridTextColumn CanUserSort="False" Binding="{Binding Attributes[ELEVATION]}" Header="Elevation"/>
                        <DataGridTextColumn CanUserSort="False" Binding="{Binding Attributes[FORMATION]}" Header="Formation"/>
                        <DataGridTextColumn CanUserSort="False" Binding="{Binding Attributes[TOP]}" Header="Top"/>
                    </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 well points near a location.  Select wells in the panel below to view related records." 
                 Width="200" Margin="30,20,30,25" HorizontalAlignment="Left" TextWrapping="Wrap" Foreground="Black"/>
        </Grid>

    </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;


namespace ArcGISWPFSDK
{
    public partial class QueryRelatedRecords : UserControl
    {
        GraphicsLayer graphicsLayer;
        QueryTask queryTask;

        public QueryRelatedRecords()
        {
            InitializeComponent();

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

            queryTask = new QueryTask("http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Petroleum/KSPetro/MapServer/0");
            queryTask.ExecuteCompleted += QueryTask_ExecuteCompleted;
            queryTask.ExecuteRelationshipQueryCompleted += QueryTask_ExecuteRelationshipQueryCompleted;
            queryTask.Failed += QueryTask_Failed;
        }

        void MyMap_MouseClick(object sender, ESRI.ArcGIS.Client.Map.MouseEventArgs e)
        {
            graphicsLayer.Graphics.Clear();
            SelectedWellsTreeView.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)
            {
                SelectedWellsTreeView.Tag = featureSet.ObjectIdFieldName;
                SelectedWellsTreeView.ItemsSource = featureSet.Features;
                foreach (Graphic g in featureSet.Features)
                {
                    g.Symbol = LayoutRoot.Resources["SelectMarkerSymbol"] as MarkerSymbol;
                    graphicsLayer.Graphics.Add(g);
                }
                ResultsDisplay.Visibility = System.Windows.Visibility.Visible;
            }
            else
            {
                ResultsDisplay.Visibility = System.Windows.Visibility.Collapsed;
                MessageBox.Show("No wells found here, please try another location.");
            }
        }

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

        private void SelectedWellsTreeView_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[SelectedWellsTreeView.Tag as string]) },
                    OutFields = new string[] { "OBJECTID, API_NUMBER, ELEVATION, FORMATION, TOP" },
                    RelationshipId = 3,
                    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
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

Namespace ArcGISWPFSDK
    Partial Public Class QueryRelatedRecords
        Inherits UserControl
        Private graphicsLayer As GraphicsLayer
        Private queryTask As QueryTask

        Public Sub New()
            InitializeComponent()

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

            queryTask = New QueryTask("http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Petroleum/KSPetro/MapServer/0")
            AddHandler queryTask.ExecuteCompleted, AddressOf QueryTask_ExecuteCompleted
            AddHandler queryTask.ExecuteRelationshipQueryCompleted, AddressOf QueryTask_ExecuteRelationshipQueryCompleted
            AddHandler queryTask.Failed, AddressOf QueryTask_Failed
        End Sub

        Private Sub MyMap_MouseClick(ByVal sender As Object, ByVal e As ESRI.ArcGIS.Client.Map.MouseEventArgs)
            graphicsLayer.Graphics.Clear()
            SelectedWellsTreeView.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(ByVal mapExtent As Envelope, ByVal point As MapPoint, ByVal 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(ByVal sender As Object, ByVal args As ESRI.ArcGIS.Client.Tasks.QueryEventArgs)
            Dim featureSet As FeatureSet = args.FeatureSet
            If featureSet IsNot Nothing AndAlso featureSet.Features.Count > 0 Then
                SelectedWellsTreeView.Tag = featureSet.ObjectIdFieldName
                SelectedWellsTreeView.ItemsSource = featureSet.Features
                For Each g As Graphic In featureSet.Features
                    g.Symbol = TryCast(LayoutRoot.Resources("SelectMarkerSymbol"), MarkerSymbol)
                    graphicsLayer.Graphics.Add(g)
                Next g
                ResultsDisplay.Visibility = System.Windows.Visibility.Visible
            Else
                ResultsDisplay.Visibility = System.Windows.Visibility.Collapsed
                MessageBox.Show("No wells found here, please try another location.")
            End If
        End Sub

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

        Private Sub SelectedWellsTreeView_SelectedItemChanged(ByVal sender As Object, ByVal 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(SelectedWellsTreeView.Tag, String)))}, .OutFields = New String() {"OBJECTID, API_NUMBER, ELEVATION, FORMATION, TOP"}, .RelationshipId = 3, .OutSpatialReference = MyMap.SpatialReference}

                queryTask.ExecuteRelationshipQueryAsync(relationshipParameters)
            End If
        End Sub

        Private Sub QueryTask_ExecuteRelationshipQueryCompleted(ByVal sender As Object, ByVal 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