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

Glossary Item Box

The StdGeographiesListParameters class provides input parameters for the Standard Geographies List task.

Object Model

StdGeographiesListParameters ClassExtentData ClassBAResultType Class

Syntax

Remarks

The search criterion is specified with either the AnalysisExtent or SearchString parameter values. If both parameters are missing, ID and Name attributes of all standard geography levels are returned.

If the AnalysisExtent parameter is specified, the SpatialRelationship parameter specifies a way for selection of matching features which fall in this extent.

The SearchString parameter can contain up to two comma-separated substrings. The first substring specifies the criterion for search in the locations' name field and the last substring specifies the criterion for search in locations' ID field. If the second string is omitted together with a delimiting comma, the search is applied to both location names and IDs with the same search criterion. The search is applied using the logical "or" operation: a location matches the search criterion if either its name contains the name search substring or its ID contains the ID search substring. The case of an empty name or ID search substring means skipping the search by name or ID, respectively. If both substrings are empty, any location of the standard geography level matches the search criteria.

Example Description
"San,123" Searches location name containing "San" substring or location ID containing "123" substring.
"123" Searches location name containing "123" substring or location ID containing "123" substring.
",123" Searches location ID containing "123" substring.
"San," Searches location name containing "San" substring.
"," Searches any location of the standard geography level.

Example

The code snippet below creates StdGeographiesListParameters and then executes a Standard Geographies List task.
C#Copy Code
StdGeographiesListParameters parameters = new StdGeographiesListParameters();
            
// Set a data extent for analysis to ExtendData object specified with myExtent.
parameters.AnalysisExtent = myExtent;
 
stdGeographiesListTask.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.StdGeographiesListParameters

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.