Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / RevisionableDocument Class / Promote Method
Promote document in background without showing it in UI. Use when promoting 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.
In This Topic
    Promote Method
    In This Topic
    If this document is part of a revision, it gets promoted to a normal document.
    Syntax
    public RevisionableDocument Promote( 
   bool silent
)

    Parameters

    silent
    Promote document in background without showing it in UI. Use when promoting 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.

    Return Value

    New promoted document.
    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.DocumentIsNotRevisionExceptionOnly revisions can be promoted. IsRevision must be true.
    EPLAN.Harness.API.Exceptions.OperationFailedException The operation was not successful.
    Remarks
    Document will be moved among other documents and you will be able to open it in read-write mode.
    See Also

    Reference

    RevisionableDocument Class
    RevisionableDocument Members

    Send Feedback