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.

TextFile Class

The TextFile class defines a text file object 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 TextFile : EmbeddedObjectBase, 
	IResizeable, IMovableRelative, IAxisAlignedBoundingBox, IObjectAlignedBoundingBox

The TextFile type exposes the following members.

Constructors
  Name Description
Public method TextFile(ViewBase, Point, String)
Creates a new text file instance using standard attributes.
Public method TextFile(ViewBase, Point, String, Size)
Creates a new text file instance using standard attributes.
Public method TextFile(ViewBase, Point, String, TextFileTextFileAttributes)
Creates a new text file instance using specific attributes.
Public method TextFile(ViewBase, Point, String, Size, TextFileTextFileAttributes)
Creates a new text file instance using specific attributes.
Top
Properties
  Name Description
Public property Angle
Gets or sets the angle (in degrees).
(Inherited from EmbeddedObjectBase.)
Public property Attributes
Gets or sets the text file attributes.
Public property FileName
Gets or sets the file name defining the embedded object.
(Inherited from EmbeddedObjectBase.)
Public property InsertionPoint
Gets or sets the insertion point.
(Inherited from EmbeddedObjectBase.)
Public property QueryReturnValue
Status information about the latest database operation (select, insert, modify, delete).
(Inherited from DatabaseObject.)
Public property Size
Gets or sets the size of the frame of the embedded object.
(Inherited from EmbeddedObjectBase.)
Top
Methods
  Name Description
Public method Delete
Deletes the text file object.
(Overrides EmbeddedObjectBaseDelete.)
Public method GetAxisAlignedBoundingBox
Gets the bounding box for the current object in the global axis coordinate system.
(Inherited from EmbeddedObjectBase.)
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
Gets the bounding box for the current object in its local coordinate system.
(Inherited from EmbeddedObjectBase.)
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 file object.
(Overrides EmbeddedObjectBaseInsert.)
Public method IsEqual
Compares the current object with an object of the same type.
(Overrides EmbeddedObjectBaseIsEqual(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 file object.
(Overrides EmbeddedObjectBaseModify.)
Public methodCode example MoveObjectRelative
Moves the object according to the given move vector.
(Inherited from EmbeddedObjectBase.)
Public method Resize
Resizes the object. The scaling type is changed to ScaleToFit.
(Inherited from EmbeddedObjectBase.)
Public method Select
Selects the text file object.
(Overrides EmbeddedObjectBaseSelect.)
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
Remarks
A text file object can be inserted as-is without scaling or it can be forced to fit inside the given space. The content is scaled in the Y direction, but it can overflow in the X direction.
Examples
The following example shows how to insert a text file object:
using Tekla.Structures.Drawing;
using Tekla.Structures.Geometry3d;
using System.IO;

public class Example
{
       public void Example1()
       {
           DrawingHandler MyDrawingHandler = new DrawingHandler();
           ViewBase _sheet = MyDrawingHandler.GetActiveDrawing().GetSheet();

           TextFile text = new TextFile(_sheet, new Point(-300, 100), Path.GetFullPath("my_text.txt"));
           text.Insert();
       }
}
The following code inserts an object whose height is forced to 400 and width to 500, but it can overflow if the text is too long.
using Tekla.Structures.Drawing;
using Tekla.Structures.Geometry3d;
using System.IO;

public class Example
{
       public void Example1()
       {
           Drawing myDrawing = new GADrawing();

           TextFile text = new TextFile(myDrawing.GetSheet(), new Point(-300, 100),
               Path.GetFullPath("my_text.txt"), new Size(500, 400));
           text.Insert();
       }
}
See Also