Overview
Defines enumerations and APIs related to Text for configuring text styles, controlling marquee effects, implementing text entity recognition, and managing text controllers. It is applicable to scenarios such as customizing text display effects, implementing dynamic text interaction, recognizing special entities in text (such as addresses and phone numbers), and precisely controlling text font weight. With these configuration APIs, you can flexibly control the display effects and interaction behaviors of text components to improve user experience.
File to include: <arkui/node_attributes/text.h>
Library: libace_ndk.z.so
System capability: SystemCapability.ArkUI.ArkUI.Full
Since: 12
Related module: ArkUI_NativeModule
Sample: native_type_sample
[h2]Structs
| Name | typedef Keyword | Description |
|---|---|---|
| OH_ArkUI_TextDataDetectorConfig | OH_ArkUI_TextDataDetectorConfig | Defines the configuration of text entity recognition. Text entities refer to special content entities such as addresses and phone numbers. |
| ArkUI_TextMarqueeOptions | ArkUI_TextMarqueeOptions | Defines text marquee options for configuring various display parameters for text marquee effects. This struct is suitable for scenarios where long text content needs to be cyclically displayed in limited space, such as message scrolling in notification bars and title scrolling for display, effectively solving the display issue when text exceeds the display area. |
| OH_ArkUI_FontWeightConfigs | OH_ArkUI_FontWeightConfigs | Defines the font weight configurations of text, which is suitable for scenarios that require precise control over text font weight or where the text font weight needs to follow device font setting changes. You can create a text font weight configuration object through OH_ArkUI_FontWeightConfigs_Create, and must call OH_ArkUI_FontWeightConfigs_Destroy to destroy the object and release resources after use to avoid memory leaks. After the configuration object is created, you can set and query the information through the following APIs: use OH_ArkUI_FontWeightConfigs_SetEnableVariableFontWeight to set whether to enable variable font weight adjustment, use OH_ArkUI_FontWeightConfigs_GetEnableVariableFontWeight to check whether variable font weight adjustment is enabled, use OH_ArkUI_FontWeightConfigs_SetEnableDeviceFontWeightCategory to set whether the text font weight is updated with the font weight level of the device, and use OH_ArkUI_FontWeightConfigs_GetEnableDeviceFontWeightCategory to check whether the text font weight is updated with the font weight level of the device. When this configuration object is used and is not a null pointer, if the user does not explicitly make the configuration through the APIs, each configuration item uses its default value (variable font weight adjustment is disabled by default, and text font weight is updated with the font weight level of the device by default). When this configuration object is a null pointer, the default values are not used, and the text font weight behavior is the same as that of the parent component. |
| OH_ArkUI_FontConfigs | OH_ArkUI_FontConfigs | Defines the font configurations of text. Currently, this struct supports setting and getting font weight configuration through related APIs, which is suitable for scenarios that require custom font weight display effects. You can create a font configuration object through OH_ArkUI_FontConfigs_Create, and destroy the font configuration object through OH_ArkUI_FontConfigs_Destroy. After the configuration object is created, you can set and query the information through the following APIs: use OH_ArkUI_FontConfigs_SetFontWeightConfigs to set the font weight, and use OH_ArkUI_FontConfigs_GetFontWeightConfigs to obtain the font weight. |
| OH_ArkUI_TextController | OH_ArkUI_TextController | Defines a text component controller, which is used to control and interact with the text component on the native side. The controller must first be bound to the text component through a node attribute before subsequent operations can be performed. One controller can only be bound to one text component. After binding, the controller manages the style and content of the corresponding text component. You can create a controller object through OH_ArkUI_TextController_Create, and must call OH_ArkUI_TextController_Destroy to destroy the object and release resources after use. The two APIs must be used in pairs; otherwise, memory leaks will occur. After creating the controller, you can bind it to the text component through a node attribute, and then use APIs such as OH_ArkUI_TextController_SetStyledString to set the styled string of the text component, enabling dynamic management and style control of text content. This struct is suitable for scenarios where the text component needs to be operated on the native layer. |
[h2]Enums
| Name | typedef Keyword | Description |
|---|---|---|
| ArkUI_FontStyle | ArkUI_FontStyle | Enumerates font styles. |
| ArkUI_FontWeight | ArkUI_FontWeight | Enumerates font weights. |
| ArkUI_TextHeightAdaptivePolicy | ArkUI_TextHeightAdaptivePolicy | Enumerates how the adaptive height is determined for the text. |
| ArkUI_TextDataDetectorType | ArkUI_TextDataDetectorType | Enumerates the entity types of text recognition. |
| ArkUI_MarqueeStartPolicy | ArkUI_MarqueeStartPolicy | Enumerates marquee startup policies. |
| ArkUI_MarqueeUpdatePolicy | ArkUI_MarqueeUpdatePolicy | Enumerates marquee update policies. |
[h2]Functions
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* OH_ArkUI_TextMarqueeOptions_Create() | Creates a text marquee option object. When the object is no longer in use, call OH_ArkUI_TextMarqueeOptions_Dispose to dispose of it and release resources to avoid memory leaks. |
| void OH_ArkUI_TextMarqueeOptions_Dispose(ArkUI_TextMarqueeOptions* option) | Disposes of the pointer to the text marquee option object. This API must be used in pair with OH_ArkUI_TextMarqueeOptions_Create; otherwise, memory leaks may occur. |
| void OH_ArkUI_TextMarqueeOptions_SetStart(ArkUI_TextMarqueeOptions* option, bool start) | Sets whether to play the text marquee option. |
| bool OH_ArkUI_TextMarqueeOptions_GetStart(ArkUI_TextMarqueeOptions* option) | Obtains whether the text marquee option is played. |
| void OH_ArkUI_TextMarqueeOptions_SetStep(ArkUI_TextMarqueeOptions* option, float step) | Sets the step of the text marquee option. |
| float OH_ArkUI_TextMarqueeOptions_GetStep(ArkUI_TextMarqueeOptions* option) | Obtains the step of the text marquee option. |
| void OH_ArkUI_TextMarqueeOptions_SetSpacing(ArkUI_TextMarqueeOptions* option, float spacing) | Sets the distance between the start and end items of the text marquee option. |
| float OH_ArkUI_TextMarqueeOptions_GetSpacing(ArkUI_TextMarqueeOptions* option) | Obtains the distance between the start and end items of the text marquee option. |
| void OH_ArkUI_TextMarqueeOptions_SetLoop(ArkUI_TextMarqueeOptions* option, int32_t loop) | Sets the number of repetitions for looping the text marquee option. The value less than or equal to 0 indicates infinite looping. |
| int32_t OH_ArkUI_TextMarqueeOptions_GetLoop(ArkUI_TextMarqueeOptions* option) | Obtains the number of repetitions for looping the text marquee option. |
| void OH_ArkUI_TextMarqueeOptions_SetFromStart(ArkUI_TextMarqueeOptions* option, bool fromStart) | Sets the direction for scrolling the text marquee option. |
| bool OH_ArkUI_TextMarqueeOptions_GetFromStart(ArkUI_TextMarqueeOptions* option) | Obtains the direction for scrolling the text marquee option. |
| void OH_ArkUI_TextMarqueeOptions_SetDelay(ArkUI_TextMarqueeOptions* option, int32_t delay) | Sets the delay of each loop for the text marquee option. |
| int32_t OH_ArkUI_TextMarqueeOptions_GetDelay(ArkUI_TextMarqueeOptions* option) | Obtains the delay of each loop for the text marquee option. |
| void OH_ArkUI_TextMarqueeOptions_SetFadeout(ArkUI_TextMarqueeOptions* option, bool fadeout) | Sets whether the text marquee option supports a fade-out effect when the text is too long. When this parameter is set to true: if the text content exceeds the display range, a fade-out effect is applied to the edges of the partially visible text; if text is partially visible at both ends, the fade-out effect is applied to both ends. When the fade-out effect is enabled, the NODE_CLIP attribute in ArkUI_NodeAttributeType is automatically locked to true and cannot be set to false. |
| bool OH_ArkUI_TextMarqueeOptions_GetFadeout(ArkUI_TextMarqueeOptions* option) | Obtains whether the text marquee option supports a fade-out effect when the text is too long. |
| void OH_ArkUI_TextMarqueeOptions_SetStartPolicy(ArkUI_TextMarqueeOptions* option, ArkUI_MarqueeStartPolicy startPolicy) | Sets the startup policy of the text marquee option. |
| ArkUI_MarqueeStartPolicy OH_ArkUI_TextMarqueeOptions_GetStartPolicy(ArkUI_TextMarqueeOptions* option) | Obtains the startup policy of the text marquee option. |
| void OH_ArkUI_TextMarqueeOptions_SetUpdatePolicy(ArkUI_TextMarqueeOptions* option, ArkUI_MarqueeUpdatePolicy updatePolicy) | Sets the update policy of the text marquee option. |
| ArkUI_MarqueeUpdatePolicy OH_ArkUI_TextMarqueeOptions_GetUpdatePolicy(ArkUI_TextMarqueeOptions* option) | Obtains the update policy of the text marquee option. |
| OH_ArkUI_TextDataDetectorConfig* OH_ArkUI_TextDataDetectorConfig_Create() | Creates a text entity recognition configuration object. When the object is no longer used, call OH_ArkUI_TextDataDetectorConfig_Destroy to destroy it and release resources to avoid memory leaks. |
| void OH_ArkUI_TextDataDetectorConfig_Destroy(OH_ArkUI_TextDataDetectorConfig* config) | Destroys the text entity recognition configuration object. This API must be used in pair with OH_ArkUI_TextDataDetectorConfig_Create; otherwise, memory leaks may occur. |
| OH_ArkUI_FontWeightConfigs* OH_ArkUI_FontWeightConfigs_Create() | Creates a text font weight configuration object. When the object is no longer used, call OH_ArkUI_FontWeightConfigs_Destroy to destroy it and release resources to avoid memory leaks. |
| void OH_ArkUI_FontWeightConfigs_Destroy(OH_ArkUI_FontWeightConfigs* option) | Destroys the text font weight configuration object. This API must be used in pair with OH_ArkUI_FontWeightConfigs_Create; otherwise, memory leaks may occur. |
| void OH_ArkUI_FontWeightConfigs_SetEnableVariableFontWeight(OH_ArkUI_FontWeightConfigs* option, bool enable) | Sets whether to enable variable font weight adjustment. Variable font weight adjustment allows the font to display weight at any integer value from 100 to 900, enabling finer control over font weight. |
| bool OH_ArkUI_FontWeightConfigs_GetEnableVariableFontWeight(OH_ArkUI_FontWeightConfigs* option) | Obtains whether variable font weight adjustment is enabled for the text font weight configuration object. |
| void OH_ArkUI_FontWeightConfigs_SetEnableDeviceFontWeightCategory(OH_ArkUI_FontWeightConfigs* option, bool enable) | Sets whether to automatically update the text font weight when the font weight level of the device changes. The font weight level of the device refers to the global font weight configuration in system settings, which users can adjust in the system settings. |
| bool OH_ArkUI_FontWeightConfigs_GetEnableDeviceFontWeightCategory(OH_ArkUI_FontWeightConfigs* option) | Obtains whether the text font weight is updated along with the font weight level of the device. |
| OH_ArkUI_FontConfigs* OH_ArkUI_FontConfigs_Create() | Creates a text font configuration object. When the object is no longer used, call OH_ArkUI_FontConfigs_Destroy to destroy it and release resources to avoid memory leaks. |
| void OH_ArkUI_FontConfigs_Destroy(OH_ArkUI_FontConfigs* option) | Destroys the text font configuration object. This API must be used in pair with OH_ArkUI_FontConfigs_Create; otherwise, memory leaks may occur. |
| void OH_ArkUI_FontConfigs_SetFontWeightConfigs(OH_ArkUI_FontConfigs* option, OH_ArkUI_FontWeightConfigs* fontWeightConfigs) | Sets the text font weight configurations for the text font configuration object. |
| OH_ArkUI_FontWeightConfigs* OH_ArkUI_FontConfigs_GetFontWeightConfigs(OH_ArkUI_FontConfigs* option) | Obtains the text font weight configurations of the text font configuration object. |
| OH_ArkUI_TextController* OH_ArkUI_TextController_Create() | Creates a text controller object. When the object is no longer used, call OH_ArkUI_TextController_Destroy to destroy it and release resources to avoid memory leaks. |
| void OH_ArkUI_TextController_Destroy(OH_ArkUI_TextController* controller) | Destroys the text controller object. This API must be used in pair with OH_ArkUI_TextController_Create; otherwise, memory leaks may occur. |
[h2]ArkUI_FontStyle
enum ArkUI_FontStyle
Description
Enumerates font styles.
Since: 12
| Value | Description |
|---|---|
| ARKUI_FONT_STYLE_NORMAL = 0 | Standard font style. |
| ARKUI_FONT_STYLE_ITALIC = 1 | Italic font style. |
[h2]ArkUI_FontWeight
enum ArkUI_FontWeight
Description
Enumerates font weights.
Since: 12
| Value | Description |
|---|---|
| ARKUI_FONT_WEIGHT_W100 = 0 | Font weight 100. |
| ARKUI_FONT_WEIGHT_W200 = 1 | Font weight 200. |
| ARKUI_FONT_WEIGHT_W300 = 2 | Font weight 300. |
| ARKUI_FONT_WEIGHT_W400 = 3 | Font weight 400. |
| ARKUI_FONT_WEIGHT_W500 = 4 | Font weight 500. |
| ARKUI_FONT_WEIGHT_W600 = 5 | Font weight 600. |
| ARKUI_FONT_WEIGHT_W700 = 6 | Font weight 700. |
| ARKUI_FONT_WEIGHT_W800 = 7 | Font weight 800. |
| ARKUI_FONT_WEIGHT_W900 = 8 | Font weight 900. |
| ARKUI_FONT_WEIGHT_BOLD = 9 | The font weight is bold. |
| ARKUI_FONT_WEIGHT_NORMAL = 10 | The font weight is normal. This is the same as ARKUI_FONT_WEIGHT_REGULAR. |
| ARKUI_FONT_WEIGHT_BOLDER = 11 | The font weight is bolder. |
| ARKUI_FONT_WEIGHT_LIGHTER = 12 | The font weight is lighter. |
| ARKUI_FONT_WEIGHT_MEDIUM = 13 | The font weight is medium. |
| ARKUI_FONT_WEIGHT_REGULAR = 14 | The font weight is normal. This is the same as ARKUI_FONT_WEIGHT_NORMAL. |
[h2]ArkUI_TextHeightAdaptivePolicy
enum ArkUI_TextHeightAdaptivePolicy
Description
Enumerates how the adaptive height is determined for the text.
Since: 12
| Value | Description |
|---|---|
| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MAX_LINES_FIRST = 0 | Prioritize the maxLines settings. When the text content exceeds the display area, the maxLines settings are met first, and the excess may be truncated or handled in other ways. |
| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MIN_FONT_SIZE_FIRST = 1 | Prioritize the minFontSize settings. When the text content exceeds the display area, the font size is reduced first to fit the height limit, ensuring the text is fully displayed. The font size is automatically adjusted within the allowed range. |
| ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_LAYOUT_CONSTRAINT_FIRST = 2 | Prioritize the layout constraint settings in terms of height for strictly following the height setting of the layout constraint. The text height or font size is not automatically adjusted, and the excess may be truncated or handled in other ways. |
[h2]ArkUI_TextDataDetectorType
enum ArkUI_TextDataDetectorType
Description
Enumerates the entity types of text recognition.
Since: 12
| Value | Description |
|---|---|
| ARKUI_TEXT_DATA_DETECTOR_TYPE_PHONE_NUMBER = 0 | Phone number. |
| ARKUI_TEXT_DATA_DETECTOR_TYPE_URL = 1 | URL. |
| ARKUI_TEXT_DATA_DETECTOR_TYPE_EMAIL = 2 | Email. |
| ARKUI_TEXT_DATA_DETECTOR_TYPE_ADDRESS = 3 | Address. |
[h2]ArkUI_MarqueeStartPolicy
enum ArkUI_MarqueeStartPolicy
Description
Enumerates marquee startup policies.
Since: 23
| Value | Description |
|---|---|
| ARKUI_MARQUEESTARTPOLICY_DEFAULT = 0 | The marquee scrolls continuously by default. |
| ARKUI_MARQUEESTARTPOLICY_ONFOCUS = 1 | The marquee starts scrolling when it has focus or when the mouse hovers over it. |
[h2]ArkUI_MarqueeUpdatePolicy
enum ArkUI_MarqueeUpdatePolicy
Description
Enumerates marquee update policies.
Since: 23
| Value | Description |
|---|---|
| ARKUI_MARQUEEUPDATEPOLICY_DEFAULT = 0 | Restarts the marquee from the start position after the attributes of the marquee component are updated. |
| ARKUI_MARQUEEUPDATEPOLICY_PRESERVEPOSITION = 1 | Resumes the marquee from the current position after the attributes of the marquee component are updated. |
[h2]OH_ArkUI_TextMarqueeOptions_Create()
ArkUI_TextMarqueeOptions* OH_ArkUI_TextMarqueeOptions_Create()
Description
Creates a text marquee option object. When the object is no longer used, call OH_ArkUI_TextMarqueeOptions_Dispose to dispose of it and release resources to avoid memory leaks.
Since: 23
Returns
| Type | Description |
|---|---|
| ArkUI_TextMarqueeOptions* | Pointer to the text marquee option object. If creation fails, a null pointer is returned. You need to call OH_ArkUI_TextMarqueeOptions_Dispose to dispose of it after use. |
[h2]OH_ArkUI_TextMarqueeOptions_Dispose()
void OH_ArkUI_TextMarqueeOptions_Dispose(ArkUI_TextMarqueeOptions* option)
Description
Disposes of the pointer to the text marquee option object. This API must be used in pair with OH_ArkUI_TextMarqueeOptions_Create; otherwise, memory leaks may occur.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
[h2]OH_ArkUI_TextMarqueeOptions_SetStart()
void OH_ArkUI_TextMarqueeOptions_SetStart(ArkUI_TextMarqueeOptions* option, bool start)
Description
Sets whether to play the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
| bool start | Whether to play the text marquee option. true indicates to play; false otherwise. Default value: true. |
[h2]OH_ArkUI_TextMarqueeOptions_GetStart()
bool OH_ArkUI_TextMarqueeOptions_GetStart(ArkUI_TextMarqueeOptions* option)
Description
Obtains whether the text marquee option is played.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
Returns
| Type | Description |
|---|---|
| bool | Whether the text marquee option is played. true indicates the text marquee option is played; false indicates the text marquee option is not played. |
[h2]OH_ArkUI_TextMarqueeOptions_SetStep()
void OH_ArkUI_TextMarqueeOptions_SetStep(ArkUI_TextMarqueeOptions* option, float step)
Description
Sets the step of the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
| float step | Step length. Unit: vp. Value range: (0, Text length]. If the value is out of range, 4.0vp is used. Default value: 4.0vp. After the step is set, the marquee moves by this step value each time. A larger step results in faster scrolling. |
[h2]OH_ArkUI_TextMarqueeOptions_GetStep()
float OH_ArkUI_TextMarqueeOptions_GetStep(ArkUI_TextMarqueeOptions* option)
Description
Obtains the step of the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
Returns
| Type | Description |
|---|---|
| float | Step. The unit is vp. |
[h2]OH_ArkUI_TextMarqueeOptions_SetSpacing()
void OH_ArkUI_TextMarqueeOptions_SetSpacing(ArkUI_TextMarqueeOptions* option, float spacing)
Description
Sets the distance between the start and end items of the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
| float spacing | Spacing between the start and end items. Unit: vp. Value range: [0, +∞). If the value is less than 0, the default value 48.0vp is used. Default value: 48.0vp. After setting, when the marquee finishes one scroll cycle, the distance between the start and end text is this spacing value. It is recommended to set this value based on the width of the display area. |
[h2]OH_ArkUI_TextMarqueeOptions_GetSpacing()
float OH_ArkUI_TextMarqueeOptions_GetSpacing(ArkUI_TextMarqueeOptions* option)
Description
Obtains the distance between the start and end items of the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
Returns
| Type | Description |
|---|---|
| float | Spacing between the start and end items. The unit is vp. |
[h2]OH_ArkUI_TextMarqueeOptions_SetLoop()
void OH_ArkUI_TextMarqueeOptions_SetLoop(ArkUI_TextMarqueeOptions* option, int32_t loop)
Description
Sets the number of repetitions for looping the text marquee option. The value less than or equal to 0 indicates infinite looping.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
| int32_t loop | Number of loops. The value less than or equal to 0 indicates infinite looping. |
[h2]OH_ArkUI_TextMarqueeOptions_GetLoop()
int32_t OH_ArkUI_TextMarqueeOptions_GetLoop(ArkUI_TextMarqueeOptions* option)
Description
Obtains the number of repetitions for looping the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
Returns
| Type | Description |
|---|---|
| int32_t | Number of loops. |
[h2]OH_ArkUI_TextMarqueeOptions_SetFromStart()
void OH_ArkUI_TextMarqueeOptions_SetFromStart(ArkUI_TextMarqueeOptions* option, bool fromStart)
Description
Sets the direction for scrolling the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
| bool fromStart | Whether to scroll the text marquee option from the start. true to scroll from the start; false to scroll in reverse. Default value: true. |
[h2]OH_ArkUI_TextMarqueeOptions_GetFromStart()
bool OH_ArkUI_TextMarqueeOptions_GetFromStart(ArkUI_TextMarqueeOptions* option)
Description
Obtains the direction for scrolling the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
Returns
| Type | Description |
|---|---|
| bool | Whether the text marquee option is scrolled from the start. true to scroll from the start; false to scroll in reverse. |
[h2]OH_ArkUI_TextMarqueeOptions_SetDelay()
void OH_ArkUI_TextMarqueeOptions_SetDelay(ArkUI_TextMarqueeOptions* option, int32_t delay)
Description
Sets the delay of each loop for the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
| int32_t delay | Delay of each loop, in milliseconds. Value range: [0, +∞). Default value: 0. |
[h2]OH_ArkUI_TextMarqueeOptions_GetDelay()
int32_t OH_ArkUI_TextMarqueeOptions_GetDelay(ArkUI_TextMarqueeOptions* option)
Description
Obtains the delay of each loop for the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
Returns
| Type | Description |
|---|---|
| int32_t | Delay of each loop, in milliseconds. |
[h2]OH_ArkUI_TextMarqueeOptions_SetFadeout()
void OH_ArkUI_TextMarqueeOptions_SetFadeout(ArkUI_TextMarqueeOptions* option, bool fadeout)
Description
Sets whether the text marquee option supports a fade-out effect when the text is too long. When this parameter is set to true: if the text content exceeds the display range, a fade-out effect is applied to the edges of the partially visible text; if text is partially visible at both ends, the fade-out effect is applied to both ends.
When the fade-out effect is enabled, the NODE_CLIP attribute in ArkUI_NodeAttributeType is automatically locked to true and cannot be set to false.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
| bool fadeout | Whether the text marquee option supports a fade-out effect when the text is too long. The value true means to apply a fade-out effect when the text is too long, in which case the NODE_CLIP attribute is automatically locked to true and cannot be set to false. The value false means not to apply a fade-out effect. |
[h2]OH_ArkUI_TextMarqueeOptions_GetFadeout()
bool OH_ArkUI_TextMarqueeOptions_GetFadeout(ArkUI_TextMarqueeOptions* option)
Description
Obtains whether the text marquee option supports a fade-out effect when the text is too long.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
Returns
| Type | Description |
|---|---|
| bool | Whether the text marquee option supports a fade-out effect when the text is too long. The value true means the fade-out effect is supported, and false means the opposite. |
[h2]OH_ArkUI_TextMarqueeOptions_SetStartPolicy()
void OH_ArkUI_TextMarqueeOptions_SetStartPolicy(ArkUI_TextMarqueeOptions* option, ArkUI_MarqueeStartPolicy startPolicy)
Description
Sets the startup policy of the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
| ArkUI_MarqueeStartPolicy startPolicy | Start policy. |
[h2]OH_ArkUI_TextMarqueeOptions_GetStartPolicy()
ArkUI_MarqueeStartPolicy OH_ArkUI_TextMarqueeOptions_GetStartPolicy(ArkUI_TextMarqueeOptions* option)
Description
Obtains the startup policy of the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
Returns
| Type | Description |
|---|---|
| ArkUI_MarqueeStartPolicy | Start policy. |
[h2]OH_ArkUI_TextMarqueeOptions_SetUpdatePolicy()
void OH_ArkUI_TextMarqueeOptions_SetUpdatePolicy(ArkUI_TextMarqueeOptions* option, ArkUI_MarqueeUpdatePolicy updatePolicy)
Description
Sets the update policy of the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
| ArkUI_MarqueeUpdatePolicy updatePolicy | Update policy. |
[h2]OH_ArkUI_TextMarqueeOptions_GetUpdatePolicy()
ArkUI_MarqueeUpdatePolicy OH_ArkUI_TextMarqueeOptions_GetUpdatePolicy(ArkUI_TextMarqueeOptions* option)
Description
Obtains the update policy of the text marquee option.
Since: 23
Parameters
| Name | Description |
|---|---|
| ArkUI_TextMarqueeOptions* option | Pointer to the text marquee option object. |
Returns
| Type | Description |
|---|---|
| ArkUI_MarqueeUpdatePolicy | Update policy. |
[h2]OH_ArkUI_TextDataDetectorConfig_Create()
OH_ArkUI_TextDataDetectorConfig* OH_ArkUI_TextDataDetectorConfig_Create()
Description
Creates a text entity recognition configuration object. When the object is no longer used, call OH_ArkUI_TextDataDetectorConfig_Destroy to destroy it and release resources to avoid memory leaks.
Since: 24
Returns
| Type | Description |
|---|---|
| OH_ArkUI_TextDataDetectorConfig* | Pointer to the OH_ArkUI_TextDataDetectorConfig object. If creation fails, a null pointer is returned. This object must be destroyed by calling OH_ArkUI_TextDataDetectorConfig_Destroy after use. |
[h2]OH_ArkUI_TextDataDetectorConfig_Destroy()
void OH_ArkUI_TextDataDetectorConfig_Destroy(OH_ArkUI_TextDataDetectorConfig* config)
Description
Destroys the text entity recognition configuration object.
Since: 24
Parameters
| Name | Description |
|---|---|
| OH_ArkUI_TextDataDetectorConfig* config | Pointer to the OH_ArkUI_TextDataDetectorConfig object. |
[h2]OH_ArkUI_FontWeightConfigs_Create()
OH_ArkUI_FontWeightConfigs* OH_ArkUI_FontWeightConfigs_Create()
Description
Creates a text font weight configuration object. When the object is no longer used, call OH_ArkUI_FontWeightConfigs_Destroy to destroy it and release resources to avoid memory leaks.
Since: 24
Returns
| Type | Description |
|---|---|
| OH_ArkUI_FontWeightConfigs* | Pointer to the text font weight configuration object. If creation fails, a null pointer is returned. You need to call OH_ArkUI_FontWeightConfigs_Destroy to destroy it after use. When the configuration object is a null pointer, no default value is applied, and the text font weight behavior remains consistent with that of the parent component. |
[h2]OH_ArkUI_FontWeightConfigs_Destroy()
void OH_ArkUI_FontWeightConfigs_Destroy(OH_ArkUI_FontWeightConfigs* option)
Description
Destroys the text font weight configuration object. This API must be used in pair with OH_ArkUI_FontWeightConfigs_Create; otherwise, memory leaks will occur.
If this object has been set to FontConfigs via SetFontWeightConfigs, destroy FontWeightConfigs only after destroying FontConfigs, or ensure that FontConfigs is no longer in use before destroying FontWeightConfigs, to prevent FontConfigs from holding an invalid pointer.
Since: 24
Parameters
| Name | Description |
|---|---|
| OH_ArkUI_FontWeightConfigs* option | Pointer to the text font weight configuration object to be destroyed. |
[h2]OH_ArkUI_FontWeightConfigs_SetEnableVariableFontWeight()
void OH_ArkUI_FontWeightConfigs_SetEnableVariableFontWeight(OH_ArkUI_FontWeightConfigs* option, bool enable)
Description
Sets whether to enable variable font weight adjustment. Variable font weight adjustment allows the font to display weight at any integer value from 100 to 900, enabling finer control over font weight.
Since: 24
Parameters
| Name | Description |
|---|---|
| OH_ArkUI_FontWeightConfigs* option | Pointer to the text font weight configuration object to be modified. |
| bool enable | Whether to enable variable font weight adjustment. The default value is false. The value true means to enable variable font weight adjustment. In this case, if the value of weight is any integer in the range [100, 900], the value is used; otherwise, the default value 400 is used. The value false means to disable variable font weight adjustment. In this case, the value of weight can only be multiples of 100 in the range [100, 900]; for a non-multiple of 100, the default value 400 is used. |
[h2]OH_ArkUI_FontWeightConfigs_GetEnableVariableFontWeight()
bool OH_ArkUI_FontWeightConfigs_GetEnableVariableFontWeight(OH_ArkUI_FontWeightConfigs* option)
Description
Obtains whether variable font weight adjustment is enabled for the text font weight configuration object.
Since: 24
Parameters
| Name | Description |
|---|---|
| OH_ArkUI_FontWeightConfigs* option | Pointer to the text font weight configuration object. |
Returns
| Type | Description |
|---|---|
| bool | Whether variable font weight adjustment is enabled. true indicates variable font weight adjustment is enabled. If the value of weight is any integer in the range of [100, 900], the value of weight is used. Otherwise, the default value 400 is used. false indicates variable font weight adjustment is disabled. If the value of weight is an integer multiple of 100 in the range of [100, 900], the value of weight is used. Otherwise, the default value 400 is used. If the value of weight is not within the range of [100, 900], the default value 400 is used. |
[h2]OH_ArkUI_FontWeightConfigs_SetEnableDeviceFontWeightCategory()
void OH_ArkUI_FontWeightConfigs_SetEnableDeviceFontWeightCategory(OH_ArkUI_FontWeightConfigs* option, bool enable)
Description
Sets whether to automatically update the text font weight when the font weight level of the device changes. The font weight level of the device refers to the global font weight configuration in system settings, which users can adjust in system settings.
Since: 24
Parameters
| Name | Description |
|---|---|
| OH_ArkUI_FontWeightConfigs* option | Pointer to the text font weight configuration object to be modified. |
| bool enable | Whether to enable the text font weight to be updated along with the font weight level of the device. true indicates that the text font weight is automatically updated when the font weight level of the device changes. false indicates that the text font weight is not automatically updated when the font weight level of the device changes. The default value is true. |
[h2]OH_ArkUI_FontWeightConfigs_GetEnableDeviceFontWeightCategory()
bool OH_ArkUI_FontWeightConfigs_GetEnableDeviceFontWeightCategory(OH_ArkUI_FontWeightConfigs* option)
Description
Obtains whether the text font weight is updated along with the font weight level of the device.
Since: 24
Parameters
| Name | Description |
|---|---|
| OH_ArkUI_FontWeightConfigs* option | Pointer to the text font weight configuration object. |
Returns
| Type | Description |
|---|---|
| bool | Whether the text font weight is updated along with the font weight level of the device. true indicates that the text font weight is automatically updated when the font weight level of the device changes. false indicates that the text font weight is not automatically updated when the font weight level of the device changes. |
[h2]OH_ArkUI_FontConfigs_Create()
OH_ArkUI_FontConfigs* OH_ArkUI_FontConfigs_Create()
Description
Creates a text font configuration object. When the object is no longer used, call OH_ArkUI_FontConfigs_Destroy to destroy it and release resources to avoid memory leaks.
Since: 24
Returns
| Type | Description |
|---|---|
| OH_ArkUI_FontConfigs* | Pointer to the text font configuration object. If creation fails, a null pointer is returned. After use, call OH_ArkUI_FontConfigs_Destroy to destroy it. |
[h2]OH_ArkUI_FontConfigs_Destroy()
void OH_ArkUI_FontConfigs_Destroy(OH_ArkUI_FontConfigs* option)
Description
Destroys the text font configuration object. This API must be used in pair with OH_ArkUI_FontConfigs_Create; otherwise, memory leaks will occur.
Before destroying FontConfigs, destroy the FontWeightConfigs object set via SetFontWeightConfigs (if it is no longer needed), or ensure that the lifecycle of FontWeightConfigs is longer than that of FontConfigs, to avoid dangling pointer issues.
Since: 24
Parameters
| Name | Description |
|---|---|
| OH_ArkUI_FontConfigs* option | Pointer to the text font configuration object to be destroyed. |
[h2]OH_ArkUI_FontConfigs_SetFontWeightConfigs()
void OH_ArkUI_FontConfigs_SetFontWeightConfigs(OH_ArkUI_FontConfigs* option, OH_ArkUI_FontWeightConfigs* fontWeightConfigs)
Description
Sets the text font weight configurations for the text font configuration object.
Since: 24
Parameters
| Name | Description |
|---|---|
| OH_ArkUI_FontConfigs* option | Pointer to the text font configuration object to be modified. |
| OH_ArkUI_FontWeightConfigs* fontWeightConfigs | Pointer to the text font weight configuration. When this parameter is not a null pointer, if the user does not explicitly set it, each configuration item uses the default value (variable font weight adjustment is disabled by default, and the text font weight following the device font weight level update is enabled by default). When this parameter is a null pointer, the above default values are not applied, and the text font weight behavior keeps consistent with that of the parent component. |
[h2]OH_ArkUI_FontConfigs_GetFontWeightConfigs()
OH_ArkUI_FontWeightConfigs* OH_ArkUI_FontConfigs_GetFontWeightConfigs(OH_ArkUI_FontConfigs* option)
Description
Obtains the text font weight configurations of the text font configuration object.
Since: 24
Parameters
| Name | Description |
|---|---|
| OH_ArkUI_FontConfigs* option | Pointer to the text font configuration object. If not set or set to a null pointer, a null pointer is returned. |
Returns
| Type | Description |
|---|---|
| OH_ArkUI_FontWeightConfigs* | Pointer to the text font weight configuration object. |
[h2]OH_ArkUI_TextController_Create()
OH_ArkUI_TextController* OH_ArkUI_TextController_Create()
Description
Creates a text controller object. When the object is no longer used, call OH_ArkUI_TextController_Destroy to destroy it and release resources to avoid memory leaks.
Since: 26.0.0
Returns
| Type | Description |
|---|---|
| OH_ArkUI_TextController* | Pointer to the text controller object. If creation fails, a null pointer is returned. After use, call OH_ArkUI_TextController_Destroy to destroy it. |
[h2]OH_ArkUI_TextController_Destroy()
void OH_ArkUI_TextController_Destroy(OH_ArkUI_TextController* controller)
Description
Destroys the text controller object. This API must be used in pair with OH_ArkUI_TextController_Create; otherwise, memory leaks will occur.
Since: 26.0.0
Parameters
| Name | Description |
|---|---|
| OH_ArkUI_TextController* controller | Pointer to the text component controller object. |