Eplan Platform API
Eplan.EplApi.DataModel.E3D Namespace / Function3D Class / AddArticleReference Method / AddArticleReference(String,String,UInt32) Method
article's number
article's variant number
count of articles to add

In This Topic
AddArticleReference(String,String,UInt32) 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,
   string strVariantNR,
   uint nCount
)

Parameters

strArticleNR
article's number
strVariantNR
article's variant number
nCount
count of articles to add

Return Value

Article added to the Function3D
Exceptions
ExceptionDescription
Eplan.EplApi.Base.BaseExceptionThrown when the Article cannot be added
System.ArgumentNullExceptionThrown when strArticleNR is null.
System.ArgumentNullExceptionThrown when strVariantNR is null.
Eplan.EplApi.DataModel.CannotAddArticleExceptionThrown when it was impossible to get valid property index.
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. 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