SetPage(CIMPage,Boolean) Method

In This Topic

Applies the changes made to a modified CIMPage to the layout. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void SetPage( 
   CIMPage page,
   bool resizeElements
)

Public Overloads Sub SetPage( _
   ByVal page As CIMPage, _
   ByVal resizeElements As Boolean _
)

Parameters

page: CIMPage
resizeElements: Scale the elements to fit the new page size

Exceptions

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

Example

Change the layout page size

//Change the layout page size.

//Reference the layout project item
LayoutProjectItem lytItem = Project.Current.GetItems<LayoutProjectItem>()
                         .FirstOrDefault(item => item.Name.Equals("MyLayout"));
if (layoutItem != null)
{
  await QueuedTask.Run(() =>
  {
    //Get the layout
    Layout lyt = lytItem.GetLayout();
    if (lyt != null)
    {
      //Change properties
      CIMPage page = lyt.GetPage();
      page.Width = 8.5;
      page.Height = 11;

      //Apply the changes to the layout
      lyt.SetPage(page);
    }
  });
}

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.1 or higher.

Reference

Layout Class
Layout Members
Overload List

Send feedback