Business Analyst Online API for Silverlight 2.2 Reference
SummaryReportsParameters Class
Members  Example  See Also  Send Feedback
ESRI.ArcGIS.Client.BAO.Tasks.Reports Namespace : SummaryReportsParameters Class

Glossary Item Box

The SummaryReportsParameters class provides input parameters for the Summary Reports task.

Object Model

SummaryReportsParameters ClassBoundaries ClassOutputTypes ClassBAResultType Class

Syntax

Remarks

Report items are usually sorted by area ID field values having the form "storeID_ringID". If the area ID field has a value non-confirming to this template, the RingIDField and StoreIDField parameters can be specified to provide the proper sorting.

Output options for this task include creating a feature class for subsequent analysis (OutputTypes.GetFeatureClass), rendering output image (OutputTypes.GetMapImage), and creating a report (OutputTypes.GetReport). If output options are not specified, the report output is requested.

Example

The code snippet below creates SummaryReportsParameters and then executes a Summary Reports task.
C#Copy Code
SummaryReportsParameters parameters = new SummaryReportsParameters();
            
// Boundaries could be either of type ESRI.ArcGIS.Client.Tasks.FeatureSet or ESRI.ArcGIS.Client.BACore.StandardLayer.
parameters.Boundaries = new Boundaries(featureSet);
 
// Set report options.
parameters.ReportOptions = new List<ReportOptions>() {
    new ReportOptions("PDF", "market_profile", new ReportHeader("Custom title"))
};
            
// "AREA_ID" is the default value for the AreaIDField parameter.
//parameters.AreaIDField = "AREA_ID";
            
// GetReport is the default option for this task.
//parameters.OutputTypes.GetReport = true;
            
summaryReportsTask.ExecuteAsync(parameters, new AsyncResponder(resultHandler, faultHandler));

Inheritance Hierarchy

System.Object
   ESRI.ArcGIS.Client.BACore.Client.BATaskParameters
      ESRI.ArcGIS.Client.BACore.Client.SummaryReportParameters
         ESRI.ArcGIS.Client.BAO.Tasks.Reports.SummaryReportsParameters

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2010-2012 ESRI Inc. All Rights Reserved.