Class MapServerIdentifyResultClass

Namespace
ESRI.ArcGIS.Carto
Assembly
ESRI.Server.Carto.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("8AEC469A-6795-454A-9C0B-E47D6DCC6C95")]
public class MapServerIdentifyResultClass : MapServerIdentifyResult, IMapServerIdentifyResult, IXMLSerialize, IXMLVersionSupport, IPersistStream, IPersist, IDocumentVersionSupportGEN
Inheritance
MapServerIdentifyResultClass
Implements
Inherited Members

Constructors

MapServerIdentifyResultClass()

public MapServerIdentifyResultClass()

Explicit Interface Implementations

ConvertToSupportedObject(esriArcGISVersion)

Convert the object to another object that is supported.

virtual object ConvertToSupportedObject(esriArcGISVersion docVersion)

Parameters

docVersion esriArcGISVersion

Returns

object

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

data IXMLSerializeData

GetClassID(out Guid)

virtual void GetClassID(out Guid pClassID)

Parameters

pClassID Guid

GetSizeMax(out _ULARGE_INTEGER)

virtual void GetSizeMax(out _ULARGE_INTEGER pcbSize)

Parameters

pcbSize _ULARGE_INTEGER

IPersist_GetClassID(out Guid)

virtual void IPersist_GetClassID(out Guid pClassID)

Parameters

pClassID Guid

IsDirty()

virtual void IsDirty()

IsSupportedAtVersion(esriArcGISVersion)

Is this object valid at the given document version.

virtual bool IsSupportedAtVersion(esriArcGISVersion docVersion)

Parameters

docVersion esriArcGISVersion

Returns

bool

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.

LayerID

The layer ID of the identified object.

virtual int LayerID { get; }

Returns

int

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

MinNamespaceSupported

The minimum namespace the class can serialize to (eg the 90 namespace).

virtual string MinNamespaceSupported { get; }

Returns

string

Name

The name of the identified object.

virtual string Name { get; }

Returns

string

Remarks

Name is defined by the primary display field set in the map document.

Properties

A set of name-value pairs for the field names and values of the identified object.

virtual IPropertySet Properties { get; }

Returns

IPropertySet

Remarks

The property set contained in Properties honors field formatting, field visibility and field aliases set in the original map document. All returned values are in string format.

RelatedRows

The related rows (relationships) of the identified object.

virtual IMapServerRelationships RelatedRows { get; }

Returns

IMapServerRelationships

Remarks

A layer can be related to a table. RelatedRows  returns a collection of MapServerRelationship objects.  IMapServerRelationship  contains the name of the relate and  Rows . This property returns a collection of MapServerRow objects. Using IMapServerRow you can access properties (Name, PropertySet and RelatedRows) of the row of a related table.

Save(IStream, int)

virtual void Save(IStream pstm, int fClearDirty)

Parameters

pstm IStream
fClearDirty int

Serialize(IXMLSerializeData)

Serializes an object to XML.

virtual void Serialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

Shape

The geometry of the identified object.

virtual IGeometry Shape { get; }

Returns

IGeometry

Remarks

Shape contains the geometry of a feature returned from a MapServer Identify query. This geometry have the same spatial reference system as the DefaultMapDescription. When ILayerResultOptions is not used, the Shape property returns geometry. If the Shape field is invisible in the source map, the Shape property may still contain geometry depending on how IncludeGeometry is set by the user. 

In some cases, for performance reasons, you may want limit or adjust the geometry being returned. Use ILayerResultOptions to manage this. If IncludeGeometry is set to False, Shape property returns nothing. This should increase performance in cases where feature geometry is large. You can also choose to densify or generalize the geometry returned by 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.

Densified or generalized geometry should only be used for navigation or display purpose, such as zooming to, flashing, or highlighting the selected feature. For spatial queries, GeometryResultOptions should not be used as it may returns unexpected results. For more information on please see IGeometry, Densify, and Generalize .