AddArticleReference(String) Method

Eplan.EplApi.DataModel Namespace / Function Class / AddArticleReference Method / AddArticleReference(String) Method

Collapse All

In This Topic

Syntax
Exceptions
Remarks
See Also

EPLAN API

AddArticleReference(String) Method

In This Topic

Syntax
Exceptions
Remarks
See Also

Adds a new ArticleReference to the Function. Returns the added 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 Function

Exceptions

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

Remarks

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

See Also

Reference

Function Class
Function Members
Overload List
ArticleReference Class

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

Send Feedback