ArcGIS Pro 3.7 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / GridOptionsEnvironment Class / Instance Property
Example

In This Topic
    Instance Property (GridOptionsEnvironment)
    In This Topic
    Gets the singleton instance for IGridOptionsEnvironment
    Syntax
    Public Shared ReadOnly Property Instance As IGridOptionsEnvironment
    public static IGridOptionsEnvironment Instance {get;}
    Example
    Show A Grid On the Map - Toggle On/Off
    {
        GridOptionsEnvironment.Instance.ShowGrid = !GridOptionsEnvironment.Instance.ShowGrid;
    }
    Get the Grid Options for a Map
    {
        QueuedTask.Run(() =>
        {
            //Does the 'map' currently have any options?
            var hasOptions = GridOptionsEnvironment.Instance.HasGridOptions(map);
    
            //If grid options have not been set for the map, then default grid options are added
            //for the map otherwise the existing gridoptions are returned.
            //NOTE: Grid options are returned by value meaning a copy is always returned. Any changes made to the
            //grid options need to be -set- back on the map using SetGridOptions for the changes to persist.
            var gridOptions = GridOptionsEnvironment.Instance.GetGridOptions(
                                       MapView.Active.Map);
    
            //Only return grid options if grid options have previously been set:
            var gridOptions2 = GridOptionsEnvironment.Instance.GetGridOptions(
                                       MapView.Active.Map, false);
        });
    }
    Get and Set Grid Options for a Map
    {
        //assume
        //var map = MapView.Active.Map;
    
        QueuedTask.Run(() =>
        {
            //If grid options have not been set for the map, then default grid options are added
            //for the map and returned otherwise the existing gridoptions are returned.
            //NOTE: Grid options are by value meaning a copy is returned. Any changes made to the
            //grid options need to be -set- back on the map using SetGridOptions for the changes to persist.
            var gridOptions = GridOptionsEnvironment.Instance.GetGridOptions(map);
            //change some properties
            gridOptions.RotateWithMap = !gridOptions.RotateWithMap;
            gridOptions.GridLineColor = ColorFactory.Instance.RedRGB;
            gridOptions.GridLineColor = ColorFactory.Instance.BlueRGB;
            //To apply changes, the gridoptions must be set back on the map
            GridOptionsEnvironment.Instance.SetGridOptions(map, gridOptions);
        });
    }
    Requirements

    Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.7 or higher.
    See Also