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.

Text Class

The Text class defines a drawing object that can hold a text string and is shown in a drawing.
Inheritance Hierarchy

Namespace:  Tekla.Structures.Drawing
Assembly:  Tekla.Structures.Drawing (in Tekla.Structures.Drawing.dll) Version: 2019.0.0.0 (2019.0.0.0)
Syntax
[SerializableAttribute]
public sealed class Text : DrawingObject, IAxisAlignedBoundingBox, 
	IObjectAlignedBoundingBox, IMovableRelative, IPlacing, IHasChildren, IHideable

The Text type exposes the following members.

Constructors
  Name Description
Public method Text(ViewBase, Point, String)
Creates a new text instance with the given text string.
Public method Text(ViewBase, Point, String, PlacingBase)
Creates a new text instance with the given text string using a specific placing type.
Public method Text(ViewBase, Point, String, TextTextAttributes)
Creates a new text instance with the given text string and text attributes.
Public method Text(ViewBase, Point, String, PlacingBase, TextTextAttributes)
Creates a new text instance with the given text string and text attributes using a specific placing type.
Top
Properties
  Name Description
Public property Attributes
The attributes for the text.
Public property Hideable
Accesses the information if this object is hidden or not or if it should be.
Public property InsertionPoint
The insertion point of the text.
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 TextString
The contents of the text.
Top
Methods
  Name Description
Public method Delete
Deletes the text from the current drawing database.
(Overrides DatabaseObjectDelete.)
Public method GetAxisAlignedBoundingBox
Returns the axis aligned bounding box of the text (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 object aligned bounding box of the text (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 text 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 text in the current drawing database.
(Overrides DatabaseObjectModify.)
Public method MoveObjectRelative
Moves the object using the move vector.
Public method Select
Selects the text 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
See Also