Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / Project Class
Members
In This Topic
    Project Class
    In This Topic
    Represents a HpD project.
    Object Model
    Project ClassActiveLibraryConnection ClassTextProperty ClassCableDrawingDisplayConfigurationsController ClassTextProperty ClassDateTimeProperty ClassTextProperty ClassDateTimeProperty ClassTextProperty ClassNailboardDisplayConfigurationsController ClassTextProperty ClassTextProperty ClassProjectSettings Class
    Inheritance Hierarchy

    System.Object
       EPLAN.Harness.API.ApiObject
          EPLAN.Harness.API.Projects.Documents.ProjectEntity
             EPLAN.Harness.API.Projects.Documents.Project

    Syntax
    Public Properties
     NameDescription
    Public Property Get the active library connection. There are available methods to browse and get parts from library.  
    Public Property Project's active library.  
    Public PropertyGets the cable drawing display configuration controller.  
    Public PropertyOverridden.  Name of the document author.  
    Public PropertyOverridden.  When was the document created.  
    Public PropertyOverridden.  Description of the document.  
    Public Property List of Electrical options of this project.  
    Public Property ID of the HpD object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public PropertyOverridden.  Tells you whether this object is valid or not.  
    Public PropertyOverridden.  When was the document last modified.  
    Public PropertyOverridden.  The user who modified the document last.  
    Public PropertyGets the nailboard display configuration controller.  
    Public Property Project's name.  
    Public PropertyOverridden.  Path to the document file.  
    Public Property Project's preview image.  
    Public Property Settings of the project.  
    Public PropertyOverridden.  List of User-defined properties of this document or project.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded.  Add the library connection to this project.  
    Public MethodBackup project.  
    Public Method Close the project. This will make all the objects from this project invalid.  
    Public MethodOverloaded.  Connect to the library.  
    Public Method Create new attached document in this project.  
    Public Method Create a new variant in this project.  
    Public MethodIs this project equal to the following object?  
    Public Method Get document which is active in the running instance of Harness ProD.  
    Public Method Get list of all attached documents in this project.  
    Public MethodGet information about all cable drawing display configurations in this project. Used for example for cable drawing derivation(Variant.CreateCableDrawing).  
    Public Method Get default cable drawing display configuration in this project.  
    Public Method Get default nailboard display configuration in this project.  
    Public MethodServes as the default hash function.  
    Public MethodGet info about all nailboard display configurations in this project. Used for example for nailboard derivation (Variant.CreateNailboard).  
    Public MethodOverloaded.  Get a list of all opened documents in this project.  
    Public Method Gets all library connections related with this project. Connections which point to a non-existent library are not returned.  
    Public Method Get list of all variants in this project.  
    Public Method Remove the library connection from this project.  
    Public Method Save the project. Does not save changes made on documents themselves.  
    Public MethodSave this project as template.  
    Public MethodReturns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)
    Top
    Public Operators
    Are these projects equal?
    Are these projects not equal?
    Top
    See Also