Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / AttachedDocument Class / Open Method
Open as read only if the document is locked? If the document is not locked, this argument has no effect.
Restore document from backup if exists? To determine whether the backup exists, use Document.BackupExists.
Open document in background without showing it in UI. If document is opened with this parameter set to true the document has to be closed by API too. If the document is not closed by API the behavior of application is undefined.
In This Topic
    Open Method (AttachedDocument)
    In This Topic
    Open this document.
    Syntax
    public override void Open( 
   bool tryReadOnly,
   bool useBackup,
   bool silent
)

    Parameters

    tryReadOnly
    Open as read only if the document is locked? If the document is not locked, this argument has no effect.
    useBackup
    Restore document from backup if exists? To determine whether the backup exists, use Document.BackupExists.
    silent
    Open document in background without showing it in UI. If document is opened with this parameter set to true the document has to be closed by API too. If the document is not closed by API the behavior of application is undefined.
    Exceptions
    ExceptionDescription
    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.FileNotFoundException This file was not found.
    EPLAN.Harness.API.Exceptions.FileLockedExceptionThrown when the document is locked by another user and the tryReadOnly is False. Set the argument to True to open this document in read-only mode.
    EPLAN.Harness.API.Exceptions.OperationFailedException The operation was not successful.
    EPLAN.Harness.API.Exceptions.LicensingErrorException This operation was denied because of your license.
    Remarks

    Some methods requires a document to be opened or closed. This is written in method's documentation.

    If you use a method, that requires document to be opened/closed and it is not, EPLAN.Harness.API.Exceptions.FileClosedException or EPLAN.Harness.API.Exceptions.FileOpenedException is thrown.

    If the document is locked by another user you can open a document in read only mode using tryReadOnly argument. As a result you won't be able to perform some actions such as Document.Save.

    If this document is already open, this method does nothing. To open read-only document in read-write mode, use Document.Close and then Document.Open again.

    See Also

    Reference

    AttachedDocument Class
    AttachedDocument Members

    Send Feedback