Eplan Platform API
Eplan.EplApi.DataModel.E3D Namespace / Function3D Class / AddArticleReference Method / AddArticleReference(String) Method
number of added article

In This Topic
AddArticleReference(String) Method
In This Topic
Adds a new Eplan.EplApi.DataModel.ArticleReference to the Function3D. Returns the added Eplan.EplApi.DataModel.ArticleReference.
Syntax
public virtual ArticleReference AddArticleReference( 
   string strArticleNR
)

Parameters

strArticleNR
number of added article

Return Value

ArticleReference added to the Function3D
Exceptions
ExceptionDescription
Eplan.EplApi.Base.BaseExceptionThrown when the Article cannot be added
Eplan.EplApi.Base.BaseExceptionThrown when this Function3D cannot have Articles
System.ArgumentNullExceptionThrown when strArticleName is null.
Eplan.EplApi.DataModel.CannotAddArticleExceptionWhen 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.
See Also

Reference

Function3D Class
Function3D Members
Overload List
ArticleReference Class

 

 

EPLAN API , 16.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

Send Feedback