Create(SymbolVariant,Page) Method

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

Collapse All

In This Topic

Syntax
Exceptions
See Also

EPLAN API

Create(SymbolVariant,Page) Method

In This Topic

Syntax
Exceptions
See Also

Creates a SymbolReference or more specialized object derived from it, depending on symbol type and function definition assigned to the symbol in symbVariant parameter. The object is placed on the page passed as a parameter, using a given SymbolVariant.

Syntax

C#
C++/CLI

public static SymbolReference Create( 
   SymbolVariant symbVariant,
   Page page
)

public:
static SymbolReference^ Create( 
   SymbolVariant^ symbVariant,
   Page^ page
)

Parameters

symbVariant: Eplan.EplApi.DataModel.MasterData.SymbolVariant that will be assigned
page: Page where the symbol reference will be located on

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

SymbolReference Class
SymbolReference Members
Overload List
SymbolVariant Class
Page Class

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

Send Feedback