Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / Document Class
Members
In This Topic
    Document Class
    In This Topic
    Represents HpD document. Base class for individual documents.
    Object Model
    Document ClassTextProperty ClassDateTimeProperty ClassTextProperty ClassDateTimeProperty ClassTextProperty ClassTextProperty 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.AttachedDocument
                EPLAN.Harness.API.Projects.Documents.RevisionableDocument
                EPLAN.Harness.API.Projects.Documents.Variant

    Syntax
    public abstract class Document : ProjectEntity, EPLAN.Harness.API.Interfaces.IApiObject, EPLAN.Harness.API.Occurrences.Interfaces.IUserDefinedProperties
    Public Properties
     NameDescription
    Public PropertyBackupExistsDoes this document have a backup file on the disc?  
    Public PropertyCreatedBy Name of the document author. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Public PropertyCreatedDate When was the document created. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Public PropertyDescription Description of the document. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Public PropertyHasFocus Does this document have focus in the UI?  
    Public PropertyID ID of the HpD object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public PropertyIsOpened Is this document opened?  
    Public PropertyIsOpenedAsReadOnly Is this document open as read only?  
    Public PropertyIsValid Tells you whether this object is valid or not. (Inherited from EPLAN.Harness.API.ApiObject)
    Public PropertyLastModified When was the document last modified. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Public PropertyLastModifiedBy The user who modified the document last. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Public PropertyName Name of the document.  
    Public PropertyPath Path to the document file. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Public PropertyUserDefinedProperties List of User-defined properties of this document or project. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Top
    Public Methods
     NameDescription
    Public MethodClose Close this document.  
    Public MethodEqualsIs this document equal to the following object?  
    Public MethodGetHashCodeServes as the default hash function.  
    Public MethodOpen Open this document.  
    Public MethodRemove Remove the document.  
    Public MethodRestore Restore this document from backup.  
    Public MethodSave Save this document.  
    Public MethodToStringReturns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)
    Top
    Public Operators
    public Operator Equality Are these documents equal?
    public Operator Inequality Are these documents not equal?
    Top
    See Also

    Reference

    Document Members
    EPLAN.Harness.API.Projects.Documents Namespace

    Send Feedback