Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / Variant Class
Properties Methods

In This Topic
    Variant Class Members
    In This Topic

    The following tables list the members exposed by Variant.

    Public Properties
     NameDescription
    Public PropertyBackupExistsDoes this document have a backup file on the disc? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public PropertyCreatedByOverridden.  Name of the document author.  
    Public PropertyCreatedDateOverridden.  When was the document created.  
    Public PropertyDescriptionOverridden.  Description of the document.  
    Public PropertyElectricalConfigurationsSettings Gets or sets list of electrical configurations of this variant.  
    Public PropertyHasFocus Does this document have focus in the UI? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public PropertyID ID of the HpD object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public PropertyIsOpened Is this document opened? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public PropertyIsOpenedAsReadOnly Is this document open as read only? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public PropertyIsValidOverridden.  Tells you whether this object is valid or not.  
    Public PropertyLastModifiedOverridden.  When was the document last modified.  
    Public PropertyLastModifiedByOverridden.  The user who modified the document last.  
    Public PropertyNameOverridden.  Name of the document.  
    Public PropertyPathOverridden.  Path to the document file.  
    Public PropertySilentModeDetermines if the variant is currently in the silent mode.  
    Public PropertyUserDefinedPropertiesOverridden.  List of User-defined properties of this document or project.  
    Top
    Public Methods
     NameDescription
    Public MethodCloseOverridden.  Close this document.  
    Public MethodCreateAttachedDocument Create new attached document in this variant.  
    Public MethodCreateCableDrawing Create a new cable drawing in this variant.  
    Public MethodCreateCableDrawingFromTemplateFile Create new cable drawing from template file in this variant.  
    Public MethodCreateNailboard Create new nailboard in this variant.  
    Public MethodCreateNailboardFromTemplateFile Create new nailboard from template in this variant.  
    Public MethodCreateReport Create a new report.  
    Public MethodCreateWorkdesk Create a new empty workdesk in this variant.  
    Public MethodCreateWorkdeskFromTemplate Create a new workdesk from template in this variant.  
    Public MethodCreateWorkspace Create a new empty workspace in this variant.  
    Public MethodCreateWorkspaceFromTemplate Create a new workspace from template in this variant.  
    Public MethodCreateWorkspaceFromWorkdeskCreate a new workspace from workdesk. Workdesk must be opened (See Document.Open)  
    Public MethodEqualsIs this document equal to the following object? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodGetAllCableUnitInfos List info of all cable units in all documents from this variant. Used for cable drawing derivation.  
    Public MethodGetAllWireHarnessInfos List info all harnesses in all documents from this variant. Used for Nailboard derivation.  
    Public MethodGetAttachedDocuments Get list of attached documents in this variant.  
    Public MethodGetCableDrawings Get list of cable drawings in this variant.  
    Public MethodGetElectricalConfigurations Get all electrical configuration information of this variant.  
    Public MethodGetHashCodeServes as the default hash function. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodGetNailboards Get list of nailboards in this variant.  
    Public MethodGetReports Get list of reports in this variant.  
    Public MethodGetWorkdesks Get list of workdesks in this variant.  
    Public MethodGetWorkspaces Get list of workspaces in this variant.  
    Public MethodImportDesignerImport Workspace or Workdesk.  
    Public MethodOpenOverridden.  Open this document.  
    Public MethodRemoveOverridden.  Remove the document.  
    Public MethodRestore Restore this document from backup. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodSave Save this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodToStringReturns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)
    Top
    See Also

    Reference

    Variant Class
    EPLAN.Harness.API.Projects.Documents Namespace

    Send Feedback