ArticleReference Class

In This Topic

This class represents a part reference on a project, function, or a connection.

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.StorableObject
      Eplan.EplApi.DataModel.ArticleReference
         Eplan.EplApi.DataModel.EObjects.TerminalAccessory

Syntax

C#
C++/CLI

public class ArticleReference : StorableObject

public ref class ArticleReference : public StorableObject

Remarks

For further information, see WorkingWithParts. Some part reference properties are taken from the part if they are set to empty on the reference. Mind that ArticleReference is offline object and if you change a property from ArticleReference.Properties, you need to call the StoreToObject method in order to write data to corresponding properties of parent object (Project/Function/Connection).

Public Constructors

	Name	Description
	ArticleReference Constructor	Constructor used to create transient article reference object. That object can be passed as a parameter to ConnectionDefinitionPoint() function.

Top

Public Properties

	Name	Description
	Article	Returns the article of this articlereference. This is the Article stored in the Project, can be NULL if the article is not found in Project.
	BelongsToArticlePlacement	Returns true, if the article reference contains to an article placement
	Count	Sets and gets count
	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)
	FunctionTemplates	Returns an array of transient object (of Connection or Function type) that represent function templates associated with the article referenced by this object.
	IdentifyingName	Gets the identifying device tag of the parent function(property ArticleReferencePropertyList.ARTICLEREF_IDENTNAME).
	IsAssembly	Represents this reference an 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)
	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)
	ParentObject	Returns the Object this ArticleReference belongs to.
	PartNr	Returns ArticleReference's part number.
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties	Represents ArticleReference properties
	ReferencePos	Returns the index of the ArticleReference reference for the given article if it is referenced by a Function. This number is useful when reading values of article reference properties (indexed properties on function, e.g. FUNC_ARTICLE_COUNT). It is not equal to the 0-based position of element in the table of articles which is returned by Function.Articles/>
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	VariantNr	Sets and gets ArticleReference's variant number.

Top

Public Methods

	Name	Description
	Dispose()	Destructor for deterministic finalization of ArticleReference object. (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)
	GetHashCode	Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	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)
	RemoveArticleReference	Removes the ArticleReference from the Object.
	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)
	StoreToObject	Commits all changes of the ArticleReference to the matching properties of a parent object (Project/Function/Connection).
	ToStringIdentifier	Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)

Top

Reference

ArticleReference Members
Eplan.EplApi.DataModel Namespace

Send Feedback