Eplan Platform API
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.

In This Topic
    Create Method (Block)
    In This Topic
    Creates valid Block object from the passed elements. At least two elements must be passed in arrPlacements.
    Syntax
    public void Create( 
       Page oPage,
       Placement[] arrPlacements
    )
    public:
    void Create( 
       Page^ oPage,
       array<Placement^>^ arrPlacements
    ) 

    Parameters

    Parameter NameDescription
    oPagePage on which the block reference will be placed. Can't be null.
    arrPlacementsList of Placement which will be combined into a block. Can't be null.
    Exceptions
    ExceptionDescription
    Thrown when any parameter is null.
    Thrown when page or one of the placements is invalid, number of passed placements is less then two or more then one SymbolReference object is in arrParameters.
    Also thrown when the given Page has PageType set to ExternalDocument.
    Thrown when the block cannot be created.
    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