1# 文本组件公共接口 2<!--Kit: ArkUI--> 3<!--Subsystem: ArkUI--> 4<!--Owner: @kangshihui--> 5<!--Designer: @pssea--> 6<!--Tester: @jiaoaozihao--> 7<!--Adviser: @HelloCrease--> 8 9>**说明：** 10> 11>文本类组件公共接口。 12>本模块首批接口从API version 10开始支持，后续版本的新增接口，采用上角标单独标记接口的起始版本。 13 14## CaretStyle<sup>10+</sup> 15 16**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 17 18**系统能力：** SystemCapability.ArkUI.ArkUI.Full 19 20| 名称 | 类型 | 只读 | 可选 | 说明 | 21| ------ | ------------------------------------------ | ---- | ---- | -------- | 22| width | [Length](ts-types.md#length) | 否 | 是 | 光标尺寸，不支持百分比。<br/>默认值：'2vp' | 23| color | [ResourceColor](ts-types.md#resourcecolor) | 否 | 是 | 光标颜色。<br/>默认值：'#ff007dff' | 24 25## LayoutManager<sup>12+</sup> 26 27布局管理器对象。 28 29> **说明：** 30> 31> 文本内容变更后，需等待布局完成才可获取到最新的布局信息。 32 33### 导入对象 34以Text组件为例，完整示例请参考Text组件的[示例10获取文本信息](./ts-basic-components-text.md#示例10获取文本信息)。 35```ts 36controller: TextController = new TextController(); 37let layoutManager: LayoutManager = this.controller.getLayoutManager(); 38``` 39 40### getLineCount 41 42getLineCount(): number 43 44获取组件内容的总行数。 45 46**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 47 48**系统能力：** SystemCapability.ArkUI.ArkUI.Full 49 50**返回值：** 51 52| 类型 | 说明 | 53| ------ | --------- | 54| number | 组件内容的总行数。 | 55 56### getGlyphPositionAtCoordinate 57 58getGlyphPositionAtCoordinate(x: number, y: number): PositionWithAffinity 59 60获取较为接近给定坐标的字形的位置信息。 61 62**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 63 64**系统能力：** SystemCapability.ArkUI.ArkUI.Full 65 66**参数：** 67 68| 参数名 | 类型 | 必填 | 说明 | 69| ------ | ------ | ---- | -------------------- | 70| x | number | 是 | 相对于组件的横坐标。<br/>单位：[px](ts-pixel-units.md) | 71| y | number | 是 | 相对于组件的纵坐标。<br/>单位：[px](ts-pixel-units.md) | 72 73**返回值：** 74 75| 类型 | 说明 | 76| --------------------------------------------- | ----------- | 77| [PositionWithAffinity](#positionwithaffinity12) | 字形位置信息。| 78 79### getLineMetrics 80 81getLineMetrics(lineNumber: number): LineMetrics 82 83获取指定行的行信息、文本样式信息、以及字体属性信息。 84 85**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 86 87**系统能力：** SystemCapability.ArkUI.ArkUI.Full 88 89**参数：** 90 91| 参数名 | 类型 | 必填 | 说明 | 92| ------ | ------ | ---- | -------------------- | 93| lineNumber | number | 是 | 行号，从0开始。 | 94 95**返回值：** 96 97| 类型 | 说明 | 98| ---------------------------------------- | -------- | 99| [LineMetrics](#linemetrics12) | 行信息、文本样式信息、以及字体属性信息。<br/>当行号小于0或超出实际行，返回无效值。 | 100 101### getRectsForRange<sup>14+</sup> 102 103getRectsForRange(range: TextRange, widthStyle: RectWidthStyle, heightStyle: RectHeightStyle): Array\<TextBox> 104 105获取给定的矩形区域宽度以及矩形区域高度的规格下，文本中任意区间范围内的字符或占位符所占的绘制区域信息。 106 107**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。 108 109**系统能力：** SystemCapability.ArkUI.ArkUI.Full 110 111**参数：** 112 113| 参数名 | 类型 | 必填 | 说明 | 114| ----------- | ----------------------------------- | ---- | ------------------------ | 115| range | [TextRange](#textrange12)| 是 | 需要获取的区域的文本区间。 | 116| widthStyle | [RectWidthStyle](#rectwidthstyle14) | 是 | 返回的矩形区域的宽度的规格。| 117| heightStyle | [RectHeightStyle](#rectheightstyle14) | 是 | 返回的矩形区域的高度的规格。| 118 119**返回值：** 120 121| 类型 | 说明 | 122| --------------------------- | ----------- | 123| Array\<[TextBox](#textbox14)> | 矩形区域数组。| 124 125## PositionWithAffinity<sup>12+</sup> 126 127位置以及亲和度。 128 129**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 130 131**系统能力：** SystemCapability.ArkUI.ArkUI.Full 132 133| 名称 | 类型 | 只读 | 可选 | 说明 | 134| --------- | --------------------- | ---- | ---- | ------------------------ | 135| position | number | 否 | 否 | 字形相对于组件内容的索引，整数。 | 136| affinity | [Affinity](#affinity12) | 否 | 否 | 位置亲和度。 | 137 138## TextMenuItemId<sup>12+</sup> 139 140自定义菜单项的Id值。用于识别菜单选项，内置菜单项Id值见下列属性表格。 141 142**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 143 144**系统能力：** SystemCapability.ArkUI.ArkUI.Full 145 146### 属性 147 148**系统能力：** SystemCapability.ArkUI.ArkUI.Full 149 150| 名称 | 类型 | 只读 | 可选 | 说明 | 151| ------------ |---------------------| ---- | ---- | ------ | 152| CUT | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 默认裁剪。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 153| COPY | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 默认复制。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 154| PASTE | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 默认粘贴。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 155| SELECT_ALL | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 默认全选。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 156| COLLABORATION_SERVICE | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 互通服务。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 157| CAMERA_INPUT | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 拍摄输入。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 158| AI_WRITER<sup>13+</sup> | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 可对选中的文本进行润色、摘要提取、排版等。该菜单项依赖大模型能力，否则不生效。<br/>**原子化服务API：** 从API version 13开始，该接口支持在原子化服务中使用。 | 159| TRANSLATE<sup>15+</sup> | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 对选中的文本提供翻译服务。<br/>**原子化服务API：** 从API version 15开始，该接口支持在原子化服务中使用。 | 160| SHARE<sup>18+</sup> | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 对选中的文本提供分享服务，拉起分享窗口分享选中文本内容。<br/>**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 | 161| SEARCH<sup>18+</sup> | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 对选中的文本提供搜索服务，拉起浏览器搜索选中文本内容。<br/>**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。 | 162| url<sup>20+</sup> | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 对选中的URL提供跳转服务，拉起浏览器搜索或者应用页面。<br/>**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 | 163| email<sup>20+</sup> | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 对选中的邮箱地址提供跳转服务，拉起邮箱应用。<br/>**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 | 164| phoneNumber<sup>20+</sup> | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 对选中的电话号码跳转服务，拉起电话拨号页面。<br/>**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 | 165| address<sup>20+</sup> | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 对选中的地址提供跳转服务，拉起地图应用。<br/>**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 | 166| dateTime<sup>20+</sup> | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 对选中的日期和时间提供跳转服务，拉起新建日程页面。<br/>**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 | 167| askAI<sup>20+</sup> | [TextMenuItemId](#textmenuitemid12) | 是 | 否 | 对选中的文本提供AI问询能力。<br/>**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 | 168### of 169 170static of(id: ResourceStr): TextMenuItemId 171 172根据id创建TextMenuItemId。 173 174**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 175 176**系统能力：** SystemCapability.ArkUI.ArkUI.Full 177 178**参数：** 179 180| 参数名 | 类型 | 必填 | 说明 | 181| ------- | --------------------------------- | ---- | ------------------------------------------------------------ | 182| id | [ResourceStr](ts-types.md#resourcestr) | 是 | 菜单的id。 | 183 184**返回值：** 185 186| 类型 | 说明 | 187| ------- | --------------------------------- | 188| [TextMenuItemId](#textmenuitemid12) | TextMenuItemId的对象。 | 189 190### equals 191 192equals(id: TextMenuItemId): boolean 193 194判断TextMenuItemId是否相等。 195 196**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 197 198**系统能力：** SystemCapability.ArkUI.ArkUI.Full 199 200**参数：** 201 202| 参数名 | 类型 | 必填 | 说明 | 203| ------- | --------------------------------- | ---- | ------------------------------------------------------------ | 204| id | [TextMenuItemId](#textmenuitemid12) | 是 | TextMenuItemId的id。 | 205 206**返回值：** 207 208| 类型 | 说明 | 209| ------- | --------------------------------- | 210| boolean | 两个TextMenuItemId是否相等。<br/>true表示相等，false表示不相等。 | 211 212## TextMenuItem<sup>12+</sup>对象说明 213 214**系统能力：** SystemCapability.ArkUI.ArkUI.Full 215 216| 名称 | 类型 | 只读 | 可选 | 说明 | 217| ------- | --------------------------------- | ---- | ---- | --------------------------------- | 218| content | [ResourceStr](ts-types.md#resourcestr) | 否 | 否 | 菜单名称。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 219| icon | [ResourceStr](ts-types.md#resourcestr) | 否 | 是 | 菜单图标。<br/>不支持网络图片。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 220| id | [TextMenuItemId](#textmenuitemid12) | 否 | 否 | 菜单id。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 221| labelInfo<sup>15+</sup> | [ResourceStr](ts-types.md#resourcestr) | 否 | 是 | 快捷键提示。<br/>该字段仅2in1设备支持。<br/>**原子化服务API：** 从API version 15开始，该接口支持在原子化服务中使用。 | 222 223## EditMenuOptions 224 225**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 226 227**系统能力：** SystemCapability.ArkUI.ArkUI.Full 228 229### onCreateMenu<sup>12+</sup> 230 231onCreateMenu(menuItems: Array\<TextMenuItem>): Array\<TextMenuItem> 232 233在菜单创建时触发该回调，可在该回调中进行菜单数据设置。 234 235**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 236 237**系统能力：** SystemCapability.ArkUI.ArkUI.Full 238 239**参数：** 240 241| 参数名 | 类型 | 必填 | 说明 | 242| ------- | --------------------------------- | ---- | --------------------------------- | 243| menuItems | Array<[TextMenuItem](#textmenuitem12对象说明)> | 是 | 将要显示的菜单项。<br/>**说明：** <br/>对默认菜单项的名称、图标、快捷键提示修改不生效。 | 244 245**返回值：** 246 247| 类型 | 说明 | 248| ------- | --------------------------------- | 249| Array\<[TextMenuItem](#textmenuitem12对象说明)> | 处理后的菜单项。| 250 251### onMenuItemClick<sup>12+</sup> 252 253onMenuItemClick(menuItem: TextMenuItem, range: TextRange): boolean 254 255菜单项功能函数。 256 257**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 258 259**系统能力：** SystemCapability.ArkUI.ArkUI.Full 260 261**参数：** 262 263| 参数名 | 类型 | 必填 | 说明 | 264| ------- | --------------------------------- | ---- | --------------------------------- | 265| menuItem | [TextMenuItem](#textmenuitem12对象说明) | 是 | 菜单项。 | 266| range | [TextRange](#textrange12) | 是 | 选中的文本信息。 | 267 268**返回值：** 269 270| 类型 | 说明 | 271| ------- | --------------------------------- | 272| boolean | 菜单项的执行逻辑。<br/>返回为true，拦截系统默认逻辑，仅执行自定义逻辑。<br/>返回为false，先执行自定义逻辑，再执行系统逻辑。 | 273 274### onPrepareMenu<sup>20+</sup> 275 276onPrepareMenu?: OnPrepareMenuCallback 277 278当文本选择区域变化后显示菜单之前触发该回调，可在该回调中进行菜单数据设置。 279 280**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 281 282**系统能力：** SystemCapability.ArkUI.ArkUI.Full 283 284**返回值：** 285 286| 类型 | 说明 | 287| --------------------------------- | --------------------------------- | 288| [OnPrepareMenuCallback](#onpreparemenucallback20) | 当文本选择区域变化后显示菜单之前触发该回调，可在该回调中进行菜单数据设置。| 289 290## OnPrepareMenuCallback<sup>20+</sup> 291 292type OnPrepareMenuCallback = (menuItems: Array\<TextMenuItem\>) => Array\<TextMenuItem\> 293 294当文本选择区域变化后显示菜单之前触发该回调，可在该回调中进行菜单数据设置。 295 296**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 297 298**系统能力：** SystemCapability.ArkUI.ArkUI.Full 299 300**参数：** 301 302| 参数名 | 类型 | 必填 | 说明 | 303| ------- | --------------------------------- | ---- | --------------------------------- | 304| menuItems | Array<[TextMenuItem](#textmenuitem12对象说明)> | 是 | 将要显示的菜单项。<br/>**说明：** <br/>对默认菜单项的名称、图标、快捷键提示修改不生效。 | 305 306**返回值：** 307 308| 类型 | 说明 | 309| ------- | --------------------------------- | 310| Array\<[TextMenuItem](#textmenuitem12对象说明)> | 处理后的菜单项。| 311 312## TextRange<sup>12+</sup> 313 314文本范围。 315 316**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 317 318**系统能力：** SystemCapability.ArkUI.ArkUI.Full 319 320| 名称 | 类型 | 只读 | 可选 | 说明 | 321| -- | -- | -- | -- | -- | 322| start | number | 否 | 是 | 起始索引。 | 323| end | number | 否 | 是 | 结束索引。 | 324 325## EditableTextOnChangeCallback<sup>12+</sup> 326 327type EditableTextOnChangeCallback = (value: string, previewText?: PreviewText, options?: TextChangeOptions) => void 328 329输入内容发生变化时，触发该回调。 330 331**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 332 333**系统能力：** SystemCapability.ArkUI.ArkUI.Full 334 335**参数：** 336 337| 参数名 | 类型 | 必填 | 说明 | 338| -- | -- | -- | -- | 339| value | string | 是 | 文本框内正式上屏的文本内容。 | 340| previewText | [PreviewText](#previewtext12) | 否 | 预上屏文本信息，包含预上屏起始位置和文本内容。 | 341| options<sup>15+</sup> | [TextChangeOptions](#textchangeoptions15对象说明) | 否 | 文本内容变化信息，包含变化前后的选区范围、变化前的文本内容和预上屏文本信息。 | 342 343## TextDataDetectorType<sup>11+</sup>枚举说明 344 345**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 346 347**系统能力：** SystemCapability.ArkUI.ArkUI.Full 348 349| 名称 | 值 | 说明 | 350| ----- | ----- | --------------------------------- | 351| PHONE_NUMBER | 0 | 电话号码 | 352| URL | 1 | 链接 | 353| EMAIL | 2 | 邮箱 | 354| ADDRESS | 3 | 地址 | 355| DATE_TIME<sup>12+</sup> | 4 | 时间 | 356 357## TextDeleteDirection<sup>12+</sup>枚举说明 358 359定义删除文本方向。 360 361**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 362 363**系统能力：** SystemCapability.ArkUI.ArkUI.Full 364 365| 名称 | 值 | 说明 | 366| ------- | ---- | ---------------------------------- | 367| BACKWARD | 0 | 向后删除。 | 368| FORWARD | 1 | 向前删除。 | 369 370## SuperscriptStyle<sup>20+</sup>枚举说明 371 372定义文本上下角标样式。 373 374**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 375 376**系统能力：** SystemCapability.ArkUI.ArkUI.Full 377 378| 名称 | 值 | 说明 | 379| ------- | ---- | ---------------------------------- | 380| NORMAL | 0 | 普通文本样式。 | 381| SUPERSCRIPT | 1 | 上标文本样式。 | 382| SUBSCRIPT | 2 | 下标文本样式。 | 383 384## MenuType<sup>13+</sup>枚举说明 385 386菜单类型。 387 388**原子化服务API：** 从API version 13开始，该接口支持在原子化服务中使用。 389 390**系统能力：** SystemCapability.ArkUI.ArkUI.Full 391 392| 名称 | 值 | 说明 | 393| ------- | ---- | ------------------- | 394| SELECTION_MENU | 0 | 文本选择菜单。| 395| PREVIEW_MENU | 1 | 图片预览菜单。| 396 397## KeyboardAppearance<sup>15+</sup>枚举说明 398 399键盘外观。 400 401**原子化服务API：** 从API version 15开始，该接口支持在原子化服务中使用。 402 403**系统能力：** SystemCapability.ArkUI.ArkUI.Full 404 405| 名称 | 值 | 说明 | 406| ------- | ---- | ------------------- | 407| NONE_IMMERSIVE | 0 | 默认外观模式，不采用沉浸式风格。| 408| IMMERSIVE | 1 | 沉浸式模式，跟随系统。| 409| LIGHT_IMMERSIVE | 2 | 浅色沉浸式风格。| 410| DARK_IMMERSIVE | 3 | 深色沉浸式风格。| 411 412## InsertValue<sup>12+</sup>对象说明 413 414**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 415 416**系统能力：** SystemCapability.ArkUI.ArkUI.Full 417 418| 名称 | 类型 | 只读 | 可选 | 说明 | 419| ------- | ----------------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | 420| insertOffset | number | 否 | 否 | 插入的值的位置信息。 | 421| insertValue | string | 否 | 否 | 插入的值。 | 422 423## DeleteValue<sup>12+</sup>对象说明 424 425**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 426 427**系统能力：** SystemCapability.ArkUI.ArkUI.Full 428 429| 名称 | 类型 | 只读 | 可选 | 说明 | 430| ------- | ----------------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | 431| deleteOffset | number | 否 | 否 | 删除的值的位置信息。 | 432| direction | [TextDeleteDirection](#textdeletedirection12枚举说明) | 否 | 否 | 删除值的方向。 | 433| deleteValue | string | 否 | 否 | 删除的值。 | 434 435## TextDataDetectorConfig<sup>11+</sup>对象说明 436 437该配置只支持[Text](ts-basic-components-text.md)组件和[RichEditor](ts-basic-components-richeditor.md)组件。 438 439**系统能力：** SystemCapability.ArkUI.ArkUI.Full 440 441| 名称 | 类型 | 只读 | 可选 | 说明 | 442| ------ | -------- | ---- | ---- | ------------------------------------------- | 443| types | [TextDataDetectorType](ts-text-common.md#textdatadetectortype11枚举说明)[] | 否 | 否 | 设置文本识别的实体类型。设置types为null或者[]时，识别所有类型的实体，否则只识别指定类型的实体。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 444| onDetectResultUpdate | Callback\<string> | 否 | 是 | 文本识别成功后，触发onDetectResultUpdate回调。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 445| color<sup>12+</sup> | [ResourceColor](ts-types.md#resourcecolor) | 否 | 是 | 设置文本识别成功后的实体颜色。<br/>默认值：'#ff0a59f7'<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 446| decoration<sup>12+</sup> | [DecorationStyleInterface](ts-universal-styled-string.md#decorationstyleinterface)| 否 | 是 | 设置文本识别成功后的实体装饰线样式。<br/>默认值：<br/>{<br/> type: TextDecorationType.Underline,<br/> color: 与实体颜色一致,<br/> style: TextDecorationStyle.SOLID <br/>}<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 447| enablePreviewMenu<sup>20+</sup> | boolean | 否 | 是 | 设置是否开启文本识别长按显示预览菜单。true表示开启，false表示未开启。<br/>默认值：false<br/>当[copyOptions](ts-basic-components-richeditor.md#copyoptions)设置为None时，若enablePreviewMenu设置为true，长按AI实体也不能显示预览菜单。<br/>**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 | 448 449## PreviewText<sup>12+</sup> 450 451预上屏信息。 452 453**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 454 455**系统能力：** SystemCapability.ArkUI.ArkUI.Full 456 457| 名称 | 类型 | 只读 | 可选 | 说明 | 458| -------- | ------------------------------------------------ | ---- | ---- | -------------------------------------------------------- | 459| offset | number | 否 | 否 | 预上屏内容的起始位置。 | 460| value | string | 否 | 否 | 预上屏的内容。 | 461 462## FontSettingOptions<sup>12+</sup>对象说明 463 464字体配置项，比如通过设置应用内组件的字体粗细，进行可变字重调节。 465 466**卡片能力：** 从API version 12开始，该接口支持在ArkTS卡片中使用。 467 468**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 469 470**系统能力：** SystemCapability.ArkUI.ArkUI.Full 471 472| 名称 | 类型 | 只读 | 可选 | 说明 | 473| -------- | ------------------------------------------------ | ---- | ---- | -------------------------------------------------------- | 474| enableVariableFontWeight | boolean | 否 | 是 | 是否支持可变字重调节。<br/>默认值：false<br/>值为true，表示支持字重调节，值为false，表示不支持字重调节。 | 475 476## OnDidChangeCallback<sup>12+</sup> 477 478type OnDidChangeCallback = (rangeBefore: TextRange, rangeAfter: TextRange) => void 479 480文本变换后回调。 481 482**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 483 484**系统能力：** SystemCapability.ArkUI.ArkUI.Full 485 486**参数：** 487 488| 参数名 | 类型 | 必填 | 说明 | 489| -- | -- | -- | -- | 490| rangeBefore | [TextRange](#textrange12) | 是 | 文本变化前将要被替换的文本范围。 | 491| rangeAfter | [TextRange](#textrange12) | 是 | 文本变化后新增内容的文本范围。 | 492 493## StyledStringChangedListener<sup>12+</sup> 494 495属性字符串的文本内容变化监听器。 496 497**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 498 499**系统能力：** SystemCapability.ArkUI.ArkUI.Full 500 501| 名称 | 类型 | 只读 | 可选 | 说明 | 502| -- | -- | -- | -- | -- | 503| onWillChange | Callback<[StyledStringChangeValue](#styledstringchangevalue12), boolean> | 否 | 是 | 文本内容将要变化回调函数。 | 504| onDidChange | [OnDidChangeCallback](#ondidchangecallback12) | 否 | 是 | 文本内容完成变化回调函数。 | 505 506## StyledStringChangeValue<sup>12+</sup> 507 508属性字符串的文本变化信息。 509 510**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 511 512**系统能力：** SystemCapability.ArkUI.ArkUI.Full 513 514| 名称 | 类型 | 只读 | 可选 | 说明 | 515| -- | -- | -- | -- | -- | 516| range | [TextRange](#textrange12) | 否 | 否 | 即将被替换的属性字符串子串在原字符串中的范围。 | 517| replacementString | [StyledString](ts-universal-styled-string.md#styledstring) | 否 | 否 | 用于替换的属性字符串。 | 518| previewText | [StyledString](ts-universal-styled-string.md#styledstring) | 否 | 是 | 预览样式字符串。 | 519 520## AutoCapitalizationMode<sup>20+</sup>枚举说明 521 522自动大小写模式类型，只提供接口能力，具体实现以输入法应用为主。 523 524**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 525 526**系统能力：** SystemCapability.ArkUI.ArkUI.Full 527 528| 名称 | 值 | 说明 | 529| ------- | ---- | ------------------- | 530| NONE | 0 | 默认状态无效。| 531| WORDS | 1 | 按单词自动大小写。| 532| SENTENCES | 2 | 按句子自动大小写。| 533| ALL_CHARACTERS | 3 | 按全字符自动大小写。| 534 535## TextBaseController<sup>12+</sup> 536 537文本选择控制器。 538 539**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 540 541**系统能力：** SystemCapability.ArkUI.ArkUI.Full 542 543### setSelection<sup>12+</sup> 544 545setSelection(selectionStart: number, selectionEnd: number, options?: SelectionOptions): void 546 547支持设置组件内的内容选中，选中部分背板高亮。 548 549selectionStart和selectionEnd均为-1时表示全选。 550 551未获焦时调用该接口不产生选中效果。 552 553从API version 12开始，在2in1设备中，无论options取何值，调用setSelection接口都不会弹出菜单，此外，如果组件中已经存在菜单，调用setSelection接口会关闭菜单。 554 555在非2in1设备中，options取值为MenuPolicy.DEFAULT时，遵循以下规则： 556 5571. 组件内有手柄菜单时，接口调用后不关闭菜单，并且调整菜单位置。 558 5592. 组件内有不带手柄的菜单时，接口调用后不关闭菜单，并且菜单位置不变。 560 5613. 组件内无菜单时，接口调用后也无菜单显示。 562 563**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 564 565**系统能力：** SystemCapability.ArkUI.ArkUI.Full 566 567**参数：** 568 569| 参数名 | 类型 | 必填 | 说明 | 570| -------------- | ------ | ---- | ------- | 571| selectionStart | number | 是 | 选中开始位置。<br/>取值小于0时，按0处理。 | 572| selectionEnd | number | 是 | 选中结束位置。<br/>取值大于文本长度时，按当前文本长度处理。 | 573| options | [SelectionOptions](ts-universal-attributes-text-style.md#selectionoptions12对象说明) | 否 | 选择项配置。 | 574 575### closeSelectionMenu<sup>12+</sup> 576 577closeSelectionMenu(): void 578 579关闭自定义选择菜单或系统默认选择菜单。 580 581**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 582 583**系统能力：** SystemCapability.ArkUI.ArkUI.Full 584 585### getLayoutManager<sup>12+</sup> 586 587getLayoutManager(): LayoutManager 588 589获取布局管理器对象。 590 591**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 592 593**系统能力：** SystemCapability.ArkUI.ArkUI.Full 594 595**返回值：** 596 597| 类型 | 说明 | 598| ---------------------------------------- | ------- | 599| [LayoutManager](ts-text-common.md#layoutmanager12) | 布局管理器对象。 | 600 601## TextEditControllerEx<sup>12+</sup> 602 603文本扩展编辑控制器。 604 605继承自[TextBaseController](#textbasecontroller12)。 606 607**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 608 609**系统能力：** SystemCapability.ArkUI.ArkUI.Full 610 611### isEditing<sup>12+</sup> 612 613isEditing(): boolean 614 615获取当前富文本的编辑状态。 616 617**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 618 619**系统能力：** SystemCapability.ArkUI.ArkUI.Full 620 621**返回值：** 622 623| 类型 | 说明 | 624| ------- | ----------------------------- | 625| boolean | true为编辑态，false为非编辑态。 | 626 627### stopEditing<sup>12+</sup> 628 629stopEditing(): void 630 631退出编辑态。 632 633**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 634 635**系统能力：** SystemCapability.ArkUI.ArkUI.Full 636 637### getCaretOffset<sup>12+</sup> 638 639getCaretOffset(): number 640 641返回当前光标所在位置。 642 643**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 644 645**系统能力：** SystemCapability.ArkUI.ArkUI.Full 646 647**返回值：** 648 649| 类型 | 说明 | 650| ------ | --------- | 651| number | 当前光标所在位置。 | 652 653### setCaretOffset<sup>12+</sup> 654 655setCaretOffset(offset: number): boolean 656 657设置光标位置。 658 659**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 660 661**系统能力：** SystemCapability.ArkUI.ArkUI.Full 662 663**参数：** 664 665| 参数名 | 类型 | 必填 | 说明 | 666| ------ | ------ | ---- | -------------------- | 667| offset | number | 是 | 光标偏移位置。超出所有内容范围时，设置失败。 | 668 669**返回值：** 670 671| 类型 | 说明 | 672| ------- | --------- | 673| boolean | 光标是否设置成功。<br/>true表示光标设置成功，false表示设置失败。 | 674 675### getPreviewText<sup>12+</sup> 676 677getPreviewText?(): PreviewText 678 679获取预上屏信息。 680 681**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 682 683**系统能力：** SystemCapability.ArkUI.ArkUI.Full 684 685**返回值：** 686 687| 类型 | 说明 | 688| ---------------------------------------- | ------- | 689| [PreviewText](#previewtext12) | 预上屏信息。 |. 690 691## StyledStringController<sup>12+</sup> 692 693定义StyledString控制器。 694 695**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 696 697**系统能力：** SystemCapability.ArkUI.ArkUI.Full 698 699### setStyledString<sup>12+</sup> 700 701setStyledString(styledString: StyledString): void 702 703设置富文本组件显示的属性字符串。 704 705**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 706 707**系统能力：** SystemCapability.ArkUI.ArkUI.Full 708 709**参数：** 710 711| 参数名 | 类型 | 必填 | 说明 | 712| ----- | ------ | ---- | ------------------- | 713| styledString | [StyledString](ts-universal-styled-string.md#styledstring) | 是 | 属性字符串。<br/>**说明：** <br/>StyledString的子类[MutableStyledString](ts-universal-styled-string.md#mutablestyledstring)也可以作为入参值。 | 714 715### getStyledString<sup>12+</sup> 716 717getStyledString(): MutableStyledString 718 719获取富文本组件显示的属性字符串。 720 721**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 722 723**系统能力：** SystemCapability.ArkUI.ArkUI.Full 724 725**返回值：** 726 727| 类型 | 说明 | 728| ------- | ----------------------------- | 729| [MutableStyledString](ts-universal-styled-string.md#mutablestyledstring) | 富文本组件显示的属性字符串。 | 730 731## DecorationStyleResult<sup>12+</sup> 732 733后端返回的文本装饰线样式信息。 734 735**系统能力：** SystemCapability.ArkUI.ArkUI.Full 736 737| 名称 | 类型 | 只读 | 可选 | 说明 | 738| ------- | --------------------------------- | ---- | ---- | --------------------------------- | 739| type | [TextDecorationType](ts-appendix-enums.md#textdecorationtype) | 否 | 否 | 装饰线类型。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 740| color | [ResourceColor](ts-types.md#resourcecolor) | 否 | 否 | 装饰线颜色。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 741| style | [TextDecorationStyle](ts-appendix-enums.md#textdecorationstyle12) | 否 | 是 | 装饰线样式。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 742| thicknessScale<sup>20+</sup> | number | 否 | 是 | 装饰线粗细缩放比例。<br/>默认值：1.0<br/>取值范围：[0, +∞) <br/>**说明：** 负值按默认值处理。<br/> **原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 | 743 744## LineMetrics<sup>12+</sup> 745 746type LineMetrics = LineMetrics 747 748用于描述文本布局中单行文字的度量信息。 749 750**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 751 752**系统能力：** SystemCapability.ArkUI.ArkUI.Full 753 754| 类型 | 说明 | 755| --------------------------------- | --------------------------------- | 756| [LineMetrics](../../apis-arkgraphics2d/js-apis-graphics-text.md#linemetrics) | 用于描述文本布局中单行文字的度量信息。 | 757 758## Affinity<sup>12+</sup> 759 760type Affinity = Affinity 761 762位置亲和度枚举。 763 764**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 765 766**系统能力：** SystemCapability.ArkUI.ArkUI.Full 767 768| 类型 | 说明 | 769| --------------------------------- | --------------------------------- | 770| [Affinity](../../apis-arkgraphics2d/js-apis-graphics-text.md#affinity) | 位置亲和度枚举。 | 771 772## TextBox<sup>14+</sup> 773 774type TextBox = TextBox 775 776文本矩形区域。 777 778**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。 779 780**系统能力：** SystemCapability.ArkUI.ArkUI.Full 781 782| 类型 | 说明 | 783| --------------------------------- | --------------------------------- | 784| [TextBox](../../apis-arkgraphics2d/js-apis-graphics-text.md#textbox) | 文本矩形区域。 | 785 786## Paragraph<sup>20+</sup> 787 788type Paragraph = Paragraph 789 790保存文本内容及样式的载体，支持排版与绘制操作。 791 792**系统能力：** SystemCapability.ArkUI.ArkUI.Full 793 794| 类型 | 说明 | 795| --------------------------------- | --------------------------------- | 796| [Paragraph](../../apis-arkgraphics2d/js-apis-graphics-text.md#paragraph) | 保存文本内容及样式的载体，支持排版与绘制操作。 | 797 798## RectHeightStyle<sup>14+</sup> 799 800type RectHeightStyle = RectHeightStyle 801 802矩形区域高度规格枚举。 803 804**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。 805 806**系统能力：** SystemCapability.ArkUI.ArkUI.Full 807 808| 类型 | 说明 | 809| --------------------------------- | --------------------------------- | 810| [RectHeightStyle](../../apis-arkgraphics2d/js-apis-graphics-text.md#rectheightstyle) | 矩形区域高度规格枚举。 | 811 812## RectWidthStyle<sup>14+</sup> 813 814type RectWidthStyle = RectWidthStyle 815 816矩形区域宽度规格枚举。 817 818**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。 819 820**系统能力：** SystemCapability.ArkUI.ArkUI.Full 821 822| 类型 | 说明 | 823| --------------------------------- | --------------------------------- | 824| [RectWidthStyle](../../apis-arkgraphics2d/js-apis-graphics-text.md#rectwidthstyle) | 矩形区域宽度规格枚举。 | 825 826## TextChangeOptions<sup>15+</sup>对象说明 827 828变化前的文本信息，以及变化后的选区范围。 829 830**原子化服务API：** 从API version 15开始，该接口支持在原子化服务中使用。 831 832**系统能力：** SystemCapability.ArkUI.ArkUI.Full 833 834| 名称 | 类型 | 只读 | 可选 | 说明 | 835| ------- | ----------------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | 836| rangeBefore | [TextRange](#textrange12) | 否 | 否 | 变化前的选区范围。 | 837| rangeAfter | [TextRange](#textrange12) | 否 | 否 | 变化后的选区范围。 | 838| oldContent | string | 否 | 否 | 变化前的文本内容。 | 839| oldPreviewText | [PreviewText](#previewtext12) | 否 | 否 | 变化前的预上屏信息。 | 840 841## EditableTextChangeValue<sup>15+</sup> 842 843文本变化的详细信息，包括预上屏。 844 845**原子化服务API：** 从API version 15开始，该接口支持在原子化服务中使用。 846 847**系统能力：** SystemCapability.ArkUI.ArkUI.Full 848 849| 名称 | 类型 | 只读 | 可选 | 说明 | 850| ------- | ----------------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | 851| content | string | 否 | 否 | 当前的文本内容。 | 852| previewText | [PreviewText](#previewtext12) | 否 | 是 | 预上屏的内容信息。 | 853| options | [TextChangeOptions](#textchangeoptions15对象说明) | 否 | 是 | 变化的文本内容信息。 | 854 855## TextMenuShowMode<sup>16+</sup> 856 857菜单的显示模式。 858 859**原子化服务API：** 从API version 16开始，该接口支持在原子化服务中使用。 860 861**系统能力：** SystemCapability.ArkUI.ArkUI.Full 862 863| 名称 | 值 | 说明 | 864| ------- | ---- | ------------------- | 865| DEFAULT | 0 | 显示在当前窗口中。<br/>| 866| PREFER_WINDOW | 1 | 优先显示在独立窗口中，若不支持独立窗口，则显示在当前窗口中。<br/>**说明：** <br/>除应用主窗口、应用子窗口、系统模态窗口及系统桌面类型的窗口外，其他类型的窗口不支持将文本选择菜单显示在独立窗口中。<br/>在预览器中不支持将文本选择菜单显示在独立窗口中。<br/>在UIExtension中不支持将文本选择菜单显示在独立窗口中。<br/>当文本类组件已经显示在子窗类型的Popup、Dialog、Toast、Menu中时，不支持将其对应的文本选择菜单显示在独立窗口中。<br/>当TextInput、TextArea可支持拉起AutoFill时，不支持将其对应的文本选择菜单显示在独立窗口中。<br/>| 867 868## TextMenuOptions<sup>16+</sup>对象说明 869 870菜单选项。 871 872**原子化服务API：** 从API version 16开始，该接口支持在原子化服务中使用。 873 874**系统能力：** SystemCapability.ArkUI.ArkUI.Full 875 876| 名称 | 类型 | 只读 | 可选 | 说明 | 877| ------- | ----------------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | 878| showMode | [TextMenuShowMode](#textmenushowmode16) | 否 | 是 | 菜单的显示模式。<br/>默认值：TextMenuShowMode.DEFAULT | 879 880## ShaderStyle<sup>20+</sup> 881 882文本着色器效果基类。 883 884**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 885 886**系统能力：** SystemCapability.ArkUI.ArkUI.Full 887 888## LinearGradientStyle<sup>20+</sup> 889 890显示为线性渐变。LinearGradientStyle继承自[ShaderStyle](#shaderstyle20)。 891 892**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 893 894**系统能力：** SystemCapability.ArkUI.ArkUI.Full 895 896### 属性 897 898**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 899 900**系统能力：** SystemCapability.ArkUI.ArkUI.Full 901 902| 名称 | 类型 | 只读 | 可选 | 说明 | 903| ------- | ------ | ---- | ----- | ----- | 904| options | [LinearGradientOptions](../arkui-ts/ts-universal-attributes-gradient-color.md#lineargradientoptions18对象说明) | 否 | 否 | 显示为线性渐变效果。 | 905 906### constructor<sup>20+</sup> 907 908constructor(options: LinearGradientOptions) 909 910用于创建LinearGradientStyle对象的构造函数。 911 912**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 913 914**系统能力：** SystemCapability.ArkUI.ArkUI.Full 915 916**参数：** 917 918| 参数名 | 类型 | 必填 | 说明 | 919| ------- | ------ | ---- | ----- | 920| options | [LinearGradientOptions](../arkui-ts/ts-universal-attributes-gradient-color.md#lineargradientoptions18对象说明) | 是 | 显示为线性渐变效果。 | 921 922## RadialGradientStyle<sup>20+</sup> 923 924显示为径向渐变。RadialGradientStyle继承自[ShaderStyle](#shaderstyle20)。 925 926**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 927 928**系统能力：** SystemCapability.ArkUI.ArkUI.Full 929 930### 属性 931 932**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 933 934**系统能力：** SystemCapability.ArkUI.ArkUI.Full 935 936| 名称 | 类型 | 只读 | 可选 | 说明 | 937| ------- | ----------------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | 938| options | [RadialGradientOptions](../arkui-ts/ts-universal-attributes-gradient-color.md#radialgradientoptions18对象说明) | 否 | 否 | 显示为径向渐变效果。 | 939 940### constructor<sup>20+</sup> 941 942constructor(options: RadialGradientOptions) 943 944用于创建RadialGradientOptions对象的构造函数。 945 946**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 947 948**系统能力：** SystemCapability.ArkUI.ArkUI.Full 949 950**参数：** 951 952| 参数名 | 类型 | 必填 | 说明 | 953| ------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ | 954| options | [RadialGradientOptions](../arkui-ts/ts-universal-attributes-gradient-color.md#radialgradientoptions18对象说明) | 是 | 显示为径向渐变效果。 | 955 956## ColorShaderStyle<sup>20+</sup> 957 958显示为纯色。ColorShaderStyle继承自[ShaderStyle](#shaderstyle20)。 959 960**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 961 962**系统能力：** SystemCapability.ArkUI.ArkUI.Full 963 964### 属性 965 966**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 967 968**系统能力：** SystemCapability.ArkUI.ArkUI.Full 969 970| 名称 | 类型 | 只读 | 可选 | 说明 | 971| ------- | ----------------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | 972| color | [ResourceColor](ts-types.md#resourcecolor) | 否 | 否 | 显示为纯色效果。 | 973 974### constructor<sup>20+</sup> 975 976constructor(color: ResourceColor) 977 978用于创建ResourceColor对象的构造函数。 979 980**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 981 982**系统能力：** SystemCapability.ArkUI.ArkUI.Full 983 984**参数：** 985 986| 参数名 | 类型 | 必填 | 说明 | 987| ------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ | 988| color | [ResourceColor](ts-types.md#resourcecolor) | 是 | 显示为纯色效果。 | 989 990## IMEClient<sup>20+</sup>对象说明 991 992输入控件绑定输入法客户端类型。 993 994**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 995 996**系统能力：** SystemCapability.ArkUI.ArkUI.Full 997 998| 名称 | 类型 | 只读 | 可选 | 说明 | 999| ------- | ----------------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | 1000| nodeId | number | 否 | 否 | 当前输入控件的组件UniqueId。取值范围大于等于0。 | 1001 1002## TextChangeReason<sup>20+</sup> 1003 1004组件内容变化原因。 1005 1006**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 1007 1008**系统能力：** SystemCapability.ArkUI.ArkUI.Full 1009 1010| 名称 | 值 | 说明 | 1011| ------- | ---- | ------------------- | 1012| UNKNOWN | 0 | 未知原因。 | 1013| INPUT | 1 | 用户输入。 | 1014| PASTE | 2 | 粘贴。 | 1015| CUT | 3 | 剪切。 | 1016| DRAG | 4 | 拖拽。 | 1017| AUTO_FILL | 5 | 自动填充。 | 1018| AI_WRITE | 6 | 小艺帮写。 | 1019| REDO | 7 | 重做。 | 1020| UNDO | 8 | 撤销。 | 1021| CONTROLLER | 9 | 开发者API调用。 | 1022| ACCESSIBILITY | 10 | 无障碍接口。 | 1023| COLLABORATION | 11 | 跨端拍照。 | 1024| STYLUS | 12 | 手写笔。 | 1025 1026## MaxLinesOptions<sup>20+</sup>对象说明 1027 1028配置TextArea组件，文本超长时的显示效果。 1029 1030**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 1031 1032**系统能力：** SystemCapability.ArkUI.ArkUI.Full 1033 1034| 名称 | 类型 | 只读 | 可选 | 说明 | 1035| ------------------- | ------- | ------- | ------- | ------------------------------------------------------------ | 1036| overflowMode | [MaxLinesMode](#maxlinesmode20) | 否 | 是 | `overflowMode`可配置TextArea组件的非内联模式。当超出设置的`maxLines`最大行数时，会启用滚动效果。需同时配置[`textOverflow`](ts-basic-components-textarea.md#textoverflow12)，且仅当`textOverflow`为None或Clip时，`MaxLinesMode`才能生效。默认情况下，`MaxLinesMode`的值为Clip，超出`maxLines`后文本会被截断。 | 1037 1038## MaxLinesMode<sup>20+</sup> 1039 1040TextArea组件在文本超长时显示效果。默认值为CLIP，按最大行截断显示。 1041 1042**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 1043 1044**系统能力：** SystemCapability.ArkUI.ArkUI.Full 1045 1046| 名称 | 值 | 说明 | 1047| --------------------- | ------- | ------------------- | 1048| CLIP | 0 | 文本超长时按最大行截断显示。 | 1049| SCROLL | 1 | 文本超长时可滚动显示。 | 1050 1051## LineSpacingOptions<sup>20+</sup>对象说明 1052 1053设置文本的行间距，是否仅在行与行之间生效。 1054 1055**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 1056 1057**系统能力：** SystemCapability.ArkUI.ArkUI.Full 1058 1059**参数：** 1060 1061| 名称 | 类型 | 只读 | 可选 | 说明 | 1062| ------ | ------------------------------------------------------------ | ---- | ---- | ---------------- | 1063| onlyBetweenLines | boolean | 否 | 是 | 文本的行间距是否仅在行与行之间生效。<br/>当设置为true时，行间距仅适用于行与行之间，首行上方和尾行下方无额外的行间距。当设置为false时，首行上方和尾行下方均会存在行间距。<br/>默认值：false | 1064 1065## TextVerticalAlign<sup>20+</sup> 1066 1067文本垂直对齐的方式。默认值BASELINE，沿基线对齐。 1068 1069**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 1070 1071**系统能力：** SystemCapability.ArkUI.ArkUI.Full 1072 1073| 名称 | 值 | 说明 | 1074| --------------------- | -------------------| ------------------- | 1075| BASELINE | 0 | 对齐文本基线。 | 1076| BOTTOM | 1 | 对齐文本底部。 | 1077| CENTER | 2 | 垂直居中对齐。 | 1078| TOP | 3 | 对齐文本顶部。 | 1079 1080## ContentTransition<sup>20+</sup> 1081 1082文本动效基类。 1083 1084**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 1085 1086**系统能力：** SystemCapability.ArkUI.ArkUI.Full 1087 1088## NumericTextTransition<sup>20+</sup> 1089 1090数字翻牌动效。仅限正整数，不支持小数和负数。不支持渐变色和Text跑马灯模式。不支持选中，[copyOption](../arkui-ts/ts-basic-components-text.md#copyoption9)属性无效。当文本存在子组件时或通过属性字符串设置时，数字翻牌失效。 1091 1092NumericTextTransition继承自[ContentTransition](#contenttransition20)。 1093 1094**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 1095 1096**系统能力：** SystemCapability.ArkUI.ArkUI.Full 1097 1098### 属性 1099 1100**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 1101 1102**系统能力：** SystemCapability.ArkUI.ArkUI.Full 1103 1104| 名称 | 类型 | 只读 | 可选 | 说明 | 1105| ------------------------------------------ | ---------------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | 1106| flipDirection | [FlipDirection](#flipdirection20) | 否 | 是 | 翻牌方向。<br>默认值：FlipDirection.DOWN | 1107| enableBlur | boolean | 否 | 是 | 是否开启翻牌模糊效果。<br>默认值：false<br>true：开启翻牌模糊效果。<br>false：不开启翻牌模糊效果。| 1108 1109### constructor<sup>20+</sup> 1110 1111constructor(options?: NumericTextTransitionOptions) 1112 1113用于创建NumericTextTransition对象的构造函数。 1114 1115**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 1116 1117**系统能力：** SystemCapability.ArkUI.ArkUI.Full 1118 1119**参数：** 1120 1121| 参数名 | 类型 | 必填 | 说明 | 1122| ------- | ------ | ---- | ----- | 1123| options | [NumericTextTransitionOptions](#numerictexttransitionoptions20对象说明) | 否 | 设置数字翻牌动效。 | 1124 1125## NumericTextTransitionOptions<sup>20+</sup>对象说明 1126 1127数字翻牌的参数。 1128 1129**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 1130 1131**系统能力：** SystemCapability.ArkUI.ArkUI.Full 1132 1133| 名称 | 类型 | 只读 | 可选 | 说明 | 1134| ------------------------------------------ | ---------------------------------------------------------- | ---- | ---- | ------------------------------------------------------------ | 1135| flipDirection | [FlipDirection](#flipdirection20) | 否 | 是 | 翻牌方向。<br>默认值：FlipDirection.DOWN | 1136| enableBlur | boolean | 否 | 是 | 是否开启翻牌模糊效果。<br>默认值：false<br>true：开启翻牌模糊效果。<br>false：不开启翻牌模糊效果。| 1137 1138## FlipDirection<sup>20+</sup> 1139 1140翻牌方向。默认值为DOWN。 1141 1142**原子化服务API：** 从API version 20开始，该接口支持在原子化服务中使用。 1143 1144**系统能力：** SystemCapability.ArkUI.ArkUI.Full 1145 1146| 名称 | 值 | 说明 | 1147| --------------------- | ------- | ------------------- | 1148| DOWN | 0 | 内容往下翻。| 1149| UP | 1 | 内容往上翻。 | 1150 1151## TextLayoutOptions对象说明<sup>20+</sup> 1152 1153文本布局选项。 1154 1155**系统能力：** SystemCapability.ArkUI.ArkUI.Full 1156 1157| 名称 | 类型 | 只读 | 可选 | 说明 | 1158| -------- | -------- | -------- | -------- | -------- | 1159| constraintWidth | [LengthMetrics](../js-apis-arkui-graphics.md#lengthmetrics12) | 否 | 是 | 设置被计算文本布局宽度。若不设置则宽度为单行布局所占最大宽度值。 | 1160