Article Class

In This Topic

This class represents articles in the Project.

Inheritance Hierarchy

System.Object
Eplan.EplApi.DataModel.StorableObject
Eplan.EplApi.DataModel.Article

Syntax

C#
C++/CLI

public class Article : StorableObject

public ref class Article : public StorableObject

Example

The following example shows how to use class Article.

foreach (Article oArticle in m_oTestProject.Articles)
{
    if ("BECK.KL2012" == oArticle.PartNr)
    {
        if (!oArticle.Properties.ARTICLE_DEPTH.IsEmpty)
            Console.Out.WriteLine("ARTICLE_DEPTH : " + oArticle.Properties.ARTICLE_DEPTH);
        if (!oArticle.Properties.ARTICLE_VARIANT.IsEmpty)
            Console.Out.WriteLine("ARTICLE_VARIANT : " + oArticle.Properties.ARTICLE_VARIANT);

        foreach (int nIndex in oArticle.Properties.ARTICLE_FREE_DATA_DESCRIPTION.Indexes)
            Console.Out.WriteLine("ARTICLE_FREE_DATA_DESCRIPTION[" + nIndex + "] : " + oArticle.Properties.ARTICLE_FREE_DATA_DESCRIPTION[nIndex]);

        foreach (int nIndex in oArticle.Properties.ARTICLE_FREE_DATA_UNIT.Indexes)
            Console.Out.WriteLine("ARTICLE_FREE_DATA_UNIT[" + nIndex + "] : " + oArticle.Properties.ARTICLE_FREE_DATA_UNIT[nIndex]);

        foreach (int nIndex in oArticle.Properties.ARTICLE_FREE_DATA_VALUE.Indexes)
            Console.Out.WriteLine("ARTICLE_FREE_DATA_VALUE[" + nIndex + "] : " + oArticle.Properties.ARTICLE_FREE_DATA_VALUE[nIndex]);
    }
}

Public Constructors

	Name	Description
	Article Constructor	Overloaded.

Top

Public Properties

	Name	Description
	ArticleAccessories	Returns the list of the accessories from the article.
	ArticleAssemblies	Returns an array of Article.Assembly objects representing parts of an assembly.
	ArticleModules	Returns an array of Article.Module objects representing module items. Array contains a lists of subparts structured by device tag (DT).
	ConnectionPointsInfo	Connection point pattern defined for this article. Returns `null` if article does not contain connection pattern.
	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	Represents this article 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)
	PartNr	Returns article's part number.
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties	.NET Property enabling access to P8 properties of the Article object.
	TypeIdentifier	Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	VariantNr	Returns article's variant number.

Top

Public Methods

	Name	Description
	AddModule	Overloaded. Creates copy of existing module and adds it to article.
	Create	Creates a Article in Project with the specified strPartnr and strVariant.
	Dispose()	Destructor for deterministic finalization of Article 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)
	LoadFromMasterdata	Loads the article from system article database
	LockObject	Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Remove	Removes the article from the Project.
	RemoveModule	Removes module from article.
	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

Article Members
Eplan.EplApi.DataModel Namespace
Working with parts

Send Feedback