AddArticleReference(String,String,UInt32,Boolean) Method

In This Topic

Adds a new ArticleReference to the Project. Returns the added ArticleReference.

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
)

Parameter Name	Description
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.

ArticleReference added to the Project

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when the ArticleReference cannot be added
System.ArgumentNullException	Thrown when `strArticleNR` is `null`.
System.ArgumentNullException	Thrown when `strVariantNR` is `null`.
CannotAddArticleException	Thrown when it was impossible to get valid `property index`.

Remarks

This method adds the article to the Project only if the part already exists in the system database.