API Help
Eplan.EplApi.DataModel Namespace / Connection Class

In This Topic
Connection Class Methods
In This Topic

For a list of all members of this type, see Connection members.

Public Methods
 NameDescription
Public MethodOverloaded. Adds a new ArticleReference to the Connection. Returns the added ArticleReference.  
Public MethodAssigns this connection to another, which means that values of this connection's properties are copied to the target connection and the source connection itself is removed from the project.  
Public MethodDestructor for deterministic finalization of Connection object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodChecks if a specific write protection kind was set.  
Public MethodTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodAllows to create non-placed connection from a connection template. In effect connection template becomes covered template.  
Public MethodTemporarily disables write protection. Note that current write protection  
Public MethodPlaces this connection as a connection def. point on the given schematic page and in the given location. If this is an uncovered connection template and the location points to a connection line on schematic page, the template automatically becomes covered (i.e. connection is created in the project) Note: When uncovered connection template becomes covered, connections on the page are updated which may affect performance. If this method needs to be called repeatedly, use the DisableConnectionUpdateStep object to make the performance better.  
Public MethodRemoves the connection from the Project.  
Public MethodRemoves the ArticleReference from the Connecttion  
Public MethodTries to lock current object. If object is Placement - it's page will be locked as well; Eplan.EplApi.DataModel.E3D.Placement3D locks it's installation space; Function locks all it's connections and connection definition points; Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Top
See Also