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.

Symbol Class

The Symbol class defines a drawing object that is displayed as a symbol in a drawing. Symbols are located in the environment directory under the folder named "symbols" in .sym files that can contain up to 255 symbols. Symbol files can be created with SymEd. See the Tekla Structures help for more information.
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 Symbol : DrawingObject, 
	IAxisAlignedBoundingBox, IObjectAlignedBoundingBox, IMovableRelative, IPlacing, IHasChildren, 
	IHideable

The Symbol type exposes the following members.

Constructors
  Name Description
Public method Symbol(ViewBase, Point)
Creates a new symbol instance using the default symbol information and standard attributes.
Public method Symbol(ViewBase, Point, PlacingBase)
Creates a new symbol instance using the default symbol information, standard attributes and the given placing.
Public method Symbol(ViewBase, Point, SymbolInfo)
Creates a new symbol instance using standard attributes.
Public method Symbol(ViewBase, Point, SymbolInfo, PlacingBase)
Creates a new symbol instance using standard attributes.
Public method Symbol(ViewBase, Point, SymbolInfo, SymbolSymbolAttributes)
Creates a new symbol instance using the given attributes.
Public method Symbol(ViewBase, Point, SymbolInfo, SymbolSymbolAttributes, PlacingBase)
Creates a new symbol instance using the given attributes and placing.
Top
Properties
  Name Description
Public property Attributes
Gets or sets the symbol attributes.
Public property Hideable
Accesses the information if this object is hidden or not or if it should be.
Public property InsertionPoint
Gets or sets the symbol insertion point.
Public property Placing
The current placing of the object. See the placing types for different placing options.
Public property QueryReturnValue
Status information about the latest database operation (select, insert, modify, delete).
(Inherited from DatabaseObject.)
Public property SymbolInfo
Gets or sets the symbol information.
Top
Methods
  Name Description
Public method Delete
Deletes the symbol from the current drawing database.
(Overrides DatabaseObjectDelete.)
Public method GetAxisAlignedBoundingBox
Returns the bounding box of the symbol (rectangle format).
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 GetDrawing
Gets the drawing where the drawing object is.
(Inherited from DrawingObject.)
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 GetObjectAlignedBoundingBox
Returns the bounding box of the symbol (rectangle format).
Public method GetObjects
Gets the children objects of the current object.
Public method GetObjects(Type)
Gets the children objects of the current object that are of certain types.
Public method GetRelatedObjects
Gets the related objects of the current object.
(Inherited from DrawingObject.)
Public method GetRelatedObjects(Type)
Gets the related objects of the current object that are of certain types.
(Inherited from DrawingObject.)
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 GetView
Gets the view where the drawing object is.
(Inherited from DrawingObject.)
Public method Insert
Inserts the symbol into the current drawing database.
(Overrides DatabaseObjectInsert.)
Public method IsEqual
Compares the current object with an object of the same type.
(Overrides DrawingObjectIsEqual(Object).)
Public method IsSameDatabaseObject
Returns true if the current object and the given object are referencing the same database object.
(Inherited from DatabaseObject.)
Public method Modify
Modifies the symbol in the current drawing database.
(Overrides DatabaseObjectModify.)
Public method MoveObjectRelative
Moves the object using the move vector.
Public method Select
Selects the symbol from the current drawing database.
(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.)
Public method ToString
Changes the string presentation of the drawing object.
(Inherited from DrawingObject.)
Top
Examples
using Tekla.Structures.Drawing;
using Tekla.Structures.Geometry3d;

public class Example
{
       public void Example1()
       {
           DrawingHandler MyDrawingHandler = new DrawingHandler();
           ViewBase view = MyDrawingHandler.GetActiveDrawing().GetSheet().GetAllViews().Current as ViewBase;

           Symbol xs = new Symbol(view, new Point(1000, 2000), new SymbolInfo("xsteel", 52));
           xs.Attributes.Angle = 30;
           xs.Attributes.Frame.Type = FrameTypes.Rectangular;
           xs.Attributes.Height = 4.0;
           xs.Insert();
       }
}
See Also