AddGroup(String,Boolean,Boolean,String,String) Method

In This Topic

Adds a group section to the report. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public void AddGroup( 
   string fieldName,
   bool sortAscending,
   bool caseSensitiveSort,
   string parentGroupFieldName,
   string containerSectionName
)

Public Overloads Sub AddGroup( _
   ByVal fieldName As String, _
   ByVal sortAscending As Boolean, _
   ByVal caseSensitiveSort As Boolean, _
   ByVal parentGroupFieldName As String, _
   ByVal containerSectionName As String _
)

Parameters

fieldName: The name of the field for the group.
sortAscending: Sort the group field data in ascending order.
caseSensitiveSort: Use case sensitive compares when sorting the group field data.
parentGroupFieldName: The name of the parent group. If empty, the group will be the topmost group.
containerSectionName: The name of the section to add the group.

Exceptions

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

Example

Modify the Report DefinitionQuery

//Note: Call within QueuedTask.Run()
//Remove Groups
// The fields in the datasource used for the report
var listFields = new List<string> {
       "STATE_NAME"
      };
report.RemoveGroups(listFields);

//Add Group
report.AddGroup("STATE_NAME", true, true, "");

//Modify the Definition Query
var defQuery = "STATE_NAME LIKE 'C%'";
report.SetDefinitionQuery(defQuery);

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3.0 or higher.

Reference

Report Class
Report Members
Overload List

Send feedback