Class TopologyRuleClass

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll
[Guid("8AD43889-F2A4-43B2-83DC-6D1D38DDBCC8")]
[ClassInterface(ClassInterfaceType.None)]
public class TopologyRuleClass : TopologyRule, IRule, ITopologyRule, IXMLSerialize, IClone, IPersistStream, IPersist
Inheritance
TopologyRuleClass
Implements
Inherited Members

Constructors

TopologyRuleClass()

public TopologyRuleClass()

Explicit Interface Implementations

AllDestinationSubtypes

Indicates if all destination subtypes are specified for the topology rule.

virtual bool AllDestinationSubtypes { get; set; }

Returns

bool

Remarks

AllDestinationSubtypes specifies if the rule applies to all subtypes in the destination feature class. By default, AllDestinationSubtypes is False, and the DestinationSubtype property is set to -1. If the destination class contains subtypes, and these values are not changed, adding the rule to the topology will fail.

AllDestinationSubtypes is set to the opposite value of DestinationSubtypeSpecified. If the topology rule is a single feature class type, AllDestinationSubtypes is set to True once the rule is added to the topology.

AllOriginSubtypes

Indicates if all origin subtypes are specified for the topology rule.

virtual bool AllOriginSubtypes { get; set; }

Returns

bool

Remarks

AllOriginSubtypes specifies if the rule applies to all subtypes in the origin feature class. By default, AllOriginSubtypes is False, and the OriginSubtype property is set to -1. If the origin class contains subtypes, and these values are not changed, adding the rule to the topology will fail.

AllOriginSubtypes is set to the opposite value of OriginSubtypeSpecified. If the topology rule is a single feature class type, AllOriginSubtypes is set to True once the rule is added to the topology.

Assign(IClone)

Assigns the properties of src to the receiver.

virtual void Assign(IClone src)

Parameters

src IClone

Category

The name associated with the validation rule.

virtual int Category { get; set; }

Returns

int

Clone()

Clones the receiver and assigns the result to *clone.

virtual IClone Clone()

Returns

IClone

Deserialize(IXMLSerializeData)

Deserializes an object from XML.

virtual void Deserialize(IXMLSerializeData data)

Parameters

data IXMLSerializeData

DestinationClassID

Destination ClassID of the topology rule.

virtual int DestinationClassID { get; set; }

Returns

int

Remarks

The DestinationClassID of the topology rule.  If the topology rule is a single feature class type, the DestinationClassID does not need to be set, and it will be equal to the OriginClassID by default. If DestinationClassID is specified, it will be ignored.

DestinationSubtype

Destination subtype of the topology rule.

virtual int DestinationSubtype { get; set; }

Returns

int

Remarks

The DestinationSubtype specifies the destination subtype of the topology rule.  If AllDestinationSubtypes is set to True, the DestinationSubtype is ignored. If DestinationSubtype is set to -1, AllDestinationSubtypes will return True.  If the assigned value does not correspond to a valid subtype, an error will be raised when the rule is added to the topology.

DestinationSubtypeSpecified

Indicates if a destination subtype has been specified.

virtual bool DestinationSubtypeSpecified { get; }

Returns

bool

Remarks

The DestinationSubtypeSpecified will return True whenever the rule has been specified at the subtype level using ITopologyRule::DestinationSubtype. The DestinationSubtypeSpecified is the opposite of ITopologyRule::AllDestinationSubtypes.

ErrorShapeTypes(out bool, out bool, out bool)

Indicates the shape types of errors for the topology rule.

virtual void ErrorShapeTypes(out bool multipoints, out bool polylines, out bool polygons)

Parameters

multipoints bool
polylines bool
polygons bool

Remarks

The ErrorShapeTypes method returns the supported error geometries for the specific topology rule. If a topology rule does not support multi-points, this parameter equates to points. Every topology rule supports the creation of point topology errors.

GUID

GUID of the topology rule.

virtual string GUID { get; }

Returns

string

Remarks

A GUID uniquely identifies each topology rule, and it is assigned when the rule is added to the topology using ITopologyRuleContainer::AddRule. The GUID is also used to get the topology rule using ITopologyRuleContainer::RulebyGUID.

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

Helpstring

The helpstring associated with the validation rule.

virtual string Helpstring { get; set; }

Returns

string

ID

The ID of the validation rule.

virtual int ID { get; set; }

Returns

int

Remarks

This property will always return -1 for rules in geodatabases created in versions of ArcGIS later than 9.3.1.

IsDirty()

virtual void IsDirty()

IsEqual(IClone)

Indicates if the receiver and other have the same properties.

virtual bool IsEqual(IClone other)

Parameters

other IClone

Returns

bool

IsIdentical(IClone)

Indicates if the receiver and other are the same object.

virtual bool IsIdentical(IClone other)

Parameters

other IClone

Returns

bool

Load(IStream)

virtual void Load(IStream pstm)

Parameters

pstm IStream

Name

Name of the topology rule.

virtual string Name { get; set; }

Returns

string

Remarks

The Name property can be used to assign a user-specified string to each rule. By default, the Name property is empty.

OriginClassID

Origin ClassID of the topology rule.

virtual int OriginClassID { get; set; }

Returns

int

Remarks

The OriginClassID of the topology rule.

OriginSubtype

Origin subtype of the topology rule.

virtual int OriginSubtype { get; set; }

Returns

int

Remarks

The origin subtype of a topology rule. If AllOriginSubtypes is set to True, the OriginSubtype is ignored. If OriginSubtype is set to -1, AllOriginSubtypes will return True. If the assigned value does not correspond to a valid subtype, an error will be raised when the rule is added to the topology.

OriginSubtypeSpecified

Indicates if an origin subtype has been specified.

virtual bool OriginSubtypeSpecified { get; }

Returns

bool

Remarks

The ITopologyRule::OriginSubtypeSpecified property will return True whenever the rule has been specified at the subtype level with the use of ITopologyRule::OriginSubtype. The OriginSubtypeSpecified is the opposite of ITopologyRule::AllOriginSubtypes.

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

TopologyRuleType

Topology rule type of the topology rule.

virtual esriTopologyRuleType TopologyRuleType { get; set; }

Returns

esriTopologyRuleType

Remarks

A value from the esriTopologyRuleType enumeration that represents the rule's type.

TriggerErrorEvents

Indicates if error events are triggered for the topology rule.

virtual bool TriggerErrorEvents { get; set; }

Returns

bool

Remarks

The TriggerErrorEvents property is not currently in use and is reserved for future use.

Type

The type associated with the validation rule.

virtual esriRuleType Type { get; }

Returns

esriRuleType