ArcObjects Library Reference (Carto)  

ILayerResultOptions Interface

Provides access to methods that control geometry options.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

This interface is new at ArcGIS 9.3.

Members

Description
Read/write property FormatValuesInResults Indicates whether to format the values in results.
Read/write property GeometryResultOptions Indicates whether we need to modify Geometry.
Read/write property IncludeGeometry Indicates whether we should include Geometry.
Read/write property ReturnFieldNamesInResults Indicates whether to include field name or alias.

CoClasses that implement ILayerResultOptions

CoClasses and Classes Description
LayerResultOptions Layer Result Options CoClass.

Remarks

LayerResultOptions has properties that can be used to customize the results of a MapServer query.

If IncludeGeometry is set to False (default value is True), no geometry is returned. This should increase performance in cases where feature geometry is large. When IncludeGeometry is set to True, you can also choose to densify or generalize the geometry using GeometryResultOptions. Densification is used to better support clients that do not support Arcs (e.g. Bezier, Circular etc.). Generalization reduces the amount of geography being sent across the network and should lead to better performance.

It is important to note that QueryHyperLinks() always returns geometry regardless InlcudeGeometrys value, but honors GeometryResultOptions.

FormatValuesInResults and ReturnFieldNamesInResults are only applied to Find and Identify functions. They are ignored by QueryData, QueryFeatureData2, QueryRowIDs, QueryFeatureIDs2, QueryRowCount, QueryFeatureCount2 & QueryHyperLinks functions. The default values for FormatValuesInResults & ReturnFieldNamesInResults are True and False respectively that means if they are not set explicitly, those functions will respect field formatting and field alias set in the source map document and values are converted to a string in the result. When FormatValuesInResults is set to False, the numerical results of the query will be unformatted. When ReturnFieldNamesInResults is set to True, the results will display original field names.

It is important to note that Identify and Find ignores these properties when querying a layer that does not implement IFeatureLayer interface (i.e. RasterLayer etc.)