API Reference

Detailed and full API reference helps you master Tekla development

This is the most recent version of Tekla Open API.
For older versions, please visit Tekla Warehouse.

DrawingHandler Methods

The DrawingHandler type exposes the following members.

Methods
  NameDescription
Public methodCloseActiveDrawing
Closes the drawing editor.
Public methodCloseActiveDrawing(Boolean)
Closes the drawing editor.
Public methodGetActiveDrawing
Returns an instance of the active drawing that is currently open in Tekla Structures.
Public methodGetConnectionStatus
Returns true if a proper connection to the Tekla Structures process has been established. A proper connection to Tekla Stuctures in the drawing API needs Tekla Structures up and running and a model open. Currently, there's no way to re-establish the connection.
Public methodGetDrawingObjectSelector
Gets a drawing object selector. With a drawing object selector drawing objects can be selected and highlighted in the drawing editor. A drawing object selector also provides a list of currently selected drawing objects.
Public methodGetDrawings
Gets all the drawings from the database.
Public methodGetDrawingSelector
Gets a drawing selector. With a drawing selector the list of selected drawings can be gotten.
Public methodStatic memberGetMessageExecutionStatus Obsolete.
Gets the current message execution mode for the application.
Public methodGetModelObjectIdentifiers
Gets model object identifiers of the drawing.
Public methodGetPicker
Gets a picker for picking points and objects in a drawing.
Public methodIssueDrawing
Issues the drawing if the drawing is not issued or was previously issued but has been modified since. This is the same as pressing Issue on the drawing list for a selected drawing.
Public methodPrintDrawing(Drawing, DPMPrinterAttributes)
Prints the drawing using the given printer attributes.
Public methodPrintDrawing(Drawing, PrintAttributes)
Prints the drawing using the given printer instance. NOTE! The drawing cannot be active, otherwise printing fails.
Public methodPrintDrawing(Drawing, DPMPrinterAttributes, String)
Prints the drawing to file using the given printer attributes and name of the output file. The given output file overrides the printer attributes file settings.
Public methodPrintDrawing(Drawing, PrintAttributes, String)
Prints the drawing to file using the given printer instance. NOTE! The drawing cannot be active, otherwise printing fails.
Public methodPrintDrawings
Prints the list of drawings using the given printer attributes.
Public methodSaveActiveDrawing
Saves the currently open drawing.
Public methodSetActiveDrawing(Drawing)
Sets the active drawing that is currently open in Tekla Structures.
Public methodSetActiveDrawing(Drawing, Boolean)
Sets the active drawing that is currently open in Tekla Structures.
Public methodStatic memberSetMessageExecutionStatus Obsolete.
Sets the message execution mode for the application.
Public methodUnissueDrawing
Unissues the drawing. This is the same as pressing Unissue on the drawing list for a selected drawing.
Public methodUpdateDrawing
Updates the drawing. This is the same as pressing Update on the drawing list for a selected drawing. NOTE! The drawing cannot be active, otherwise the operation fails. NOTE! Numbering must be executed before this operation.
Top
See Also