SaveAsFile Method (Layout)

In This Topic

Exports a layout to a new layout (.pagx) file. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void SaveAsFile( 
   string fullPathToPagXFile,
   bool overwrite
)

Public Sub SaveAsFile( _
   ByVal fullPathToPagXFile As String, _
   ByVal overwrite As Boolean _
)

Parameters

fullPathToPagXFile: A string representing the full path of the output file.
overwrite: Set to true to overwrite the mapx file if it already exists

Exceptions

Exception	Description
System.ArgumentNullException	value fullPathToPagXFile cannot be null
ArcGIS.Core.CalledOnWrongThreadException	This method must be called within the lambda passed to QueuedTask.Run.

Remarks

A copy of the layout's definition is saved to file. A layout file can be imported into another project using the ItemFactory Class. A suffix of .pagx is added if the filename does not have one or has a different suffix. To overwrite an existing file of the same name, set overwrite = true.

Example

Layout_SaveAsFile

//Save a layout to a pagx file.

//Perform on the worker thread
await QueuedTask.Run(() =>
{
  layout.SaveAsFile(filePath, true);
});

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

Layout Class
Layout Members

Send feedback