Text Class

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

Inheritance Hierarchy

SystemObject
  Tekla.Structures.DrawingDatabaseObject
    Tekla.Structures.DrawingDrawingObject
      Tekla.Structures.DrawingText

Namespace: Tekla.Structures.Drawing
Assembly: Tekla.Structures.Drawing (in Tekla.Structures.Drawing.dll) Version: 2024.0.0+a110b435391768740483e3032720a566518c9a63

Syntax

Copy

[SerializableAttribute]
public sealed class Text : DrawingObject, IAxisAlignedBoundingBox, 
	IObjectAlignedBoundingBox, IMovableRelative, IPlacing, IHasChildren, IHideable

<SerializableAttribute>
Public NotInheritable Class Text
	Inherits DrawingObject
	Implements IAxisAlignedBoundingBox, IObjectAlignedBoundingBox, IMovableRelative, IPlacing, 
	IHasChildren, IHideable

The Text type exposes the following members.

Constructors

	Name	Description
	Text(ViewBase, Point, String)	Creates a new text instance with the given text string.
	Text(ViewBase, Point, String, PlacingBase)	Creates a new text instance with the given text string using a specific placing type.
	Text(ViewBase, Point, String, TextTextAttributes)	Creates a new text instance with the given text string and text attributes.
	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
	Attributes	The attributes for the text.
	Hideable	Accesses the information if this object is hidden or not or if it should be.
	InsertionPoint	The insertion point of the text.
	Placing	The current placing of the object. See the placing types for different placing options.
	QueryReturnValue	Status information about the latest database operation (select, insert, modify, delete). (Inherited from DatabaseObject.)
	TextString	The contents of the text.

Top

Methods

	Name	Description
	Delete	Deletes the text from the current drawing database. (Overrides DatabaseObjectDelete.)
	GetAxisAlignedBoundingBox	Returns the axis aligned bounding box of the text (rectangle format).
	GetDoubleUserProperties(DictionaryString, Double)	Retrieves all double user properties for the object with the given list of names. (Inherited from DatabaseObject.)
	GetDoubleUserProperties(ListString, DictionaryString, Double)	Retrieves all double user properties for the object with the given list of names. (Inherited from DatabaseObject.)
	GetDrawing	Gets the drawing where the drawing object is. (Inherited from DrawingObject.)
	GetIntegerUserProperties(DictionaryString, Int32)	Retrieves all integer user properties for the object with the given list of names. (Inherited from DatabaseObject.)
	GetIntegerUserProperties(ListString, DictionaryString, Int32)	Retrieves all integer user properties for the object with the given list of names. (Inherited from DatabaseObject.)
	GetObjectAlignedBoundingBox	Returns the object aligned bounding box of the text (rectangle format).
	GetObjects	Gets the children objects of the current object.
	GetObjects(Type)	Gets the children objects of the current object that are of certain types.
	GetRelatedObjects	Gets the related objects of the current object. (Inherited from DrawingObject.)
	GetRelatedObjects(Type)	Gets the related objects of the current object that are of certain types. (Inherited from DrawingObject.)
	GetStringUserProperties(DictionaryString, String)	Retrieves all string user properties for the object with the given list of names. (Inherited from DatabaseObject.)
	GetStringUserProperties(ListString, DictionaryString, String)	Retrieves all string user properties for the object with the given list of names. (Inherited from DatabaseObject.)
	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.)
	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.)
	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.)
	GetView	Gets the view where the drawing object is. (Inherited from DrawingObject.)
	Insert	Inserts the text into the current drawing database. (Overrides DatabaseObjectInsert.)
	IsEqual	Compares the current object with an object of the same type. (Overrides DrawingObjectIsEqual(Object).)
	IsSameDatabaseObject	Returns true if the current object and the given object are referencing the same database object. (Inherited from DatabaseObject.)
	Modify	Modifies the text in the current drawing database. (Overrides DatabaseObjectModify.)
	MoveObjectRelative	Moves the object using the move vector.
	Select	Selects the text from the current drawing database. (Overrides DatabaseObjectSelect.)
	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.)
	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.)
	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.)
	ToString	Changes the string presentation of the drawing object. (Inherited from DrawingObject.)

Top

Reference

Tekla.Structures.Drawing Namespace