Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / Variant Class
Members
In This Topic
    Variant Class
    In This Topic
    Represents HpD Variant.
    Object Model
    Variant 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.Variant

    Syntax
    Public Properties
     NameDescription
    Public PropertyDoes this document have a backup file on the disc? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public PropertyOverridden.  Name of the document author.  
    Public PropertyOverridden.  When was the document created.  
    Public PropertyOverridden.  Description of the document.  
    Public Property Gets or sets list of electrical configurations of this variant.  
    Public Property Does this document have focus in the UI? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    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 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 PropertyOverridden.  Name of the document.  
    Public PropertyOverridden.  Path to the document file.  
    Public PropertyOverridden.  List of User-defined properties of this document or project.  
    Top
    Public Methods
     NameDescription
    Public Method Close this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Method Create new attached document in this variant.  
    Public Method Create a new cable drawing in this variant  
    Public Method Create new cable drawing from template file in this variant.  
    Public Method Create new nailboard in this variant.  
    Public Method Create new nailboard from template in this variant.  
    Public Method Create a new report.  
    Public Method Create a new empty workdesk in this variant.  
    Public Method Create a new workdesk from template in this variant.  
    Public Method Create a new empty workspace in this variant.  
    Public Method Create a new workspace from template in this variant.  
    Public MethodCreate a new workspace from workdesk. Workdesk must be opened (See Document.Open)  
    Public MethodIs this document equal to the following object? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Method List info of all cable units in all documents from this variant. Used for cable drawing derivation.  
    Public Method List info all harnesses in all documents from this variant. Used for Nailboard derivation.  
    Public Method Get list of attached documents in this variant.  
    Public Method Get list of cable drawings in this variant.  
    Public Method Get all electrical configuration information of this variant.  
    Public MethodServes as the default hash function. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Method Get list of nailboards in this variant.  
    Public Method Get list of reports in this variant.  
    Public Method Get list of workdesks in this variant.  
    Public Method Get list of workspaces in this variant.  
    Public MethodImport Workspace or Workdesk.  
    Public MethodOverridden.  Open this document.  
    Public MethodOverridden.  Remove the document.  
    Public Method Restore this document from backup. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Method Save this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodReturns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)
    Top
    See Also