MergedArticleReference Class

In This Topic

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

C#
C++/CLI

public class MergedArticleReference : StorableObject

public ref class MergedArticleReference : public StorableObject

Public Constructors

	Name	Description
	MergedArticleReference Constructor	Default constructor

Top

Public Properties

	Name	Description
	CanBePlacedDisassembled	Returns true if this compound representing an articles assembly can be placed disassembled.
	Count	Gets count of objects included in this compound.
	CrossReferencedObjectsAll	Returns 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)
	DatabaseIdentifier	Returns 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)
	IsAssembly	Returns true if this compound is an articles assembly.
	IsLocked	Determines if the the StorableObject is locked. The StorableObject is locked when it was explicitly or implicitly locked. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsModule	Returns true if this compound is a module.
	IsReadOnly	Determines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
	IsTransient	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)
	IsValid	Determines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties	List of P8 properties of the MergedArticleReference object.
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Public Methods

	Name	Description
	Create	Creates a MergedArticleReference object out of an array of ArticleReference objects.
	DisassembleRecursive	Disassembles assembly or module, returns NULL if it wasn't an assembly or module
	Dispose()	Destructor (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Equals	Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetArticleReferences	Returns an array of ArticleReference objects included in this compound.
	GetHashCode	Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetMainArticleReference	Returns the main ArticleReference object included in this compound.
	GetMainReleatedObject	Returns the main data model object included in this compound.
	GetPosInAssemblyStructure	Returns the position in assembly-structure
	GetRelatedObjects	Returns an array of data model objects included in this compound.
	GetTypeName	Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	LockObject	Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	SmartLock	Tries 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)
	ToStringIdentifier	Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Reference

MergedArticleReference Members
Eplan.EplApi.DataModel Namespace
ArticleReference Class

Send Feedback