Esri Business Analyst Server API for Silverlight 2.2 Reference
StdGeographiesFromTreeParameters Class
Members  Example  See Also  Send Feedback
ESRI.ArcGIS.Client.BAServer.Tasks.StdGeographies Namespace : StdGeographiesFromTreeParameters Class

Glossary Item Box

The StdGeographiesFromTreeParameters class provides input parameters for the Standard Geographies from Tree task.

Object Model

StdGeographiesFromTreeParameters ClassBAResultType Class

Syntax

Remarks

A geography level is selected using the BranchID and Depth parameters. The BranchID specifies a branch of the tree of standard geography levels (e.g. "USbyTracts", "USbyCounties", or "USbyZIP5") and the Depth specifies the geography level depth for the given branch (e.g. the level depth in "USbyZIP5" branch is 0 for whole USA, 1 for States, 2 for Counties, and 3 for ZIPs).

The Criterion and IDCriterion parameters specify the criteria for search in locations' name and ID fields, respectively. If both criteria are specified, the geography locations are searched in the standard geography level using the logical AND operation. If both criteria are missing, all locations of the standard geography level are queried. The returned feature list represents the complete list of children of all matching locations from the specified geography level.

Example

The code snippet below creates StdGeographiesFromTreeParameters and then executes a Standard Geographies from Tree task.
C#Copy Code
StdGeographiesFromTreeParameters parameters = new StdGeographiesFromTreeParameters();
            
// Set an ID of branch in the tree of standard geography levels.
parameters.BranchID = "USbyZIP5";
            
// Set a depth of the geography level in the given branch. This is the US Counties level.
parameters.Depth = 2;
            
// Set a string to search in names of geography locations. This is the San Diego County.
parameters.Criterion = "San Diego"; 
            
// Execute the task. The result will be a list of all ZIP5 codes of the San Diego County.
stdGeographiesFromTreeTask.ExecuteAsync(parameters, new AsyncResponder(resultHandler, faultHandler));

Inheritance Hierarchy

System.Object
   ESRI.ArcGIS.Client.BACore.Client.BABaseParameters
      ESRI.ArcGIS.Client.BACore.Client.BAUtilityParameters
         ESRI.ArcGIS.Client.BAServer.Tasks.StdGeographies.StdGeographiesFromTreeParameters

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.