• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 文本组件公共接口 (系统接口)
2<!--Kit: ArkUI-->
3<!--Subsystem: ArkUI-->
4<!--Owner: @xiangyuan6-->
5<!--Designer: @pssea-->
6<!--Tester: @jiaoaozihao-->
7<!--Adviser: @HelloCrease-->
8
9文本类组件公共接口。
10
11>  **说明:**
12>
13>  本模块首批接口从API version 10开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
14>
15>  当前页面仅包含本模块的系统接口,其他公开接口参见[公共类型](ts-types.md)和[文本组件公共接口](ts-text-common.md)。
16
17## TextContentControllerBase
18
19TextInput、TextArea、Search的基础控制器。
20
21**原子化服务API:** 从API version 11开始,该接口支持在原子化服务中使用。
22
23**系统能力:** SystemCapability.ArkUI.ArkUI.Full
24
25### getText<sup>19+</sup>
26
27getText(range?: TextRange): string
28
29获取指定范围的文本内容。
30
31**原子化服务API:** 从API version 19开始,该接口支持在原子化服务中使用。
32
33**系统接口:** 此接口为系统接口。
34
35**系统能力:** SystemCapability.ArkUI.ArkUI.Full
36
37**参数:**
38
39| 参数名  | 类型   | 必填   | 说明  |
40| ------- | ------ | ---- | ----- |
41| range | [TextRange](ts-text-common.md#textrange12) | 否    | 获取文本的范围,包括需要获取文本的起始位置和终止位置。<br>未指定范围时,默认将获取全部文本。未指定获取文本的起始位置,则默认从下标0开始;未指定获取文本的终止位置,则默认以文本末尾作为结束点。 |
42
43**返回值:**
44
45| 类型    | 说明               |
46| ------ | ---------------- |
47| string | 指定范围的文本内容。 |
48
49## KeyboardGradientMode<sup>20+</sup>枚举说明
50
51键盘模糊效果。
52
53**系统接口:** 此接口为系统接口。
54
55**系统能力:** SystemCapability.ArkUI.ArkUI.Full
56
57| 名称                                 | 值 | 说明                                       |
58| ---------------------------------- | --- | ---------------------------------------- |
59| NONE | 0 | 键盘无模糊效果。 |
60| LINEAR_GRADIENT | 1 | 键盘设置线性渐变模糊效果。 |
61
62## KeyboardFluidLightMode<sup>20+</sup>枚举说明
63
64键盘流光效果。
65
66**系统接口:** 此接口为系统接口。
67
68**系统能力:** SystemCapability.ArkUI.ArkUI.Full
69
70| 名称                                 | 值 | 说明                                       |
71| ---------------------------------- | --- | ---------------------------------------- |
72| NONE | 0 | 键盘无流光效果。 |
73| BACKGROUND_FLUID_LIGHT | 1 | 键盘设置流光效果。 |
74
75## KeyboardAppearanceConfig<sup>20+</sup>
76
77键盘外观样式属性。
78
79**系统接口:** 此接口为系统接口。
80
81**系统能力:** SystemCapability.ArkUI.ArkUI.Full
82
83| 名称    | 类型                                                    | 必填 | 说明                                                    |
84| ------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ |
85| gradientMode  | [KeyboardGradientMode](#keyboardgradientmode20枚举说明) | 否   | 键盘的模糊效果。<br/>默认值:KeyboardGradientMode.NONE |
86| fluidLightMode  | [KeyboardFluidLightMode](#keyboardfluidlightmode20枚举说明) | 否   | 键盘的流光效果。<br/>默认值:KeyboardFluidLightMode.NONE |