RelateDescription
A class that describes the related table for which the related records are being queried and how result records are formatted.
|
Property |
Type |
Description |
|---|---|---|
|
RelationshipID |
int |
The ID of a relationship between two tables or layers. |
|
RelatedTableDefinitionExpression |
string |
The definition expression to limit available features/rows to query. |
|
RelatedTableFields |
string |
The list of fields to be returned in the result. |
|
OutputSpatialReference | SpatialReference |
Used to output the result geometry in desired Coordinate System. |
|
GeoTransformation | GeoTransformation |
Ensures the spatial correctness of the resultant geometry. |
|
IncludeGeometry |
bool |
Boolean to flag whether geometry should be included in the result. |
|
GeometryResultOptions | GeometryResultOptions |
Used to generalize or densify the returned geometry. |
|
ResultFormat | esriRelateResultFormat |
The output result format. |
Remarks
Pass in "*" to RelatedTableFields if you want to have a visible fields returned, or specify a list of field name if you want a subset of field list. It will throw an exception when the field list contains an invalid field name or invisible field name.
If there is a DefinitionExpression set to the related StandaloneTableDescription or LayerDescription, the RelatedTableDefinitionExpression should be set to the one set to the related StandaloneTableDescription or LayerDescription. For example, Layer A is related to Table B. Records in that table in the source map document restricted not to include information beyond 1990 (DefinitionExpression is used to do that). If RelatedTableDefinitionExpression is not set, the related results will contain information beyond 1990.
IncludeGeometry flags whether records from a related layer will contain geometry. Unless you need geometry, setting it to false will improve the performance.
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.