Eplan Platform API
Eplan.EplApi.DataModel Namespace / MergedArticleReference Class
Members

MergedArticleReference Class
This class represents a compound of ArticleReference objects. This may be an articles assembly, a module or a compound of one article's references of all representations of one Function object.
Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.StorableObject
      Eplan.EplApi.DataModel.MergedArticleReference

Syntax
public class MergedArticleReference : StorableObject 
Public Constructors
 NameDescription
Public ConstructorDefault constructor  
Top
Public Properties
 NameDescription
Public PropertyReturns true if this compound representing an articles assembly can be placed disassembled.  
Public PropertyGets count of objects included in this compound.  
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 PropertyReturns true if this compound is an articles assembly.  
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 this compound is a module.  
Public PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
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 the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public PropertyList of P8 properties of the MergedArticleReference object.  
Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Top
Public Methods
 NameDescription
Public MethodCreates a MergedArticleReference object out of an array of ArticleReference objects.  
Public MethodDisassembles assembly or module, returns NULL if it wasn't an assembly or module  
Public MethodDestructor (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 MethodReturns an array of ArticleReference objects included in this compound.  
Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
Public MethodReturns the main ArticleReference object included in this compound.  
Public MethodReturns the main data model object included in this compound.  
Public MethodReturns the position in assembly-structure  
Public MethodReturns an array of data model objects included in this compound.  
Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
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 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