AddArticleReference(String) Method

In This Topic

Adds a new Eplan.EplApi.DataModel.ArticleReference to the Function3D. Returns the added Eplan.EplApi.DataModel.ArticleReference.

Syntax

C#
C++/CLI

public virtual ArticleReference AddArticleReference( 
   string strArticleNR
)

public:
virtual ArticleReference^ AddArticleReference( 
   String^ strArticleNR
)

Parameters

strArticleNR: number of added article

Return Value

ArticleReference added to the Function3D

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when the Article cannot be added
Eplan.EplApi.Base.BaseException	Thrown when this Function3D cannot have Articles
System.ArgumentNullException	Thrown when `strArticleName` is `null`.
Eplan.EplApi.DataModel.CannotAddArticleException	When 2nd ArticleReference is added to a Function3D having ArticlePlacement category

Remarks

Stores the article from System article database in the Project. Adds one article with variant 1 and count 1. Functions3D of category ArticlePlacement can have only 1 ArticleReference object.

Reference

Function3D Class
Function3D Members
Overload List
ArticleReference Class

Send Feedback