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

In This Topic
    Nailboard Class Members
    In This Topic

    The following tables list the members exposed by Nailboard.

    Public Properties
     NameDescription
    Public PropertyAllowRenderingGets or sets whether scene is updated after changed or not. After set true the scene is updated immediately. (Inherited from EPLAN.Harness.API.Projects.Documents.GraphicDocument)
    Public PropertyBackupExistsDoes this document have a backup file on the disc? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public PropertyCameraCamera of this drawing. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public PropertyCreatedByOverridden.  Name of the document author.  
    Public PropertyCreatedDateOverridden.  When was the document created.  
    Public PropertyDescriptionOverridden.  Description of the document.  
    Public PropertyDisplayConfigurationOverridden. Gets current display configuration of this drawing.  
    Public PropertyElectricalConfigurationInfoOverridden.  Get electrical configuration of this drawing.  
    Public PropertyGlobalGridGlobal grid of this drawing. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    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 PropertyIsUpToDate Is this drawing up to date? (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    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 PropertyLastUpdateOverridden.  Get last update date of this document.  
    Public PropertyLayerManagementLayer management of this drawing. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public PropertyLocalGridLocal grid (gap) of this nailboard.  
    Public PropertyLocalRotationGridLocal rotation grid of this nailboard.  
    Public PropertyModifiedGet modified (dirty) flag on 2D and 3D documents (Inherited from EPLAN.Harness.API.Projects.Documents.GraphicDocument)
    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. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public PropertyScale Scale of this drawing. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public PropertySelectSetGets set of selected occurrences. (Inherited from EPLAN.Harness.API.Projects.Documents.GraphicDocument)
    Public PropertySettings Settings of the nailboard.  
    Public PropertyUpdateTreeViewGets or sets whether tree view is updated after changed or not. After set true the tree view is updated immediately. (Inherited from EPLAN.Harness.API.Projects.Documents.GraphicDocument)
    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 PropertyViewOptionView option of the drawing. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public PropertyViewsGet controller of stored views of this document. (Inherited from EPLAN.Harness.API.Projects.Documents.GraphicDocument)
    Top
    Public Methods
     NameDescription
    Public MethodAddSourcesAdd given wire harness(es) to this Nailboard's sources.  
    Public MethodAddToWireHarnessOverloaded. Add selected free drawings to wire harness.  
    Public MethodApplyDisplayConfigurationOverridden. Apply selected display configuration to this drawing.  
    Public MethodAssignObjectsToLayersByTypesAssign objects in drawing to layers by its layer types. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodBringOneLayerForwardBring occurrence one layer forward.  
    Public MethodBringToFrontBring occurrence to front.  
    Public MethodClose Close this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodCreateArcCreates an arc on a circle circumscribed to a triangle specified by three points. First two point parameters are endpoints of the arc. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodCreateCircleOverloaded. Creates a circle circumscribed to a triangle specified by points. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodCreateDimensionCreates a free dimension between two points in drawing. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodCreateEllipseCreates an ellipse specified by center and minor and major radii. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodCreateLineCreates a line between two specified points. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodCreatePointCreates a point on specified position. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodCreatePolygonCreates a polygon through specified points. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodCreatePolyLineDraws a poly line through specified points. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodCreateRectangleCreates a rectangle based on specified points. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodCreateSplineDraws a spline through specified points. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodDeleteOccurrenceDelete occurrence from this drawing. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodEqualsIs this document equal to the following object? (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodExportExport this drawing to a file. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodFlipObjectHorizontallyFlip object horizontally. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodFlipObjectVerticallyFlip object vertically. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodGetAllOccurrencesOverloaded.  Get all occurrences in this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodGetAllTables Get all table occurrences in the drawing document. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodGetDefaultLayer Returns name of the default layer of this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodGetEnvironmentOccurrencesOverridden.  Get environment occurrences in this document.  
    Public MethodGetHashCodeServes as the default hash function. (Inherited from EPLAN.Harness.API.Projects.Documents.Document)
    Public MethodGetLayers Returns names of all layers in this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodGetSources Get derivation sources of this drawing. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodHideHide selected occurrences. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodHideAllButMeHide all occurrences in this drawing except of the selected ones. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodImportDrawingImport and place drawing from file. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodImportImageImport and place raster image from file. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodMoveWireHarnessSegmentMove (rotate) wire harness segments.  
    Public MethodOpenOverridden.  Open this document.  
    Public MethodPlaceAccessoryListTablePlace list of accessories table. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceAssemblyTablePlace assembly / device content table. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceBalloonsOverridden. Insert balloons to drawings.  
    Public MethodPlaceBomTablePlace bill of materials table. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceBundleContentTablePlace bundle / cable content table.  
    Public MethodPlaceCableTieSymbolPlace a symbol of cable tie into drawing. It is placed on 0, 0 coordinates. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceConnectableObjectSymbol 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. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceConnectableObjectTablePlace connectable object table.  
    Public MethodPlaceControlPoint Place custom control point on control path (bundle, wire, cable). The custom point is placed between two control points on specified distance from 1st one. The control points must lay on the same control path and they must be neighbours.  
    Public MethodPlaceCustomTablePlace custom table. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceDrawingBorderPlace drawing border from library. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceDrawingHeaderPlace drawing header from library. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceDrawingNotesTablePlace drawing notes table. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceGapPlace gap symbol between two control points.  
    Public MethodPlaceInnerDimensionPlace inner dimension between two neighboring control points.  
    Public MethodPlaceLabelSymbolPlace a symbol of label into drawing. It is placed on 0, 0 coordinates. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceNailPlace nail to this nailboard.  
    Public MethodPlaceOuterDimensionPlace outer dimension between two selected control points. The control points must be members of the same wire harness.  
    Public MethodPlacePartAccessoryTablePlace part accessory table.  
    Public MethodPlacePartSymbolPlace symbol of mechanical part from library. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlacePlotFramePlace plot frame. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceRasterWithPositionsPlace raster with positions. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceSpecialComponentSymbolPlace a symbol of special component into drawing. It is placed on 0, 0 coordinates. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceSpecialComponentTablePlace special electrical components table. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceSpecifiedBalloonsOverridden. Insert BOM (bill of materials) balloons to drawings.  
    Public MethodPlaceSpiderDiagramPlace spider diagram. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceSurfaceProtectionLegendPlace surface protection legend. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceSurfaceProtectionTablePlace surface protection table. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceSymbolPlace symbol from library. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodPlaceWireHarnessesTablePlace wire harnesses table.  
    Public MethodPlaceWireListPlace wire list. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    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 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 MethodRemoveFromWireHarnessRemove selected free drawings from wire harness.  
    Public MethodRemoveSourcesOverridden. Remove given source(s) from this drawing.  
    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 MethodSave Save this document. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodSaveAs Save this as a new document.  
    Public MethodSaveAsTemplateSave this document as template. (Inherited from EPLAN.Harness.API.Projects.Documents.RevisionableDocument)
    Public MethodSendOneLayerBackwardSend occurrence one layer backward.  
    Public MethodSendToBackSend occurrence to back.  
    Public MethodShowShow selected occurrences. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodShowAllObjectsShow all occurrences in this drawing. (Inherited from EPLAN.Harness.API.Projects.Documents.Drawing2D)
    Public MethodShrinkBundlePlace gap symbol between two control points.  
    Public MethodToStringReturns a string that represents the current object. (Inherited from EPLAN.Harness.API.ApiObject)
    Public MethodUpdateOverridden. Update this drawing. Any changes in source documents will show up in the drawing.  
    Top
    See Also

    Reference

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

    Send Feedback