Create(Page,SymbolVariant) Method

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

Collapse All

In This Topic

Syntax
Exceptions
Remarks
See Also

EPLAN API

Create(Page,SymbolVariant) Method

In This Topic

Syntax
Exceptions
Remarks
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 oPage,
   SymbolVariant symbVariant
)

public:
void Create( 
   Page^ oPage,
   SymbolVariant^ symbVariant
) override

Parameters

oPage
symbVariant: Eplan.EplApi.DataModel.MasterData.SymbolVariant that will be assigned

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.

See Also

Reference

Cable Class
Cable Members
Overload List
SymbolVariant Class
Page Class

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

Send Feedback