Interface IRelateDescription

Namespace
ESRI.ArcGIS.Carto
Assembly
ESRI.Server.Carto.dll

Provides access to the RelateDescription Interface.

[Guid("BADFD2ED-2776-4B21-879A-B99B2EA582A6")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IRelateDescription

Properties

GeoTransformation

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

IGeoTransformation GeoTransformation { get; set; }

Property Value

IGeoTransformation

GeometryResultOptions

Indicates whether we need to modify Geometry.

IGeometryResultOptions GeometryResultOptions { get; set; }

Property Value

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.

IncludeGeometry

Indicates whether we should include Geometry.

bool IncludeGeometry { get; set; }

Property Value

bool

Remarks

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

OutputSpatialReference

Spatial reference of the output geometry in the related records.

ISpatialReference OutputSpatialReference { get; set; }

Property Value

ISpatialReference

OutputTimeReference

Output time reference for the time fields.

ITimeReference OutputTimeReference { get; set; }

Property Value

ITimeReference

RelatedTableDefinitionExpression

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

string RelatedTableDefinitionExpression { get; set; }

Property Value

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.

string RelatedTableFields { get; set; }

Property Value

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.

int RelationshipID { get; set; }

Property Value

int

ResultFormat

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

esriRelateResultFormat ResultFormat { get; set; }

Property Value

esriRelateResultFormat