Remove Method (Variant)

In This Topic

Remove the document.

Syntax

public override void Remove( 
   bool silent
)

silent: Remove document in background without showing it in UI. Use when removing bigger bunch of documents at once to avoid refreshing UI constantly. You are responsible for calling the UpdateProjectStructure method at the end, otherwise the state of the project structure is undefined.

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.ObjectInvalidException	The object is in invalid state. Obtain a new one.
EPLAN.Harness.API.Exceptions.InternalErrorException	Internal error of HpD or HpD API. IMPORTANT: Throwing this exception changes HpD Api's state to Failed.
EPLAN.Harness.API.Exceptions.FileOpenedException	The file is open.
EPLAN.Harness.API.Exceptions.FileLockedException	File you are trying to open is locked by another user.

Remarks

You need to save the project (Save) to apply this.

Send Feedback