SetDefinition Method (MapSeries)

In This Topic

Sets the CIM definition of the map series. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void SetDefinition( 
   CIMMapSeries cimMapSeries
)

Public Sub SetDefinition( _
   ByVal cimMapSeries As CIMMapSeries _
)

Parameters

cimMapSeries

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.

Example

MapSeries_GetSetDefinition

//Get and modify a map series CIM definition and set the changes back to the layout

//Perform on the worker thread
await QueuedTask.Run(() =>
{
  MapSeries MS = layout.MapSeries as MapSeries;
  CIMMapSeries CIM_MS = MS.GetDefinition();
  CIM_MS.Enabled = false;
  MS.SetDefinition(CIM_MS);
  layout.SetMapSeries(MS);
});

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.0 or higher.

Reference

MapSeries Class
MapSeries Members

Send feedback