• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Text Component Common APIs (System API)
2
3This topic covers the common APIs of text components.
4
5>  **NOTE**
6>
7>  The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
8>
9>  This topic describes only the system APIs provided by the module. For details about its public APIs, see [Basic Types](ts-types.md) and [Text Component Common APIs](ts-text-common.md).
10
11## TextContentControllerBase
12
13Represents the base controller for **TextInput**, **TextArea**, and **Search** components.
14
15**Atomic service API**: This API can be used in atomic services since API version 11.
16
17**System capability**: SystemCapability.ArkUI.ArkUI.Full
18
19### getText<sup>19+</sup>
20
21getText(range?: TextRange): string
22
23Obtains the text content within a specified range.
24
25**Atomic service API**: This API can be used in atomic services since API version 19.
26
27**System API**: This is a system API.
28
29**System capability**: SystemCapability.ArkUI.ArkUI.Full
30
31**Parameters**
32
33| Name | Type  | Mandatory  | Description |
34| ------- | ------ | ---- | ----- |
35| range | [TextRange](ts-text-common.md#textrange12) | No   | Range of the text content to obtain, defined by start and end positions.<br>If the range is not specified, the entire text is obtained by default. If the start position is not specified, it defaults to index 0. If the end position is not specified, it defaults to the end of the text.|
36
37**Return value**
38
39| Type   | Description              |
40| ------ | ---------------- |
41| string | Text content within the specified range.|
42
43## KeyboardGradientMode<sup>20+</sup>
44
45Enumerates keyboard gradient effects.
46
47**System API**: This is a system API.
48
49**System capability**: SystemCapability.ArkUI.ArkUI.Full
50
51| Name                                | Value| Description                                      |
52| ---------------------------------- | --- | ---------------------------------------- |
53| NONE | 0 | No gradient effect.|
54| LINEAR_GRADIENT | 1 | Linear gradient effect.|
55
56## KeyboardFluidLightMode<sup>20+</sup>
57
58Enumerates keyboard fluid lighting effects.
59
60**System API**: This is a system API.
61
62**System capability**: SystemCapability.ArkUI.ArkUI.Full
63
64| Name                                | Value| Description                                      |
65| ---------------------------------- | --- | ---------------------------------------- |
66| NONE | 0 | No fluid lighting effect.|
67| BACKGROUND_FLUID_LIGHT | 1 | Background fluid lighting effect enabled.|
68
69## KeyboardAppearanceConfig<sup>20+</sup>
70
71Describes the keyboard visual style configuration.
72
73**System API**: This is a system API.
74
75**System capability**: SystemCapability.ArkUI.ArkUI.Full
76
77| Name   | Type                                                   | Mandatory| Description                                                   |
78| ------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ |
79| gradientMode  | [KeyboardGradientMode](#keyboardgradientmode20) | No  | Keyboard gradient effect.<br>Default value: **KeyboardGradientMode.NONE**.|
80| fluidLightMode  | [KeyboardFluidLightMode](#keyboardfluidlightmode20) | No  | Keyboard fluid lighting effect.<br>Default value: **KeyboardFluidLightMode.NONE**.|
81