Create(Page,FunctionDefinition) Method

Eplan.EplApi.DataModel Namespace / Function Class / Create Method / Create(Page,FunctionDefinition) Method

Collapse All

In This Topic

Syntax
Exceptions
Remarks
See Also

EPLAN API

Create(Page,FunctionDefinition) Method

In This Topic

Syntax
Exceptions
Remarks
See Also

Creates a Function object placed on a Page given as the first parameter and having a FunctionDefinition taken from FunctionDefinition passed as the second parameter.

Syntax

C#
C++/CLI

public void Create( 
   Page page,
   FunctionDefinition functionDefinition
)

public:
void Create( 
   Page^ page,
   FunctionDefinition^ functionDefinition
)

Parameters

page: Page where the Function will be placed on
functionDefinition: FunctionDefinition the Function will be assigned

Exceptions

Exception	Description
ObjectCreationException	Thrown when the function cannot be created.
System.ArgumentNullException	Thrown when `page` is `null`.
System.ArgumentNullException	Thrown when `functionDefinition` is `null`.
IncorrectSymbolTypeException	Thrown when the function cannot be created.
ObjectAlreadyCreatedException	Thrown when the function has already been 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

Function Class
Function Members
Overload List
Page Class
FunctionDefinition Class

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

Send Feedback