TextFile Class |
The TextFile class defines a text file object in a drawing.
Inheritance Hierarchy
SystemObject
Tekla.Structures.DrawingDatabaseObject
Tekla.Structures.DrawingDrawingObject
Tekla.Structures.DrawingEmbeddedObjectBase
Tekla.Structures.DrawingTextFile
Tekla.Structures.DrawingDatabaseObject
Tekla.Structures.DrawingDrawingObject
Tekla.Structures.DrawingEmbeddedObjectBase
Tekla.Structures.DrawingTextFile
Namespace: Tekla.Structures.Drawing
Assembly: Tekla.Structures.Drawing (in Tekla.Structures.Drawing.dll) Version: 2023.0.3
Syntax
The TextFile type exposes the following members.
Constructors
Name | Description | |
---|---|---|
TextFile(ViewBase, Point, String) |
Creates a new text file instance using standard attributes.
| |
TextFile(ViewBase, Point, String, Size) |
Creates a new text file instance using standard attributes.
| |
TextFile(ViewBase, Point, String, TextFileTextFileAttributes) |
Creates a new text file instance using specific attributes.
| |
TextFile(ViewBase, Point, String, Size, TextFileTextFileAttributes) |
Creates a new text file instance using specific attributes.
|
Properties
Name | Description | |
---|---|---|
Angle |
Gets or sets the angle (in degrees).
(Inherited from EmbeddedObjectBase.) | |
Attributes |
Gets or sets the text file attributes.
| |
FileName |
Gets or sets the file name defining the embedded object.
(Inherited from EmbeddedObjectBase.) | |
InsertionPoint |
Gets or sets the insertion point.
(Inherited from EmbeddedObjectBase.) | |
QueryReturnValue |
Status information about the latest database operation (select, insert, modify, delete).
(Inherited from DatabaseObject.) | |
Size |
Gets or sets the size of the frame of the embedded object.
(Inherited from EmbeddedObjectBase.) |
Methods
Name | Description | |
---|---|---|
Delete |
Deletes the text file object.
(Overrides EmbeddedObjectBaseDelete.) | |
GetAxisAlignedBoundingBox |
Gets the bounding box for the current object in the global axis coordinate system.
(Inherited from EmbeddedObjectBase.) | |
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 |
Gets the bounding box for the current object in its local coordinate system.
(Inherited from EmbeddedObjectBase.) | |
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 file object.
(Overrides EmbeddedObjectBaseInsert.) | |
IsEqual |
Compares the current object with an object of the same type.
(Overrides EmbeddedObjectBaseIsEqual(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 file object.
(Overrides EmbeddedObjectBaseModify.) | |
MoveObjectRelative |
Moves the object according to the given move vector.
(Inherited from EmbeddedObjectBase.) | |
Resize |
Resizes the object. The scaling type is changed to ScaleToFit.
(Inherited from EmbeddedObjectBase.) | |
Select |
Selects the text file object.
(Overrides EmbeddedObjectBaseSelect.) | |
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.) |
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:
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() { 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(); } }
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