Class RelateDescriptionClass

Namespace
ESRI.ArcGIS.Carto
Assembly
ESRI.Server.Carto.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("B1353E90-50D2-42FA-B9A6-519BAF66A951")]
public class RelateDescriptionClass : RelateDescription, IRelateDescription, IXMLSerialize, IXMLVersionSupport, IPersistStream, IPersist
Inheritance
RelateDescriptionClass
Implements
Inherited Members

Constructors

RelateDescriptionClass()

public RelateDescriptionClass()

Explicit Interface Implementations

Deserialize(IXMLSerializeData)

Deserializes an object from XML.

virtual void Deserialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

GeoTransformation

Geo transformation required to transform the geometry if the requested GCS is different from the source.

virtual IGeoTransformation GeoTransformation { get; set; }

Returns

IGeoTransformation

GeometryResultOptions

Indicates whether we need to modify Geometry.

virtual IGeometryResultOptions GeometryResultOptions { get; set; }

Returns

IGeometryResultOptions

Remarks

GeometryResultOptions can be used to generalize or densify geometry of related features. When a geometry is need to flash or highlight those features, you may consider reducing number of vertices in those returned geometry by generalizing which will improve the performance. Some time a feature may be made of arc(s), in case the client application can’t process those arcs, geometry can be densified to return geometry made of a series of vertices.

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

IncludeGeometry

Indicates whether we should include Geometry.

virtual bool IncludeGeometry { get; set; }

Returns

bool

Remarks

IncludeGeometry flags whether records from a related layer will contain geometry. Unless you need geometry, setting is false will improve the performance.

IsDirty()

virtual void IsDirty()

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

OutputSpatialReference

Spatial reference of the output geometry in the related records.

virtual ISpatialReference OutputSpatialReference { get; set; }

Returns

ISpatialReference

OutputTimeReference

Output time reference for the time fields.

virtual ITimeReference OutputTimeReference { get; set; }

Returns

ITimeReference

RelatedTableDefinitionExpression

Definition expression of the related table for which related records are being requested.

virtual string RelatedTableDefinitionExpression { get; set; }

Returns

string

Remarks

In case your related StandaloneTable/layer has definition expression and you want that to be honored, or you want to restrict your search within a subset of the related StandaloneTable/layer, you need to explicitly set that to this property. You may get the default definition expression set to that layer/StandaloneTable in the source document from IMapTableDescription::DefinitionExpression.

For example, LayerA is related to TableB. Records in that table in the source map document restricted not to include information beyond 1990 [i.e. "Year" <= 1990]. If RelatedTableDefinitionExpression is not set, the related results may contain information beyond 1990.

When this property is empty, the search will be performed on all the records/features on the StandaloneTable/layer.

 

RelatedTableFields

Table fields that need to be returned as a part of the relate results.

virtual string RelatedTableFields { get; set; }

Returns

string

Remarks

Pass in “*” to RelatedTableFields if you want to have all visible fields returned, or specify a list of field name if you want a subset of field list. You may get the list of all visible fields from IMapTableInfo::Fields. It throws exception when the field list contains an invalid field name or invisible field name.

RelationshipID

Relationship ID that uniquely idenentifies a relate to a table.

virtual int RelationshipID { get; set; }

Returns

int

ResultFormat

Result format that indicates the type of content in the result.

virtual esriRelateResultFormat ResultFormat { get; set; }

Returns

esriRelateResultFormat

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