Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / Designer Class
Members
In This Topic
    Designer Class
    In This Topic
    Base class for document which contains designer (workspace, workdesk).
    Object Model
    Designer ClassElectricalConfigurationInfo ClassCamera3D ClassTextProperty ClassDateTimeProperty ClassTextProperty ClassHighlightSet ClassDateTimeProperty ClassTextProperty ClassTextProperty ClassSelectSet ClassDesignerSettings ClassTasksController ClassVariant ClassViewsController 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.Designer
                         EPLAN.Harness.API.Projects.Documents.Workdesk
                         EPLAN.Harness.API.Projects.Documents.Workspace

    Syntax
    Public Properties
     NameDescription
    Public PropertyGets active electrical configuration of this designer.  
    Public PropertyDoes this document have a backup file on the disc? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public PropertyCamera of this designer.  
    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? (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public PropertyGets set of highlighted occurrences. (Inherited from EPLAN.Harness.API.Projects.Documents.GraphicDocument)
    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? (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    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. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public PropertyGets set of selected occurrences. (Inherited from EPLAN.Harness.API.Projects.Documents.GraphicDocument)
    Public Property Settings saved with this Designer.  
    Public Propertystatic (Shared in Visual Basic) Get a collection of supported 3D file formats to export.  
    Public Propertystatic (Shared in Visual Basic) Get a collection of supported 3D file formats to import.  
    Public PropertyController of tasks.  
    Public Property List of User-defined properties of this document or project. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public Property Gets parent variant of this document. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public PropertyGet controller of stored views of this document. (Inherited from EPLAN.Harness.API.Projects.Documents.GraphicDocument)
    Top
    Public Methods
     NameDescription
    Public MethodAdd new EPLAN.Harness.API.Occurrences.Interfaces.IOccCableUnit.  
    Public MethodAdd new EPLAN.Harness.API.Occurrences.Interfaces.IOccComplexEntity to this document.  
    Public MethodAdd new EPLAN.Harness.API.Occurrences.Interfaces.IOccWireHarness.  
    Public MethodAdd new EPLAN.Harness.API.Occurrences.Interfaces.IOccTerminalStrip.  
    Public MethodAutomatically add, remove or delete redundant attached parts.  
    Public Method Automatically route selected routable objects.  
    Public Method Automatically route all unrouted cables.  
    Public Method Automatically route all unrouted wires.  
    Public MethodChange active electrical configuration of this designer.  
    Public Method Close this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Method Connects cable shield node to a pin with shield wire.  
    Public MethodCopy control path shape to another control path.  
    Public Method Create a constraint between occurrences.  
    Public MethodCreate pattern of parts.  
    Public MethodDelete following occurrence from this designer.  
    Public Method Disconnects shield wire which starts in provided shield node.  
    Public MethodIs this document equal to the following object? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Method Export current 3D scene of workdesk or workspace to CAD file. The format of the file must be specified by its extension. Some options of the export are available in settings.  
    Public MethodExport complex entities from this document to .hxce file.  
    Public MethodExport scene to raster image.  
    Public Method Gets names of all predefined materials and all materials from the currently connected library.  
    Public MethodOverloaded. Overridden.  Get all occurrences in this document.  
    Public MethodOverridden.  Get environment occurrences in this document.  
    Public MethodServes as the default hash function. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodHide selected occurrences.  
    Public MethodHide all occurrences in this designer except of the selected ones.  
    Public Method Import 3d part to designer.  
    Public MethodImport complex entities to this document.  
    Public Method Import image into designer.  
    Public MethodDetermines whether the selected occurrence is part of active electrical configuration of this designer.  
    Public MethodDetermines whether the selected occurrence is part of given electrical configuration.  
    Public Method Lock position between master and slave objects. The simple constraint is created. The slave objects are moved and rotated with the master together.  
    Public Method Merges bundles in control point provided in argument.  
    Public MethodMerge control point with leading parts, clips or special electrical components.  
    Public MethodOverridden.  Open this document.  
    Public Method Place a Assembly or Device on position.  
    Public Method Place an auxiliary coordinate system to coordinates.  
    Public Method Place an auxiliary line to coordinates.  
    Public Method Place an auxiliary pin to coordinates.  
    Public Method Place an auxiliary plane to coordinates.  
    Public Method Place an auxiliary point to coordinates.  
    Public Method Place bundle to this designer.  
    Public Method Places a cable from library.  
    Public Method Place a cable tie on a bundle or flat cable between two control points.  
    Public MethodOverloaded.  Place a capacitor on a bundle or wire between two control points.  
    Public Method Place a cavity plug.  
    Public Method Place a cavity seal.  
    Public Method Places any kind of connectable objects on position.  
    Public Method Place control point on cable, wire, bundle etc.  
    Public MethodOverloaded.  Place a fuse on a bundle or wire between two control points.  
    Public Method Place a graphical accessory and attach it to a part.  
    Public Method Place a label between two control points on a bundle, wire, shield, etc..  
    Public Method Place a Leading Part, Grommet or Clip on position.  
    Public MethodOverloaded.  Place a light on a bundle or wire between two control points.  
    Public MethodPlace loop on a control point.  
    Public Method Place a multiple seal.  
    Public Method Place a non-graphical accessory and attach it to a part.  
    Public Method Place a part, back shell or housing on position.  
    Public MethodOverloaded.  Place rapid capacitor to scene.  
    Public MethodOverloaded.  Place rapid fuse to scene.  
    Public MethodOverloaded.  Place rapid light to scene.  
    Public Method Place a rapid prototype cable.  
    Public Method Place a rapid prototype connector.  
    Public MethodOverloaded.  Place a rapid prototype ribbon cable.  
    Public Method Place rapid prototype wire.  
    Public MethodOverloaded.  Place rapid resistor to scene.  
    Public MethodOverloaded.  Place rapid splice to scene.  
    Public MethodOverloaded.  Place a resistor on a bundle or wire between two control points.  
    Public MethodOverloaded.  Places a ribbon cable from library to designer.  
    Public MethodOverloaded.  Place a splice on a bundle or wire between two control points.  
    Public MethodOverloaded.  Place surface protection in space.  
    Public Method Place a twist to this designer.  
    Public Method Place a user defined accessory.  
    Public MethodOverloaded.  Place a wire. Wire can be placed between all kind of pins - standard pin on a connector, grouped pin on a connector, special component (splice, fuse, light, resistor, capacitor), virtual pin (concrete pin of a grouped pin on a connector or special component) and auxiliary pin.  
    Public MethodOverloaded.  Place a wire terminal (non graphically).  
    Public Method If this document is part of a revision, it gets promoted to a normal document. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public Method Reload property panel of this document to show current state of all controls in the panel. (Inherited from EPLAN.Harness.API.Projects.Documents.GraphicDocument)
    Public Method Remove the document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Method Removes special component from a bundle and places it to an arbitrary position.  
    Public Method Repeat selected cable tie on its parent bundle.  
    Public MethodReplace this occurrence.  
    Public Method Restore this document from backup. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public Method Create new revision of this document. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public Method Route selected objects through given bundles.  
    Public Method Routes a path segment between two control points through some other suitable object.  
    Public Method Save this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodSave this document as template. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public Method Route selected objects between given control points.  
    Public MethodShow selected occurrences.  
    Public MethodShow all occurrences in this designer.  
    Public Method Split bundle in control point provided in argument.  
    Public MethodReturns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public Method Unroute selected routable objects.  
    Top
    See Also