CreateLayout(Double,Double,LinearUnit,Boolean,Double) Method

In This Topic

Creates a layout using a simple set of parameters. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public Layout CreateLayout( 
   double width,
   double height,
   LinearUnit units,
   bool showRulers,
   double smallestRulerDivision
)

Public Overloads Function CreateLayout( _
   ByVal width As Double, _
   ByVal height As Double, _
   ByVal units As LinearUnit, _
   Optional ByVal showRulers As Boolean, _
   Optional ByVal smallestRulerDivision As Double _
) As Layout

Parameters

width: The width of the page layout in page units.
height: The height of the page layout in page units.
units: Specify the linear units.
showRulers: An optional boolean to show rulers on the layout.
smallestRulerDivision: An optional double to specify smallest ruler division.

Return Value

Returns Layout or a null.

Exceptions

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

Example

CreateLayout_WITH_WD_AND_HT

//This example creates a new layout using a minimum set of parameters.

//Added references
using ArcGIS.Desktop.Layouts;                    
using ArcGIS.Desktop.Framework.Threading.Tasks; 
using ArcGIS.Desktop.Core;

public class CreateLayoutEx1
{
  async public static Task<Layout> CreateBasicLayout(double width, double height, LinearUnit units, string LayoutName)
  {
    Layout layout = null;
    await QueuedTask.Run(() =>
    {
      layout = LayoutFactory.Instance.CreateLayout(width, height, units);
      layout.SetName(LayoutName);
    });

    //Open the layout in a pane on the UI!
    await ProApp.Panes.CreateLayoutPaneAsync(layout);

    return layout;
  }
}

Create a new, basic layout and open it

//Create a new, basic layout and open it.

//Create layout with minimum set of parameters on the worker thread
Layout lyt = await QueuedTask.Run(() =>
{
  var newLayout = LayoutFactory.Instance.CreateLayout(8.5, 11, LinearUnit.Inches);
  newLayout.SetName("New 8.5x11 Layout");
  return newLayout;
});
      
//Open new layout on the GUI thread
await ProApp.Panes.CreateLayoutPaneAsync(lyt);

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

LayoutFactory Class
LayoutFactory Members
Overload List

Send feedback