# TextFrame Object

> The TextFrame object represents a rectangle that can be filled with text by an end-user and can be edited like the main text.

- **Product:** TX Text Control .NET Server
- **Section:** Reference
- **Kind:** Object
- **Introduced:** 28.0
- **Path:** TX Text Control .NET Server > Reference > JavaScript API > TextFrame Object
- **Web URL:** https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/
- **LLMs URL:** https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/llms-full.txt

---

## On This Page

- [Description](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/#description)
- [Syntax](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/#syntax)
- [Examples](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/#examples)
- [Members](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/#members)

---

## In This Section

- [Javascript: TextFrame.activate Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/activate-method/llms.txt): Activates the text frame. The text frame receives the input focus. A text frame can only be activated, if the text part that contains the text frame has the input focus.
- [Javascript: TextFrame.changeZOrder Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/changezorder-method/llms.txt): Changes the frame's z-order.
- [Javascript: TextFrame.getAlignment Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getalignment-method/llms.txt): Gets the frame's horizontal alignment when it is anchored to a paragraph.
- [Javascript: TextFrame.getBackColor Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getbackcolor-method/llms.txt): Gets the background color of the text frame.
- [Javascript: TextFrame.getBorderColor Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getbordercolor-method/llms.txt): Gets the border color of the text frame.
- [Javascript: TextFrame.getBorderStyle Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getborderstyle-method/llms.txt): Gets the style of a text frame's border line.
- [Javascript: TextFrame.getBorderWidth Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getborderwidth-method/llms.txt): Gets the width, in twips, of a text frame's border line.
- [Javascript: TextFrame.getBounds Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getbounds-method/llms.txt): Gets the frame's bounding rectangle relative to the upper left corner of the document.
- [Javascript: TextFrame.getDescriptiveText Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getdescriptivetext-method/llms.txt): Gets the descriptive text for the text frame. An empty string indicates that the text frame has no such text.
- [Javascript: TextFrame.getID Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getid-method/llms.txt): Gets an identifier for the frame. A value of zero indicates that the image, text frame, chart, barcode or drawing has no identifier.
- [Javascript: TextFrame.getInsertionMode Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getinsertionmode-method/llms.txt): Gets a value determining whether the frame is treated as a single character or the document's text either flows around or overwrites the frame. If the document's text flows around or overwrites the frame, this property also determines whether the image, text frame, chart, barcode or drawing is moved with the text or fixed positioned on a page.
- [Javascript: TextFrame.getInternalMargins Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getinternalmargins-method/llms.txt): Sets the distances, in twips, between the text frame's border line and the text.
- [Javascript: TextFrame.getLocation Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getlocation-method/llms.txt): Gets, in twips, the frame's current location. If the image, text frame, chart, barcode or drawing is anchored to a paragraph, the location is relative to the paragraph. Otherwise, it is relative to the document. If the frame has a horizontal alignment or if it is inserted inline, this property returns zero. This property cannot be set for images, text frames, charts, barcodes or drawings which are inserted inline.
- [Javascript: TextFrame.getMoveable Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getmoveable-method/llms.txt): Gets whether a frame can be moved in the document at run time with the built-in mouse interface.
- [Javascript: TextFrame.getName Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getname-method/llms.txt): Gets the name for the frame. An empty string indicates that the frame has no name.
- [Javascript: TextFrame.getSize Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getsize-method/llms.txt): Gets the frame's size in twips.
- [Javascript: TextFrame.getSizeable Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/getsizeable-method/llms.txt): Gets whether the frame can be resized at run time with the built-in mouse interface.
- [Javascript: TextFrame.getTextDistances Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/gettextdistances-method/llms.txt): Gets the distances, in twips, between the frame and the document's text.
- [Javascript: TextFrame.getTextPosition Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/gettextposition-method/llms.txt): Gets the frame's character position in the document's text (one-based).
- [Javascript: TextFrame.getTransparency Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/gettransparency-method/llms.txt): Gets the text frame's transparency. Zero means opaque and 1.0 means completely transparent.
- [Javascript: TextFrame.setAlignment Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setalignment-method/llms.txt): Sets the frame's horizontal alignment when it is anchored to a paragraph.
- [Javascript: TextFrame.setBackColor Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setbackcolor-method/llms.txt): Sets the background color for the text frame.
- [Javascript: TextFrame.setBorderColor Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setbordercolor-method/llms.txt): Sets the border color for the text frame.
- [Javascript: TextFrame.setBorderStyle Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setborderstyle-method/llms.txt): Sets the style of a text frame's border line.
- [Javascript: TextFrame.setBorderWidth Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setborderwidth-method/llms.txt): Sets the width, in twips, of a text frame's border line. To alter the distance between the border line and the text, use the InternalMargins property. If this property is set to zero, the text frame has no border line.
- [Javascript: TextFrame.setDescriptiveText Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setdescriptivetext-method/llms.txt): Sets a descriptive text for the text frame. An empty string or null can be used to delete a previously set text.
- [Javascript: TextFrame.setID Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setid-method/llms.txt): Sets an identifier for the frame. It must be a one-based value. A value of zero indicates that the image, text frame, chart, barcode or drawing has no identifier. Zero can also be used to delete a previously set identifier.
- [Javascript: TextFrame.setInsertionMode Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setinsertionmode-method/llms.txt): Sets a value determining whether the frame is treated as a single character or the document's text either flows around or overwrites the frame. If the document's text flows around or overwrites the frame, this property also determines whether the image, text frame, chart, barcode or drawing is moved with the text or fixed positioned on a page.
- [Javascript: TextFrame.setInternalMargins Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setinternalmargins-method/llms.txt): Sets the distances, in twips, between the text frame's border line and the text. If a value is set to -1, it is not changed.
- [Javascript: TextFrame.setLocation Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setlocation-method/llms.txt): Sets, in twips, the frame's current location. If the image, text frame, chart, barcode or drawing is anchored to a paragraph, the location is relative to the paragraph. Otherwise, it is relative to the document. If the frame has a horizontal alignment or if it is inserted inline, this property returns zero. This property cannot be set for images, text frames, charts, barcodes or drawings which are inserted inline.
- [Javascript: TextFrame.setMoveable Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setmoveable-method/llms.txt): Sets whether a frame can be moved in the document at run time with the built-in mouse interface.
- [Javascript: TextFrame.setName Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setname-method/llms.txt): Sets a name for the frame. An empty string indicates that the frame has no name. An empty string can also be used to delete a previously set name.
- [Javascript: TextFrame.setSize Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setsize-method/llms.txt): Sets the frame's size in twips. For images this property is read only.
- [Javascript: TextFrame.setSizeable Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/setsizeable-method/llms.txt): Sets whether the frame can be resized at run time with the built-in mouse interface.
- [Javascript: TextFrame.setTextDistances Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/settextdistances-method/llms.txt): Sets the distances, in twips, between the frame and the document's text. If a value is set to -1, it is not changed.
- [Javascript: TextFrame.setTransparency Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/settransparency-method/llms.txt): Sets the text frame's transparency. It must be a value between 0.0 and 1.0. Zero means opaque and 1.0 means completely transparent.

---

## Nearby

- **Previous:** [Javascript: TextFormFieldInfo Constructor](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textformfieldinfo/constructor/llms.txt)
- **Next:** [Javascript: TextFrame.activate Method](https://docs.textcontrol.com/tx-text-control-dotnet-server/reference/javascript/textframe/activate-method/llms.txt)
