SetMetadata Method (Layout)

In This Topic

Sets the Layout metadata. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Sub SetMetadata( _
   ByVal metadataXml As String _
)

public void SetMetadata( 
   string metadataXml
)

Parameters

metadataXml: The xml formatted metadata

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.Xml.XmlException	There is a load or parse error in the XML

Remarks

The input xml must be a valid metadata document. The Layout metadata must be editable. Refer to GetCanEditMetadata.

Example

Layout Metadata

{
  //Note: Must be on QueuedTask.Run

  //Gets the Layout metadata.
  var layout_xml = layout.GetMetadata();
  //Can metadata be edited?
  if (layout.GetCanEditMetadata())
    //Set the metadata back
    layout.SetMetadata(layout_xml);
}

Requirements

Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

ArcGIS Pro version: 3.0 or higher.

Reference

Layout Class
Layout Members

Send feedback