API Help
Eplan.EplApi.DataModel Namespace / Article Class
Members Example

In This Topic
    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
    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
     NameDescription
    Public ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyReturns the list of the accessories from the article.  
    Public PropertyReturns an array of Article.Assembly objects representing parts of an assembly.  
    Public PropertyReturns an array of Article.Module objects representing module items. Array contains a lists of subparts structured by device tag (DT).  
    Public PropertyConnection point pattern defined for this article. Returns null if article does not contain connection pattern.  
    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 PropertyRepresents this article an 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 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 article's part number.  
    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 Article object.  
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns article's variant number.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Creates copy of existing module and adds it to article.  
    Public MethodCreates a Article in Project with the specified strPartnr and strVariant.  
    Public MethodDestructor for deterministic finalization of Article object. (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 MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodLoads the article from system article database  
    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 MethodRemoves the article from the Project.  
    Public MethodRemoves module from article.  
    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