Class LayerResultOptionsClass
[Guid("80308F69-EE5A-457A-AD33-9F897C70EA40")]
[ClassInterface(ClassInterfaceType.None)]
public class LayerResultOptionsClass : LayerResultOptions, ILayerResultOptions, IXMLSerialize, IPersistStream, IPersist, IXMLVersionSupport, IDocumentVersionSupportGEN
- Inheritance
-
LayerResultOptionsClass
- Implements
- Inherited Members
Constructors
LayerResultOptionsClass()
public LayerResultOptionsClass()
Explicit Interface Implementations
ConvertToSupportedObject(esriArcGISVersion)
Convert the object to another object that is supported.
virtual object ConvertToSupportedObject(esriArcGISVersion docVersion)
Parameters
docVersionesriArcGISVersion
Returns
Remarks
This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.
Deserialize(IXMLSerializeData)
Deserializes an object from XML.
virtual void Deserialize(IXMLSerializeData data)
Parameters
dataIXMLSerializeData
FormatValuesInResults
Indicates whether to format the values in results.
virtual bool FormatValuesInResults { get; set; }
Returns
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)
GeometryResultOptions
Indicates whether we need to modify Geometry.
virtual IGeometryResultOptions GeometryResultOptions { get; set; }
Returns
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.
GetClassID(out Guid)
virtual void GetClassID(out Guid pClassID)
Parameters
pClassIDGuid
GetSizeMax(out _ULARGE_INTEGER)
virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)
Parameters
pcbSize_ULARGE_INTEGER
IncludeGeometry
Indicates whether we should include Geometry.
virtual bool IncludeGeometry { get; set; }
Returns
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.
IsDirty()
virtual void IsDirty()
IsSupportedAtVersion(esriArcGISVersion)
Is this object valid at the given document version.
virtual bool IsSupportedAtVersion(esriArcGISVersion docVersion)
Parameters
docVersionesriArcGISVersion
Returns
Remarks
Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.
Load(IStream)
virtual void Load(IStream pstm)
Parameters
pstmIStream
MinNamespaceSupported
The minimum namespace the class can serialize to (eg the 90 namespace).
virtual string MinNamespaceSupported { get; }
Returns
ReturnFieldNamesInResults
Indicates whether to include field name or alias.
virtual bool ReturnFieldNamesInResults { get; set; }
Returns
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)
Save(IStream, int)
virtual void Save(IStream pstm, int fClearDirty)
Parameters
Serialize(IXMLSerializeData)
Serializes an object to XML.
virtual void Serialize(IXMLSerializeData data)
Parameters
dataIXMLSerializeData