ArkUI_NodeAttributeType(文本显示类组件相关属性)
enum ArkUI_NodeAttributeType
概述
定义ArkUI在Native侧可以设置的文本显示类组件相关属性样式集合,包含Text、Span、ImageSpan等组件属性设置。
起始版本: 12
相关模块: ArkUI_NativeModule
所在头文件: native_node.h
NODE_TEXT_CONTENT
NODE_TEXT_CONTENT = MAX_NODE_SCOPE_NUM * ARKUI_NODE_TEXT = 1000
Text组件设置文本内容属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .string | 表示文本内容。 |
返回:
| 类型 | 说明 |
|---|---|
| .string | 表示文本内容。 |
NODE_FONT_COLOR
NODE_FONT_COLOR = 1001
组件字体颜色属性,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].u32 | 字体颜色数值,0xargb格式,形如 0xFFFF0000 表示红色。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].u32 | 字体颜色数值,0xargb格式。 |
NODE_FONT_SIZE
NODE_FONT_SIZE = 1002
组件字体大小属性,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 字体大小数值,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 字体大小数值,单位为fp。 |
NODE_FONT_STYLE
NODE_FONT_STYLE = 1003
组件字体样式属性,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 字体样式ArkUI_FontStyle,默认值为ARKUI_FONT_STYLE_NORMAL。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 字体样式ArkUI_FontStyle。 |
NODE_FONT_WEIGHT
NODE_FONT_WEIGHT = 1004
组件字体粗细属性,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 字体粗细样式ArkUI_FontWeight,默认值为ARKUI_FONT_WEIGHT_NORMAL。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 字体粗细样式ArkUI_FontWeight。 |
NODE_TEXT_LINE_HEIGHT
NODE_TEXT_LINE_HEIGHT = 1005
文本行高属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 表示lineHeight值,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 表示lineHeight值,单位为fp。 |
NODE_TEXT_DECORATION
NODE_TEXT_DECORATION = 1006
文本装饰线样式及其颜色属性,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 文本装饰线类型ArkUI_TextDecorationType,默认值为ARKUI_TEXT_DECORATION_TYPE_NONE。 |
| .value[1]?.u32 | 可选值,装饰线颜色,0xargb格式,形如 0xFFFF0000 表示红色。 |
| .value[2]?.i32 | 文本装饰线样式ArkUI_TextDecorationStyle。 |
| .value[3]?.f32 | 可选值,文本装饰线粗细比例,默认值:1.0,取值范围:[0, +∞)。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 文本装饰线类型ArkUI_TextDecorationType。 |
| .value[1].u32 | 装饰线颜色,0xargb格式。 |
| .value[2].i32 | 文本装饰线样式ArkUI_TextDecorationStyle。 |
| .value[3].f32 | 文本装饰线粗细比例。 |
NODE_TEXT_CASE
NODE_TEXT_CASE = 1007
文本大小写属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 表示文本大小写类型ArkUI_TextCase,默认值为ARKUI_TEXT_CASE_NORMAL。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 表示文本大小写类型ArkUI_TextCase。 |
NODE_TEXT_LETTER_SPACING
NODE_TEXT_LETTER_SPACING = 1008
文本字符间距属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 表示字符间距值,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 表示字符间距值,单位为fp。 |
NODE_TEXT_MAX_LINES
NODE_TEXT_MAX_LINES = 1009
文本最大行数属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 表示最大行数。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 表示最大行数。 |
NODE_TEXT_ALIGN
NODE_TEXT_ALIGN = 1010
文本水平对齐方式, 支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 表示文本水平对齐方式,取ArkUI_TextAlignment枚举值。默认值为ARKUI_TEXT_ALIGNMENT_START。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 表示文本水平对齐方式,取ArkUI_TextAlignment枚举值。 |
NODE_TEXT_OVERFLOW
NODE_TEXT_OVERFLOW = 1011
文本超长时的显示方式属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 表示文本超长时的显示方式ArkUI_TextOverflow。默认值为ARKUI_TEXT_OVERFLOW_NONE。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 表示文本超长时的显示方式。ArkUI_TextOverflow。 |
NODE_FONT_FAMILY
NODE_FONT_FAMILY = 1012
Text字体列表属性,支持属性设置,属性重置和属性获取。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .string | 字体字符串,多个用,分隔。 |
返回:
| 类型 | 说明 |
|---|---|
| .string | 字体字符串,多个用,分隔。 |
NODE_TEXT_COPY_OPTION
NODE_TEXT_COPY_OPTION = 1013
文本复制粘贴属性,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 复制粘贴方式ArkUI_CopyOptions,默认值为ARKUI_COPY_OPTIONS_NONE。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 复制粘贴方式ArkUI_CopyOptions。 |
NODE_TEXT_BASELINE_OFFSET
NODE_TEXT_BASELINE_OFFSET = 1014
文本基线的偏移量属性,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 偏移量数值,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 偏移量数值,单位为fp。 |
NODE_TEXT_TEXT_SHADOW
NODE_TEXT_TEXT_SHADOW = 1015
文字阴影效果属性,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 阴影模糊半径,单位为vp。 |
| .value[1].i32 | 阴影类型ArkUI_ShadowType,默认值为ARKUI_SHADOW_TYPE_COLOR。 |
| .value[2].u32 | 阴影颜色,0xargb格式,形如 0xFFFF0000 表示红色。 |
| .value[3].f32 | 阴影X轴偏移量,单位为vp。 |
| .value[4].f32 | 阴影Y轴偏移量,单位为vp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 阴影模糊半径,单位为vp。 |
| .value[1].i32 | 阴影类型ArkUI_ShadowType。 |
| .value[2].u32 | 阴影颜色,0xargb格式。 |
| .value[3].f32 | 阴影X轴偏移量,单位为vp。 |
| .value[4].f32 | 阴影Y轴偏移量,单位为vp。 |
NODE_TEXT_MIN_FONT_SIZE
NODE_TEXT_MIN_FONT_SIZE = 1016
Text最小显示字号,支持属性设置,属性重置和属性获取。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 文本最小显示字号,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 文本最小显示字号,单位为fp。 |
NODE_TEXT_MAX_FONT_SIZE
NODE_TEXT_MAX_FONT_SIZE = 1017
Text最大显示字号,支持属性设置,属性重置和属性获取。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 文本最大显示字号,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 文本最大显示字号,单位为fp。 |
NODE_TEXT_FONT
NODE_TEXT_FONT = 1018
Text样式,支持属性设置,属性重置和属性获取。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .string? | 可选值 字体列表,使用多个字体,使用','进行分割。 |
| .value[0].f32 | 文本尺寸,单位为fp。 |
| .value[1]?.i32 | 可选值,文本的字体粗细,参数类型ArkUI_FontWeight。默认值为ARKUI_FONT_WEIGHT_NORMAL。 |
| .value[2]?.i32 | 可选值,字体样式,参数类型ArkUI_FontStyle。默认值为ARKUI_FONT_STYLE_NORMAL。 |
返回:
| 类型 | 说明 |
|---|---|
| .string | 字体列表,使用多个字体,使用','进行分割。 |
| .value[0].f32 | 文本尺寸,单位为fp。 |
| .value[1].i32 | 文本的字体粗细,参数类型ArkUI_FontWeight。默认值为ARKUI_FONT_WEIGHT_NORMAL。 |
| .value[2].i32 | 字体样式,参数类型ArkUI_FontStyle。默认值为ARKUI_FONT_STYLE_NORMAL。 |
NODE_TEXT_HEIGHT_ADAPTIVE_POLICY
NODE_TEXT_HEIGHT_ADAPTIVE_POLICY = 1019
Text自适应高度的方式,支持属性设置,属性重置和属性获取。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 参数类型ArkUI_TextHeightAdaptivePolicy。默认值为ARKUI_TEXT_HEIGHT_ADAPTIVE_POLICY_MAX_LINES_FIRST。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 参数类型ArkUI_TextHeightAdaptivePolicy。 |
NODE_TEXT_INDENT
NODE_TEXT_INDENT = 1020
文本首行缩进属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 表示首行缩进值,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 表示首行缩进值,单位为vp。 |
NODE_TEXT_WORD_BREAK
NODE_TEXT_WORD_BREAK = 1021
文本断行规则属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 参数类型ArkUI_WordBreak。默认值为ARKUI_WORD_BREAK_BREAK_WORD。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 参数类型ArkUI_WordBreak。 |
NODE_TEXT_ELLIPSIS_MODE
NODE_TEXT_ELLIPSIS_MODE = 1022
设置文本省略位置,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 参数类型ArkUI_EllipsisMode。默认值为ARKUI_ELLIPSIS_MODE_END。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 参数类型ArkUI_EllipsisMode。 |
NODE_TEXT_LINE_SPACING
NODE_TEXT_LINE_SPACING = 1023
文本行间距属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 表示lineSpacing值,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 表示lineSpacing值,单位为fp。 |
NODE_FONT_FEATURE
NODE_FONT_FEATURE = 1024
设置文本特性效果,设置NODE_FONT_FEATURE属性,NODE_FONT_FEATURE是 OpenType 字体的高级排版能力,如支持连字、数字等宽等特性,一般用在自定义字体中,其能力需要字体本身支持,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .string | 符合文本特性格式的字符串,格式为normal |<feature-tag-value>。 <feature-tag-value>的格式为:<string> [ <integer> |on |off ]。 <feature-tag-value>的个数可以有多个,中间用','隔开,例如,使用等宽数字的输入格式为:ss01 on。 |
返回:
| 类型 | 说明 |
|---|---|
| .string | 表示文本特性的内容,多个文本特性之间使用逗号分隔。 |
NODE_TEXT_ENABLE_DATA_DETECTOR
NODE_TEXT_ENABLE_DATA_DETECTOR = 1025
设置使能文本识别。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 使能文本识别,默认值false,true表示文本可实体识别,false表示不可识别。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 使能文本识别。 |
NODE_TEXT_ENABLE_DATA_DETECTOR_CONFIG
NODE_TEXT_ENABLE_DATA_DETECTOR_CONFIG = 1026
设置文本识别配置。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0...].i32 | 实体类型数组,参数类型ArkUI_TextDataDetectorType。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0...].i32 | 实体类型数组,参数类型ArkUI_TextDataDetectorType。 |
NODE_TEXT_SELECTED_BACKGROUND_COLOR
NODE_TEXT_SELECTED_BACKGROUND_COLOR = 1027
文本选中时的背景色属性,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].u32 | 颜色数值,0xargb格式,形如 0xFFFF0000 表示红色。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].u32 | 颜色数值,0xargb格式。 |
NODE_TEXT_CONTENT_WITH_STYLED_STRING
NODE_TEXT_CONTENT_WITH_STYLED_STRING = 1028
Text组件使用格式化字符串对象设置文本内容属性,支持属性设置,属性重置,属性获取接口。配置自定义OH_Drawing_Typography对象到Text组件,会跳过文本控件的布局测算阶段,需要注意:
1、需要保证OH_ArkUI_StyledString对象、OH_Drawing_Typography对象的生命周期跟随Text组件生命周期,Text组件析构时重置OH_ArkUI_StyledString对象,否则会导致应用出现空指针崩溃。
2、保证OH_Drawing_TypographyLayout方法调用时序在Text组件的布局测算之前。
3、释放OH_ArkUI_StyledString对象、OH_Drawing_Typography对象时,需要同步调用Text组件的reset方法,否则会导致应用出现空指针崩溃。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .object | 表示 ArkUI_StyledString 格式化字符串数据,参数类型为ArkUI_StyledString。 |
返回:
| 类型 | 说明 |
|---|---|
| .object | 表示 ArkUI_StyledString 格式化字符串数据,参数类型为ArkUI_StyledString。 |
NODE_TEXT_HALF_LEADING
NODE_TEXT_HALF_LEADING = 1029
Text组件设置文本纵向居中显示。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 文本是否纵向居中显示,默认值false。 true表示文本是纵向居中显示,false表示文本不是纵向居中显示。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 文本是否纵向居中显示。 |
NODE_IMMUTABLE_FONT_WEIGHT
NODE_IMMUTABLE_FONT_WEIGHT = 1030
组件字体粗细属性,支持属性设置,属性重置和属性获取接口。通过此接口设置的粗细属性不会跟随系统字体粗细变化。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 15
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 字体粗细样式ArkUI_FontWeight,默认值为ARKUI_FONT_WEIGHT_NORMAL。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 字体粗细样式ArkUI_FontWeight。 |
NODE_TEXT_LINE_COUNT
NODE_TEXT_LINE_COUNT = 1031
文本行数属性,支持属性获取接口。
作为属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 20
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 表示文本行数。 |
NODE_TEXT_OPTIMIZE_TRAILING_SPACE
NODE_TEXT_OPTIMIZE_TRAILING_SPACE = 1032
设置文本排版时是否优化每行结尾的空格,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 20
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 设置文本排版时是否优化每行结尾的空格,默认值为false。 true表示设置文本排版时优化每行结尾的空格,false表示不优化。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 文本排版时是否优化每行结尾的空格。 |
NODE_TEXT_LINEAR_GRADIENT
NODE_TEXT_LINEAR_GRADIENT = 1033
设置文本线性渐变效果,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 20
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 线性渐变的起始角度。当direction属性设置为ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM时,angle属性生效;否则,以direction属性为主要布局方式。0点方向顺时针旋转为正向角度,默认值:180。 |
| .value[1].i32 | 线性渐变的方向ArkUI_LinearGradientDirection。设置除ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM之外的线性渐变方向后,angle不生效。默认值:ARKUI_LINEAR_GRADIENT_DIRECTION_LEFT_BOTTOM。 |
| .value[2].i32 | 为渐变的颜色重复着色,false表示不重复着色,true表示重复着色。默认值:false。 |
| .object | 参数类型为ArkUI_ColorStop。指定某百分比位置处的渐变色颜色,设置非法颜色直接跳过。 |
| colors | 渐变色颜色数组,数组元素为0xargb格式,形如0xFFFF0000表示红色。 |
| stops | stops表示指定颜色所处位置的数组,数组元素取值范围为[0,1.0],0表示需要设置渐变色的容器的开始处,1.0表示容器的结尾处。想要实现多个颜色渐变效果时,数组元素建议递增设置,如后一个数组元素比前一个数组元素小的话,按照等于前一个数组元素的值处理。 |
| size | 颜色个数,若小于colors数组长度则仅生效前size个颜色,不建议设置大于colors数组长度或小于等于0的值以及异常值。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 线性渐变的起始角度。当为ARKUI_LINEAR_GRADIENT_DIRECTION_CUSTOM时,angle为设置值,其他情况均为默认值0。 |
| .value[1].i32 | 线性渐变的方向ArkUI_LinearGradientDirection。 |
| .value[2].i32 | 为渐变的颜色重复着色,0表示不重复着色,1表示重复着色。默认值:0。 |
| .object | 参数类型为ArkUI_ColorStop。指定某百分比位置处的渐变色颜色,设置非法颜色直接跳过: |
| colors | 渐变色颜色数组,数组元素为0xargb格式,形如0xFFFF0000表示红色。 |
| stops | stops表示指定颜色所处位置的数组,数组元素取值范围为[0,1.0],0表示需要设置渐变色的容器的开始处,1.0表示容器的结尾处。 |
| size | 生效后渐变色的颜色个数。 |
NODE_TEXT_RADIAL_GRADIENT
NODE_TEXT_RADIAL_GRADIENT = 1034
设置文本径向渐变渐变效果,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 20
参数:
| 参数项 | 描述 |
|---|---|
| .value[0]?.f32 | 为径向渐变的中心点,即相对于当前文本框左上角的X轴坐标。 |
| .value[1]?.f32 | 为径向渐变的中心点,即相对于当前文本框左上角的Y轴坐标。文本框左上角的坐标为[0,0]。 |
| .value[2]?.f32 | 径向渐变的半径,默认值0。 |
| .value[3]?.i32 | 为渐变的颜色重复着色,false表示不重复着色,true表示重复着色。默认值:false。 |
| .object | 参数类型为ArkUI_ColorStop。指定某百分比位置处的渐变色颜色,设置非法颜色直接跳过: |
| colors | 渐变色颜色数组,数组元素为0xargb格式,形如0xFFFF0000表示红色。 |
| stops | stops表示指定颜色所处位置的数组,数组元素取值范围为[0,1.0],0表示需要设置渐变色的容器的开始处,1.0表示容器的结尾处。想要实现多个颜色渐变效果时,数组元素建议递增设置,如后一个数组元素比前一个数组元素小的话,按照等于前一个数组元素的值处理。 |
| size | 颜色个数,若小于colors数组长度则仅生效前size个颜色,不建议设置大于colors数组长度或小于等于0的值以及异常值。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0]?.f32 | 为径向渐变的中心点,即相对于当前文本框左上角的X轴坐标。 |
| .value[1]?.f32 | 为径向渐变的中心点,即相对于当前文本框左上角的Y轴坐标。文本框左上角的坐标为[0,0]。 |
| .value[2]?.f32 | 径向渐变的半径,默认值0。 |
| .value[3]?.i32 | 为渐变的颜色重复着色,0表示不重复着色,1表示重复着色。默认值:0。 |
| .object | 参数类型为ArkUI_ColorStop。指定某百分比位置处的渐变色颜色,设置非法颜色直接跳过: |
| colors | 渐变色颜色数组,数组元素为0xargb格式,形如0xFFFF0000表示红色。 |
| stops | stops表示指定颜色所处位置的数组,数组元素取值范围为[0,1.0],0表示需要设置渐变色的容器的开始处,1.0表示容器的结尾处。 |
| size | 生效后渐变色的颜色个数。 |
NODE_TEXT_VERTICAL_ALIGN
NODE_TEXT_VERTICAL_ALIGN = 1035
设置文本内容垂直对齐方式,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 20
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 文本内容垂直对齐方式ArkUI_TextVerticalAlignment,默认值:ARKUI_TEXT_VERTICAL_ALIGNMENT_BASELINE。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 文本内容垂直对齐方式ArkUI_TextVerticalAlignment。 |
NODE_TEXT_CONTENT_ALIGN
NODE_TEXT_CONTENT_ALIGN = 1036
设置文本内容区垂直对齐方式,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 21
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 文本内容区垂直对齐方式ArkUI_TextContentAlign,默认值:ARKUI_TEXT_CONTENT_ALIGN_CENTER。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 文本内容区垂直对齐方式ArkUI_TextContentAlign。 |
NODE_TEXT_MIN_LINES
NODE_TEXT_MIN_LINES = 1037
文本最小行数属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 22
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 表示文本最小行数。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 表示文本最小行数。 |
NODE_TEXT_ENABLE_SELECTED_DATA_DETECTOR
NODE_TEXT_ENABLE_SELECTED_DATA_DETECTOR = 1038
开启选中词文本识别。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 22
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 开启选中词文本识别,true表示开启识别,false表示关闭识别。默认值:true。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 是否开启选中词文本识别。 |
NODE_TEXT_MIN_LINE_HEIGHT
NODE_TEXT_MIN_LINE_HEIGHT = 1040
设置文本最小行高,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 22
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 文本最小行高,默认值:0。单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 文本最小行高。单位为fp。 |
NODE_TEXT_MAX_LINE_HEIGHT
NODE_TEXT_MAX_LINE_HEIGHT = 1041
设置文本最大行高,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 22
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 文本最大行高,默认值:0,表示最大行高不受限制。单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 文本最大行高。单位为fp。 |
NODE_TEXT_LINE_HEIGHT_MULTIPLE
NODE_TEXT_LINE_HEIGHT_MULTIPLE = 1042
设置倍数行高模式的倍数值,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 22
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 倍数行高模式的倍数值,默认值:0,表示使用默认行高高度。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 倍数行高模式的倍数值。 |
NODE_TEXT_LAYOUT_MANAGER
NODE_TEXT_LAYOUT_MANAGER = 1043
文本布局管理器,支持属性获取接口。
作为属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 22
返回:
| 类型 | 说明 |
|---|---|
| .object | 文本布局管理器对象,参数类型为ArkUI_LayoutManager。 |
NODE_TEXT_EDIT_MENU_OPTIONS
NODE_TEXT_EDIT_MENU_OPTIONS = 1044
文本菜单扩展项,支持属性设置接口。
作为属性设置方法参数ArkUI_AttributeItem格式如下。
起始版本: 22
参数:
| 参数项 | 描述 |
|---|---|
| .object | 文本菜单扩展项配置数据,参数类型为ArkUI_TextEditMenuOptions。 |
NODE_TEXT_BIND_SELECTION_MENU
NODE_TEXT_BIND_SELECTION_MENU = 1045
自定义文本选择菜单,支持属性设置接口。
作为属性设置方法参数ArkUI_AttributeItem格式如下。
起始版本: 22
参数:
| 参数项 | 描述 |
|---|---|
| .object | 自定义文本选择菜单配置数据,参数类型为ArkUI_TextSelectionMenuOptions。 |
NODE_TEXT_TEXT_SELECTION
NODE_TEXT_TEXT_SELECTION = 1046
设置文本选择区域,设置后选中区域将被高亮显示,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 23
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 文本选择的起始位置。 |
| .value[1].i32 | 文本选择的结束位置。 |
| .object | 选择选项。参数类型为ArkUI_SelectionOptions。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 文本选择的起始位置。 |
| .value[1].i32 | 文本选择的结束位置。 |
| .object | 选择选项。参数类型为ArkUI_SelectionOptions。 |
NODE_TEXT_ORPHAN_CHAR_OPTIMIZATION
NODE_TEXT_ORPHAN_CHAR_OPTIMIZATION = 1047
设置Text文本排版时是否使能孤字优化,设置后通过更高效地处理孤立字符(段落尾行首字符)来改善文本布局。使能后,它会调整换行点以尽可能避免孤立字符。孤字优化特性需在ArkUI_WordBreak属性为非ARKUI_WORD_BREAK_BREAK_ALL时生效。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 26.0.0
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 是否使能,true表示使能,false表示不使能。默认值false。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 是否使能孤字优化。 |
NODE_TEXT_COMPRESS_LEADING_PUNCTUATION
NODE_TEXT_COMPRESS_LEADING_PUNCTUATION = 1048
文本行首标点压缩开关,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 23
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 是否打开行首标点压缩开关。 true表示开启行首标点压缩,false表示关闭行首标点压缩。默认值false。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 是否打开行首标点压缩开关。 |
NODE_TEXT_INCLUDE_FONT_PADDING
NODE_TEXT_INCLUDE_FONT_PADDING = 1049
设置是否在首行和尾行增加间距以避免文字截断。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 23
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 设置是否在首行和尾行增加间距以避免文字截断。true表示开启增加间距,false表示关闭增加间距。默认值:false。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 是否在首行和尾行增加间距。true表示增加间距,false表示不增加间距。 |
NODE_TEXT_FALLBACK_LINE_SPACING
NODE_TEXT_FALLBACK_LINE_SPACING = 1050
针对多行文字叠加,支持行高基于文字实际高度自适应。此接口仅当行高小于文字实际高度时生效。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 23
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 支持行高基于文字实际高度自适应。true表示开启自适应,false表示关闭自适应。默认值:false。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 是否开启行高基于文字实际高度自适应。true表示开启自适应,false表示关闭自适应。 |
NODE_TEXT_MARQUEE_OPTIONS
NODE_TEXT_MARQUEE_OPTIONS = 1051
文本跑马灯模式配置项,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 23
参数:
| 参数项 | 描述 |
|---|---|
| .object | 文本跑马灯模式配置,参数类型为ArkUI_TextMarqueeOptions。 |
返回:
| 类型 | 说明 |
|---|---|
| .object | 文本跑马灯模式配置,参数类型为ArkUI_TextMarqueeOptions。 |
NODE_TEXT_DIRECTION
NODE_TEXT_DIRECTION = 1052
文本排版方向。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 23
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 表示文本的排版方向,取ArkUI_TextDirection枚举值。默认值为ARKUI_TEXT_DIRECTION_DEFAULT。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 表示文本的排版方向,对应取值及含义请参考ArkUI_TextDirection枚举值。 |
NODE_TEXT_SELECTED_DRAG_PREVIEW_STYLE
NODE_TEXT_SELECTED_DRAG_PREVIEW_STYLE = 1053
用于设置文本选中状态下的拖拽预览样式。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 23
参数:
| 参数项 | 描述 |
|---|---|
| .object | 文本选中状态下的拖拽预览样式。参数类型为ArkUI_SelectedDragPreviewStyle。 |
返回:
| 类型 | 说明 |
|---|---|
| .object | 文本选中状态下的拖拽预览样式。参数类型为ArkUI_SelectedDragPreviewStyle。 |
NODE_SPAN_CONTENT
NODE_SPAN_CONTENT = MAX_NODE_SCOPE_NUM * ARKUI_NODE_SPAN = 2000
文本内容属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .string | 表示span的文本内容。 |
返回:
| 类型 | 说明 |
|---|---|
| .string | 表示span的文本内容。 |
NODE_SPAN_TEXT_BACKGROUND_STYLE
NODE_SPAN_TEXT_BACKGROUND_STYLE = 2001
文本背景色属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].u32 | 表示文本背景颜色,0xargb格式,形如0xFFFF0000 表示红色。 第二个参数为文本背景圆角设置,支持如下两种设置方式: - .value[1].f32:四个方向的圆角半径统一设置,单位为vp。 - .value[1].f32:设置左上角圆角半径,单位为vp。 |
| .value[2].f32 | 设置右上角圆角半径,单位为vp。 |
| .value[3].f32 | 设置左下角圆角半径,单位为vp。 |
| .value[4].f32 | 设置右下角圆角半径,单位为vp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].u32 | 文本背景颜色,0xargb格式。 |
| .value[1].f32 | 左上角圆角半径,单位为vp。 |
| .value[2].f32 | 右上角圆角半径,单位为vp。 |
| .value[3].f32 | 左下角圆角半径,单位为vp。 |
| .value[4].f32 | 右下角圆角半径,单位为vp。 |
NODE_SPAN_BASELINE_OFFSET
NODE_SPAN_BASELINE_OFFSET = 2002
文本基线的偏移量属性,支持属性设置,属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 偏移量数值,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 偏移量数值,单位为fp。 |
NODE_SPAN_FONT
NODE_SPAN_FONT = 2003
定义文本样式属性,支持属性设置、属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| .string? | 字体列表,多个字体使用,进行分割。可选。 |
| .value[0].f32 | 文本尺寸,单位为fp。 |
| .value[1]?.i32 | 文本的字体粗细。可选。取值为[100, 900],默认为400。取值越大,字体越粗。 |
| .value[2]?.i32 | 字体样式。可选。参数类型为ArkUI_FontStyle。默认值为ARKUI_FONT_STYLE_NORMAL。 |
| ?.object | 字体配置。可选。参数类型为OH_ArkUI_FontConfigs。 |
返回:
| 类型 | 说明 |
|---|---|
| .string | 字体列表,多个字体使用,进行分割。 |
| .value[0].f32 | 文本尺寸,单位为fp。 |
| .value[1].i32 | 文本的字体粗细,无单位。取值越大,字体越粗。 |
| .value[2].i32 | 字体样式。参数类型为ArkUI_FontStyle。 |
| .object | 字体配置。参数类型为OH_ArkUI_FontConfigs。 |
NODE_SPAN_FONT_WEIGHT
NODE_SPAN_FONT_WEIGHT = 2004
定义文本字体粗细属性,支持属性设置、属性重置和属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 24
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 文本的字体粗细。取值为[100, 900],默认为400。取值越大,字体越粗。 |
| ?.object | 可选。文本字体粗细配置。参数类型为OH_ArkUI_FontWeightConfigs。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 文本字体粗细,无单位。取值越大,字体越粗。 |
| .object | 文本字体粗细配置。参数类型为OH_ArkUI_FontWeightConfigs。 |
NODE_IMAGE_SPAN_SRC
NODE_IMAGE_SPAN_SRC = MAX_NODE_SCOPE_NUM * ARKUI_NODE_IMAGE_SPAN = 3000
imageSpan组件图片地址属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .string | 表示imageSpan的图片地址。 |
| .object | 表示 PixelMap 图片数据,参数类型为ArkUI_DrawableDescriptor。 .object参数和.string参数二选一,不可同时设置。 |
返回:
| 类型 | 说明 |
|---|---|
| .string | 表示imageSpan的图片地址。 |
| .object | 表示 PixelMap 图片数据,参数类型为ArkUI_DrawableDescriptor。 |
NODE_IMAGE_SPAN_VERTICAL_ALIGNMENT
NODE_IMAGE_SPAN_VERTICAL_ALIGNMENT = 3001
图片基于文本的对齐方式属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 表示图片基于文本的对齐方式,取ArkUI_ImageSpanAlignment枚举值。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 表示图片基于文本的对齐方式,取ArkUI_ImageSpanAlignment枚举值。 |
NODE_IMAGE_SPAN_ALT
NODE_IMAGE_SPAN_ALT = 3002
imageSpan组件占位图地址属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 12
参数:
| 参数项 | 描述 |
|---|---|
| .string | 表示image组件占位图地址(不支持gif类型图源)。 |
| .object | 表示 PixelMap 图片数据,参数类型为ArkUI_DrawableDescriptor; .object参数和.string参数二选一,不可同时设置。 |
返回:
| 类型 | 说明 |
|---|---|
| .string | 表示image组件占位图地址。 |
| .object | 表示 PixelMap 图片数据,参数类型为ArkUI_DrawableDescriptor。 |
NODE_IMAGE_SPAN_BASELINE_OFFSET
NODE_IMAGE_SPAN_BASELINE_OFFSET = 3003
imageSpan组件的基线偏移量属性,支持属性设置,属性重置和属性获取接口。偏移量数值为正数时向上偏移,负数时向下偏移,默认值0,单位为fp。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 13
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 | 偏移量数值,单位为fp。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 | 偏移量数值,单位为fp。 |
NODE_IMAGE_SPAN_COLOR_FILTER
NODE_IMAGE_SPAN_COLOR_FILTER = 3004
图片滤镜效果属性,支持属性设置,属性重置,属性获取接口。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 22
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].f32 ~ .value[19].f32 | 表示滤镜矩阵数组。 |
| .size | 表示滤镜数组大小为5x4。 |
| .object | 颜色滤波器指针,参数类型为OH_Drawing_ColorFilter。 .object和.size参数只能二选一,不可同时设置。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].f32 ~ .value[19].f32 | 表示滤镜矩阵数组。 |
| .size | 表示滤镜数组大小为5x4。 |
| .object | 颜色滤波器指针,参数类型为OH_Drawing_ColorFilter。 |
NODE_IMAGE_SPAN_SUPPORT_SVG2
NODE_IMAGE_SPAN_SUPPORT_SVG2 = 3005
通过启用SVG新解析能力开关设置SVG解析功能支持的范围,支持属性设置,属性重置,属性获取接口。ImageSpan组件创建后,不支持动态修改该属性的值。
作为属性设置方法参数、属性获取方法返回值ArkUI_AttributeItem格式如下。
起始版本: 22
参数:
| 参数项 | 描述 |
|---|---|
| .value[0].i32 | 是否启用SVG新解析能力开关。true:支持SVG解析新能力;false:保持原有SVG解析能力。 默认值:false。 |
返回:
| 类型 | 说明 |
|---|---|
| .value[0].i32 | 是否启用SVG新解析能力开关。 |
你可能感兴趣的鸿蒙文章
openharmony 鸿蒙 arkts-apis-uicontext-contextmenucontroller
openharmony 鸿蒙 errorcode-canvas
openharmony 鸿蒙 capi-oh-nativexcomponent-native-xcomponent-oh-nativexcomponent
openharmony 鸿蒙 errorcode-bindSheet
openharmony 鸿蒙 js-apis-arkui-uiExtension-sys
openharmony 鸿蒙 capi-arkui-accessibility-arkui-accessibilityeventinfo
openharmony 鸿蒙 capi-arkui-rendernodeutils
openharmony 鸿蒙 capi-native-node-h-nodeattributetype-layoutcomponent