Create Method (Block)

Eplan.EplApi.DataModel Namespace / Block Class / Create Method

Page on which the block reference will be placed. Can't be null.

List of Placement which will be combined into a block. Can't be null.

Collapse All

In This Topic

Syntax
Exceptions
Remarks
See Also

EPLAN API

Create Method (Block)

In This Topic

Syntax
Exceptions
Remarks
See Also

Creates valid Block object from the passed elements. At least two elements must be passed in arrPlacements.

Syntax

C#
C++/CLI

public void Create( 
   Page oPage,
   Placement[] arrPlacements
)

public:
void Create( 
   Page^ oPage,
   array<Placement^>^ arrPlacements
)

Parameters

oPage: Page on which the block reference will be placed. Can't be null.
arrPlacements: List of Placement which will be combined into a block. Can't be null.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown when any parameter is `null`.
InvalidArgumentException	Thrown when page or one of placements is invalid, number of passed placements is less then two or more then one SymbolReference object is in `arrParameters`
ObjectCreationException	Thrown when the `block` cannot be created.
InvalidArgumentException	Thrown when the given Page has PageType set to ExternalDocument.

Remarks

* Only one SymbolReference object can be passed in arrPlacements. In such a case that SymbolReference object becomes the block itself. * If a new block is created and one of its elements is a symbol reference which already has some embedded objects (i.e. it is a block reference itself), new block is not created but rather the other elements are inserted to the already existing block. After such operation, two Block objects refer to the same block reference in the project. * IMPORTANT: Graphical placements passed in the arrPlacements parameter become invalid (i.e. destroyed) after they are embedded into a block.

See Also

Reference

Block Class
Block Members

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

Send Feedback