Eplan Platform API
Eplan.EplApi.DataModel Namespace / Function Class / Create Method / Create(Page,SymbolVariant) Method
Page where the symbol reference will be located on
Eplan.EplApi.DataModel.MasterData.SymbolVariant that will be assigned

In This Topic
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
public override void Create( 
   Page page,
   SymbolVariant symbVariant
)

Parameters

page
Page where the symbol reference will be located on
symbVariant
Eplan.EplApi.DataModel.MasterData.SymbolVariant that will be assigned
Exceptions
ExceptionDescription
System.ArgumentNullExceptionThrown when page is null.
System.ArgumentNullExceptionThrown when symbVariant is null.
IncorrectSymbolTypeExceptionThrown when symbVariant is incompatible with this object. See IncorrectSymbolTypeException for details.
ObjectCreationExceptionThrown when the function cannot be created.
InvalidArgumentExceptionThrown 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.
See Also

Reference

Function Class
Function Members
Overload List
SymbolVariant Class
Page Class

 

 

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

Send Feedback