Harness proD API Help
EPLAN.Harness.API.Projects.Documents Namespace / Drawing2D Class
Members
In This Topic
    Drawing2D Class
    In This Topic
    Base class for nailboard and cable drawing classes. Base class for nailboard and cable drawing classes.
    Object Model
    Drawing2D ClassCamera2D ClassTextProperty ClassDateTimeProperty ClassEntityInfo ClassTextProperty ClassElectricalConfigurationInfo ClassI2DGlobalGridStyle InterfaceHighlightSet ClassDateTimeProperty ClassTextProperty ClassDateTimeProperty ClassTextProperty ClassSelectSet ClassDrawingSettings 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.Drawing2D
                         EPLAN.Harness.API.Projects.Documents.CableDrawing
                         EPLAN.Harness.API.Projects.Documents.Nailboard

    Syntax
    Public Properties
     NameDescription
    Public PropertyDoes this document have a backup file on the disc? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public PropertyCamera of this drawing.  
    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 Get current display configuration of this drawing.  
    Public Property Description of the document. (Inherited from EPLAN.Harness.API.Projects.Documents.ProjectEntity)
    Public Property Get electrical configuration of this drawing.  
    Public PropertyGlobal grid of this drawing.  
    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 Property Is this drawing up to date?  
    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 Get last update date of this document.  
    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 drawing.  
    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 MethodApply selected display configuration to this drawing.  
    Public Method Close this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodCreates an arc on a circle circumscribed to a triangle specified by three points. First two point parameters are endpoints of the arc.  
    Public MethodOverloaded. Creates a circle circumscribed to a triangle specified by points.  
    Public MethodCreates a free dimension between two points in drawing.  
    Public MethodCreates an ellipse specified by center and minor and major radii.  
    Public MethodCreates a line between two specified points.  
    Public MethodCreates a point on specified position.  
    Public MethodCreates a polygon through specified points.  
    Public MethodDraws a poly line through specified points.  
    Public MethodCreates a rectangle based on specified points.  
    Public MethodDraws a spline through specified points.  
    Public MethodDelete occurrence from this drawing.  
    Public MethodIs this document equal to the following object? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodExport this drawing to a file.  
    Public MethodFlip object horizontally.  
    Public MethodFlip object vertically.  
    Public MethodOverloaded. Overridden.  Get all occurrences in this document.  
    Public Method Get all table occurrences in the drawing document.  
    Public Method Returns name of the default layer of 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 Method Returns names of all layers in this document.  
    Public Method Get derivation sources of this drawing.  
    Public MethodHide selected occurrences.  
    Public MethodHide all occurrences in this drawing except of the selected ones.  
    Public MethodImport and place drawing from file.  
    Public MethodImport and place image from file.  
    Public MethodOverridden.  Open this document.  
    Public MethodPlace list of accessories table.  
    Public MethodPlace assembly / device content table.  
    Public MethodInsert balloons to drawings.  
    Public MethodPlace bill of materials table.  
    Public MethodPlace a symbol of cable tie into drawing. It is placed on 0, 0 coordinates.  
    Public Method Place a symbol of connectable object symbol into drawing. It is placed on 0, 0 coordinates. See examples how to obtain a control point or an end symbol.  
    Public MethodPlace custom table.  
    Public MethodPlace drawing border from library.  
    Public MethodPlace drawing header from library.  
    Public MethodPlace drawing notes table.  
    Public MethodPlace a symbol of label into drawing. It is placed on 0, 0 coordinates.  
    Public MethodPlace symbol of mechanical part from library.  
    Public MethodPlace plot frame.  
    Public MethodPlace raster with positions.  
    Public MethodPlace a symbol of special component into drawing. It is placed on 0, 0 coordinates.  
    Public MethodPlace special electrical components table.  
    Public MethodPlace spider diagram.  
    Public MethodPlace surface protection legend.  
    Public MethodPlace surface protection table.  
    Public MethodPlace symbol from library.  
    Public MethodPlace wire list.  
    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 MethodRemove given source(s) from this drawing.  
    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 MethodOverridden.  Save this document.  
    Public MethodSave this document as template. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public MethodShow selected occurrences.  
    Public MethodShow all occurrences in this drawing.  
    Public MethodReturns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public MethodUpdate this drawing. Any changes in source documents will show up in the drawing.  
    Top
    See Also