Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / Workdesk Class
Members
In This Topic
    Workdesk Class
    In This Topic
    Represents HpD workdesk.
    Object Model
    Workdesk ClassElectricalConfigurationInfo ClassCamera3D ClassTextProperty ClassDateTimeProperty ClassTextProperty ClassHighlightSet ClassDateTimeProperty ClassTextProperty ClassTextProperty ClassTextProperty ClassSelectSet ClassWorkdeskSettings 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

    Syntax
    public class Workdesk : Designer, EPLAN.Harness.API.Interfaces.IApiObject, EPLAN.Harness.API.Occurrences.Interfaces.IUserDefinedProperties
    Public Properties
     NameDescription
    Public PropertyActiveElectricalConfigurationGets active electrical configuration of this designer. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public PropertyBackupExistsDoes this document have a backup file on the disc? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public PropertyCameraCamera of this designer. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public PropertyCreatedByOverridden.  Name of the document author.  
    Public PropertyCreatedDateOverridden.  When was the document created.  
    Public PropertyDescriptionOverridden.  Description of the document.  
    Public PropertyHasFocus Does this document have focus in the UI? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public PropertyHasRevision Does this document have a revision? (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public PropertyHighlightSetGets set of highlighted occurrences. (Inherited from EPLAN.Harness.API.Projects.Documents.GraphicDocument)
    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 PropertyIsRevision Is this document part of a revision? (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    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 PropertyRevisions List all revisions this document has. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public PropertyRevisionText Note related to revision of this document.  
    Public PropertySelectSetGets set of selected occurrences. (Inherited from EPLAN.Harness.API.Projects.Documents.GraphicDocument)
    Public PropertySettings Settings of the workdesk.  
    Public PropertyTasksController of tasks. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public PropertyUserDefinedProperties List of User-defined properties of this document or project. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public PropertyVariant Gets parent variant of this document. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public PropertyViewsGet controller of stored views of this document. (Inherited from EPLAN.Harness.API.Projects.Documents.GraphicDocument)
    Top
    Public Methods
     NameDescription
    Public MethodAddNewCableUnitAdd new EPLAN.Harness.API.Occurrences.Interfaces.IOccCableUnit. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodAddNewComplexEntityAdd new EPLAN.Harness.API.Occurrences.Interfaces.IOccComplexEntity to this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodAddNewWireHarnessAdd new EPLAN.Harness.API.Occurrences.Interfaces.IOccWireHarness. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodAddTerminalStripAdd new EPLAN.Harness.API.Occurrences.Interfaces.IOccTerminalStrip. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodAutoPlaceAttachedPartsAutomatically add, remove or delete redundant attached parts. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodAutoRoute Automatically route selected routable objects. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodAutoRouteAllCables Automatically route all unrouted cables. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodAutoRouteAllWires Automatically route all unrouted wires. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodChangeElectricalConfigurationChange active electrical configuration of this designer. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodClose Close this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodConnectShield Connects cable shield node to a pin with shield wire. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodCopyShapeToCopy control path shape to another control path. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodCreateConstraints Create a constraint between occurrences. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodCreatePatternCreate pattern of parts. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodDeleteOccurrenceDelete following occurrence from this designer. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodDisconnectShield Disconnects shield wire which starts in provided shield node. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodEqualsIs this document equal to the following object? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodExport Export this designer to a file.  
    Public MethodExport3DFile 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. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodExportComplexEntityExport complex entities from this document to .hxce file. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodExportImageExport scene to raster image. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodGetAllMaterialsNames Gets names of all predefined materials and all materials from the currently connected library. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodGetAllOccurrencesOverloaded.  Get all occurrences in this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodGetEnvironmentOccurrences Get environment occurrences in this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodGetHashCodeServes as the default hash function. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodHideHide selected occurrences. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodHideAllButMeHide all occurrences in this designer except of the selected ones. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodImport3DPart Import 3d part to designer. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodImportComplexEntityImport complex entities to this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodImportDrawing Import drawings to workdesk.  
    Public MethodImportImage Import image into designer. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodIsOccurrencePartOfActiveConfigurationDetermines whether the selected occurrence is part of active electrical configuration of this designer. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodIsOccurrencePartOfConfigurationDetermines whether the selected occurrence is part of given electrical configuration. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodLockEndPointsToConnector Lock position between master and slave objects. The simple constraint is created. The slave objects are moved and rotated with the master together. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodMergeBundlesInPoint Merges bundles in control point provided in argument. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodMergeControlPointsMerge control point with leading parts, clips or special electrical components. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodOpenOverridden.  Open this document.  
    Public MethodPlaceAssembly Place a Assembly or Device on position. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceAuxiliaryCoordinateSystem Place an auxiliary coordinate system to coordinates. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceAuxiliaryLine Place an auxiliary line to coordinates. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceAuxiliaryPin Place an auxiliary pin to coordinates. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceAuxiliaryPlane Place an auxiliary plane to coordinates. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceAuxiliaryPoint Place an auxiliary point to coordinates. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceBundle Place bundle to this designer. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceCable Places a cable from library. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceCableTie Place a cable tie on a bundle or flat cable between two control points. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceCapacitorOverloaded.  Place a capacitor on a bundle or wire between two control points. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceCavityPlug Place a cavity plug. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceCavitySeal Place a cavity seal. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceConnectableObject Places any kind of connectable objects on position. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceControlPoint Place control point on cable, wire, bundle etc. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceFuseOverloaded.  Place a fuse on a bundle or wire between two control points. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceGraphicalAccessory Place a graphical accessory and attach it to a part. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceLabel Place a label between two control points on a bundle, wire, shield, etc.. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceLeadingPart Place a Leading Part, Grommet or Clip on position. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceLightOverloaded.  Place a light on a bundle or wire between two control points. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceLoopPlace loop on a control point. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceMultipleSeal Place a multiple seal. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceNonGraphicalAccessory Place a non-graphical accessory and attach it to a part. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlacePart Place a part, back shell or housing on position. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceRapidCapacitorOverloaded.  Place rapid capacitor to scene. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceRapidFuseOverloaded.  Place rapid fuse to scene. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceRapidLightOverloaded.  Place rapid light to scene. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceRapidPrototypeCable Place a rapid prototype cable. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceRapidPrototypeConnector Place a rapid prototype connector. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceRapidPrototypeRibbonCableOverloaded.  Place a rapid prototype ribbon cable. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceRapidPrototypeWire Place rapid prototype wire. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceRapidResistorOverloaded.  Place rapid resistor to scene. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceRapidSpliceOverloaded.  Place rapid splice to scene. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceResistorOverloaded.  Place a resistor on a bundle or wire between two control points. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceRibbonCableOverloaded.  Places a ribbon cable from library to designer. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceSpliceOverloaded.  Place a splice on a bundle or wire between two control points. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceSurfaceProtectionOverloaded.  Place surface protection in space. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceTwist Place a twist to this designer. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceUserDefinedAccessory Place a user defined accessory. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceWireOverloaded.  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. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPlaceWireTerminalOverloaded.  Place a wire terminal (non graphically). (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodPromote If this document is part of a revision, it gets promoted to a normal document. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public MethodRegenerateActiveDimensionsRestore deleted active dimensions for the control path.  
    Public MethodReloadPropertyPanel 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 MethodRemoveOverridden.  Remove the document.  
    Public MethodRemoveSpecialComponentFromBundle Removes special component from a bundle and places it to an arbitrary position. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodRepeatCableTie Repeat selected cable tie on its parent bundle. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodReplaceOccurrence<T>Replace this occurrence. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodRestore Restore this document from backup. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodRevise Create new revision of this document. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public MethodRoute Route selected objects through given bundles. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodRoutePathSegment Routes a path segment between two control points through some other suitable object. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodSave Save this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodSaveAs Save this as a new document.  
    Public MethodSaveAsTemplateSave this document as template. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public MethodSemiAutoRoute Route selected objects between given control points. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodShowShow selected occurrences. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodShowAllObjectsShow all occurrences in this designer. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodSplitBundleInPoint Split bundle in control point provided in argument. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Public MethodToStringReturns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public MethodUnRoute Unroute selected routable objects. (Inherited from EPLAN.Harness.API.Projects.Documents.Designer)
    Top
    See Also

    Reference

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

    Send Feedback