The CatchmentGroup type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
| AddCatchmentId |
Adds a catchment to this group.
| |
| ComputeFingerPrint |
Compute FingerPrint of the Entity.
(Inherited from Entity.) | |
| Create |
Creates a new catchment group and adds it to the database.
Throws an error if a catchment group of the same name already exists
| |
| GetAllCatchmentIds |
Gets all the catchments in this group
| |
| GetCatchmentId |
Gets a catchment with the given name. Throws if it does not exist in this group.
| |
| GetReferenceInfo |
For Data Shortcut reference entity (IsReferenceObject == true), gets the entity's reference information.
(Inherited from Entity.) | |
| RemoveAllCatchments |
Deletes all catchments in this catchment group
| |
| RemoveCatchmentId |
Deletes a catchment and removes it from this group.
|
Properties
| Name | Description | |
|---|---|---|
| Application |
Gets the Application. Not currently implemented.
(Inherited from Entity.) | |
| Description |
Gets or sets the Entity object's description.
(Inherited from Entity.) | |
| DisplayName |
Gets the Entity object's display name.
(Inherited from Entity.) | |
| Document |
Gets the Document. Not currently implemented.
(Inherited from Entity.) | |
| FingerPrint |
Gets or sets FingerPrint of the Entity.
(Inherited from Entity.) | |
| FolderId |
Gets the folder ObjectId of the Entity
Returns ObjectId::Null if the Entity is located in root folder
(Inherited from Entity.) | |
| IsReferencedSourceExisting |
For reference object (IsReferenceObject == true), it will try to get its source entity while opening a drawing.
This indicates whether the reference object has source entity.
(Inherited from Entity.) | |
| IsReferenceObject |
Gets whether the Entity is a reference object. A reference object is
located in another drawing, and linked using a data shortcut or Vault.
If the entity is native to the current drawing this property returns false;
if it is being referenced via data shortcuts or AutoCAD Vault it returns true.
(Inherited from Entity.) | |
| IsReferenceStale |
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is stale.
(Inherited from Entity.) | |
| IsReferenceSubObject |
For reference objects (IsReferenceObject == true), gets whether the Entity is a reference subobject.
For example, when iterating through the structure of a pipe network referenced from another drawing,
this property is true for each entity.
(Inherited from Entity.) | |
| IsReferenceValid |
For reference objects (IsReferenceObject == true), gets whether the Entity object's reference is valid.
(Inherited from Entity.) | |
| IsUsed |
Gets whether the style is used by other objects in the current drawing.
(Inherited from Entity.) | |
| Name |
Returns the name of a catchment group
(Overrides Entity..::..Name.) | |
| ShowToolTip |
Gets or sets whether to show tooltips for the Entity.
(Inherited from Entity.) | |
| StyleId |
Gets or sets the Entity object's style Id.
(Inherited from Entity.) | |
| StyleName |
Gets or sets the Entity object's style name.
(Inherited from Entity.) |