Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / RevisionableDocument Class
Members
In This Topic
    RevisionableDocument Class
    In This Topic
    Base class for HpD documents which can be revisioned.
    Object Model
    RevisionableDocument ClassTextProperty ClassDateTimeProperty ClassTextProperty ClassDateTimeProperty ClassTextProperty ClassTextProperty ClassBaseSettings ClassVariant Class
    Inheritance Hierarchy

    System.Object
       EPLAN.Harness.API.ApiObject
          EPLAN.Harness.API.Projects.Documents.ProjectEntity
             EPLAN.Harness.API.Projects.Documents.Document
                EPLAN.Harness.API.Projects.Documents.RevisionableDocument
                   EPLAN.Harness.API.Projects.Documents.GraphicDocument
                   EPLAN.Harness.API.Projects.Documents.Report

    Syntax
    Remarks

    Revisions can NOT be nested. This means that only those documents that are not part of a revision can be revisioned.

    Public Properties
     NameDescription
    Public PropertyDoes this document have a backup file on the disc? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Property Name of the document author. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Public Property When was the document created. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Public Property Description of the document. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Public Property Does this document have focus in the UI? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Property Does this document have a revision?  
    Public Property ID of the HpD object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public Property Is this document opened? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Property Is this document open as read only? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Property Is this document part of a revision?  
    Public PropertyOverridden.  Tells you whether this object is valid or not.  
    Public Property When was the document last modified. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Public Property The user who modified the document last. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Public Property Name of the document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Property Path to the document file. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Public Property List all revisions this document has.  
    Public Property Settings stored with this document.  
    Public PropertyOverridden.  List of User-defined properties of this document or project.  
    Public Property Gets parent variant of this document.  
    Top
    Public Methods
     NameDescription
    Public Method Close this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodIs this document equal to the following object? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodServes as the default hash function. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Method Open this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Method If this document is part of a revision, it gets promoted to a normal document.  
    Public Method Remove the document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Method Restore this document from backup. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Method Create new revision of this document.  
    Public Method Save this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodSave this document as template.  
    Public MethodReturns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)
    Top
    See Also