ArcGIS Pro 3.4 API Reference Guide
ArcGIS.Core.CIM Namespace / CIMLayout Class
Members Example Version

CIMLayout Class
Represents a layout in a project.
Object Model
CIMLayout ClassCIMLayout ClassTimeInstant ClassTimeInstant ClassCIMLayout ClassCIMMapSeries ClassCIMPage ClassTimeInstant Class
Syntax
Remarks

A layout is a collection of visual elements arranged on a logical sheet of paper. A layout in a GIS is typically used to display one or more maps at a particular extent and scale. The layout is used to compose a presentation of data, describe the maps, and/or tell a story of the map data.

A layout defines a logical sheet of paper. It has a height and a width, and also a linear unit used to display positions on the page. It can have a snapping grid and a set of guides to help users arrange its elements.

The layout contains an ordered list of elements. When the layout draws, it tells each element to draw, in order.

Example
Layout_GetSetDefinition
//Modify a layout's CIM definition

//Perform on the worker thread
await QueuedTask.Run(() =>
{
  CIMLayout cimLayout = layout.GetDefinition();

  //Do something

  layout.SetDefinition(cimLayout);
});
Inheritance Hierarchy

System.Object
   ArcGIS.Core.CIM.CIMObject
      ArcGIS.Core.CIM.CIMDefinition
         ArcGIS.Core.CIM.CIMLayout
            ArcGIS.Core.CIM.CIMReport

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.
See Also