Provides access to methods that control geometry options.
Description
This interface is new at ArcGIS 9.3.
Members
| Name | Description | |
|---|---|---|
 |
FormatValuesInResults | Indicates whether to format the values in results. |
 |
GeometryResultOptions | Indicates whether we need to modify Geometry. |
|
IncludeGeometry | Indicates whether we should include Geometry. |
|
ReturnFieldNamesInResults | Indicates whether to include field name or alias. |
ILayerResultOptions.FormatValuesInResults Property
Indicates whether to format the values in results.
Public Property FormatValuesInResults As Boolean
public bool FormatValuesInResults {get; set;}
Remarks
FormatValuesInResults is only applied to Find and Identify functions. It is ignored by other query function such as QueryData, QueryFeatureData2, QueryHyperLinks etc. The default value for FormatValuesInResults is True � that means if it is not set explicitly, field formatting set in the source map document will be honored. For example, if the format for a field of type double is set to have thousand separator and 3 digits after decimal, the output will be a string �999,999.999�. When it is set to False, values will be returned in the source data type, for the same case, the returned value will be a double 999999.9999999.
This property is ignored by Identify and Find functions when querying a layer that does not implement IFeatureLayer interface (i.e. Raster layer)
ILayerResultOptions.GeometryResultOptions Property
Indicates whether we need to modify Geometry.
Public Property GeometryResultOptions As IGeometryResultOptions
public IGeometryResultOptions GeometryResultOptions {get; set;}
Remarks
Use GeometryResultOptions to densify or generalize the geometry returned from a query. 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.
ILayerResultOptions.IncludeGeometry Property
Indicates whether we should include Geometry.
Public Property IncludeGeometry As Boolean
public bool IncludeGeometry {get; set;}
Remarks
If IncludeGeometry is set to False, no geometry is returned. This should increase performance in cases where feature geometry is large. The default value for IncludeGeometry is True.
QueryHyperLinks() always returns geometry regardless InlcudeGeometry�s value.
ILayerResultOptions.ReturnFieldNamesInResults Property
Indicates whether to include field name or alias.
Public Property ReturnFieldNamesInResults As Boolean
public bool ReturnFieldNamesInResults {get; set;}
Remarks
ReturnFieldNamesInResults is only applied to Find and Identify functions. It is ignored by other query function such as QueryData, QueryFeatureData2, QueryHyperLinks etc. The default value for ReturnFieldNamesInResults is False � that means if it is not set explicitly, field aliases set in the source map document will be honored in Find and Identify results. For example, if a field named �CNTRY_NM� has an alias set to �Country Name� in the original map document, a Find or Identify result will display �Country Name�. When ReturnFieldNamesInResult set to True, the field name �CNTRY_NM� will be returned instead of the alias.
This property is ignored by Identify and Find functions when querying a layer that does not implement the IFeatureLayer interface (i.e. Raster layer)
Classes that implement ILayerResultOptions
| 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 InlcudeGeometry�s 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.)