API Help
Eplan.EplApi.DataModel Namespace / Connection Class

Connection Class Properties

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

Public Properties
 NameDescription
Public PropertyReturns ArticleReferences that are referenced by Connection.  
Public PropertyReturns Articles that are referenced by Connection, and only those that are stored in project database.  
Public PropertyReturns Eplan.EplApi.DataModel.EObjects.Cable from a ConnectionDefinitionPoint assigned to this Connection. If there are more then one ConnectionDefinitionPoint assigned to this Connection, an exception is thrown. Such situation has to be handled by calling ConnectionDefPoints and analyze of the result.  
Public PropertyGets/Sets a cable's name to the connection.  
Public PropertyCheck if the Connection can have Articles.  
Public PropertyReturns the Eplan.EplApi.DataModel.E3D.Connection3D which is a 3d representation of this connection.  
Public PropertyAllows to access properties of a ConnectionDefinitionPoint assigned to this Connection. If there are more then one ConnectionDefinitionPoint assigned to this Connection, an exception is thrown. Such situation has to be handled by calling ConnectionDefPoints and analyze of the result.  
Public PropertyReturns the ConnectionDefinitionPoint related to this connection.  
Public PropertyReturns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated) (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyReturns the project as number. The number is unique for all open projects in one session. The number changes when the project is closed and opened again. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyIndex of the end function's connection point (0,1,2,...) that the connection is connected to.  
Public PropertyReturns the end Pin of this connection, if such exists (i.e. if the connection is connected on the target side). Otherwise, NULL is returned.  
Public PropertyReturns the PinBase which this connection is connected to on the target side. If this connection is not connected on the target side, NULL is returned.  
Public PropertyReturns the second of two SymbolReferences connected by this connection.  
Public PropertyTarget number of end function (1,2,3...)  
Public PropertyReturns the FunctionDefinition of the Connection.  
Public PropertyReturns true if this is a Connection object that covers a wire's template in the cable where it belongs.  
Public PropertyChecks if device to which connection is assign is fixed or not.  
Public Property

Determines if the the StorableObject is locked.

The StorableObject is locked when it was explicitly or implicitly locked.

(Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyReturns true if the placement is placed  
Public PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyReturns true if the Connection can be removed  
Public PropertyReturns true if this is a transient Connection object representing a cable wire's template.  
Public Property

Determines if the the StorableObject is transient.

The StorableObject is transient when it was created by default constructor and:

it is a Page and it was not assigned a Project,

it is a Placement or any class derived from it and was not assigned a Page.

(Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyReturns kind of wire.  
Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyReturns the Page where the connection is placed on.  
Public PropertyReturns the PotentialDefinition related to this connection.  
Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public Property.NET Property enabling access to P8 properties of the Connection object.  
Public PropertyGets/Sets connection's representation type.  
Public PropertyReturns the Shielding objects the connection is composed of. It does not return Shielding objects the connection is shielded by.  
Public PropertyIndex of the start function's connection point (0,1,2,...) that the connection is connected to.  
Public PropertyReturns the start Pin of this connection, if such exists (i.e. if the connection is connected on the source side). Otherwise, NULL is returned.  
Public PropertyReturns the PinBase which this connection is connected to on the source side. If this connection is not connected on the source side, NULL is returned.  
Public PropertyReturns the first of two SymbolReferences connected by this connection.  
Public PropertyTarget number of start function (1,2,3...)  
Public PropertyIf connection contains interruption points, this method returns an array of partial connections which current connection consists of For a "net connection" this method will return an empty array.  
Public PropertyThis method returns an array of SymbolReferences objects that belong to a connection . This may for example be T-pieces or corners. Also beginning and end are returned.  
Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyCheck if object is currently write protected or sets Manual write protection  
Top
See Also