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.

GADrawing Class

The GADrawing class is for handling general arrangement drawings 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 sealed class GADrawing : Drawing

The GADrawing type exposes the following members.

Constructors
  Name Description
Public method GADrawing
Instantiates a new GA drawing using standard attributes.
Public method GADrawing(String)
Instantiates a new GA drawing with the given attributes.
Public method GADrawing(String, String)
Instantiates a new GA drawing with the given name and attribute file.
Public method GADrawing(String, Size)
Instantiates a new GA drawing with attributes. Loads the specified attribute file and overrides with the given layout attributes.
Top
Properties
  Name Description
Public property CommitMessage
Gets the commit message
(Inherited from Drawing.)
Public property CreationDate
The drawing creation date.
(Inherited from Drawing.)
Public property IsFrozen
Describes whether the drawing is frozen.
(Inherited from Drawing.)
Public property IsIssued
Describes whether the drawing is issued.
(Inherited from Drawing.)
Public property IsIssuedButModified
Describes whether the drawing is issued but modified since it was issued.
(Inherited from Drawing.)
Public property IsLocked
Describes whether the drawing is locked.
(Inherited from Drawing.)
Public property IsLockedBy
Gets the logged in username that set the drawing to locked
(Inherited from Drawing.)
Public property IsMasterDrawing
Describes whether the drawing is a master drawing (shown with a special symbol on the drawing list).
(Inherited from Drawing.)
Public property IsReadyForIssue
Describes whether the drawing is ready for issue.
(Inherited from Drawing.)
Public property IsReadyForIssueBy
Gets the logged in username that set the drawing Ready for issue
(Inherited from Drawing.)
Public property IssuingDate
The drawing issuing date.
(Inherited from Drawing.)
Public property Layout
Gets the drawing layout attributes.
(Inherited from Drawing.)
Public property Mark
The drawing mark.
(Inherited from Drawing.)
Public property ModificationDate
The drawing modification date.
(Inherited from Drawing.)
Public property Name
The name of the drawing.
(Inherited from Drawing.)
Public property OutputDate
The drawing output date. XS_DISABLE_DRAWING_PLOT_DATE controls whether this date is set.
(Inherited from Drawing.)
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
(Inherited from Drawing.)
Public property Title1
The first drawing title.
(Inherited from Drawing.)
Public property Title2
The second drawing title.
(Inherited from Drawing.)
Public property Title3
The third drawing title.
(Inherited from Drawing.)
Public property UpToDateStatus
Gets the drawing up to date status.
(Inherited from Drawing.)
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.
(Inherited from Drawing.)
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.
(Inherited from Drawing.)
Public method Delete
Deletes the drawing. An active drawing cannot be deleted.
(Inherited from Drawing.)
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.
(Inherited from Drawing.)
Public method GetSheet
Gets the sheet of the drawing.
(Inherited from 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 an empty general arrangement drawing. Views must be added separately. A drawing can be inserted only when there is no active drawing.
(Overrides DatabaseObjectInsert.)
Public method IsSameDatabaseObject
Returns true if the current object and the given object are referencing the same database object.
(Inherited from Drawing.)
Public method Modify
Applies the changes made to the drawing attributes.
(Overrides DatabaseObjectModify.)
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.
(Inherited from Drawing.)
Public method Select
Selects the drawing.
(Overrides DatabaseObjectSelect.)
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
Examples
Creates an empty GA drawing based on standard attributes and opens it:
using Tekla.Structures.Drawing;

public class Example
{
       public void Example1()
       {
           DrawingHandler drawingHandler = new DrawingHandler();
           Drawing gaDrawing = new GADrawing();
           gaDrawing.Insert();
           drawingHandler.SetActiveDrawing(gaDrawing);
       }
}
The following example shows how to insert an A3-sized GA drawing:
using Tekla.Structures.Drawing;

public class Example
{
       public void Example1()
       {
           Size A3 = new Size(410.0, 287.0);
           Drawing newDrawing = new GADrawing("standard", A3);
           newDrawing.Insert();
       }
}
See Also