Create(Page,SymbolVariant) Method

In This Topic

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.

Remarks

This method no longer can create functions with category Shielding. The correct way to create Shield object is either use one of static Create methods or use a method on Shield class.

Reference

PLC Class
PLC Members
Overload List
SymbolVariant Class
Page Class

Send Feedback