 | Connection Methods |
The Connection type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | CompareTo |
Compares Identifiers of model objects.
(Inherited from ModelObject.) |
| Delete |
Deletes the connection instance with the given ID from the model database.
(Overrides ModelObjectDelete.) |
| Equals |
Check if Identifiers of model objects are same.
(Inherited from ModelObject.) |
 | GetAllReportProperties |
Retrieves all properties for the model object in one hashtable.
Type for the returned value must be checked using type casting.
(Inherited from ModelObject.) |
| GetAllUserProperties |
Retrieves all properties for the model object in one hashtable.
Type for the returned value must be checked using type casting.
(Inherited from ModelObject.) |
| GetAttribute(String, Double) |
Retrieves the attribute with the given name.
(Inherited from BaseComponent.) |
| GetAttribute(String, Int32) |
Retrieves the attribute with the given name.
(Inherited from BaseComponent.) |
| GetAttribute(String, String) |
Retrieves the attribute with the given name.
(Inherited from BaseComponent.) |
| GetChildren |
Returns an enumerator of all the children model objects.
(Inherited from ModelObject.) |
| GetCoordinateSystem |
Returns the coordinate system for the given model object.
(Inherited from ModelObject.) |
| GetDoubleReportProperties |
Retrieves multiple double report properties for the model object. It is faster
to fetch multiple properties at once.
(Inherited from ModelObject.) |
| GetDoubleUserProperties |
Retrieves all double properties for the model object.
(Inherited from ModelObject.) |
| GetDynamicStringProperty |
Gets a dynamic string property from the model object.
(Inherited from ModelObject.) |
| GetFatherComponent |
Returns the father component of the model object.
(Inherited from ModelObject.) |
| GetHierarchicObjects |
Returns an enumerator of all the connected hierarchic objects.
(Inherited from ModelObject.) |
| GetIntegerReportProperties |
Retrieves multiple integer report properties for the model object. It is faster
to fetch multiple properties at once.
(Inherited from ModelObject.) |
| GetIntegerUserProperties |
Retrieves all integer properties for the model object.
(Inherited from ModelObject.) |
| GetPhase |
Retrieves the phase of the model object (the phase number, the phase name,
the phase comment and whether the phase is the current one or not).
(Inherited from ModelObject.) |
| GetPrimaryObject |
Returns the primary object of the connection.
|
| GetReportProperty(String, Double) |
Retrieves a double property of the report for the model object.
(Inherited from ModelObject.) |
| GetReportProperty(String, Int32) |
Retrieves an integer property of the report for the model object.
(Inherited from ModelObject.) |
| GetReportProperty(String, String) |
Retrieves a string property of the report for the model object.
(Inherited from ModelObject.) |
| GetSecondaryObjects |
Returns the secondary objects.
|
| GetStringReportProperties |
Retrieves multiple string report properties for the model object. It is faster
to fetch multiple properties at once.
(Inherited from ModelObject.) |
| GetStringUserProperties |
Retrieves all string properties for the model object.
(Inherited from ModelObject.) |
| GetUserProperty(String, Double) |
Retrieves a double property for the model object.
(Inherited from ModelObject.) |
| GetUserProperty(String, Int32) |
Retrieves an integer property for the model object.
(Inherited from ModelObject.) |
| GetUserProperty(String, String) |
Retrieves a string property for the model object.
(Inherited from ModelObject.) |
| Insert |
Inserts the connection into the model database. All the attributes must be set.
(Overrides ModelObjectInsert.) |
| LoadAttributesFromFile |
Loads the attributes for the component from the given file. These attributes
will be loaded before all the attributes that have been set with the SetAttribute
methods, so any attributes that are set with SetAttribute will override those
loaded from the given standard file.
(Inherited from BaseComponent.) |
| Modify |
Modifies the existing connection in the model database to match the current one.
(Overrides ModelObjectModify.) |
| Select |
Selects a connection from the model database. The connection ID must be set.
(Overrides ModelObjectSelect.) |
| SetAttribute(String, Double) |
Sets the attribute's value to the given value.
(Inherited from BaseComponent.) |
| SetAttribute(String, Int32) |
Sets the attribute's value to the given value.
(Inherited from BaseComponent.) |
| SetAttribute(String, String) |
Sets the attribute's value to the given value.
(Inherited from BaseComponent.) |
| SetDynamicStringProperty |
Sets a dynamic string property for the model object.
(Inherited from ModelObject.) |
| SetLabel |
Sets a label for an object when a new instance is created, this method must be called before Insert.
The label is used in plug-ins for identifying the changed object in modification.
(Inherited from ModelObject.) |
| SetPhase |
Sets the phase of the model object.
(Inherited from ModelObject.) |
| SetPrimaryObject |
Sets the primary object of the connection.
|
| SetSecondaryObject |
Sets the secondary object of the connection. Use this
method if you wish to add only one secondary object
to the connection.
|
| SetSecondaryObjects |
Sets an array list of model objects as the secondary objects of the connection.
|
| SetUserProperties |
Sets multiple properties for the model object.
(Inherited from ModelObject.) |
| SetUserProperty(String, Double) |
Sets a double property for the model object.
(Inherited from ModelObject.) |
| SetUserProperty(String, Int32) |
Sets an integer property for the model object.
(Inherited from ModelObject.) |
| SetUserProperty(String, String) |
Sets a string property for the model object.
(Inherited from ModelObject.) |
See Also