Eplan Platform API
Eplan.EplApi.DataModel.E3D Namespace / Function3D Class / AddArticleReference Method / AddArticleReference(String,String,UInt32,Boolean) Method
article's number
article's variant number
count of articles to add
Some ArticleReferences might not be completly cleaned in the past. Setting parameter to true allows to clean ArticleReference position before inserting new one.

In This Topic
    AddArticleReference(String,String,UInt32,Boolean) Method
    In This Topic
    Syntax
    public virtual ArticleReference AddArticleReference( 
       string strArticleNR,
       string strVariantNR,
       uint nCount,
       bool bClean
    )
    public:
    virtual ArticleReference^ AddArticleReference( 
       String^ strArticleNR,
       String^ strVariantNR,
       uint nCount,
       bool bClean
    ) 

    Parameters

    strArticleNR
    article's number
    strVariantNR
    article's variant number
    nCount
    count of articles to add
    bClean
    Some ArticleReferences might not be completly cleaned in the past. Setting parameter to true allows to clean ArticleReference position before inserting new one.

    Return Value

    Article added to the Function3D
    Exceptions
    ExceptionDescription
    Thrown when the Article cannot be added
    Thrown when strArticleNR is null.
    Thrown when strVariantNR is null.
    Thrown when it was impossible to get valid property index.
    When 2nd ArticleReference is added to a Function3D having ArticlePlacement category
    Remarks
    Stores the article from System article database in the Project. Functions3D of category ArticlePlacement can have only 1 ArticleReference object.
    See Also