Tekla Open API

Detailed and full API reference helps you master Tekla Open API

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

Drawing Class

The Drawing class represents a drawing in Tekla Structures.
Inheritance Hierarchy

Namespace:  Tekla.Structures.Drawing
Assembly:  Tekla.Structures.Drawing (in Tekla.Structures.Drawing.dll) Version: 2018.1.0.0 (2018.1.0.0)
Syntax
[SerializableAttribute]
public abstract class Drawing : DatabaseObject

The Drawing type exposes the following members.

Properties
  Name Description
Public property CommitMessage
Gets the commit message
Public property CreationDate
The drawing creation date.
Public property IsFrozen
Describes whether the drawing is frozen.
Public property IsIssued
Describes whether the drawing is issued.
Public property IsIssuedButModified
Describes whether the drawing is issued but modified since it was issued.
Public property IsLocked
Describes whether the drawing is locked.
Public property IsLockedBy
Gets the logged in username that set the drawing to locked
Public property IsMasterDrawing
Describes whether the drawing is a master drawing (shown with a special symbol on the drawing list).
Public property IsReadyForIssue
Describes whether the drawing is ready for issue.
Public property IsReadyForIssueBy
Gets the logged in username that set the drawing Ready for issue
Public property IssuingDate
The drawing issuing date.
Public property Layout
Gets the drawing layout attributes.
Public property Mark
The drawing mark.
Public property ModificationDate
The drawing modification date.
Public property Name
The name of the drawing.
Public property OutputDate
The drawing output date. XS_DISABLE_DRAWING_PLOT_DATE controls whether this date is set.
Public property QueryReturnValue
Status information about the latest database operation (select, insert, modify, delete).
(Inherited from DatabaseObject.)
Public property SectionViewStartLabel
Gets the drawing attribute for start label of section view
Public property Title1
The first drawing title.
Public property Title2
The second drawing title.
Public property Title3
The third drawing title.
Public property UpToDateStatus
Gets the drawing up to date status.
Top
Methods
  Name Description
Public method CommitChanges
Commits the changes made to the drawings database so far. Commit inserts a kind of save-point into the database and the save-point will be retrieved if the user does undo. Commit also executes all messages. Please note that you need to also to save the drawings database to persists the changes to disk.
Public method CommitChanges(String)
Commits the changes made to the drawings database so far. Commit inserts a kind of save-point into the database and the save-point will be retrieved if the user does undo. Commit also executes all messages. Please note that you need to also to save the drawings database to persists the changes to disk.
Public method Delete
Deletes the drawing. An active drawing cannot be deleted.
(Overrides DatabaseObjectDelete.)
Public method GetDoubleUserProperties(DictionaryString, Double)
Retrieves all double user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetDoubleUserProperties(ListString, DictionaryString, Double)
Retrieves all double user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetIntegerUserProperties(DictionaryString, Int32)
Retrieves all integer user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetIntegerUserProperties(ListString, DictionaryString, Int32)
Retrieves all integer user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetPlotFileName
Get plot file name.
Public method GetSheet
Gets the sheet of the drawing.
Public method GetStringUserProperties(DictionaryString, String)
Retrieves all string user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetStringUserProperties(ListString, DictionaryString, String)
Retrieves all string user properties for the object with the given list of names.
(Inherited from DatabaseObject.)
Public method GetUserProperty(String, Double)
Gets a double property from the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method GetUserProperty(String, Int32)
Gets an integer property from the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method GetUserProperty(String, String)
Gets a string property from the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method Insert
Inserts the object instance into the database. The inserted instance must be of a real type.
(Inherited from DatabaseObject.)
Public method IsSameDatabaseObject
Returns true if the current object and the given object are referencing the same database object.
(Overrides DatabaseObjectIsSameDatabaseObject(DatabaseObject).)
Public method Modify
Modifies the instance in the database.
(Inherited from DatabaseObject.)
Public method PlaceViews
Places views on the sheet. Computes the required size of the views to fit the parts, then places the views so that they fit on the sheet and do not overlap. Adjusts the sheet size if needed.
Public method Select
Selects the object instance from the database.
(Inherited from DatabaseObject.)
Public method SetUserProperty(String, Double)
Sets a double property for the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method SetUserProperty(String, Int32)
Sets an integer property for the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Public method SetUserProperty(String, String)
Sets a string property for the drawing object. The object has to be in a drawing before the method can be used.
(Inherited from DatabaseObject.)
Top
See Also