Class RelateDescriptionClass
[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
dataIXMLSerializeData
GeoTransformation
Geo transformation required to transform the geometry if the requested GCS is different from the source.
virtual IGeoTransformation GeoTransformation { get; set; }
Returns
GeometryResultOptions
Indicates whether we need to modify Geometry.
virtual IGeometryResultOptions GeometryResultOptions { get; set; }
Returns
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
pClassIDGuid
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
pClassIDGuid
IncludeGeometry
Indicates whether we should include Geometry.
virtual bool IncludeGeometry { get; set; }
Returns
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
pstmIStream
MinNamespaceSupported
The minimum namespace the class can serialize to (eg the 90 namespace).
virtual string MinNamespaceSupported { get; }
Returns
OutputSpatialReference
Spatial reference of the output geometry in the related records.
virtual ISpatialReference OutputSpatialReference { get; set; }
Returns
OutputTimeReference
Output time reference for the time fields.
virtual ITimeReference OutputTimeReference { get; set; }
Returns
RelatedTableDefinitionExpression
Definition expression of the related table for which related records are being requested.
virtual string RelatedTableDefinitionExpression { get; set; }
Returns
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
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
ResultFormat
Result format that indicates the type of content in the result.
virtual esriRelateResultFormat ResultFormat { get; set; }
Returns
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