ArcGIS Pro 3.3 API Reference Guide
ArcGIS.Desktop.Reports Namespace / Report Class


In This Topic
    Report Class Methods
    In This Topic

    For a list of all members of this type, see Report members.

    Public Methods
     NameDescription
    Public MethodAddGroupOverloaded.   
    Public MethodAddLayoutPageOverloaded.   
    Public MethodAddRelatedReport Adds a related report section to the report. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodAddSubReport Adds a subreport to the report. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodAddTemplateSubReport Adds a template subreport to the report. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodClearElementSelection Clears all selected elements in the report.  
    Public MethodDeleteElement Deletes the specified element from the report. Note that section elements cannot be deleted and will be ignored if specified. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodDeleteElements Deletes the set of elements from the report. Note that section elements cannot be deleted and will be ignored if specified. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodExportToPDF Export a report to a PDF format. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodFindElement Finds the report element by name.  
    Public MethodFindElements Finds the elements with the given names on the report.  
    Public MethodGetDefinition Returns the element's CIM definition. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetElementsAsFlattenedListGet the collection of ArcGIS.Desktop.Layouts.Element from the report as a flattened list. Nested groups within ArcGIS.Desktop.Layouts.GroupElement are not preserved.  
    Public MethodGetExpressions Gets the expressions of the report section. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodGetSelectedElements Gets the set of selected elements on the report.  
    Public MethodGetStatistics Returns the statistics in the given Report or Related Report Section.  
    Public MethodMoveGroupSection Moves the group section elements to new location. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodMoveRelateSection Moves the relate section to new location. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodMoveReportSectionElement Moves the report section element to new index location. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodRemoveGroupsOverloaded.   
    Public MethodRemoveRelatedReport Removes the related report from the report. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodRemoveSectionElement Removes the report section element from the report. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodRemoveSupplementalPage Removes the supplemental page from the report. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodReplaceLayoutPage Replaces a layout page section with a new layout definition. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSelectAllElements Select all report elements in a report.  
    Public MethodSelectElement Selects the specified element in the report.  
    Public MethodSelectElements Selects the set of elements in the report.  
    Public MethodSetDataSourceOverloaded.   
    Public MethodSetDataSourceFieldsOverloaded.   
    Public MethodSetDefinitionApplies the changes made to a modified ArcGIS.Core.CIM.CIMReport back to the report. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetDefinitionQueryOverloaded.   
    Public MethodSetExpressions Updates the expressions of the report section. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetName Updates the name of the report. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetPage Sets the page of the report. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetPageHeight Updates the page height of the report. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetRelatedDataSource Updates the data source of the related report section. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetRelatedDataSourceFields Updates the grouping and sorting fields of the related report section. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodSetRelatedReportName Updates the name of the related report element. This method must be called on the MCT. Use QueuedTask.Run.  
    Public MethodUnSelectElement Unselect the element on the report.  
    Public MethodUnSelectElements Unselect the elements on the report.  
    Top
    Protected Methods
     NameDescription
    Protected MethodNotifyPropertyChangedOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Protected MethodSetPropertyOverloaded.  (Inherited from ArcGIS.Desktop.Framework.Contracts.PropertyChangedBase)
    Top
    See Also

    Reference

    Report Class
    ArcGIS.Desktop.Reports Namespace

     

     

    ©2024 Esri Inc., All Rights Reserved. Generated on Monday, April 22, 2024

    Send feedback