Create(Page,SymbolVariant,PointD,PointD) Method

In This Topic

Creates a Function object placed on a Eplan.EplApi.DataModel.Page given as a parameter and sets it Eplan.EplApi.DataModel.MasterData.SymbolVariant together with LogicalArea.

Syntax

C#
C++/CLI

public override void Create( 
   Page pPage,
   SymbolVariant pSymbolVariant,
   PointD oStartPoint,
   PointD oEndPoint
)

public:
void Create( 
   Page^ pPage,
   SymbolVariant^ pSymbolVariant,
   PointD oStartPoint,
   PointD oEndPoint
) override

Parameters

Parameter Name	Description
pPage	Page on which shield will be placed. Can't be `null`.
pSymbolVariant	Eplan.EplApi.DataModel.MasterData.SymbolVariantSymbol variant for this function.
oStartPoint	Eplan.EplApi.Base.PointDLower left corner of function's logical area.
oEndPoint	Eplan.EplApi.Base.PointDUpper right corner of function's logical area.

Exceptions

Exception	Description
Eplan.EplApi.Base.BaseException	Thrown when the function cannot be created.
System.ArgumentNullException	Thrown when `oPage` parameter is `null`.
IncorrectSymbolTypeException	Thrown when the function cannot be created.
System.ArgumentNullException	Thrown when `oSymbolVariant` parameter is `null`.
ObjectAlreadyCreatedException	Thrown when the function has already been created.
System.NotImplementedException	Thrown when implementation of requested interface isn't found.
CreatingConnectionDefinitionPointsFailedException	Thrown when creating connection definition points fail.
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

Shield Class
Shield Members
Overload List

Use the Eplan Global Support Portal for feedback and support