Eplan Platform API
Eplan.EplApi.DataModel Namespace / ConnectionDefinitionPoint Class / AddArticleReference Method / AddArticleReference(ArticleReference,Boolean) Method
ArticleReference object is a prototype for ArticleReference added to ConnectionDefinitionPoint.
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(ArticleReference,Boolean) Method
In This Topic
Adds ArticleReference to the ConnectionDefinitionPoint.
Syntax
public ArticleReference AddArticleReference( 
   ArticleReference oArticle,
   bool bClean
)

Parameters

oArticle
ArticleReference object is a prototype for ArticleReference added to ConnectionDefinitionPoint.
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 reference added to the ConnectionDefinitionPoint. Article reference passed as parameter is not changed.
Exceptions
ExceptionDescription
Eplan.EplApi.Base.BaseExceptionThrown when the Article cannot be added
System.ArgumentNullExceptionThrown when article number is null.
System.ArgumentNullExceptionThrown when article variant is null.
CannotAddArticleExceptionThrown when it was impossible to get valid property index.
See Also

Reference

ConnectionDefinitionPoint Class
ConnectionDefinitionPoint Members
Overload List
ArticleReference Class

 

 

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

Send Feedback