TextBox Class
Defines the Textbox Class.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Vml.TextBox
Namespace: DocumentFormat.OpenXml.Vml
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(TextBoxContent))> _
Public Class TextBox _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As TextBox
[ChildElementInfoAttribute(typeof(TextBoxContent))]
public class TextBox : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
- DocumentFormat.OpenXml.Wordprocessing.TextBoxContent <w:txbxContent>
[ISO/IEC 29500-1 1st Edition]
14.1.2.22 textbox (Text Box)
This element is used to define text that appears inside the shape. This text can contain rich formatting and is rendered to fit inside the textboxrect defined by the path element (§14.1.2.14).
[Example:
<v:shape style="width=200;height=200" coordsize="400,400"
fillcolor="yellow" strokecolor="maroon"
path="m 119,0 l 148,86 238,86 166,140 192,226 119,175 46,226
72,140 0,86 90,86 x e">
<v:textbox inset="32pt,35pt,,">VML</v:textbox>
</v:shape>
end example]
Parent Elements |
---|
arc (§14.1.2.1); background (Part 1, §17.2.1); curve (§14.1.2.3); group (§14.1.2.7); image (§14.1.2.10); line (§14.1.2.12); object (Part 1, §17.3.3.19); oval (§14.1.2.13); pict (§9.2.2.2); pict (§9.5.1); polyline (§14.1.2.15); rect (§14.1.2.16); roundrect (§14.1.2.17); shape (§14.1.2.19); shapedefaults (§14.2.2.28); shapetype (§14.1.2.20) |
Child Elements |
Subclause |
---|---|
txbxContent (Rich Text Box Content Container) |
§9.8.1.1 |
Attributes |
Description |
---|---|
id (Unique Identifier) |
Specifies a unique identifier that can be used to reference a VML object. Default is no value. [Example:
end example] The possible values for this attribute are defined by the W3C XML Schema string datatype. |
inset (Text Box Inset) |
Specifies inner margin values for textbox text. Default is "0.1in, 0.05in, 0.1in, 0.05in". Missing values are set to the default. This is used if insetmode is custom. The internal text margin value is specified as a string containing four values, each separated by commas or spaces. The values measure inset from the left, top, right, and bottom edges of the box specified by the textboxrect attribute of the path element (§14.1.2.14). [Example: The text is set toward the lower right of a small square:
end example] The possible values for this attribute are defined by the W3C XML Schema string datatype. |
insetmode (Text Inset Mode) Namespace: urn:schemas-microsoft-com:office:office |
Specifies whether the application calculates the internal text margin instead of using the inset attribute. Default is custom. [Example:
end example] The possible values for this attribute are defined by the ST_InsetMode simple type (§14.2.3.17). |
singleclick (Text Box Single-Click Selection Toggle) Namespace: urn:schemas-microsoft-com:office:office |
Specifies whether text is selectable with a single click. Default is false. The possible values for this attribute are defined by the ST_TrueFalse simple type (§15.1.2.5). |
style (Shape Styling Properties) |
Specifies the CSS2 styling properties of the shape. The CSS2 (Cascading Style Sheets, Level 2) specification, a Recommendation of the World Wide Web Consortium, is available here: http://www.w3.org/TR/REC-CSS2. This attribute uses a semi-colon delimited list of “name:value” pairs, the syntax defined by section 4.1.8 of the CSS2 specification for grouped declarations (without the surrounding braces). The following tables define the allowed properties and the VML treatment of each. [Example:
end example] Property Description flip Specifies that the orientation of a shape is flipped. Default is no value. Allowed values are:
height Specifies the height of the containing block of the shape. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element. Allowed values are:
left Specifies the position of the left of the containing block of the shape relative to the element left of it in the flow of the page. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element. This property shall not be used for shapes anchored inline. Allowed values are:
margin-bottom Specifies the position of the bottom of the containing block of the shape relative to the shape anchor. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element. Allowed values are:
margin-left Specifies the position of the left of the containing block of the shape relative to the shape anchor. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element. Allowed values are:
margin-right Specifies the position of the right of the containing block of the shape relative to the shape anchor. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element. Allowed values are:
margin-top Specifies the position of the top of the containing block of the shape relative to the shape anchor. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element. Allowed values are:
mso-position-horizontal Specifies the horizontal positioning data for objects in WordprocessingML documents. Default is absolute. Allowed values are:
mso-position-horizontal-relative Specifies relative horizontal position data for objects in WordprocessingML documents. This modifies the mso-position-horizontal property. Default is text. Allowed values are:
mso-position-vertical Specifies the vertical positioning data for objects in WordprocessingML documents. Default is absolute. Allowed values are:
mso-position-vertical-relative Specifies relative vertical position data for objects in WordprocessingML documents. This modifies the mso-position-vertical property. Default is text. Allowed values are:
mso-wrap-distance-bottom Specifies the distance from the bottom of the shape to the text that wraps around it. Default is 0 pt. This property is different from the CSS margin property, which changes the origin of the shape to include the margin areas. This property does not change the origin. mso-wrap-distance-left Specifies the distance from the left side of the shape to the text that wraps around it. Default is 0 pt. This property is different from the CSS margin property, which changes the origin of the shape to include the margin areas. This property does not change the origin. mso-wrap-distance-right Specifies the distance from the right side of the shape to the text that wraps around it. Default is 0 pt. This property is different from the CSS margin property, which changes the origin of the shape to include the margin areas. This property does not change the origin. mso-wrap-distance-top Specifies the distance from the top of the shape to the text that wraps around it. Default is 0 pt. This property is different from the CSS margin property, which changes the origin of the shape to include the margin areas. This property does not change the origin. mso-wrap-edited Specifies whether the wrap coordinates were customized by the user. If the wrap coordinates are generated by an editor, this property is true; otherwise they were customized by a user. Default is false. mso-wrap-style Specifies the wrapping mode for text in shapes in WordprocessingML documents. Default is square. Allowed values are:
position Specifies the kind of positioning used to place an element. Default is static. When the element is contained inside a group, this property shall be absolute. Allowed values are:
rotation Specifies the angle that a shape is rotated, in degrees. Default is 0. Positive angles are clockwise. top Specifies the position of the top of the containing block of the shape relative to the element above it in the flow of the page. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element. This property shall not be used for shapes anchored inline. Allowed values are:
visibility Specifies whether a shape is displayed. Only inherit and hidden are used; any other values are mapped to inherit. Default is inherit. Allowed values are:
width Specifies the width of the containing block of the shape. Default is 0. It is specified in CSS units or, for elements in a group, in the coordinate system of the parent element. Allowed values are:
z-index Specifies the display order of overlapping shapes. Default is 0. This property shall not be used for shapes anchored inline. Allowed values are:
The following properties are only used by the textbox element (§14.1.2.22): Property Description direction Specifies the direction of the text in the textbox. Default is ltr. This property is superceded by the mso-direction-alt property if that is specified. Allowed values are:
layout-flow Determines the flow of the text layout in a textbox. Default is horizontal. Allowed values are:
mso-direction-alt Specifies an alternate direction for text in textboxes. Overrides the direction property. The only allowed value is context. mso-fit-shape-to-text Specifies whether the shape stretches to fit the text in the textbox. Default is false. mso-fit-text-to-shape Specifies whether the text stretches to fit the textbox. Default is false. mso-layout-flow-alt Specifies the alternate layout flow for text in textboxes. This property is used instead of layout-flow when the layout flow is from bottom to top for non-ideographic languages. Its only value is bottom-to-top. mso-next-textbox Specifies the ID of the next textbox in a series. Used to keep track of a set of linked textboxes. Default is no value. mso-rotate Specifies a specific rotation value for text in a textbox. Default is 0. Allowed values are:
mso-text-scale Specifies the scaling factor for fitting text to shapes. Default is 0. This property is only used if mso-fit-text-to-shape is true. v-text-anchor Specifies the vertical anchoring of text in a textbox. Default is top. The alignment of a text anchor only becomes evident if mso-fit-text-to-shape is false. This property is different from the vertical-align CSS property, which is used for ideographic languages. Allowed values are:
The following properties are only used by the textpath element (§14.1.2.23): Property Description font Specifies a compound value of font settings. Default is no value. The values are the same as those of the CSS font property. The order of definitions in the string is: font-style, font-variant, font-weight, font-size, line-height, font-family. font-family Specifies the family of the font. Default is no value. The values are the same as those of the CSS font-family property. font-size Specifies the size of the font. Default is no value. The font size is defined in points. The values are the same as those of the CSS font-size property. font-style Specifies the amount of slant for a font. Default is normal. The values are the same as those of the CSS font-style property. Allowed values are:
font-variant Specifies the variant style of a font. Default is normal. The values are the same as those of the CSS font-variant property. Allowed values are:
font-weight Specifies the thickness of the letters of the font. Default is normal. The values are the same as those of the CSS font-weight property. Allowed values are: Value Description normal lighter 100 200 300 400 Treated as non-bold. bold bolder 500 600 700 800 900 Treated as bold. mso-text-shadow Specifies whether a shadow is applied to the text on a text path. Default is false. text-decoration Specifies the style of text decoration. Default is none. The values are the same as those of the CSS text-decoration property. Allowed values are:
v-rotate-letters Specifies whether the letters of the text are rotated counterclockwise by 90 degrees. Default is false. v-same-letter-heights Specifies whether all letters are the same height regardless of initial case. If true, the lowercase letters are stretched to the height of the uppercase letters. Default is false. v-text-align Specifies the alignment of text. Default is left. Allowed values are:
v-text-kern Specifies whether kerning is turned on. Default is false. v-text-reverse Specifies whether the layout order of rows is reversed. Default is false. This is used for vertical text layout. v-text-spacing-mode Specifies the mode for letter spacing. Default is tightening. This property determines whether space is removed between each letter (tightening) or added between each letter (tracking). The amount of letter spacing change is defined by the v-text-spacing property. Allowed values are:
v-text-spacing Specifies the amount of spacing for text in 100ths of single line spacing. Default is 100. The line (§14.1.2.12), polyline (§14.1.2.15) and curve (§14.1.2.3) elements ignore the following properties:
The following properties are not inherited by an element that references a shapetype element (§14.1.2.20) via the id attribute:
The possible values for this attribute are defined by the W3C XML Schema string datatype. |
[Note: The W3C XML Schema definition of this element’s content model (CT_Textbox) is located in §A.6.1. end note]
© ISO/IEC29500: 2008.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.