Create(Page,SymbolVariant) Method

Eplan.EplApi.DataModel.EObjects Namespace / PLC Class / Create Method / Create(Page,SymbolVariant) Method

Collapse All

In This Topic

Syntax
Exceptions
See Also

EPLAN API

Create(Page,SymbolVariant) Method

In This Topic

Syntax
Exceptions
See Also

Creates a SymbolReference. It is placed on the page passed as a parameter, using a given SymbolVariant.

Syntax

C#
C++/CLI

public override void Create( 
   Page page,
   SymbolVariant variant
)

public:
void Create( 
   Page^ page,
   SymbolVariant^ variant
) override

Parameters

page: Eplan.EplApi.DataModel.Page where the symbol reference will be located on
variant: Eplan.EplApi.DataModel.MasterData.SymbolVariant representing the graphical symbol of the PLC

Exceptions

Exception	Description
System.ArgumentNullException	Thrown when `page` is `null`.
System.ArgumentNullException	Thrown when `symbVariant` is `null`.
IncorrectSymbolTypeException	Thrown when symbVariant is incompatible with this object. See IncorrectSymbolTypeException for details.
ObjectCreationException	Thrown when the function cannot be created.
InvalidArgumentException	Thrown when given Page has PageType sets to ExternalDocument.

See Also

Reference

PLC Class
PLC Members
Overload List
SymbolVariant Class
Page Class

EPLAN API , 15.12.2018, © by EPLAN Software and Service GmbH and Co. KG. All rights reserved.

Send Feedback