AddNewComplexEntity Method

In This Topic

Add new EPLAN.Harness.API.Occurrences.Interfaces.IOccComplexEntity to this document.

Syntax

public IOccComplexEntity AddNewComplexEntity( 
   IEnumerable<IComplexEntityAddable> occurrences
)

Parameters

occurrences: Occurrences that will be added to the newly created complex entity.

Return Value

Created complex entity.

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.HpdApiNotInitializedException	Api is not in an initialized state. You can get current state from EPLAN.Harness.API.HpdApi.Status property. If API is uninitialized, you can initialize it by calling EPLAN.Harness.API.HpdApi.Init method. If API is in failed state, you can not resurrect it.
EPLAN.Harness.API.Exceptions.ObjectInvalidException	The object is in invalid state. Obtain a new one.
EPLAN.Harness.API.Exceptions.ArgumentNullException	Argument is null.
EPLAN.Harness.API.Exceptions.FileClosedException	This file is not opened.
EPLAN.Harness.API.Exceptions.OccurrenceMissingInDocumentException	Thrown when the occurrence is not part of this document.

Example

This example shows how to add a new empty complex entity to the workspace.

Workspace workspace = ...

IOccComplexEntity complexEntity = workspace.AddNewComplexEntity();

This example shows how to add a new complex entity with some occurrences.

Workdesk workdesk = ...

// All addable occurrences from this wordesk:
IEnumerable<IComplexEntityAddable> occurrences = workdesk.GetAllOccurrences().OfType<IComplexEntityAddable>();

IOccComplexEntity complexEntity = workdesk.AddNewComplexEntity(occurrences);

Reference

Designer Class
Designer Members
OccWsComplexEntity Class
OccWdComplexEntity Class

Send Feedback