Public Overloads Function GetGridOptions( _ ByVal map As Map _ ) As GridOptions
public GridOptions GetGridOptions( Map map )
Parameters
- map
- The input map
Return Value
The grid options
Public Overloads Function GetGridOptions( _ ByVal map As Map _ ) As GridOptions
public GridOptions GetGridOptions( Map map )
| Exception | Description |
|---|---|
| System.ArgumentNullException | map cannot be null |
| ArcGIS.Core.CalledOnWrongThreadException | This method or property must be called within the lambda passed to QueuedTask.Run. |
{
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);
});
}
{
//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);
});
}
{
//assume
//var map = MapView.Active.Map;
var center_pt = MapView.Active.Extent.Center;
var width = MapView.Active.Extent.Width;
var height = MapView.Active.Extent.Height;
var qtr_width = width * 0.25;
var qtr_ht = height * 0.25;
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);
//Set the grid origin
var x1 = center_pt.X + qtr_width;
var y1 = center_pt.Y + qtr_ht;
gridOptions.SetGridOrigin(new Coordinate2D(x1, y1));
//or use Coordinate3D
gridOptions.SetGridOrigin(new Coordinate3D(x1, y1, 0));
//To apply changes, the gridoptions must be set back on the map
GridOptionsEnvironment.Instance.SetGridOptions(map, gridOptions);
});
}
Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)