TrayButtons

This sample illustrates how to build custom tray buttons.
Three samples are included.
The first is a simple map tray button, ZoomToVisibleExtentTrayButton. This tray button will change the map extent to the visible extent of all layers in the map.
The second sample is the layout tray toggle button. This tray button is the Toggle button type created to be used in layout only.
When toggled on and off layout guides that have been authored in the current layout will change from being visible to invisible or vice versa depending on the toggle state of the tray button.
The third sample is a map tray popup button. This tray button toggles the editing mini toolbar visibility and re-creates on the popup, UI from the Editing backstage options controlling the mini toolbar.

View it live

Language:              C#
Subject:               Map Authoring
Contributor:           ArcGIS Pro SDK Team <arcgisprosdk@esri.com>
Organization:          Esri, https://www.esri.com
Date:                  04/04/2024
ArcGIS Pro:            3.3
Visual Studio:         2022
.NET Target Framework: net8.0-windows

Resources

Community Sample Resources

Samples Data

• Sample data for ArcGIS Pro SDK Community Samples can be downloaded from the Releases page.

How to use the sample

1. In Visual Studio click the Build menu.Then select Build Solution.
2. Launch the debugger to open ArcGIS Pro.
3. ArcGIS Pro will open, select a project that has editable layers in the map.
4. Change the map extent and test out the tray button with the zoom to extent icon and see that the map extent will update to the extent off all visible layers.
5. Open a layout, or insert a new layout and add a map frame to the layout.
6. Right click on the ruler and select 'Add Guides..' In the dialog select Orientation 'Both' and Placement 'Evenly spaced' and click OK.
   
7. Click on the tray toggle button 'LayoutGuideToggle', which had the ruler icon and is directly to the right of the snapping tray button in the bottom left of the map.
   
8. The first click turns on the Guides, so click a second time to toggle them off, a third click will toggle them back on.
9. Activate the map view again and open the Create Features dialog and select a template to start sketching. The editing mini toolbar will appear on the map.
10. Hover over the red square tray button icon, which is the Mini Toolbar Tray Button defined in this sample.
    
11. Click on a radio button to change the position and size of the mini toolbar and check Magnify. Notice the toolbar is updated to match the new properties.
12. Toggle the tray button and notice the mini toolbar is no longer visible.
13. Revert any properties change to the mini toobar if not desired.

                    Home | API Reference | Requirements | Download | Samples