ArcGIS Pro 3.1 API Reference Guide
ArcGIS.Desktop.Layouts Namespace / Layout Class / SetMetadata Method
The xml formatted metadata
Example

In This Topic
    SetMetadata Method (Layout)
    In This Topic
    Sets the Layout metadata. This method must be called on the MCT. Use QueuedTask.Run.
    Syntax
    public void SetMetadata( 
       string metadataXml
    )
    Public Sub SetMetadata( _
       ByVal metadataXml As String _
    ) 

    Parameters

    metadataXml
    The xml formatted metadata
    Exceptions
    ExceptionDescription
    This method or property must be called within the lambda passed to QueuedTask.Run.
    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
    //var layout = ...;
    //Must be on the 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, Windows 10

    ArcGIS Pro version: 3.0 or higher.
    See Also