ArcGIS Pro 3.3 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / MapTool Class / OverlayEmbeddableControl Property
Example

In This Topic
    OverlayEmbeddableControl Property
    In This Topic
    Gets the EmbeddableControl created for the tool to be shown on the map view. This is control set by the OverlayControlID property.
    Syntax
    protected EmbeddableControl OverlayEmbeddableControl {get;}
    Protected ReadOnly Property OverlayEmbeddableControl As EmbeddableControl
    Remarks
    In some cases you may need to provide a control that displays on top of the map view to configure the behavior of the tool while in use similar to the measure tool. This property returns the instance of the overlay EmbeddableControl set by the OverlayControlID. property. When you activate a different tool the overlay control will be removed.
    Example
    Tool with an Overlay Embeddable Control
    // Using the Visual Studio SDK templates, add a MapTool and an EmbeddableControl
    // The EmbeddableControl is registered in the "esri_embeddableControls" category in the config.daml file
    // 
    //  <categories>
    //    <updateCategory refID = "esri_embeddableControls" >
    //      <insertComponent id="mapTool_EmbeddableControl" className="EmbeddableControl1ViewModel">
    //        <content className = "EmbeddableControl1View" />
    //      </insertComponent>
    //    <updateCategory>
    //  </categories>
    
    internal class MapTool_WithOverlayControl : MapTool
    {
      public MapTool_WithOverlayControl()
      {
        // substitute this string with the daml ID of the embeddable control you added
        OverlayControlID = "mapTool_EmbeddableControl";
      }
    
      protected override void OnToolMouseDown(MapViewMouseButtonEventArgs e)
      {
        e.Handled = true;
      }
    
      protected override Task HandleMouseDownAsync(MapViewMouseButtonEventArgs e)
      {
        //Get the instance of the ViewModel
        var vm = OverlayEmbeddableControl;
        if (vm == null)
          return Task.FromResult(0);
    
        // cast vm to your viewModel in order to access your properties
    
        //Get the map coordinates from the click point and set the property on the ViewMode.
        return QueuedTask.Run(() =>
        {
          var mapPoint = MapView.Active.ClientToMap(e.ClientPoint);
          string clickText = string.Format("X: {0}, Y: {1}, Z: {2}", mapPoint.X, mapPoint.Y, mapPoint.Z);
        });
      }
    }
    Requirements

    Target Platforms: Windows 11, Windows 10

    ArcGIS Pro version: 3 or higher.
    See Also