styled_string.h

概述

在Native侧定义ArkUI_NodeType为ARKUI_NODE_TEXT的组件的文本样式和文本布局管理器。

引用文件： <arkui/styled_string.h>

库： libace_ndk.z.so

系统能力： SystemCapability.ArkUI.ArkUI.Full

起始版本： 12

相关模块： ArkUI_NativeModule

相关示例： StyledStringSample

汇总

结构体

名称	typedef关键字	描述
ArkUI_StyledString	ArkUI_StyledString	定义文本组件支持的格式化字符串数据对象。
OH_ArkUI_SpanStyle	OH_ArkUI_SpanStyle	定义属性字符串样式对象。 可以通过OH_ArkUI_SpanStyle_Create接口创建对应的属性字符串样式对象。 可以通过OH_ArkUI_SpanStyle_Destroy接口销毁属性字符串样式对象。 对象创建后通过OH_ArkUI_SpanStyle_SetStart和OH_ArkUI_SpanStyle_SetLength指定样式作用的范围。 对象创建后通过OH_ArkUI_SpanStyle_SetXXXStyle系列接口设置生效的具体样式，例如通过OH_ArkUI_SpanStyle_SetTextStyle设置字体样式效果。
OH_ArkUI_ImageAttachment	OH_ArkUI_ImageAttachment	定义图片样式对象。 可以通过OH_ArkUI_ImageAttachment_Create接口创建对应的图片样式对象。 可以通过OH_ArkUI_ImageAttachment_Destroy接口销毁图片样式对象。 对象创建后通过OH_ArkUI_ImageAttachment_SetXXX系列接口设置生效的具体样式，例如通过OH_ArkUI_ImageAttachment_SetPixelMap设置图片源。
OH_ArkUI_CustomSpan	OH_ArkUI_CustomSpan	定义自定义绘制Span。 可以通过OH_ArkUI_CustomSpan_Create接口创建对应的自定义绘制Span对象。 可以通过OH_ArkUI_CustomSpan_Destroy接口销毁自定义绘制Span对象。 对象创建后通过OH_ArkUI_CustomSpan_RegisterOnMeasureCallback和OH_ArkUI_CustomSpan_RegisterOnDrawCallback接口注册绘制回调函数。
OH_ArkUI_TextStyle	OH_ArkUI_TextStyle	定义文本字体样式。 可以通过OH_ArkUI_TextStyle_Create接口创建对应的文本字体样式对象。 可以通过OH_ArkUI_TextStyle_Destroy接口销毁文本字体样式对象。 对象创建后通过OH_ArkUI_TextStyle_SetXXX系列接口设置生效的具体样式，例如通过OH_ArkUI_TextStyle_SetFontColor设置字体颜色。
OH_ArkUI_ParagraphStyle	OH_ArkUI_ParagraphStyle	定义段落样式。 可以通过OH_ArkUI_ParagraphStyle_Create接口创建对应的段落样式对象。 可以通过OH_ArkUI_ParagraphStyle_Destroy接口销毁段落样式对象。 对象创建后通过OH_ArkUI_ParagraphStyle_SetXXX系列接口设置生效的具体样式，例如通过OH_ArkUI_ParagraphStyle_SetTextAlign设置文本对齐方式。
OH_ArkUI_GestureStyle	OH_ArkUI_GestureStyle	定义事件手势样式。 可以通过OH_ArkUI_GestureStyle_Create接口创建对应的事件手势样式对象。 可以通过OH_ArkUI_GestureStyle_Destroy接口销毁事件手势样式对象。 对象创建后通过OH_ArkUI_GestureStyle_RegisterOnXXXCallback系列接口注册具体的事件回调，例如通过OH_ArkUI_GestureStyle_RegisterOnClickCallback注册点击事件回调。
OH_ArkUI_TextShadowStyle	OH_ArkUI_TextShadowStyle	定义文本阴影样式。 可以通过OH_ArkUI_TextShadowStyle_Create接口创建对应的文本阴影样式对象。 可以通过OH_ArkUI_TextShadowStyle_Destroy接口销毁文本阴影样式对象。 对象创建后通过OH_ArkUI_TextShadowStyle_SetTextShadow接口设置生效的具体样式。
OH_ArkUI_DecorationStyle	OH_ArkUI_DecorationStyle	定义文本装饰线样式。 可以通过OH_ArkUI_DecorationStyle_Create接口创建对应的文本装饰线样式对象。 可以通过OH_ArkUI_DecorationStyle_Destroy接口销毁文本装饰线样式对象。 对象创建后通过OH_ArkUI_DecorationStyle_SetXXX系列接口设置生效的具体样式，例如通过OH_ArkUI_DecorationStyle_SetTextDecorationType设置装饰线类型。
OH_ArkUI_BaselineOffsetStyle	OH_ArkUI_BaselineOffsetStyle	定义基线偏移量样式。 可以通过OH_ArkUI_BaselineOffsetStyle_Create接口创建对应的基线偏移量样式对象。 可以通过OH_ArkUI_BaselineOffsetStyle_Destroy接口销毁基线偏移量样式对象。 对象创建后通过OH_ArkUI_BaselineOffsetStyle_SetBaselineOffset接口设置具体的基线偏移量值。
OH_ArkUI_LetterSpacingStyle	OH_ArkUI_LetterSpacingStyle	定义字符间距样式。 可以通过OH_ArkUI_LetterSpacingStyle_Create接口创建对应的字符间距样式对象。 可以通过OH_ArkUI_LetterSpacingStyle_Destroy接口销毁字符间距样式对象。 对象创建后通过OH_ArkUI_LetterSpacingStyle_SetLetterSpacing接口设置具体的字符间距值。
OH_ArkUI_LineHeightStyle	OH_ArkUI_LineHeightStyle	定义行高样式。 可以通过OH_ArkUI_LineHeightStyle_Create接口创建对应的行高样式对象。 可以通过OH_ArkUI_LineHeightStyle_Destroy接口销毁行高样式对象。 对象创建后可以通过OH_ArkUI_LineHeightStyle_SetLineHeight接口设置具体的固定行高值。 从API版本26.0.0开始，对象创建后可以通过OH_ArkUI_LineHeightStyle_SetLineHeightMultiple接口设置具体的行高的倍数值。
OH_ArkUI_LineSpacingStyle	OH_ArkUI_LineSpacingStyle	定义行间距样式。 可以通过OH_ArkUI_LineSpacingStyle_Create接口创建对应的行间距样式对象。 可以通过OH_ArkUI_LineSpacingStyle_Destroy接口销毁行间距样式对象。 对象创建后可以通过OH_ArkUI_LineSpacingStyle_SetLineSpacing接口设置具体的行间距值。 对象创建后可以通过OH_ArkUI_LineSpacingStyle_SetOnlyBetweenLines接口设置行间距是否只在行间生效。
OH_ArkUI_UrlStyle	OH_ArkUI_UrlStyle	定义超链接样式。 可以通过OH_ArkUI_UrlStyle_Create接口创建对应的超链接样式对象。 可以通过OH_ArkUI_UrlStyle_Destroy接口销毁超链接样式对象。 对象创建后通过OH_ArkUI_UrlStyle_SetUrl接口设置链接地址。
OH_ArkUI_BackgroundColorStyle	OH_ArkUI_BackgroundColorStyle	定义背景颜色样式。 可以通过OH_ArkUI_BackgroundColorStyle_Create接口创建对应的背景颜色样式对象。 可以通过OH_ArkUI_BackgroundColorStyle_Destroy接口销毁背景颜色样式对象。 对象创建后通过OH_ArkUI_BackgroundColorStyle_SetColor和OH_ArkUI_BackgroundColorStyle_SetRadius接口设置背景颜色和圆角。
OH_ArkUI_UserDataSpan	OH_ArkUI_UserDataSpan	定义用户数据Span样式。 可以通过OH_ArkUI_UserDataSpan_Create接口创建对应的用户数据Span样式对象。 可以通过OH_ArkUI_UserDataSpan_Destroy接口销毁用户数据Span样式对象。 对象创建后通过OH_ArkUI_UserDataSpan_SetUserData接口绑定用户数据。
OH_ArkUI_LeadingMarginSpanDrawInfo	OH_ArkUI_LeadingMarginSpanDrawInfo	定义段落缩进的自定义绘制信息。 可以通过OH_ArkUI_LeadingMarginSpanDrawInfo_Create接口创建对应的段落缩进的自定义绘制信息对象。 可以通过OH_ArkUI_LeadingMarginSpanDrawInfo_Destroy接口销毁段落缩进的自定义绘制信息对象。 对象用于在OH_ArkUI_ParagraphStyle_RegisterOnDrawLeadingMarginCallback注册的回调函数中，提供当前行的绘制上下文信息。
ArkUI_TextLayoutManager	ArkUI_TextLayoutManager	定义文本布局管理器对象。

枚举

名称	typedef关键字	描述
OH_ArkUI_StyledStringKey	OH_ArkUI_StyledStringKey	属性字符串的属性类型枚举。
OH_ArkUI_SuperscriptStyle	OH_ArkUI_SuperscriptStyle	定义文本上下角标样式枚举。

函数

名称	描述
ArkUI_StyledString* OH_ArkUI_StyledString_Create(OH_Drawing_TypographyStyle* style, OH_Drawing_FontCollection* collection)	创建指向ArkUI_StyledString对象的指针。
void OH_ArkUI_StyledString_Destroy(ArkUI_StyledString* handle)	释放被ArkUI_StyledString对象占据的内存。
void OH_ArkUI_StyledString_PushTextStyle(ArkUI_StyledString* handle, OH_Drawing_TextStyle* style)	将新的排版风格设置到当前格式化字符串样式栈顶。
void OH_ArkUI_StyledString_AddText(ArkUI_StyledString* handle, const char* content)	基于当前格式化字符串样式设置对应的文本内容。
void OH_ArkUI_StyledString_PopTextStyle(ArkUI_StyledString* handle)	将当前格式化字符串对象中栈顶样式出栈。
OH_Drawing_Typography* OH_ArkUI_StyledString_CreateTypography(ArkUI_StyledString* handle)	基于格式字符串对象创建指向OH_Drawing_Typography对象的指针，用于提前进行文本测算排版。OH_Drawing_Typography对象的生命周期由应用管理，当应用销毁该对象时，应同步调用NODE_TEXT_CONTENT_WITH_STYLED_STRING对应的reset方法进行置空，避免野指针崩溃风险。
void OH_ArkUI_StyledString_AddPlaceholder(ArkUI_StyledString* handle, OH_Drawing_PlaceholderSpan* placeholder)	设置占位符。
ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_Create(void)	创建属性字符串数据对象。
void OH_ArkUI_StyledString_Descriptor_Destroy(ArkUI_StyledString_Descriptor* descriptor)	释放被ArkUI_StyledString_Descriptor对象占据的内存。
int32_t OH_ArkUI_UnmarshallStyledStringDescriptor(uint8_t* buffer, size_t bufferSize, ArkUI_StyledString_Descriptor* descriptor)	将包含属性字符串信息的字节数组反序列化为属性字符串。
int32_t OH_ArkUI_MarshallStyledStringDescriptor(uint8_t* buffer, size_t bufferSize, ArkUI_StyledString_Descriptor* descriptor, size_t* resultSize)	将属性字符串信息序列化为字节数组。
const char* OH_ArkUI_ConvertToHtml(ArkUI_StyledString_Descriptor* descriptor)	将属性字符串信息转换成html。
ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_CreateWithString(const char* value, const OH_ArkUI_SpanStyle** styles, int32_t length)	创建纯文本内容类型的ArkUI_StyledString_Descriptor对象。
ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_CreateWithImageAttachment(const OH_ArkUI_ImageAttachment* value)	创建图片内容类型的ArkUI_StyledString_Descriptor对象。
ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_CreateWithCustomSpan(const OH_ArkUI_CustomSpan* value)	创建自定义绘制Span内容类型的ArkUI_StyledString_Descriptor对象。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_GetLength(const ArkUI_StyledString_Descriptor* descriptor, int32_t* length)	获取属性字符串的字符长度。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_GetString(const ArkUI_StyledString_Descriptor* descriptor, char* buffer, int32_t bufferSize, int32_t* writeLength)	获取属性字符串的文本内容。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_IsEqual(const ArkUI_StyledString_Descriptor* firstDescriptor, const ArkUI_StyledString_Descriptor* secondDescriptor, bool* isEqual)	判断两个属性字符串是否相同。当属性字符串的文本及样式均一致，视为相同。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_SubStyledString(const ArkUI_StyledString_Descriptor* descriptor, ArkUI_StyledString_Descriptor* subDescriptor, uint32_t start, uint32_t length)	获取属性字符串的子属性字符串。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_GetStyles(const ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length, OH_ArkUI_StyledStringKey styledKey, OH_ArkUI_SpanStyle** styles, uint32_t stylesSize, uint32_t* writeLength)	获取属性字符串指定范围内的样式集合。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_FromHtml(ArkUI_StyledString_Descriptor* descriptor, const char* html)	将HTML格式字符串转换成属性字符串。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_ReplaceString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length, const char* string)	替换属性字符串指定范围的文本。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_InsertString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, const char* string)	在属性字符串的指定位置插入文本。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_RemoveString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length)	移除属性字符串指定范围的文本。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_ReplaceStyle(ArkUI_StyledString_Descriptor* descriptor, const OH_ArkUI_SpanStyle* spanStyle)	替换属性字符串指定范围内的样式。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_SetStyle(ArkUI_StyledString_Descriptor* descriptor, const OH_ArkUI_SpanStyle* spanStyle)	为属性字符串指定范围设置新样式。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_RemoveStyle(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length, OH_ArkUI_StyledStringKey styledKey)	清除属性字符串指定范围内容的指定类型样式。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_ClearStyles(ArkUI_StyledString_Descriptor* descriptor)	清除属性字符串对象的所有样式。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_ReplaceStyledString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length, const ArkUI_StyledString_Descriptor* other)	替换指定范围的属性字符串。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_InsertStyledString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, const ArkUI_StyledString_Descriptor* other)	在属性字符串的指定位置插入新的属性字符串。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_AppendStyledString(ArkUI_StyledString_Descriptor* descriptor, const ArkUI_StyledString_Descriptor* other)	在属性字符串的末尾追加新的属性字符串。
ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_InvalidateCustomSpan(const ArkUI_StyledString_Descriptor* descriptor)	主动刷新属性字符串中的自定义绘制Span。
OH_ArkUI_TextStyle* OH_ArkUI_TextStyle_Create()	创建OH_ArkUI_TextStyle对象。
void OH_ArkUI_TextStyle_Destroy(OH_ArkUI_TextStyle* textStyle)	释放OH_ArkUI_TextStyle对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_TextStyle_SetFontColor(OH_ArkUI_TextStyle* textStyle, uint32_t fontColor)	设置文本字体样式中的字体颜色。
ArkUI_ErrorCode OH_ArkUI_TextStyle_GetFontColor(const OH_ArkUI_TextStyle* textStyle, uint32_t* fontColor)	获取文本字体样式中的字体颜色。
ArkUI_ErrorCode OH_ArkUI_TextStyle_SetFontFamily(OH_ArkUI_TextStyle* textStyle, const char* fontFamily)	设置文本字体样式中的字体族。
ArkUI_ErrorCode OH_ArkUI_TextStyle_GetFontFamily(const OH_ArkUI_TextStyle* textStyle, char* buffer, int32_t bufferSize, int32_t* writeLength)	获取文本字体样式中的字体族。
ArkUI_ErrorCode OH_ArkUI_TextStyle_SetFontSize(OH_ArkUI_TextStyle* textStyle, float fontSize)	设置文本字体样式中的字体大小。
ArkUI_ErrorCode OH_ArkUI_TextStyle_GetFontSize(const OH_ArkUI_TextStyle* textStyle, float* fontSize)	获取文本字体样式中的字体大小。
ArkUI_ErrorCode OH_ArkUI_TextStyle_SetFontWeight(OH_ArkUI_TextStyle* textStyle, uint32_t fontWeight)	设置文本字体样式中的字体粗细。
ArkUI_ErrorCode OH_ArkUI_TextStyle_GetFontWeight(const OH_ArkUI_TextStyle* textStyle, uint32_t* fontWeight)	获取文本字体样式中的字体粗细。
ArkUI_ErrorCode OH_ArkUI_TextStyle_SetFontStyle(OH_ArkUI_TextStyle* textStyle, ArkUI_FontStyle fontStyle)	设置文本字体样式中的字体风格。
ArkUI_ErrorCode OH_ArkUI_TextStyle_GetFontStyle(const OH_ArkUI_TextStyle* textStyle, ArkUI_FontStyle* fontStyle)	获取文本字体样式中的字体风格。
ArkUI_ErrorCode OH_ArkUI_TextStyle_SetStrokeWidth(OH_ArkUI_TextStyle* textStyle, float strokeWidth)	设置文本字体样式中的描边宽度。
ArkUI_ErrorCode OH_ArkUI_TextStyle_GetStrokeWidth(const OH_ArkUI_TextStyle* textStyle, float* strokeWidth)	获取文本字体样式中的描边宽度。
ArkUI_ErrorCode OH_ArkUI_TextStyle_SetStrokeColor(OH_ArkUI_TextStyle* textStyle, uint32_t strokeColor)	设置文本字体样式中的描边颜色。
ArkUI_ErrorCode OH_ArkUI_TextStyle_GetStrokeColor(const OH_ArkUI_TextStyle* textStyle, uint32_t* strokeColor)	获取文本字体样式中的描边颜色。
ArkUI_ErrorCode OH_ArkUI_TextStyle_SetSuperscript(OH_ArkUI_TextStyle* textStyle, OH_ArkUI_SuperscriptStyle superscript)	设置文本字体样式中的上下标样式。
ArkUI_ErrorCode OH_ArkUI_TextStyle_GetSuperscript(const OH_ArkUI_TextStyle* textStyle, OH_ArkUI_SuperscriptStyle* superscript)	获取文本字体样式中的上下标样式。
OH_ArkUI_SpanStyle* OH_ArkUI_SpanStyle_Create()	创建OH_ArkUI_SpanStyle对象。
void OH_ArkUI_SpanStyle_Destroy(OH_ArkUI_SpanStyle* spanStyle)	释放OH_ArkUI_SpanStyle对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetStyledKey(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_StyledStringKey* styledKey)	获取属性字符串样式对象的样式类型。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetStart(OH_ArkUI_SpanStyle* spanStyle, int32_t start)	设置属性字符串样式对象的起始位置。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetStart(const OH_ArkUI_SpanStyle* spanStyle, int32_t* start)	获取属性字符串样式对象的起始位置。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetLength(OH_ArkUI_SpanStyle* spanStyle, int32_t length)	设置属性字符串样式对象的长度。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetLength(const OH_ArkUI_SpanStyle* spanStyle, int32_t* length)	获取属性字符串样式对象的长度。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetTextStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_TextStyle* textStyle)	设置属性字符串样式对象的文本字体样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetTextStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_TextStyle* textStyle)	获取属性字符串样式对象的文本字体样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetParagraphStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_ParagraphStyle* paragraphStyle)	设置属性字符串样式对象的段落样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetParagraphStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_ParagraphStyle* paragraphStyle)	获取属性字符串样式对象的段落样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetGestureStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_GestureStyle* gestureStyle)	设置属性字符串样式对象的事件手势样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetGestureStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_GestureStyle* gestureStyle)	获取属性字符串样式对象的事件手势样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetTextShadowStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_TextShadowStyle* textShadowStyle)	设置属性字符串样式对象的文本阴影样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetTextShadowStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_TextShadowStyle* textShadowStyle)	获取属性字符串样式对象的文本阴影样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetDecorationStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_DecorationStyle* decorationStyle)	设置属性字符串样式对象的文本装饰线样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetDecorationStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_DecorationStyle* decorationStyle)	获取属性字符串样式对象的文本装饰线样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetBaselineOffsetStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle)	设置属性字符串样式对象的基线偏移量样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetBaselineOffsetStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle)	获取属性字符串样式对象的基线偏移量样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetLetterSpacingStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_LetterSpacingStyle* letterSpacingStyle)	设置属性字符串样式对象的字符间距样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetLetterSpacingStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_LetterSpacingStyle* letterSpacingStyle)	获取属性字符串样式对象的字符间距样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetLineHeightStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_LineHeightStyle* lineHeightStyle)	设置属性字符串样式对象的行高样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetLineHeightStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_LineHeightStyle* lineHeightStyle)	获取属性字符串样式对象的行高样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetUrlStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_UrlStyle* urlStyle)	设置属性字符串样式对象的超链接样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetUrlStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_UrlStyle* urlStyle)	获取属性字符串样式对象的超链接样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetBackgroundColorStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_BackgroundColorStyle* backgroundColorStyle)	设置属性字符串样式对象的背景颜色样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetBackgroundColorStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_BackgroundColorStyle* backgroundColorStyle)	获取属性字符串样式对象的背景颜色样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetUserDataSpan(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_UserDataSpan* userDataSpan)	设置属性字符串样式对象的用户数据Span样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetUserDataSpan(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_UserDataSpan* userDataSpan)	获取属性字符串样式对象的用户数据Span样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetCustomSpan(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_CustomSpan* customSpan)	设置属性字符串样式对象的自定义绘制Span样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetCustomSpan(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_CustomSpan* customSpan)	获取属性字符串样式对象的自定义绘制Span样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetImageAttachment(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_ImageAttachment* imageAttachment)	设置属性字符串样式对象的图片样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetImageAttachment(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_ImageAttachment* imageAttachment)	获取属性字符串样式对象的图片样式。
OH_ArkUI_LeadingMarginSpanDrawInfo* OH_ArkUI_LeadingMarginSpanDrawInfo_Create()	创建OH_ArkUI_LeadingMarginSpanDrawInfo对象。
void OH_ArkUI_LeadingMarginSpanDrawInfo_Destroy(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo)	释放OH_ArkUI_LeadingMarginSpanDrawInfo对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetX(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float x)	设置段落缩进的自定义绘制信息对象中当前行相对于组件的水平偏移。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetX(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float* x)	获取段落缩进的自定义绘制信息对象中当前行相对于组件的水平偏移。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetTop(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float top)	设置段落缩进的自定义绘制信息对象中行顶与组件上边缘的距离。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetTop(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float* top)	获取段落缩进的自定义绘制信息对象中行顶与组件上边缘的距离。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetBottom(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float bottom)	设置段落缩进的自定义绘制信息对象中行底与组件上边缘的距离。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetBottom(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float* bottom)	获取段落缩进的自定义绘制信息对象中行底与组件上边缘的距离。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetBaseline(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float baseline)	设置段落缩进的自定义绘制信息对象中当前行的基线与组件上边缘的距离。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetBaseline(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float* baseline)	获取段落缩进的自定义绘制信息对象中当前行的基线与组件上边缘的距离。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetTextDirection(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, ArkUI_TextDirection direction)	设置段落缩进的自定义绘制信息对象中文本内容的方向。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetTextDirection(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, ArkUI_TextDirection* direction)	获取段落缩进的自定义绘制信息对象中文本内容的方向。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetStart(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, uint32_t start)	设置段落缩进的自定义绘制信息对象中当前行的起始索引。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetStart(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, uint32_t* start)	获取段落缩进的自定义绘制信息对象中当前行的起始索引。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetEnd(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, uint32_t end)	设置段落缩进的自定义绘制信息对象中当前行的结束索引。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetEnd(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, uint32_t* end)	获取段落缩进的自定义绘制信息对象中当前行的结束索引。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetFirst(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, bool first)	设置段落缩进的自定义绘制信息对象中当前行是否为段落的首行。
ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetFirst(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, bool* first)	获取段落缩进的自定义绘制信息对象中当前行是否为段落的首行。
OH_ArkUI_ParagraphStyle* OH_ArkUI_ParagraphStyle_Create()	创建OH_ArkUI_ParagraphStyle对象。
void OH_ArkUI_ParagraphStyle_Destroy(OH_ArkUI_ParagraphStyle* paragraphStyle)	释放OH_ArkUI_ParagraphStyle对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetTextAlign(OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextAlignment align)	设置段落样式中的水平方向的文本对齐方式。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetTextAlign(const OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextAlignment* align)	获取段落样式中的水平方向的文本对齐方式。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetTextIndent(OH_ArkUI_ParagraphStyle* paragraphStyle, float textIndent)	设置段落样式中的首行文本缩进。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetTextIndent(const OH_ArkUI_ParagraphStyle* paragraphStyle, float* textIndent)	获取段落样式中的首行文本缩进。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetMaxLines(OH_ArkUI_ParagraphStyle* paragraphStyle, int32_t maxLines)	设置段落样式中的最大行数。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetMaxLines(const OH_ArkUI_ParagraphStyle* paragraphStyle, int32_t* maxLines)	获取段落样式中的最大行数。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetOverflow(OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextOverflow overflow)	设置段落样式中的段落超长时的显示方式。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetOverflow(const OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextOverflow* overflow)	获取段落样式中的段落超长时的显示方式。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetWordBreak(OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_WordBreak wordBreak)	设置段落样式中的断行规则。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetWordBreak(const OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_WordBreak* wordBreak)	获取段落样式中的断行规则。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetLeadingMarginPixelMap(OH_ArkUI_ParagraphStyle* paragraphStyle, struct OH_PixelmapNative* pixelmap)	设置段落样式中的段落缩进的像素图。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetLeadingMarginPixelMap(const OH_ArkUI_ParagraphStyle* paragraphStyle, struct OH_PixelmapNative** pixelmap)	获取段落样式中的段落缩进的像素图。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetLeadingMarginWidth(OH_ArkUI_ParagraphStyle* paragraphStyle, uint32_t width)	设置段落样式中的段落缩进宽度。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetLeadingMarginWidth(const OH_ArkUI_ParagraphStyle* paragraphStyle, uint32_t* width)	获取段落样式中的段落缩进宽度。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetLeadingMarginHeight(OH_ArkUI_ParagraphStyle* paragraphStyle, uint32_t height)	设置段落样式中的段落缩进高度。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetLeadingMarginHeight(const OH_ArkUI_ParagraphStyle* paragraphStyle, uint32_t* height)	获取段落样式中的段落缩进高度。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetParagraphSpacing(OH_ArkUI_ParagraphStyle* paragraphStyle, uint32_t paragraphSpacing)	设置段落样式中的段落间距。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetParagraphSpacing(const OH_ArkUI_ParagraphStyle* paragraphStyle, uint32_t* paragraphSpacing)	获取段落样式中的段落间距。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetTextVerticalAlign(OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextVerticalAlignment verticalAlignment)	设置段落样式中的垂直方向的文本对齐方式。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetTextVerticalAlign(const OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextVerticalAlignment* verticalAlignment)	获取段落样式中的垂直方向的文本对齐方式。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_RegisterOnDrawLeadingMarginCallback(OH_ArkUI_ParagraphStyle* paragraphStyle, void(*onDraw)(ArkUI_DrawContext* context, OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo))	设置段落样式中绘制段落缩进时触发的回调函数。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_RegisterOnGetLeadingMarginCallback(OH_ArkUI_ParagraphStyle* paragraphStyle, float(*leadingMargin)())	设置段落样式中获取段落缩进距离时触发的回调函数。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetTextDirection(OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextDirection textDirection)	设置段落样式中的文本方向。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetTextDirection(const OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextDirection* textDirection)	获取段落样式中的文本方向。
OH_ArkUI_GestureStyle* OH_ArkUI_GestureStyle_Create()	创建OH_ArkUI_GestureStyle对象。
void OH_ArkUI_GestureStyle_Destroy(OH_ArkUI_GestureStyle* gestureStyle)	释放OH_ArkUI_GestureStyle对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_GestureStyle_RegisterOnClickCallback(OH_ArkUI_GestureStyle* gestureStyle, void(*onClick)(ArkUI_NodeEvent*))	设置事件手势样式中的点击事件回调。
ArkUI_ErrorCode OH_ArkUI_GestureStyle_RegisterOnLongPressCallback(OH_ArkUI_GestureStyle* gestureStyle, void(*onLongPress)(ArkUI_GestureEvent*))	设置事件手势样式中的长按事件回调。
ArkUI_ErrorCode OH_ArkUI_GestureStyle_RegisterOnTouchCallback(OH_ArkUI_GestureStyle* gestureStyle, void(*onTouch)(ArkUI_NodeEvent*))	设置事件手势样式中的触摸事件回调。
OH_ArkUI_TextShadowStyle* OH_ArkUI_TextShadowStyle_Create()	创建OH_ArkUI_TextShadowStyle对象。
void OH_ArkUI_TextShadowStyle_Destroy(OH_ArkUI_TextShadowStyle* textShadowStyle)	释放OH_ArkUI_TextShadowStyle对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_TextShadowStyle_SetTextShadow(OH_ArkUI_TextShadowStyle* textShadowStyle, const OH_ArkUI_ShadowOptions** options, uint32_t length)	设置文本阴影样式的文本阴影选项。
ArkUI_ErrorCode OH_ArkUI_TextShadowStyle_GetTextShadow(const OH_ArkUI_TextShadowStyle* textShadowStyle, OH_ArkUI_ShadowOptions** shadowOptions, uint32_t shadowOptionsSize, uint32_t* writeLength)	获取文本阴影样式的文本阴影选项。
OH_ArkUI_DecorationStyle* OH_ArkUI_DecorationStyle_Create()	创建OH_ArkUI_DecorationStyle对象。
void OH_ArkUI_DecorationStyle_Destroy(OH_ArkUI_DecorationStyle* decorationStyle)	释放OH_ArkUI_DecorationStyle对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_DecorationStyle_SetTextDecorationType(OH_ArkUI_DecorationStyle* decorationStyle, ArkUI_TextDecorationType type)	设置文本装饰线样式的装饰线类型。
ArkUI_ErrorCode OH_ArkUI_DecorationStyle_GetTextDecorationType(const OH_ArkUI_DecorationStyle* decorationStyle, ArkUI_TextDecorationType* type)	获取文本装饰线样式的装饰线类型。
ArkUI_ErrorCode OH_ArkUI_DecorationStyle_SetColor(OH_ArkUI_DecorationStyle* decorationStyle, uint32_t color)	设置文本装饰线样式的装饰线颜色。
ArkUI_ErrorCode OH_ArkUI_DecorationStyle_GetColor(const OH_ArkUI_DecorationStyle* decorationStyle, uint32_t* color)	获取文本装饰线样式的装饰线颜色。
ArkUI_ErrorCode OH_ArkUI_DecorationStyle_SetTextDecorationStyle(OH_ArkUI_DecorationStyle* decorationStyle, ArkUI_TextDecorationStyle style)	设置文本装饰线样式的装饰线样式。
ArkUI_ErrorCode OH_ArkUI_DecorationStyle_GetTextDecorationStyle(const OH_ArkUI_DecorationStyle* decorationStyle, ArkUI_TextDecorationStyle* style)	获取文本装饰线样式的装饰线样式。
ArkUI_ErrorCode OH_ArkUI_DecorationStyle_SetThicknessScale(OH_ArkUI_DecorationStyle* decorationStyle, float thicknessScale)	设置文本装饰线样式的装饰线的粗细缩放比例。
ArkUI_ErrorCode OH_ArkUI_DecorationStyle_GetThicknessScale(const OH_ArkUI_DecorationStyle* decorationStyle, float* thicknessScale)	获取文本装饰线样式的装饰线的粗细缩放比例。
ArkUI_ErrorCode OH_ArkUI_DecorationStyle_SetEnableMultiType(OH_ArkUI_DecorationStyle* decorationStyle, bool enableMultiType)	设置文本装饰线样式中是否开启多装饰线显示。
ArkUI_ErrorCode OH_ArkUI_DecorationStyle_GetEnableMultiType(const OH_ArkUI_DecorationStyle* decorationStyle, bool* enableMultiType)	获取文本装饰线样式中是否开启多装饰线显示。
OH_ArkUI_BaselineOffsetStyle* OH_ArkUI_BaselineOffsetStyle_Create()	创建OH_ArkUI_BaselineOffsetStyle对象。
void OH_ArkUI_BaselineOffsetStyle_Destroy(OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle)	释放OH_ArkUI_BaselineOffsetStyle对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_BaselineOffsetStyle_SetBaselineOffset(OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle, float baselineOffset)	设置基线偏移量。
ArkUI_ErrorCode OH_ArkUI_BaselineOffsetStyle_GetBaselineOffset(const OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle, float* baselineOffset)	获取基线偏移量。
OH_ArkUI_LetterSpacingStyle* OH_ArkUI_LetterSpacingStyle_Create()	创建OH_ArkUI_LetterSpacingStyle对象。
void OH_ArkUI_LetterSpacingStyle_Destroy(OH_ArkUI_LetterSpacingStyle* letterSpacingStyle)	释放OH_ArkUI_LetterSpacingStyle对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_LetterSpacingStyle_SetLetterSpacing(OH_ArkUI_LetterSpacingStyle* letterSpacingStyle, float letterSpacing)	设置字符间距。
ArkUI_ErrorCode OH_ArkUI_LetterSpacingStyle_GetLetterSpacing(const OH_ArkUI_LetterSpacingStyle* letterSpacingStyle, float* letterSpacing)	获取字符间距。
OH_ArkUI_LineHeightStyle* OH_ArkUI_LineHeightStyle_Create()	创建OH_ArkUI_LineHeightStyle对象。
void OH_ArkUI_LineHeightStyle_Destroy(OH_ArkUI_LineHeightStyle* lineHeightStyle)	释放OH_ArkUI_LineHeightStyle对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_LineHeightStyle_SetLineHeight(OH_ArkUI_LineHeightStyle* lineHeightStyle, float lineHeight)	设置文本行高。
ArkUI_ErrorCode OH_ArkUI_LineHeightStyle_GetLineHeight(const OH_ArkUI_LineHeightStyle* lineHeightStyle, float* lineHeight)	获取文本行高。
ArkUI_ErrorCode OH_ArkUI_LineHeightStyle_SetLineHeightMultiple(OH_ArkUI_LineHeightStyle* lineHeightStyle, float lineHeightMultiple)	设置行高样式的行高倍数。
ArkUI_ErrorCode OH_ArkUI_LineHeightStyle_GetLineHeightMultiple(const OH_ArkUI_LineHeightStyle* lineHeightStyle, float* lineHeightMultiple)	获取行高样式的行高倍数。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetLineSpacingStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_LineSpacingStyle* lineSpacingStyle)	设置属性字符串样式对象的行间距样式。
ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetLineSpacingStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_LineSpacingStyle* lineSpacingStyle)	获取属性字符串样式对象的行间距样式。
OH_ArkUI_LineSpacingStyle* OH_ArkUI_LineSpacingStyle_Create()	创建OH_ArkUI_LineSpacingStyle对象。
void OH_ArkUI_LineSpacingStyle_Destroy(OH_ArkUI_LineSpacingStyle* lineSpacingStyle)	释放OH_ArkUI_LineSpacingStyle对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_LineSpacingStyle_SetLineSpacing(OH_ArkUI_LineSpacingStyle* lineSpacingStyle, float lineSpacing)	设置行间距。
ArkUI_ErrorCode OH_ArkUI_LineSpacingStyle_GetLineSpacing(const OH_ArkUI_LineSpacingStyle* lineSpacingStyle, float* lineSpacing)	查询行间距。
ArkUI_ErrorCode OH_ArkUI_LineSpacingStyle_SetOnlyBetweenLines(OH_ArkUI_LineSpacingStyle* lineSpacingStyle, bool onlyBetweenLines)	设置行间距是否只在行间生效。
ArkUI_ErrorCode OH_ArkUI_LineSpacingStyle_GetOnlyBetweenLines(const OH_ArkUI_LineSpacingStyle* lineSpacingStyle, bool* onlyBetweenLines)	查询行间距是否只在行间生效。
OH_ArkUI_BackgroundColorStyle* OH_ArkUI_BackgroundColorStyle_Create()	创建OH_ArkUI_BackgroundColorStyle对象。
void OH_ArkUI_BackgroundColorStyle_Destroy(OH_ArkUI_BackgroundColorStyle* style)	释放OH_ArkUI_BackgroundColorStyle对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_BackgroundColorStyle_SetColor(OH_ArkUI_BackgroundColorStyle* style, uint32_t color)	设置背景颜色样式的背景色。
ArkUI_ErrorCode OH_ArkUI_BackgroundColorStyle_GetColor(const OH_ArkUI_BackgroundColorStyle* style, uint32_t* color)	获取背景颜色样式的背景色。
ArkUI_ErrorCode OH_ArkUI_BackgroundColorStyle_SetRadius(OH_ArkUI_BackgroundColorStyle* style, float topLeft, float topRight, float bottomLeft, float bottomRight)	设置背景颜色样式的背景圆角。
ArkUI_ErrorCode OH_ArkUI_BackgroundColorStyle_GetRadius(const OH_ArkUI_BackgroundColorStyle* style, float* topLeft, float* topRight, float* bottomLeft, float* bottomRight)	获取背景颜色样式的背景圆角。
OH_ArkUI_UrlStyle* OH_ArkUI_UrlStyle_Create()	创建OH_ArkUI_UrlStyle对象。
void OH_ArkUI_UrlStyle_Destroy(OH_ArkUI_UrlStyle* style)	释放OH_ArkUI_UrlStyle对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_UrlStyle_SetUrl(OH_ArkUI_UrlStyle* style, const char* url)	设置超链接样式的超链接内容。
ArkUI_ErrorCode OH_ArkUI_UrlStyle_GetUrl(const OH_ArkUI_UrlStyle* style, char* buffer, int32_t bufferSize, int32_t* writeLength)	获取超链接样式的超链接内容。
OH_ArkUI_UserDataSpan* OH_ArkUI_UserDataSpan_Create()	创建OH_ArkUI_UserDataSpan对象。
void OH_ArkUI_UserDataSpan_Destroy(OH_ArkUI_UserDataSpan* userDataSpan)	释放OH_ArkUI_UserDataSpan对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_UserDataSpan_SetUserData(OH_ArkUI_UserDataSpan* userDataSpan, void* userData)	设置用户数据Span样式中的用户数据。
ArkUI_ErrorCode OH_ArkUI_UserDataSpan_GetUserData(const OH_ArkUI_UserDataSpan* userDataSpan, void** userData)	获取用户数据Span样式中的用户数据。
OH_ArkUI_CustomSpan* OH_ArkUI_CustomSpan_Create()	创建OH_ArkUI_CustomSpan对象。
void OH_ArkUI_CustomSpan_Destroy(OH_ArkUI_CustomSpan* customSpan)	释放OH_ArkUI_CustomSpan对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_CustomSpan_RegisterOnMeasureCallback(OH_ArkUI_CustomSpan* customSpan, ArkUI_CustomSpanMetrics*(*onMeasure)(float))	设置自定义绘制Span获取尺寸大小时的回调函数。
ArkUI_ErrorCode OH_ArkUI_CustomSpan_RegisterOnDrawCallback(OH_ArkUI_CustomSpan* customSpan, void(*onDraw)(ArkUI_DrawContext*, ArkUI_CustomSpanDrawInfo*))	注册自定义绘制Span绘制时的回调函数。
OH_ArkUI_ImageAttachment* OH_ArkUI_ImageAttachment_Create()	创建OH_ArkUI_ImageAttachment对象。
void OH_ArkUI_ImageAttachment_Destroy(OH_ArkUI_ImageAttachment* imageAttachment)	释放OH_ArkUI_ImageAttachment对象占用的内存。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetPixelMap(OH_ArkUI_ImageAttachment* imageAttachment, struct OH_PixelmapNative* pixelmap)	设置图片样式中的图片数据源。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetPixelMap(const OH_ArkUI_ImageAttachment* imageAttachment, struct OH_PixelmapNative** pixelmap)	获取图片样式中的图片数据源。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetResource(OH_ArkUI_ImageAttachment* imageAttachment, const char* resource)	设置图片样式中的图片资源地址。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetResource(const OH_ArkUI_ImageAttachment* imageAttachment, char* buffer, int32_t bufferSize, int32_t* writeLength)	获取图片样式中的图片资源地址。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetSizeWidth(OH_ArkUI_ImageAttachment* imageAttachment, float width)	设置图片样式中的图片宽度。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetSizeWidth(const OH_ArkUI_ImageAttachment* imageAttachment, float* width)	获取图片样式中的图片宽度。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetSizeHeight(OH_ArkUI_ImageAttachment* imageAttachment, float height)	设置图片样式中的图片高度。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetSizeHeight(const OH_ArkUI_ImageAttachment* imageAttachment, float* height)	获取图片样式中的图片高度。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetVerticalAlign(OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_ImageSpanAlignment verticalAlign)	设置图片样式中的图片对齐方式。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetVerticalAlign(const OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_ImageSpanAlignment* verticalAlign)	获取图片样式中的图片对齐方式。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetObjectFit(OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_ObjectFit objectFit)	设置图片样式中的图片缩放类型。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetObjectFit(const OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_ObjectFit* objectFit)	获取图片样式中的图片缩放类型。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetMargin(OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_Margin margin)	设置图片样式中的图片外边距。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetMargin(const OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_Margin* margin)	获取图片样式中的图片外边距。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetPadding(OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_Margin padding)	设置图片样式中的图片内边距。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetPadding(const OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_Margin* padding)	获取图片样式中的图片内边距。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetBorderRadiuses(OH_ArkUI_ImageAttachment* imageAttachment, float topLeft, float topRight, float bottomLeft, float bottomRight)	设置图片样式中的图片圆角。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetBorderRadiuses(const OH_ArkUI_ImageAttachment* imageAttachment, float* topLeft, float* topRight, float* bottomLeft, float* bottomRight)	获取图片样式中的图片圆角。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetColorFilter(OH_ArkUI_ImageAttachment* imageAttachment, const float* colorFilter, uint32_t size)	设置图片样式中的图片颜色过滤器。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetColorFilter(const OH_ArkUI_ImageAttachment* imageAttachment, float** colorFilter, uint32_t colorFilterSize, uint32_t* writeLength)	获取图片样式中的图片颜色过滤器。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetDrawingColorFilter(OH_ArkUI_ImageAttachment* imageAttachment, const OH_Drawing_ColorFilter* drawingColorFilter)	设置图片样式中的图片颜色滤镜。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetDrawingColorFilter(const OH_ArkUI_ImageAttachment* imageAttachment, OH_Drawing_ColorFilter* drawingColorFilter)	获取图片样式中的图片颜色滤镜。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetSyncLoad(OH_ArkUI_ImageAttachment* imageAttachment, bool syncLoad)	设置图片样式中是否同步加载图片。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetSyncLoad(const OH_ArkUI_ImageAttachment* imageAttachment, bool* syncLoad)	获取图片样式中是否同步加载图片。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetSupportSvg(OH_ArkUI_ImageAttachment* imageAttachment, bool supportSvg)	设置图片样式中是否开启SVG标签解析能力增强功能。
ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetSupportSvg(const OH_ArkUI_ImageAttachment* imageAttachment, bool* supportSvg)	获取图片样式中是否开启SVG标签解析能力增强功能。
ArkUI_ErrorCode OH_ArkUI_TextEditorChangeEvent_GetRangeBefore(const OH_ArkUI_TextEditorChangeEvent* event, uint32_t* start, uint32_t* end)	获取文本变化信息中的待替换内容的范围。
ArkUI_ErrorCode OH_ArkUI_TextEditorChangeEvent_GetReplacementStyledString(const OH_ArkUI_TextEditorChangeEvent* event, ArkUI_StyledString_Descriptor* descriptor)	获取文本变化信息中的用于替换的属性字符串。
ArkUI_ErrorCode OH_ArkUI_TextEditorChangeEvent_GetPreviewStyledString(const OH_ArkUI_TextEditorChangeEvent* event, ArkUI_StyledString_Descriptor* descriptor)	获取文本变化信息中的预览内容属性字符串。
void OH_ArkUI_TextLayoutManager_Dispose(ArkUI_TextLayoutManager* layoutManager)	释放被文本布局管理器对象占据的内存。
ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetLineCount(ArkUI_TextLayoutManager* layoutManager, int32_t* outLineCount)	获取文本行数。
ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetRectsForRange(ArkUI_TextLayoutManager* layoutManager, int32_t start, int32_t end, OH_Drawing_RectWidthStyle widthStyle, OH_Drawing_RectHeightStyle heightStyle, OH_Drawing_TextBox** outTextBoxes)	获取给定的矩形区域宽度样式以及高度样式的规格下，文本中任意区间范围内的字符或占位符所占的绘制区域信息。
ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetGlyphPositionAtCoordinate(ArkUI_TextLayoutManager* layoutManager, double dx, double dy, OH_Drawing_PositionAndAffinity** outPos)	获取距离给定坐标最近的字形的位置信息。
ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetLineMetrics(ArkUI_TextLayoutManager* layoutManager, int32_t lineNumber, OH_Drawing_LineMetrics* outMetrics)	获取指定行的行信息、文本样式信息、以及字体属性信息。
ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetCharacterPositionAtCoordinate(ArkUI_TextLayoutManager* layoutManager, double dx, double dy, OH_Drawing_PositionAndAffinity** outPos)	获取距离指定坐标最近的字符的位置信息。
ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetGlyphRangeForCharacterRange(ArkUI_TextLayoutManager* layoutManager, OH_Drawing_Range* charRange, OH_Drawing_Range** outGlyphRange, OH_Drawing_Range** outActualCharRange)	获取由指定字符范围所生成的字形范围。
ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetCharacterRangeForGlyphRange(ArkUI_TextLayoutManager* layoutManager, OH_Drawing_Range* glyphRange, OH_Drawing_Range** outCharRange, OH_Drawing_Range** outActualGlyphRange)	获取由指定字形范围所生成的字符范围。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetLinearGradient(OH_ArkUI_ParagraphStyle* paragraphStyle, const OH_ArkUI_LinearGradientOptions* linearGradient)	设置段落样式的线性渐变。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetLinearGradient(const OH_ArkUI_ParagraphStyle* paragraphStyle, OH_ArkUI_LinearGradientOptions* linearGradient)	获取段落样式的线性渐变。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetRadialGradient(OH_ArkUI_ParagraphStyle* paragraphStyle, const OH_ArkUI_RadialGradientOptions* radialGradient)	设置段落样式的径向渐变。
ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetRadialGradient(const OH_ArkUI_ParagraphStyle* paragraphStyle, OH_ArkUI_RadialGradientOptions* radialGradient)	获取段落样式的径向渐变。

枚举类型说明

OH_ArkUI_StyledStringKey

enum OH_ArkUI_StyledStringKey

描述

属性字符串的样式类型枚举。

起始版本： 24

枚举项	描述
OH_ARKUI_STYLEDSTRINGKEY_UNSPECIFIED = -1	未指定样式。
OH_ARKUI_STYLEDSTRINGKEY_FONT = 0	文本字体样式。
OH_ARKUI_STYLEDSTRINGKEY_DECORATION = 1	文本装饰线样式。
OH_ARKUI_STYLEDSTRINGKEY_BASELINE_OFFSET = 2	文本基线偏移量样式。
OH_ARKUI_STYLEDSTRINGKEY_LETTER_SPACING = 3	文本字符间距样式。
OH_ARKUI_STYLEDSTRINGKEY_TEXT_SHADOW = 4	文本阴影样式。
OH_ARKUI_STYLEDSTRINGKEY_LINE_HEIGHT = 5	文本行高样式。
OH_ARKUI_STYLEDSTRINGKEY_BACKGROUND_COLOR = 6	文本背景颜色样式。
OH_ARKUI_STYLEDSTRINGKEY_URL = 7	超链接样式。
OH_ARKUI_STYLEDSTRINGKEY_LINE_SPACING = 8	文本行间距样式。起始版本： 26.0.0
OH_ARKUI_STYLEDSTRINGKEY_GESTURE = 100	事件手势样式。
OH_ARKUI_STYLEDSTRINGKEY_PARAGRAPH_STYLE = 200	文本段落样式。
OH_ARKUI_STYLEDSTRINGKEY_IMAGE = 300	图片样式。
OH_ARKUI_STYLEDSTRINGKEY_CUSTOM_SPAN = 400	自定义绘制Span样式。
OH_ARKUI_STYLEDSTRINGKEY_USER_DATA = 500	用户数据Span样式。

OH_ArkUI_SuperscriptStyle

enum OH_ArkUI_SuperscriptStyle

描述

定义文本上下角标样式枚举。

起始版本： 24

枚举项	描述
OH_ARKUI_SUPERSCRIPTSTYLE_NORMAL = 0	普通文本样式。
OH_ARKUI_SUPERSCRIPTSTYLE_SUPERSCRIPT = 1	上标文本样式。
OH_ARKUI_SUPERSCRIPTSTYLE_SUBSCRIPT = 2	下标文本样式。

函数说明

OH_ArkUI_StyledString_Create()

ArkUI_StyledString* OH_ArkUI_StyledString_Create(OH_Drawing_TypographyStyle* style, OH_Drawing_FontCollection* collection)

描述：

创建指向ArkUI_StyledString对象的指针。

起始版本： 12

参数：

参数项	描述
OH_Drawing_TypographyStyle* style	指向OH_Drawing_TypographyStyle的指针，由OH_Drawing_CreateTypographyStyle获取。
OH_Drawing_FontCollection* collection	指向OH_Drawing_FontCollection的指针，由OH_Drawing_CreateFontCollection获取。

返回：

类型	说明
ArkUI_StyledString*	创建指向ArkUI_StyledString对象的指针。如果对象返回空指针，表示创建失败，失败的原因是地址空间已满，或者是style，collection参数异常如空指针。

OH_ArkUI_StyledString_Destroy()

void OH_ArkUI_StyledString_Destroy(ArkUI_StyledString* handle)

描述：

释放被ArkUI_StyledString对象占据的内存。

起始版本： 12

参数：

参数项	描述
ArkUI_StyledString* handle	指向ArkUI_StyledString对象的指针。

OH_ArkUI_StyledString_PushTextStyle()

void OH_ArkUI_StyledString_PushTextStyle(ArkUI_StyledString* handle, OH_Drawing_TextStyle* style)

描述：

将新的排版风格设置到当前格式化字符串样式栈顶。

起始版本： 12

参数：

参数项	描述
ArkUI_StyledString* handle	指向ArkUI_StyledString对象的指针。
OH_Drawing_TextStyle* style	指向OH_Drawing_TextStyle对象的指针。

OH_ArkUI_StyledString_AddText()

void OH_ArkUI_StyledString_AddText(ArkUI_StyledString* handle, const char* content)

描述：

基于当前格式化字符串样式设置对应的文本内容。

起始版本： 12

参数：

参数项	描述
ArkUI_StyledString* handle	指向ArkUI_StyledString对象的指针。
const char* content	指向文本内容的指针。

OH_ArkUI_StyledString_PopTextStyle()

void OH_ArkUI_StyledString_PopTextStyle(ArkUI_StyledString* handle)

描述：

将当前格式化字符串对象中栈顶样式出栈。

起始版本： 12

参数：

参数项	描述
ArkUI_StyledString* handle	指向ArkUI_StyledString对象的指针。

OH_ArkUI_StyledString_CreateTypography()

OH_Drawing_Typography* OH_ArkUI_StyledString_CreateTypography(ArkUI_StyledString* handle)

描述：

基于格式字符串对象创建指向OH_Drawing_Typography对象的指针，用于提前进行文本测算排版。OH_Drawing_Typography对象的生命周期由应用管理，当应用销毁该对象时，应同步调用NODE_TEXT_CONTENT_WITH_STYLED_STRING对应的reset方法进行置空，避免野指针崩溃风险。

起始版本： 12

参数：

参数项	描述
ArkUI_StyledString* handle	指向ArkUI_StyledString对象的指针。

返回：

类型	说明
OH_Drawing_Typography*	指向OH_Drawing_Typography对象的指针。如果对象返回空指针，表示创建失败，失败的原因可能是handle参数异常如空指针。

OH_ArkUI_StyledString_AddPlaceholder()

void OH_ArkUI_StyledString_AddPlaceholder(ArkUI_StyledString* handle, OH_Drawing_PlaceholderSpan* placeholder)

描述：

设置占位符。

起始版本： 12

参数：

参数项	描述
ArkUI_StyledString* handle	指向ArkUI_StyledString对象的指针。
OH_Drawing_PlaceholderSpan* placeholder	指向OH_Drawing_PlaceholderSpan对象的指针。

OH_ArkUI_StyledString_Descriptor_Create()

ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_Create(void)

描述：

创建属性字符串数据对象。

起始版本： 14

返回：

类型	说明
ArkUI_StyledString_Descriptor*	指向ArkUI_StyledString_Descriptor对象的指针。

OH_ArkUI_StyledString_Descriptor_Destroy()

void OH_ArkUI_StyledString_Descriptor_Destroy(ArkUI_StyledString_Descriptor* descriptor)

描述：

释放被ArkUI_StyledString_Descriptor对象占据的内存。

起始版本： 14

参数：

参数项	描述
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。

OH_ArkUI_UnmarshallStyledStringDescriptor()

int32_t OH_ArkUI_UnmarshallStyledStringDescriptor(uint8_t* buffer, size_t bufferSize, ArkUI_StyledString_Descriptor* descriptor)

描述：

将包含属性字符串信息的字节数组反序列化为属性字符串。

起始版本： 14

参数：

参数项	描述
uint8_t* buffer	待反序列化的字节数组。
size_t bufferSize	字节数组长度。
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_MarshallStyledStringDescriptor()

int32_t OH_ArkUI_MarshallStyledStringDescriptor(uint8_t* buffer, size_t bufferSize, ArkUI_StyledString_Descriptor* descriptor, size_t* resultSize)

描述：

将属性字符串信息序列化为字节数组。

起始版本： 14

参数：

参数项	描述
uint8_t* buffer	字节数组，用于存储属性字符串序列化后的数据。
size_t bufferSize	字节数组长度。
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
size_t* resultSize	属性字符串转换后的字节数组实际长度。

返回：

类型	说明
int32_t	错误码。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 无效的属性字符串。

OH_ArkUI_ConvertToHtml()

const char* OH_ArkUI_ConvertToHtml(ArkUI_StyledString_Descriptor* descriptor)

描述：

将属性字符串信息转化成html。

起始版本： 14

参数：

参数项	描述
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。

返回：

类型	说明
const char*	html。该指针由内部管理，在OH_ArkUI_StyledString_Descriptor_Destroy()时释放。

OH_ArkUI_StyledString_Descriptor_CreateWithString()

ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_CreateWithString(const char* value, const OH_ArkUI_SpanStyle** styles, int32_t length)

描述

创建纯文本内容类型的ArkUI_StyledString_Descriptor对象。

说明：

当该对象不再使用时，调用OH_ArkUI_StyledString_Descriptor_Destroy销毁它。

起始版本： 24

参数：

参数项	描述
const char* value	属性字符串文本内容字符串。
const OH_ArkUI_SpanStyle** styles	属性字符串初始化选项，指向OH_ArkUI_SpanStyle对象数组的指针。
int32_t length	属性字符串初始化选项的长度。

返回：

类型	说明
ArkUI_StyledString_Descriptor*	指向创建的ArkUI_StyledString_Descriptor对象的指针。 如果结果为空指针，表示创建失败，失败的原因可能是传入参数异常。

OH_ArkUI_StyledString_Descriptor_CreateWithImageAttachment()

ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_CreateWithImageAttachment(const OH_ArkUI_ImageAttachment* value)

描述

创建图片内容类型的ArkUI_StyledString_Descriptor对象。

说明：

当该对象不再使用时，调用OH_ArkUI_StyledString_Descriptor_Destroy销毁它。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* value	指向OH_ArkUI_ImageAttachment对象的指针。

返回：

类型	说明
ArkUI_StyledString_Descriptor*	指向创建的ArkUI_StyledString_Descriptor对象的指针。 如果结果为空指针，表示创建失败，失败的原因可能是传入参数异常。

OH_ArkUI_StyledString_Descriptor_CreateWithCustomSpan()

ArkUI_StyledString_Descriptor* OH_ArkUI_StyledString_Descriptor_CreateWithCustomSpan(const OH_ArkUI_CustomSpan* value)

描述

创建自定义绘制Span内容类型的ArkUI_StyledString_Descriptor对象。

说明：

当该对象不再使用时，调用OH_ArkUI_StyledString_Descriptor_Destroy销毁它。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_CustomSpan* value	指向OH_ArkUI_CustomSpan对象的指针。

返回：

类型	说明
ArkUI_StyledString_Descriptor*	指向创建的ArkUI_StyledString_Descriptor对象的指针。 如果结果为空指针，表示创建失败，失败的原因可能是传入参数异常。

OH_ArkUI_StyledString_Descriptor_GetLength()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_GetLength(const ArkUI_StyledString_Descriptor* descriptor, int32_t* length)

描述

获取属性字符串的字符长度。

起始版本： 24

参数：

参数项	描述
const ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
int32_t* length	字符长度。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_GetString()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_GetString(const ArkUI_StyledString_Descriptor* descriptor, char* buffer, int32_t bufferSize, int32_t* writeLength)

描述

获取属性字符串的文本内容。

起始版本： 24

参数：

参数项	描述
const ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
char* buffer	文本内容写入内存的缓冲区，内存空间需由开发者分配。
int32_t bufferSize	缓冲区大小。
int32_t* writeLength	返回值为ARKUI_ERROR_CODE_NO_ERROR时表示实际写入缓冲区的长度。 返回值为ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR时表示字符串完整写入缓冲区所需要的最小长度。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 缓冲区大小不足。

OH_ArkUI_StyledString_Descriptor_IsEqual()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_IsEqual(const ArkUI_StyledString_Descriptor* firstDescriptor, const ArkUI_StyledString_Descriptor* secondDescriptor, bool* isEqual)

描述

判断两个属性字符串是否相同。当属性字符串的文本及样式均一致，视为相同。

起始版本： 24

参数：

参数项	描述
const ArkUI_StyledString_Descriptor* firstDescriptor	指向ArkUI_StyledString_Descriptor对象的指针。
const ArkUI_StyledString_Descriptor* secondDescriptor	指向另一个ArkUI_StyledString_Descriptor对象的指针。
bool* isEqual	两个属性字符串是否相同。true表示相同；false表示不相同。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_SubStyledString()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_SubStyledString(const ArkUI_StyledString_Descriptor* descriptor, ArkUI_StyledString_Descriptor* subDescriptor, uint32_t start, uint32_t length)

描述

获取属性字符串的子属性字符串。

起始版本： 24

参数：

参数项	描述
const ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
ArkUI_StyledString_Descriptor* subDescriptor	指向ArkUI_StyledString_Descriptor子属性字符串对象的指针。
uint32_t start	子属性字符串的起始位置。取值范围[0, 属性字符串的字符长度]。
uint32_t length	子属性字符串的字符长度。取值范围[0, 属性字符串的字符长度与参数start的差值]。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_GetStyles()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_GetStyles(const ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length, OH_ArkUI_StyledStringKey styledKey, OH_ArkUI_SpanStyle** styles, uint32_t stylesSize, uint32_t* writeLength)

描述

获取属性字符串指定范围内的样式集合。

起始版本： 24

参数：

参数项	描述
const ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
uint32_t start	指定范围的起始位置。取值范围[0, 属性字符串的字符长度]。
uint32_t length	指定范围的长度。取值范围[0, 属性字符串的字符长度与参数start的差值]。
OH_ArkUI_StyledStringKey styledKey	需要获取的指定样式类型，取值为OH_ArkUI_StyledStringKey中的枚举。
OH_ArkUI_SpanStyle** styles	指向样式对象数组的缓冲区指针。
uint32_t stylesSize	样式对象数组的缓冲区大小。
uint32_t* writeLength	属性字符串中获取到的样式对象的数组的实际大小。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 缓冲区大小不足。

OH_ArkUI_StyledString_Descriptor_FromHtml()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_FromHtml(ArkUI_StyledString_Descriptor* descriptor, const char* html)

描述

将HTML格式字符串转换成属性字符串。

起始版本： 24

参数：

参数项	描述
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
const char* html	待转换为属性字符串的HTML格式字符串。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_ReplaceString()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_ReplaceString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length, const char* string)

描述

替换属性字符串指定范围的文本。

起始版本： 24

参数：

参数项	描述
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
uint32_t start	指定范围的起始位置。取值范围[0, 属性字符串的字符长度]。
uint32_t length	指定范围的长度。取值范围[0, 属性字符串的字符长度与参数start的差值]。
const char* string	替换的新文本内容。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_InsertString()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_InsertString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, const char* string)

描述

在属性字符串的指定位置插入文本。

起始版本： 24

参数：

参数项	描述
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
uint32_t start	插入位置。取值范围[0, 属性字符串的字符长度]。
const char* string	插入的新文本内容。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_RemoveString()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_RemoveString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length)

描述

移除属性字符串指定范围的文本。

起始版本： 24

参数：

参数项	描述
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
uint32_t start	指定范围的起始位置。取值范围[0, 属性字符串的字符长度]。
uint32_t length	指定范围的字符长度。取值范围[0, 属性字符串的字符长度与参数start的差值]。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_ReplaceStyle()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_ReplaceStyle(ArkUI_StyledString_Descriptor* descriptor, const OH_ArkUI_SpanStyle* spanStyle)

描述

替换属性字符串指定范围内的样式。

起始版本： 24

参数：

参数项	描述
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。 需先调用OH_ArkUI_SpanStyle_SetStart和OH_ArkUI_SpanStyle_SetLength在该对象中设置目标范围。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_SetStyle()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_SetStyle(ArkUI_StyledString_Descriptor* descriptor, const OH_ArkUI_SpanStyle* spanStyle)

描述

为属性字符串指定范围设置新样式。

起始版本： 24

参数：

参数项	描述
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。需先调用OH_ArkUI_SpanStyle_SetStart和OH_ArkUI_SpanStyle_SetLength在该对象中设置目标范围。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_RemoveStyle()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_RemoveStyle(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length, OH_ArkUI_StyledStringKey styledKey)

描述

清除属性字符串指定范围内容的指定类型样式。

说明：

被清除后属性样式取对应TextEditor组件对应属性的默认值。

起始版本： 24

参数：

参数项	描述
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
uint32_t start	指定范围的起始位置。取值范围[0, 属性字符串的字符长度]。
uint32_t length	指定范围的长度。取值范围[0, 属性字符串的字符长度与参数start的差值]。
OH_ArkUI_StyledStringKey styledKey	样式类型枚举值，取值为OH_ArkUI_StyledStringKey中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_ClearStyles()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_ClearStyles(ArkUI_StyledString_Descriptor* descriptor)

描述

清除属性字符串对象的所有样式。

说明：

被清除后属性样式取对应TextEditor组件对应属性的默认值。

起始版本： 24

参数：

参数项	描述
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_ReplaceStyledString()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_ReplaceStyledString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, uint32_t length, const ArkUI_StyledString_Descriptor* other)

描述

替换指定范围的属性字符串。

起始版本： 24

参数：

参数项	描述
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
uint32_t start	指定范围的起始位置。取值范围[0, 属性字符串的字符长度]。
uint32_t length	指定范围的长度。取值范围[0, 属性字符串的字符长度与参数start的差值]。
const ArkUI_StyledString_Descriptor* other	指向新的ArkUI_StyledString_Descriptor对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_InsertStyledString()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_InsertStyledString(ArkUI_StyledString_Descriptor* descriptor, uint32_t start, const ArkUI_StyledString_Descriptor* other)

描述

在属性字符串的指定位置插入新的属性字符串。

起始版本： 24

参数：

参数项	描述
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
uint32_t start	插入位置。取值范围[0, 属性字符串的字符长度]。
const ArkUI_StyledString_Descriptor* other	指向新的ArkUI_StyledString_Descriptor对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_AppendStyledString()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_AppendStyledString(ArkUI_StyledString_Descriptor* descriptor, const ArkUI_StyledString_Descriptor* other)

描述

在属性字符串的末尾追加新的属性字符串。

起始版本： 24

参数：

参数项	描述
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。
const ArkUI_StyledString_Descriptor* other	指向新的ArkUI_StyledString_Descriptor对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_StyledString_Descriptor_InvalidateCustomSpan()

ArkUI_ErrorCode OH_ArkUI_StyledString_Descriptor_InvalidateCustomSpan(const ArkUI_StyledString_Descriptor* descriptor)

描述

主动刷新属性字符串中的自定义绘制Span。

说明：

调用该接口会立即触发通过OH_ArkUI_CustomSpan_RegisterOnDrawCallback注册在自定义绘制Span上的回调函数。

起始版本： 24

参数：

参数项	描述
const ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_INVALID_STYLED_STRING 属性字符串无效。

OH_ArkUI_TextStyle_Create()

OH_ArkUI_TextStyle* OH_ArkUI_TextStyle_Create()

描述

创建OH_ArkUI_TextStyle对象。

说明：

当该对象不再使用时，调用OH_ArkUI_TextStyle_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_TextStyle*	指向OH_ArkUI_TextStyle对象的指针。

OH_ArkUI_TextStyle_Destroy()

void OH_ArkUI_TextStyle_Destroy(OH_ArkUI_TextStyle* textStyle)

描述

释放OH_ArkUI_TextStyle对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。

OH_ArkUI_TextStyle_SetFontColor()

ArkUI_ErrorCode OH_ArkUI_TextStyle_SetFontColor(OH_ArkUI_TextStyle* textStyle, uint32_t fontColor)

描述

设置文本字体样式中的字体颜色。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
uint32_t fontColor	字体颜色，0xARGB格式。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_GetFontColor()

ArkUI_ErrorCode OH_ArkUI_TextStyle_GetFontColor(const OH_ArkUI_TextStyle* textStyle, uint32_t* fontColor)

描述

获取文本字体样式中的字体颜色。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
uint32_t* fontColor	字体颜色，0xARGB格式。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_SetFontFamily()

ArkUI_ErrorCode OH_ArkUI_TextStyle_SetFontFamily(OH_ArkUI_TextStyle* textStyle, const char* fontFamily)

描述

设置文本字体样式中的字体族。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
const char* fontFamily	字体族。存放待设置的字体名称，不同字体名称通过逗号拼接。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_GetFontFamily()

ArkUI_ErrorCode OH_ArkUI_TextStyle_GetFontFamily(const OH_ArkUI_TextStyle* textStyle, char* buffer, int32_t bufferSize, int32_t* writeLength)

描述

获取文本字体样式中的字体族。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
char* buffer	字体族内容写入内存的缓冲区，内存空间需由开发者分配。
int32_t bufferSize	缓冲区最多可写入的字符的数量。
int32_t* writeLength	返回ARKUI_ERROR_CODE_NO_ERROR时，表示实际写入缓冲区的字符串长度。 返回ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR时，表示字符串完整写入缓冲区所需要的最小长度。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 缓冲区大小不足。

OH_ArkUI_TextStyle_SetFontSize()

ArkUI_ErrorCode OH_ArkUI_TextStyle_SetFontSize(OH_ArkUI_TextStyle* textStyle, float fontSize)

描述

设置文本字体样式中的字体大小。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
float fontSize	字体大小，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_GetFontSize()

ArkUI_ErrorCode OH_ArkUI_TextStyle_GetFontSize(const OH_ArkUI_TextStyle* textStyle, float* fontSize)

描述

获取文本字体样式中的字体大小。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
float* fontSize	字体大小，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_SetFontWeight()

ArkUI_ErrorCode OH_ArkUI_TextStyle_SetFontWeight(OH_ArkUI_TextStyle* textStyle, uint32_t fontWeight)

描述

设置文本字体样式中的字体粗细。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
uint32_t fontWeight	字体粗细。取值范围为[100, 900]中的整百数值，例如100、900。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_GetFontWeight()

ArkUI_ErrorCode OH_ArkUI_TextStyle_GetFontWeight(const OH_ArkUI_TextStyle* textStyle, uint32_t* fontWeight)

描述

获取文本字体样式中的字体粗细。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
uint32_t* fontWeight	字体粗细。取值范围为[100, 900]中的整百数值，例如100、900。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_SetFontStyle()

ArkUI_ErrorCode OH_ArkUI_TextStyle_SetFontStyle(OH_ArkUI_TextStyle* textStyle, ArkUI_FontStyle fontStyle)

描述

设置文本字体样式中的字体风格。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
ArkUI_FontStyle fontStyle	字体风格。取值为ArkUI_FontStyle中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_GetFontStyle()

ArkUI_ErrorCode OH_ArkUI_TextStyle_GetFontStyle(const OH_ArkUI_TextStyle* textStyle, ArkUI_FontStyle* fontStyle)

描述

获取文本字体样式中的字体风格。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
ArkUI_FontStyle* fontStyle	字体风格。取值为ArkUI_FontStyle中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_SetStrokeWidth()

ArkUI_ErrorCode OH_ArkUI_TextStyle_SetStrokeWidth(OH_ArkUI_TextStyle* textStyle, float strokeWidth)

描述

设置文本字体样式中的描边宽度。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
float strokeWidth	描边宽度，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_GetStrokeWidth()

ArkUI_ErrorCode OH_ArkUI_TextStyle_GetStrokeWidth(const OH_ArkUI_TextStyle* textStyle, float* strokeWidth)

描述

获取文本字体样式中的描边宽度。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
float* strokeWidth	描边宽度，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_SetStrokeColor()

ArkUI_ErrorCode OH_ArkUI_TextStyle_SetStrokeColor(OH_ArkUI_TextStyle* textStyle, uint32_t strokeColor)

描述

设置文本字体样式中的描边颜色。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
uint32_t strokeColor	描边颜色，0xARGB格式。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_GetStrokeColor()

ArkUI_ErrorCode OH_ArkUI_TextStyle_GetStrokeColor(const OH_ArkUI_TextStyle* textStyle, uint32_t* strokeColor)

描述

获取文本字体样式中的描边颜色。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
uint32_t* strokeColor	描边颜色，0xARGB格式。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_SetSuperscript()

ArkUI_ErrorCode OH_ArkUI_TextStyle_SetSuperscript(OH_ArkUI_TextStyle* textStyle, OH_ArkUI_SuperscriptStyle superscript)

描述

设置文本字体样式中的上下标样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
OH_ArkUI_SuperscriptStyle superscript	上下标样式。取值为OH_ArkUI_SuperscriptStyle中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextStyle_GetSuperscript()

ArkUI_ErrorCode OH_ArkUI_TextStyle_GetSuperscript(const OH_ArkUI_TextStyle* textStyle, OH_ArkUI_SuperscriptStyle* superscript)

描述

获取文本字体样式中的上下标样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。
OH_ArkUI_SuperscriptStyle* superscript	上下标样式。取值为OH_ArkUI_SuperscriptStyle中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_Create()

OH_ArkUI_SpanStyle* OH_ArkUI_SpanStyle_Create()

描述

创建OH_ArkUI_SpanStyle对象。

说明：

当该对象不再使用时，调用OH_ArkUI_SpanStyle_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_SpanStyle*	指向OH_ArkUI_SpanStyle对象的指针。

OH_ArkUI_SpanStyle_Destroy()

void OH_ArkUI_SpanStyle_Destroy(OH_ArkUI_SpanStyle* spanStyle)

描述

释放OH_ArkUI_SpanStyle对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。

OH_ArkUI_SpanStyle_GetStyledKey()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetStyledKey(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_StyledStringKey* styledKey)

描述

获取属性字符串样式对象的样式类型。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_StyledStringKey* styledKey	样式类型的枚举值。取值为OH_ArkUI_StyledStringKey中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetStart()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetStart(OH_ArkUI_SpanStyle* spanStyle, int32_t start)

描述

设置属性字符串样式对象的起始位置。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
int32_t start	属性字符串样式对象的起始位置。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetStart()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetStart(const OH_ArkUI_SpanStyle* spanStyle, int32_t* start)

描述

获取属性字符串样式对象的起始位置。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
int32_t* start	属性字符串样式对象的起始位置。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetLength()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetLength(OH_ArkUI_SpanStyle* spanStyle, int32_t length)

描述

设置属性字符串样式对象的长度。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
int32_t length	属性字符串样式对象的长度。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetLength()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetLength(const OH_ArkUI_SpanStyle* spanStyle, int32_t* length)

描述

获取属性字符串样式对象的长度。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
int32_t* length	属性字符串样式对象的长度。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetTextStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetTextStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_TextStyle* textStyle)

描述

设置属性字符串样式对象的文本字体样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetTextStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetTextStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_TextStyle* textStyle)

描述

获取属性字符串样式对象的文本字体样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_TextStyle* textStyle	指向OH_ArkUI_TextStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetParagraphStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetParagraphStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_ParagraphStyle* paragraphStyle)

描述

设置属性字符串样式对象的段落样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetParagraphStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetParagraphStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_ParagraphStyle* paragraphStyle)

描述

获取属性字符串样式对象的段落样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetGestureStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetGestureStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_GestureStyle* gestureStyle)

描述

设置属性字符串样式对象的事件手势样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_GestureStyle* gestureStyle	指向OH_ArkUI_GestureStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetGestureStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetGestureStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_GestureStyle* gestureStyle)

描述

获取属性字符串样式对象的事件手势样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_GestureStyle* gestureStyle	指向OH_ArkUI_GestureStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetTextShadowStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetTextShadowStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_TextShadowStyle* textShadowStyle)

描述

设置属性字符串样式对象的文本阴影样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_TextShadowStyle* textShadowStyle	指向OH_ArkUI_TextShadowStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetTextShadowStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetTextShadowStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_TextShadowStyle* textShadowStyle)

描述

获取属性字符串样式对象的文本阴影样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_TextShadowStyle* textShadowStyle	指向OH_ArkUI_TextShadowStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetDecorationStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetDecorationStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_DecorationStyle* decorationStyle)

描述

设置属性字符串样式对象的文本装饰线样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_DecorationStyle* decorationStyle	指向OH_ArkUI_DecorationStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetDecorationStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetDecorationStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_DecorationStyle* decorationStyle)

描述

获取属性字符串样式对象的文本装饰线样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_DecorationStyle* decorationStyle	指向OH_ArkUI_DecorationStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetBaselineOffsetStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetBaselineOffsetStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle)

描述

设置属性字符串样式对象的基线偏移量样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle	指向OH_ArkUI_BaselineOffsetStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetBaselineOffsetStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetBaselineOffsetStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle)

描述

获取属性字符串样式对象的基线偏移量样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle	指向OH_ArkUI_BaselineOffsetStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetLetterSpacingStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetLetterSpacingStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_LetterSpacingStyle* letterSpacingStyle)

描述

设置属性字符串样式对象的字符间距样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_LetterSpacingStyle* letterSpacingStyle	指向OH_ArkUI_LetterSpacingStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetLetterSpacingStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetLetterSpacingStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_LetterSpacingStyle* letterSpacingStyle)

描述

获取属性字符串样式对象的字符间距样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_LetterSpacingStyle* letterSpacingStyle	指向OH_ArkUI_LetterSpacingStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetLineHeightStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetLineHeightStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_LineHeightStyle* lineHeightStyle)

描述

设置属性字符串样式对象的行高样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_LineHeightStyle* lineHeightStyle	指向OH_ArkUI_LineHeightStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetLineHeightStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetLineHeightStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_LineHeightStyle* lineHeightStyle)

描述

获取属性字符串样式对象的行高样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_LineHeightStyle* lineHeightStyle	指向OH_ArkUI_LineHeightStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetUrlStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetUrlStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_UrlStyle* urlStyle)

描述

设置属性字符串样式对象的超链接样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_UrlStyle* urlStyle	指向OH_ArkUI_UrlStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetUrlStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetUrlStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_UrlStyle* urlStyle)

描述

获取属性字符串样式对象的超链接样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_UrlStyle* urlStyle	指向OH_ArkUI_UrlStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetBackgroundColorStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetBackgroundColorStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_BackgroundColorStyle* backgroundColorStyle)

描述

设置属性字符串样式对象的背景颜色样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_BackgroundColorStyle* backgroundColorStyle	指向OH_ArkUI_BackgroundColorStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetBackgroundColorStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetBackgroundColorStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_BackgroundColorStyle* backgroundColorStyle)

描述

获取属性字符串样式对象的背景颜色样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_BackgroundColorStyle* backgroundColorStyle	指向OH_ArkUI_BackgroundColorStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetUserDataSpan()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetUserDataSpan(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_UserDataSpan* userDataSpan)

描述

设置属性字符串样式对象的用户数据Span样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_UserDataSpan* userDataSpan	指向OH_ArkUI_UserDataSpan对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetUserDataSpan()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetUserDataSpan(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_UserDataSpan* userDataSpan)

描述

获取属性字符串样式对象的用户数据Span样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_UserDataSpan* userDataSpan	指向OH_ArkUI_UserDataSpan对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetCustomSpan()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetCustomSpan(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_CustomSpan* customSpan)

描述

设置属性字符串样式对象的自定义绘制Span样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_CustomSpan* customSpan	指向OH_ArkUI_CustomSpan对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetCustomSpan()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetCustomSpan(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_CustomSpan* customSpan)

描述

获取属性字符串样式对象的自定义绘制Span样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_CustomSpan* customSpan	指向OH_ArkUI_CustomSpan对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetImageAttachment()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetImageAttachment(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_ImageAttachment* imageAttachment)

描述

设置属性字符串样式对象的图片样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetImageAttachment()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetImageAttachment(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_ImageAttachment* imageAttachment)

描述

获取属性字符串样式对象的图片样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_Create()

OH_ArkUI_LeadingMarginSpanDrawInfo* OH_ArkUI_LeadingMarginSpanDrawInfo_Create()

描述

创建OH_ArkUI_LeadingMarginSpanDrawInfo对象。

说明：

当该对象不再使用时，调用OH_ArkUI_LeadingMarginSpanDrawInfo_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_LeadingMarginSpanDrawInfo*	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。

OH_ArkUI_LeadingMarginSpanDrawInfo_Destroy()

void OH_ArkUI_LeadingMarginSpanDrawInfo_Destroy(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo)

描述

释放OH_ArkUI_LeadingMarginSpanDrawInfo对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。

OH_ArkUI_LeadingMarginSpanDrawInfo_SetX()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetX(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float x)

描述

设置段落缩进的自定义绘制信息对象中当前行相对于组件的水平偏移。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
float x	当前行相对于组件的水平偏移，单位px。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_GetX()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetX(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float* x)

描述

获取段落缩进的自定义绘制信息对象中当前行相对于组件的水平偏移。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
float* x	当前行相对于组件的水平偏移，单位px。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_SetTop()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetTop(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float top)

描述

设置段落缩进的自定义绘制信息对象中行顶与组件上边缘的距离。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
float top	行顶与组件上边缘的距离，单位px。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_GetTop()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetTop(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float* top)

描述

获取段落缩进的自定义绘制信息对象中行顶与组件上边缘的距离。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
float* top	行顶与组件上边缘的距离，单位px。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_SetBottom()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetBottom(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float bottom)

描述

设置段落缩进的自定义绘制信息对象中行底与组件上边缘的距离。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
float bottom	行底与组件上边缘的距离，单位px。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_GetBottom()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetBottom(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float* bottom)

描述

获取段落缩进的自定义绘制信息对象中行底与组件上边缘的距离。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
float* bottom	行底与组件上边缘的距离，单位px。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_SetBaseline()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetBaseline(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float baseline)

描述

设置段落缩进的自定义绘制信息对象中当前行的基线与组件上边缘的距离。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
float baseline	当前行的基线与组件上边缘的距离，单位px。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_GetBaseline()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetBaseline(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, float* baseline)

描述

获取段落缩进的自定义绘制信息对象中当前行的基线与组件上边缘的距离。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
float* baseline	当前行的基线与组件上边缘的距离，单位px。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_SetTextDirection()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetTextDirection(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, ArkUI_TextDirection direction)

描述

设置段落缩进的自定义绘制信息对象中文本内容的方向。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
ArkUI_TextDirection direction	文本内容的方向。取值为ArkUI_TextDirection中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_GetTextDirection()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetTextDirection(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, ArkUI_TextDirection* direction)

描述

获取段落缩进的自定义绘制信息对象中文本内容的方向。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
ArkUI_TextDirection* direction	文本内容的方向。取值为ArkUI_TextDirection中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_SetStart()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetStart(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, uint32_t start)

描述

设置段落缩进的自定义绘制信息对象中当前行的起始索引。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
uint32_t start	当前行的起始索引。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_GetStart()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetStart(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, uint32_t* start)

描述

获取段落缩进的自定义绘制信息对象中当前行的起始索引。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
uint32_t* start	当前行的起始索引。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_SetEnd()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetEnd(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, uint32_t end)

描述

设置段落缩进的自定义绘制信息对象中当前行的结束索引。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
uint32_t end	当前行的结束索引。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_GetEnd()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetEnd(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, uint32_t* end)

描述

获取段落缩进的自定义绘制信息对象中当前行的结束索引。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
uint32_t* end	当前行的结束索引。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_SetFirst()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_SetFirst(OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, bool first)

描述

设置段落缩进的自定义绘制信息对象中当前行是否为段落的首行。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
bool first	当前行是否为段落的首行。true表示首行；false表示非首行。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LeadingMarginSpanDrawInfo_GetFirst()

ArkUI_ErrorCode OH_ArkUI_LeadingMarginSpanDrawInfo_GetFirst(const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo, bool* first)

描述

获取段落缩进的自定义绘制信息对象中当前行是否为段落的首行。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo	指向OH_ArkUI_LeadingMarginSpanDrawInfo对象的指针。
bool* first	当前行是否为段落的首行。true表示首行；false表示非首行。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_Create()

OH_ArkUI_ParagraphStyle* OH_ArkUI_ParagraphStyle_Create()

描述

创建OH_ArkUI_ParagraphStyle对象。

说明：

当该对象不再使用时，调用OH_ArkUI_ParagraphStyle_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_ParagraphStyle*	指向OH_ArkUI_ParagraphStyle对象的指针。

OH_ArkUI_ParagraphStyle_Destroy()

void OH_ArkUI_ParagraphStyle_Destroy(OH_ArkUI_ParagraphStyle* paragraphStyle)

描述

释放OH_ArkUI_ParagraphStyle对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。

OH_ArkUI_ParagraphStyle_SetTextAlign()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetTextAlign(OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextAlignment align)

描述

设置段落样式中的水平方向的文本对齐方式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
ArkUI_TextAlignment align	水平方向的文本对齐方式。取值为ArkUI_TextAlignment中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_GetTextAlign()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetTextAlign(const OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextAlignment* align)

描述

获取段落样式中的水平方向的文本对齐方式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
ArkUI_TextAlignment* align	水平方向的文本对齐方式。取值为ArkUI_TextAlignment中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_SetTextIndent()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetTextIndent(OH_ArkUI_ParagraphStyle* paragraphStyle, float textIndent)

描述

设置段落样式中的首行文本缩进。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
float textIndent	首行缩进值，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_GetTextIndent()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetTextIndent(const OH_ArkUI_ParagraphStyle* paragraphStyle, float* textIndent)

描述

获取段落样式中的首行文本缩进。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
float* textIndent	首行缩进值，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_SetMaxLines()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetMaxLines(OH_ArkUI_ParagraphStyle* paragraphStyle, int32_t maxLines)

描述

设置段落样式中的最大行数。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
int32_t maxLines	最大行数。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_GetMaxLines()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetMaxLines(const OH_ArkUI_ParagraphStyle* paragraphStyle, int32_t* maxLines)

描述

获取段落样式中的最大行数。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
int32_t* maxLines	最大行数。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_SetOverflow()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetOverflow(OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextOverflow overflow)

描述

设置段落样式中的段落超长时的显示方式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
ArkUI_TextOverflow overflow	段落超长时的显示方式。取值为ArkUI_TextOverflow中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_GetOverflow()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetOverflow(const OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextOverflow* overflow)

描述

获取段落样式中的段落超长时的显示方式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
ArkUI_TextOverflow* overflow	段落超长时的显示方式。取值为ArkUI_TextOverflow中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_SetWordBreak()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetWordBreak(OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_WordBreak wordBreak)

描述

设置段落样式中的断行规则。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
ArkUI_WordBreak wordBreak	断行规则。取值为ArkUI_WordBreak中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_GetWordBreak()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetWordBreak(const OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_WordBreak* wordBreak)

描述

获取段落样式中的断行规则。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
ArkUI_WordBreak* wordBreak	断行规则。取值为ArkUI_WordBreak中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_SetLeadingMarginPixelMap()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetLeadingMarginPixelMap(OH_ArkUI_ParagraphStyle* paragraphStyle, struct OH_PixelmapNative* pixelmap)

描述

设置段落样式中的段落缩进的像素图。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
struct OH_PixelmapNative* pixelmap	段落缩进的像素图。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_GetLeadingMarginPixelMap()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetLeadingMarginPixelMap(const OH_ArkUI_ParagraphStyle* paragraphStyle, struct OH_PixelmapNative** pixelmap)

描述

获取段落样式中的段落缩进的像素图。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
struct OH_PixelmapNative** pixelmap	段落缩进的像素图。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_SetLeadingMarginWidth()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetLeadingMarginWidth(OH_ArkUI_ParagraphStyle* paragraphStyle, uint32_t width)

描述

设置段落样式中的段落缩进宽度。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
uint32_t width	段落缩进宽度，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_GetLeadingMarginWidth()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetLeadingMarginWidth(const OH_ArkUI_ParagraphStyle* paragraphStyle, uint32_t* width)

描述

获取段落样式中的段落缩进宽度。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
uint32_t* width	段落缩进宽度，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_SetLeadingMarginHeight()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetLeadingMarginHeight(OH_ArkUI_ParagraphStyle* paragraphStyle, uint32_t height)

描述

设置段落样式中的段落缩进高度。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
uint32_t height	段落缩进高度，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_GetLeadingMarginHeight()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetLeadingMarginHeight(const OH_ArkUI_ParagraphStyle* paragraphStyle, uint32_t* height)

描述

获取段落样式中的段落缩进高度。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
uint32_t* height	段落缩进高度，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_SetParagraphSpacing()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetParagraphSpacing(OH_ArkUI_ParagraphStyle* paragraphStyle, uint32_t paragraphSpacing)

描述

设置段落样式中的段落间距。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
uint32_t paragraphSpacing	段落间距，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_GetParagraphSpacing()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetParagraphSpacing(const OH_ArkUI_ParagraphStyle* paragraphStyle, uint32_t* paragraphSpacing)

描述

获取段落样式中的段落间距。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
uint32_t* paragraphSpacing	段落间距，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_SetTextVerticalAlign()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetTextVerticalAlign(OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextVerticalAlignment verticalAlignment)

描述

设置段落样式中的垂直方向的文本对齐方式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
ArkUI_TextVerticalAlignment verticalAlignment	垂直方向的文本对齐方式。取值为ArkUI_TextVerticalAlignment中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_GetTextVerticalAlign()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetTextVerticalAlign(const OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextVerticalAlignment* verticalAlignment)

描述

获取段落样式中的垂直方向的文本对齐方式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
ArkUI_TextVerticalAlignment* verticalAlignment	垂直方向的文本对齐方式。取值为ArkUI_TextVerticalAlignment中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_RegisterOnDrawLeadingMarginCallback()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_RegisterOnDrawLeadingMarginCallback(OH_ArkUI_ParagraphStyle* paragraphStyle, void(*onDraw)(ArkUI_DrawContext* context, OH_ArkUI_LeadingMarginSpanDrawInfo* drawInfo))

描述

设置段落样式中绘制段落缩进时触发的回调函数。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
void(*onDraw)(ArkUI_DrawContext* context	绘制段落缩进的回调函数。context 图形绘制上下文。drawInfo 自定义绘制信息。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_RegisterOnGetLeadingMarginCallback()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_RegisterOnGetLeadingMarginCallback(OH_ArkUI_ParagraphStyle* paragraphStyle, float(*leadingMargin)())

描述

设置段落样式中获取段落缩进距离时触发的回调函数。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
float(*leadingMargin)()	获取段落缩进距离时触发的回调函数。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_SetTextDirection()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetTextDirection(OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextDirection textDirection)

描述

设置段落样式中的文本方向。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
ArkUI_TextDirection textDirection	文本方向。取值为ArkUI_TextDirection中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_GetTextDirection()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetTextDirection(const OH_ArkUI_ParagraphStyle* paragraphStyle, ArkUI_TextDirection* textDirection)

描述

获取段落样式中的文本方向。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
ArkUI_TextDirection* textDirection	文本方向。取值为ArkUI_TextDirection中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_GestureStyle_Create()

OH_ArkUI_GestureStyle* OH_ArkUI_GestureStyle_Create()

描述

创建OH_ArkUI_GestureStyle对象。

说明：

当该对象不再使用时，调用OH_ArkUI_GestureStyle_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_GestureStyle*	指向OH_ArkUI_GestureStyle对象的指针。

OH_ArkUI_GestureStyle_Destroy()

void OH_ArkUI_GestureStyle_Destroy(OH_ArkUI_GestureStyle* gestureStyle)

描述

释放OH_ArkUI_GestureStyle对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_GestureStyle* gestureStyle	指向OH_ArkUI_GestureStyle对象的指针。

OH_ArkUI_GestureStyle_RegisterOnClickCallback()

ArkUI_ErrorCode OH_ArkUI_GestureStyle_RegisterOnClickCallback(OH_ArkUI_GestureStyle* gestureStyle, void(*onClick)(ArkUI_NodeEvent*))

描述

设置事件手势样式中的点击事件回调。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_GestureStyle* gestureStyle	指向OH_ArkUI_GestureStyle对象的指针。
void(*onClick)(ArkUI_NodeEvent*)	点击事件的回调。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_GestureStyle_RegisterOnLongPressCallback()

ArkUI_ErrorCode OH_ArkUI_GestureStyle_RegisterOnLongPressCallback(OH_ArkUI_GestureStyle* gestureStyle, void(*onLongPress)(ArkUI_GestureEvent*))

描述

设置事件手势样式中的长按事件回调。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_GestureStyle* gestureStyle	指向OH_ArkUI_GestureStyle对象的指针。
void(*onLongPress)(ArkUI_GestureEvent*)	长按事件回调。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_GestureStyle_RegisterOnTouchCallback()

ArkUI_ErrorCode OH_ArkUI_GestureStyle_RegisterOnTouchCallback(OH_ArkUI_GestureStyle* gestureStyle, void(*onTouch)(ArkUI_NodeEvent*))

描述

设置事件手势样式中的触摸事件回调。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_GestureStyle* gestureStyle	指向OH_ArkUI_GestureStyle对象的指针。
void(*onTouch)(ArkUI_NodeEvent*)	触摸事件回调。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextShadowStyle_Create()

OH_ArkUI_TextShadowStyle* OH_ArkUI_TextShadowStyle_Create()

描述

创建OH_ArkUI_TextShadowStyle对象。

说明：

当该对象不再使用时，调用OH_ArkUI_TextShadowStyle_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_TextShadowStyle*	指向OH_ArkUI_TextShadowStyle对象的指针。

OH_ArkUI_TextShadowStyle_Destroy()

void OH_ArkUI_TextShadowStyle_Destroy(OH_ArkUI_TextShadowStyle* textShadowStyle)

描述

释放OH_ArkUI_TextShadowStyle对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_TextShadowStyle* textShadowStyle	指向OH_ArkUI_TextShadowStyle对象的指针。

OH_ArkUI_TextShadowStyle_SetTextShadow()

ArkUI_ErrorCode OH_ArkUI_TextShadowStyle_SetTextShadow(OH_ArkUI_TextShadowStyle* textShadowStyle, const OH_ArkUI_ShadowOptions** options, uint32_t length)

描述

设置文本阴影样式的文本阴影选项。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_TextShadowStyle* textShadowStyle	指向OH_ArkUI_TextShadowStyle对象的指针。
const OH_ArkUI_ShadowOptions** options	文本阴影选项，指向OH_ArkUI_ShadowOptions对象数组的指针。
uint32_t length	文本阴影选项长度。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextShadowStyle_GetTextShadow()

ArkUI_ErrorCode OH_ArkUI_TextShadowStyle_GetTextShadow(const OH_ArkUI_TextShadowStyle* textShadowStyle, OH_ArkUI_ShadowOptions** shadowOptions, uint32_t shadowOptionsSize, uint32_t* writeLength)

描述

获取文本阴影样式的文本阴影选项。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_TextShadowStyle* textShadowStyle	指向OH_ArkUI_TextShadowStyle对象的指针。
OH_ArkUI_ShadowOptions** shadowOptions	文本阴影选项，指向OH_ArkUI_ShadowOptions对象数组的指针。
uint32_t shadowOptionsSize	阴影选项的缓冲区大小。
uint32_t* writeLength	文本阴影样式中实际的文本阴影选项数量。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 缓冲区大小不足。

OH_ArkUI_DecorationStyle_Create()

OH_ArkUI_DecorationStyle* OH_ArkUI_DecorationStyle_Create()

描述

创建OH_ArkUI_DecorationStyle对象。

说明：

当该对象不再使用时，调用OH_ArkUI_DecorationStyle_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_DecorationStyle*	指向OH_ArkUI_DecorationStyle对象的指针。

OH_ArkUI_DecorationStyle_Destroy()

void OH_ArkUI_DecorationStyle_Destroy(OH_ArkUI_DecorationStyle* decorationStyle)

描述

释放OH_ArkUI_DecorationStyle对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_DecorationStyle* decorationStyle	指向OH_ArkUI_DecorationStyle对象的指针。

OH_ArkUI_DecorationStyle_SetTextDecorationType()

ArkUI_ErrorCode OH_ArkUI_DecorationStyle_SetTextDecorationType(OH_ArkUI_DecorationStyle* decorationStyle, ArkUI_TextDecorationType type)

描述

设置文本装饰线样式的装饰线类型。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_DecorationStyle* decorationStyle	指向OH_ArkUI_DecorationStyle对象的指针。
ArkUI_TextDecorationType type	装饰线类型。取值为ArkUI_TextDecorationType中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_DecorationStyle_GetTextDecorationType()

ArkUI_ErrorCode OH_ArkUI_DecorationStyle_GetTextDecorationType(const OH_ArkUI_DecorationStyle* decorationStyle, ArkUI_TextDecorationType* type)

描述

获取文本装饰线样式的装饰线类型。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_DecorationStyle* decorationStyle	指向OH_ArkUI_DecorationStyle对象的指针。
ArkUI_TextDecorationType* type	装饰线类型。取值为ArkUI_TextDecorationType中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_DecorationStyle_SetColor()

ArkUI_ErrorCode OH_ArkUI_DecorationStyle_SetColor(OH_ArkUI_DecorationStyle* decorationStyle, uint32_t color)

描述

设置文本装饰线样式的装饰线颜色。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_DecorationStyle* decorationStyle	指向OH_ArkUI_DecorationStyle对象的指针。
uint32_t color	装饰线颜色，0xARGB格式。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_DecorationStyle_GetColor()

ArkUI_ErrorCode OH_ArkUI_DecorationStyle_GetColor(const OH_ArkUI_DecorationStyle* decorationStyle, uint32_t* color)

描述

获取文本装饰线样式的装饰线颜色。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_DecorationStyle* decorationStyle	指向OH_ArkUI_DecorationStyle对象的指针。
uint32_t* color	装饰线颜色，0xARGB格式。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_DecorationStyle_SetTextDecorationStyle()

ArkUI_ErrorCode OH_ArkUI_DecorationStyle_SetTextDecorationStyle(OH_ArkUI_DecorationStyle* decorationStyle, ArkUI_TextDecorationStyle style)

描述

设置文本装饰线样式的装饰线样式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_DecorationStyle* decorationStyle	指向OH_ArkUI_DecorationStyle对象的指针。
ArkUI_TextDecorationStyle style	装饰线样式。取值为ArkUI_TextDecorationStyle中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_DecorationStyle_GetTextDecorationStyle()

ArkUI_ErrorCode OH_ArkUI_DecorationStyle_GetTextDecorationStyle(const OH_ArkUI_DecorationStyle* decorationStyle, ArkUI_TextDecorationStyle* style)

描述

获取文本装饰线样式的装饰线样式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_DecorationStyle* decorationStyle	指向OH_ArkUI_DecorationStyle对象的指针。
ArkUI_TextDecorationStyle* style	装饰线样式。取值为ArkUI_TextDecorationStyle中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_DecorationStyle_SetThicknessScale()

ArkUI_ErrorCode OH_ArkUI_DecorationStyle_SetThicknessScale(OH_ArkUI_DecorationStyle* decorationStyle, float thicknessScale)

描述

设置文本装饰线样式的装饰线的粗细缩放比例。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_DecorationStyle* decorationStyle	指向OH_ArkUI_DecorationStyle对象的指针。
float thicknessScale	装饰线的粗细缩放比例。取值范围为[0, +∞)。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_DecorationStyle_GetThicknessScale()

ArkUI_ErrorCode OH_ArkUI_DecorationStyle_GetThicknessScale(const OH_ArkUI_DecorationStyle* decorationStyle, float* thicknessScale)

描述

获取文本装饰线样式的装饰线的粗细缩放比例。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_DecorationStyle* decorationStyle	指向OH_ArkUI_DecorationStyle对象的指针。
float* thicknessScale	装饰线的粗细缩放比例。取值范围为[0, +∞)。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_DecorationStyle_SetEnableMultiType()

ArkUI_ErrorCode OH_ArkUI_DecorationStyle_SetEnableMultiType(OH_ArkUI_DecorationStyle* decorationStyle, bool enableMultiType)

描述

设置文本装饰线样式中是否开启多装饰线显示。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_DecorationStyle* decorationStyle	指向OH_ArkUI_DecorationStyle对象的指针。
bool enableMultiType	是否开启多装饰线显示。true表示开启，false表示关闭。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_DecorationStyle_GetEnableMultiType()

ArkUI_ErrorCode OH_ArkUI_DecorationStyle_GetEnableMultiType(const OH_ArkUI_DecorationStyle* decorationStyle, bool* enableMultiType)

描述

获取文本装饰线样式中是否开启多装饰线显示。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_DecorationStyle* decorationStyle	指向OH_ArkUI_DecorationStyle对象的指针。
bool* enableMultiType	是否开启多装饰线显示。true表示开启，false表示关闭。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_BaselineOffsetStyle_Create()

OH_ArkUI_BaselineOffsetStyle* OH_ArkUI_BaselineOffsetStyle_Create()

描述

创建OH_ArkUI_BaselineOffsetStyle对象。

说明：

当该对象不再使用时，调用OH_ArkUI_BaselineOffsetStyle_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_BaselineOffsetStyle*	指向OH_ArkUI_BaselineOffsetStyle对象的指针。

OH_ArkUI_BaselineOffsetStyle_Destroy()

void OH_ArkUI_BaselineOffsetStyle_Destroy(OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle)

描述

释放OH_ArkUI_BaselineOffsetStyle对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle	指向OH_ArkUI_BaselineOffsetStyle对象的指针。

OH_ArkUI_BaselineOffsetStyle_SetBaselineOffset()

ArkUI_ErrorCode OH_ArkUI_BaselineOffsetStyle_SetBaselineOffset(OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle, float baselineOffset)

描述

设置基线偏移量。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle	指向OH_ArkUI_BaselineOffsetStyle对象的指针。
float baselineOffset	基线偏移量，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_BaselineOffsetStyle_GetBaselineOffset()

ArkUI_ErrorCode OH_ArkUI_BaselineOffsetStyle_GetBaselineOffset(const OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle, float* baselineOffset)

描述

获取基线偏移量。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_BaselineOffsetStyle* baselineOffsetStyle	指向OH_ArkUI_BaselineOffsetStyle对象的指针。
float* baselineOffset	基线偏移量，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LetterSpacingStyle_Create()

OH_ArkUI_LetterSpacingStyle* OH_ArkUI_LetterSpacingStyle_Create()

描述

创建OH_ArkUI_LetterSpacingStyle对象。

说明：

当该对象不再使用时，调用OH_ArkUI_LetterSpacingStyle_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_LetterSpacingStyle*	指向OH_ArkUI_LetterSpacingStyle对象的指针。

OH_ArkUI_LetterSpacingStyle_Destroy()

void OH_ArkUI_LetterSpacingStyle_Destroy(OH_ArkUI_LetterSpacingStyle* letterSpacingStyle)

描述

释放OH_ArkUI_LetterSpacingStyle对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_LetterSpacingStyle* letterSpacingStyle	指向OH_ArkUI_LetterSpacingStyle对象的指针。

OH_ArkUI_LetterSpacingStyle_SetLetterSpacing()

ArkUI_ErrorCode OH_ArkUI_LetterSpacingStyle_SetLetterSpacing(OH_ArkUI_LetterSpacingStyle* letterSpacingStyle, float letterSpacing)

描述

设置字符间距。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_LetterSpacingStyle* letterSpacingStyle	指向OH_ArkUI_LetterSpacingStyle对象的指针。
float letterSpacing	字符间距值，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LetterSpacingStyle_GetLetterSpacing()

ArkUI_ErrorCode OH_ArkUI_LetterSpacingStyle_GetLetterSpacing(const OH_ArkUI_LetterSpacingStyle* letterSpacingStyle, float* letterSpacing)

描述

获取字符间距。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_LetterSpacingStyle* letterSpacingStyle	指向OH_ArkUI_LetterSpacingStyle对象的指针。
float* letterSpacing	字符间距值，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LineHeightStyle_Create()

OH_ArkUI_LineHeightStyle* OH_ArkUI_LineHeightStyle_Create()

描述

创建OH_ArkUI_LineHeightStyle对象。

说明：

当该对象不再使用时，调用OH_ArkUI_LineHeightStyle_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_LineHeightStyle*	指向OH_ArkUI_LineHeightStyle对象的指针。

OH_ArkUI_LineHeightStyle_Destroy()

void OH_ArkUI_LineHeightStyle_Destroy(OH_ArkUI_LineHeightStyle* lineHeightStyle)

描述

释放OH_ArkUI_LineHeightStyle对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_LineHeightStyle* lineHeightStyle	指向OH_ArkUI_LineHeightStyle对象的指针。

OH_ArkUI_LineHeightStyle_SetLineHeight()

ArkUI_ErrorCode OH_ArkUI_LineHeightStyle_SetLineHeight(OH_ArkUI_LineHeightStyle* lineHeightStyle, float lineHeight)

描述

设置文本行高。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_LineHeightStyle* lineHeightStyle	指向OH_ArkUI_LineHeightStyle对象的指针。
float lineHeight	固定行高值，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LineHeightStyle_GetLineHeight()

ArkUI_ErrorCode OH_ArkUI_LineHeightStyle_GetLineHeight(const OH_ArkUI_LineHeightStyle* lineHeightStyle, float* lineHeight)

描述

获取文本行高。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_LineHeightStyle* lineHeightStyle	指向OH_ArkUI_LineHeightStyle对象的指针。
float* lineHeight	固定行高值，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LineHeightStyle_SetLineHeightMultiple()

ArkUI_ErrorCode OH_ArkUI_LineHeightStyle_SetLineHeightMultiple(OH_ArkUI_LineHeightStyle* lineHeightStyle, float lineHeightMultiple)

描述

设置行高样式的行高倍数。

说明：

• lineHeightMultiple与lineHeight或OH_ArkUI_LineSpacingStyle同时设置时，仅lineHeightMultiple生效，行高为该行最高字体高度与倍数的乘积。

• lineHeightMultiple小于0时不生效，使用lineHeight和OH_ArkUI_LineSpacingStyle设置行高和行间距。

• lineHeight可以通过OH_ArkUI_LineHeightStyle_SetLineHeight()接口设置。

• lineHeightMultiple等于0时等效于设置为1。

起始版本： 26.0.0

参数：

参数项	描述
OH_ArkUI_LineHeightStyle* lineHeightStyle	指向OH_ArkUI_LineHeightStyle对象的指针。
float lineHeightMultiple	行高倍数。取值范围为[0, +∞)。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LineHeightStyle_GetLineHeightMultiple()

ArkUI_ErrorCode OH_ArkUI_LineHeightStyle_GetLineHeightMultiple(const OH_ArkUI_LineHeightStyle* lineHeightStyle, float* lineHeightMultiple)

描述

获取行高样式的行高倍数。

起始版本： 26.0.0

参数：

参数项	描述
const OH_ArkUI_LineHeightStyle* lineHeightStyle	指向OH_ArkUI_LineHeightStyle对象的指针。
float* lineHeightMultiple	行高倍数。取值范围为[0, +∞)。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_SetLineSpacingStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_SetLineSpacingStyle(OH_ArkUI_SpanStyle* spanStyle, const OH_ArkUI_LineSpacingStyle* lineSpacingStyle)

描述

设置属性字符串样式对象的行间距样式。

说明：

此操作会替换OH_ArkUI_SpanStyle对象中已设置的其他样式。

起始版本： 26.0.0

参数：

参数项	描述
OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
const OH_ArkUI_LineSpacingStyle* lineSpacingStyle	指向OH_ArkUI_LineSpacingStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_SpanStyle_GetLineSpacingStyle()

ArkUI_ErrorCode OH_ArkUI_SpanStyle_GetLineSpacingStyle(const OH_ArkUI_SpanStyle* spanStyle, OH_ArkUI_LineSpacingStyle* lineSpacingStyle)

描述

获取属性字符串样式对象的行间距样式。

起始版本： 26.0.0

参数：

参数项	描述
const OH_ArkUI_SpanStyle* spanStyle	指向OH_ArkUI_SpanStyle对象的指针。
OH_ArkUI_LineSpacingStyle* lineSpacingStyle	指向OH_ArkUI_LineSpacingStyle对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LineSpacingStyle_Create()

OH_ArkUI_LineSpacingStyle* OH_ArkUI_LineSpacingStyle_Create()

描述

创建OH_ArkUI_LineSpacingStyle对象。

说明：

该对象不再使用时，请及时调用OH_ArkUI_LineSpacingStyle_Destroy销毁。

起始版本： 26.0.0

返回：

类型	说明
OH_ArkUI_LineSpacingStyle*	指向OH_ArkUI_LineSpacingStyle对象的指针。

OH_ArkUI_LineSpacingStyle_Destroy()

void OH_ArkUI_LineSpacingStyle_Destroy(OH_ArkUI_LineSpacingStyle* lineSpacingStyle)

描述

释放OH_ArkUI_LineSpacingStyle对象占用的内存。

起始版本： 26.0.0

参数：

参数项	描述
OH_ArkUI_LineSpacingStyle* lineSpacingStyle	指向OH_ArkUI_LineSpacingStyle对象的指针。

OH_ArkUI_LineSpacingStyle_SetLineSpacing()

ArkUI_ErrorCode OH_ArkUI_LineSpacingStyle_SetLineSpacing(OH_ArkUI_LineSpacingStyle* lineSpacingStyle, float lineSpacing)

描述

设置行间距。

起始版本： 26.0.0

参数：

参数项	描述
OH_ArkUI_LineSpacingStyle* lineSpacingStyle	指向OH_ArkUI_LineSpacingStyle对象的指针。
float lineSpacing	行间距值，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LineSpacingStyle_GetLineSpacing()

ArkUI_ErrorCode OH_ArkUI_LineSpacingStyle_GetLineSpacing(const OH_ArkUI_LineSpacingStyle* lineSpacingStyle, float* lineSpacing)

描述

查询行间距。

起始版本： 26.0.0

参数：

参数项	描述
const OH_ArkUI_LineSpacingStyle* lineSpacingStyle	指向OH_ArkUI_LineSpacingStyle对象的指针。
float* lineSpacing	行间距值，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LineSpacingStyle_SetOnlyBetweenLines()

ArkUI_ErrorCode OH_ArkUI_LineSpacingStyle_SetOnlyBetweenLines(OH_ArkUI_LineSpacingStyle* lineSpacingStyle, bool onlyBetweenLines)

描述

设置行间距是否只在行间生效。

起始版本： 26.0.0

参数：

参数项	描述
OH_ArkUI_LineSpacingStyle* lineSpacingStyle	指向OH_ArkUI_LineSpacingStyle对象的指针。
bool onlyBetweenLines	行间距是否只在行间生效。true表示仅在行与行之间添加间距，首行上方、尾行下方无额外间距，false表示所有行之间、首行上方、尾行下方均添加完整行间距。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_LineSpacingStyle_GetOnlyBetweenLines()

ArkUI_ErrorCode OH_ArkUI_LineSpacingStyle_GetOnlyBetweenLines(const OH_ArkUI_LineSpacingStyle* lineSpacingStyle, bool* onlyBetweenLines)

描述

查询行间距是否只在行间生效。

起始版本： 26.0.0

参数：

参数项	描述
const OH_ArkUI_LineSpacingStyle* lineSpacingStyle	指向OH_ArkUI_LineSpacingStyle对象的指针。
bool* onlyBetweenLines	行间距是否只在行间生效。true表示仅在行与行之间添加间距，首行上方、尾行下方无额外间距，false表示所有行之间、首行上方、尾行下方均添加完整行间距。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_BackgroundColorStyle_Create()

OH_ArkUI_BackgroundColorStyle* OH_ArkUI_BackgroundColorStyle_Create()

描述

创建OH_ArkUI_BackgroundColorStyle对象。

说明：

当该对象不再使用时，调用OH_ArkUI_BackgroundColorStyle_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_BackgroundColorStyle*	指向OH_ArkUI_BackgroundColorStyle对象的指针。

OH_ArkUI_BackgroundColorStyle_Destroy()

void OH_ArkUI_BackgroundColorStyle_Destroy(OH_ArkUI_BackgroundColorStyle* style)

描述

释放OH_ArkUI_BackgroundColorStyle对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_BackgroundColorStyle* style	指向OH_ArkUI_BackgroundColorStyle对象的指针。

OH_ArkUI_BackgroundColorStyle_SetColor()

ArkUI_ErrorCode OH_ArkUI_BackgroundColorStyle_SetColor(OH_ArkUI_BackgroundColorStyle* style, uint32_t color)

描述

设置背景颜色样式的背景色。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_BackgroundColorStyle* style	指向OH_ArkUI_BackgroundColorStyle对象的指针。
uint32_t color	背景颜色，0xARGB格式。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_BackgroundColorStyle_GetColor()

ArkUI_ErrorCode OH_ArkUI_BackgroundColorStyle_GetColor(const OH_ArkUI_BackgroundColorStyle* style, uint32_t* color)

描述

获取背景颜色样式的背景色。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_BackgroundColorStyle* style	指向OH_ArkUI_BackgroundColorStyle对象的指针。
uint32_t* color	背景颜色，0xARGB格式。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_BackgroundColorStyle_SetRadius()

ArkUI_ErrorCode OH_ArkUI_BackgroundColorStyle_SetRadius(OH_ArkUI_BackgroundColorStyle* style, float topLeft, float topRight, float bottomLeft, float bottomRight)

描述

设置背景颜色样式的背景圆角。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_BackgroundColorStyle* style	指向OH_ArkUI_BackgroundColorStyle对象的指针。
float topLeft	左上角圆角半径，单位为vp。
float topRight	右上角圆角半径，单位为vp。
float bottomLeft	左下角圆角半径，单位为vp。
float bottomRight	右下角圆角半径，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_BackgroundColorStyle_GetRadius()

ArkUI_ErrorCode OH_ArkUI_BackgroundColorStyle_GetRadius(const OH_ArkUI_BackgroundColorStyle* style, float* topLeft, float* topRight, float* bottomLeft, float* bottomRight)

描述

获取背景颜色样式的背景圆角。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_BackgroundColorStyle* style	指向OH_ArkUI_BackgroundColorStyle对象的指针。
float* topLeft	左上角圆角半径，单位为vp。
float* topRight	右上角圆角半径，单位为vp。
float* bottomLeft	左下角圆角半径，单位为vp。
float* bottomRight	右下角圆角半径，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_UrlStyle_Create()

OH_ArkUI_UrlStyle* OH_ArkUI_UrlStyle_Create()

描述

创建OH_ArkUI_UrlStyle对象。

说明：

当该对象不再使用时，调用OH_ArkUI_UrlStyle_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_UrlStyle*	指向OH_ArkUI_UrlStyle对象的指针。

OH_ArkUI_UrlStyle_Destroy()

void OH_ArkUI_UrlStyle_Destroy(OH_ArkUI_UrlStyle* style)

描述

释放OH_ArkUI_UrlStyle对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_UrlStyle* style	指向OH_ArkUI_UrlStyle对象的指针。

OH_ArkUI_UrlStyle_SetUrl()

ArkUI_ErrorCode OH_ArkUI_UrlStyle_SetUrl(OH_ArkUI_UrlStyle* style, const char* url)

描述

设置超链接样式的超链接内容。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_UrlStyle* style	指向OH_ArkUI_UrlStyle对象的指针。
const char* url	超链接内容。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_UrlStyle_GetUrl()

ArkUI_ErrorCode OH_ArkUI_UrlStyle_GetUrl(const OH_ArkUI_UrlStyle* style, char* buffer, int32_t bufferSize, int32_t* writeLength)

描述

获取超链接样式的超链接内容。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_UrlStyle* style	指向OH_ArkUI_UrlStyle对象的指针。
char* buffer	超链接内容写入内存的缓冲区，内存空间需由开发者分配。
int32_t bufferSize	缓冲区最多可写入的字符的数量。
int32_t* writeLength	返回ARKUI_ERROR_CODE_NO_ERROR时，表示实际写入缓冲区的字符的数量。 返回ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR时，表示字符串完整写入缓冲区所需要的最小长度。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 缓冲区大小不足。

OH_ArkUI_UserDataSpan_Create()

OH_ArkUI_UserDataSpan* OH_ArkUI_UserDataSpan_Create()

描述

创建OH_ArkUI_UserDataSpan对象。

说明：

当该对象不再使用时，调用OH_ArkUI_UserDataSpan_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_UserDataSpan*	指向OH_ArkUI_UserDataSpan对象的指针。

OH_ArkUI_UserDataSpan_Destroy()

void OH_ArkUI_UserDataSpan_Destroy(OH_ArkUI_UserDataSpan* userDataSpan)

描述

释放OH_ArkUI_UserDataSpan对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_UserDataSpan* userDataSpan	指向OH_ArkUI_UserDataSpan对象的指针。

OH_ArkUI_UserDataSpan_SetUserData()

ArkUI_ErrorCode OH_ArkUI_UserDataSpan_SetUserData(OH_ArkUI_UserDataSpan* userDataSpan, void* userData)

描述

设置用户数据Span样式中的用户数据。

说明：

该接口允许开发者将任意类型的自定义数据关联到当前的样式对象上。用于在属性字符串中存储用户数据。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_UserDataSpan* userDataSpan	指向OH_ArkUI_UserDataSpan对象的指针。
void* userData	用户数据，生命周期需由开发者自行管理。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_UserDataSpan_GetUserData()

ArkUI_ErrorCode OH_ArkUI_UserDataSpan_GetUserData(const OH_ArkUI_UserDataSpan* userDataSpan, void** userData)

描述

获取用户数据Span样式中的用户数据。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_UserDataSpan* userDataSpan	指向OH_ArkUI_UserDataSpan对象的指针。
void** userData	用户数据。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomSpan_Create()

OH_ArkUI_CustomSpan* OH_ArkUI_CustomSpan_Create()

描述

创建OH_ArkUI_CustomSpan对象。

说明：

当该对象不再使用时，调用OH_ArkUI_CustomSpan_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_CustomSpan*	指向OH_ArkUI_CustomSpan对象的指针。

OH_ArkUI_CustomSpan_Destroy()

void OH_ArkUI_CustomSpan_Destroy(OH_ArkUI_CustomSpan* customSpan)

描述

释放OH_ArkUI_CustomSpan对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_CustomSpan* customSpan	指向OH_ArkUI_CustomSpan对象的指针。

OH_ArkUI_CustomSpan_RegisterOnMeasureCallback()

ArkUI_ErrorCode OH_ArkUI_CustomSpan_RegisterOnMeasureCallback(OH_ArkUI_CustomSpan* customSpan, ArkUI_CustomSpanMetrics*(*onMeasure)(float))

描述

设置自定义绘制Span获取尺寸大小时的回调函数。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_CustomSpan* customSpan	指向OH_ArkUI_CustomSpan对象的指针。
ArkUI_CustomSpanMetrics*(*onMeasure)(float)	获取尺寸大小的回调函数。fontSize 组件中的文本字体大小，单位为fp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_CustomSpan_RegisterOnDrawCallback()

ArkUI_ErrorCode OH_ArkUI_CustomSpan_RegisterOnDrawCallback(OH_ArkUI_CustomSpan* customSpan, void(*onDraw)(ArkUI_DrawContext*, ArkUI_CustomSpanDrawInfo*))

描述

注册自定义绘制Span绘制时的回调函数。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_CustomSpan* customSpan	指向OH_ArkUI_CustomSpan对象的指针。
void(*onDraw)(ArkUI_DrawContext*	绘制时的回调函数。context 图形绘制上下文。drawInfo 自定义绘制Span的绘制信息。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_Create()

OH_ArkUI_ImageAttachment* OH_ArkUI_ImageAttachment_Create()

描述

创建OH_ArkUI_ImageAttachment对象。

说明：

当该对象不再使用时，调用OH_ArkUI_ImageAttachment_Destroy销毁它。

起始版本： 24

返回：

类型	说明
OH_ArkUI_ImageAttachment*	指向OH_ArkUI_ImageAttachment对象的指针。

OH_ArkUI_ImageAttachment_Destroy()

void OH_ArkUI_ImageAttachment_Destroy(OH_ArkUI_ImageAttachment* imageAttachment)

描述

释放OH_ArkUI_ImageAttachment对象占用的内存。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。

OH_ArkUI_ImageAttachment_SetPixelMap()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetPixelMap(OH_ArkUI_ImageAttachment* imageAttachment, struct OH_PixelmapNative* pixelmap)

描述

设置图片样式中的图片数据源。

说明：

与OH_ArkUI_ImageAttachment_SetResource同时设置时，后设置的生效。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
struct OH_PixelmapNative* pixelmap	图片数据源。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_GetPixelMap()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetPixelMap(const OH_ArkUI_ImageAttachment* imageAttachment, struct OH_PixelmapNative** pixelmap)

描述

获取图片样式中的图片数据源。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
struct OH_PixelmapNative** pixelmap	图片数据源。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_SetResource()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetResource(OH_ArkUI_ImageAttachment* imageAttachment, const char* resource)

描述

设置图片样式中的图片资源地址。

说明：

与OH_ArkUI_ImageAttachment_SetPixelMap同时设置时，后设置的生效。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
const char* resource	图片资源地址。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_GetResource()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetResource(const OH_ArkUI_ImageAttachment* imageAttachment, char* buffer, int32_t bufferSize, int32_t* writeLength)

描述

获取图片样式中的图片资源地址。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
char* buffer	图片资源地址字符串写入内存的缓冲区，内存空间需由开发者分配。
int32_t bufferSize	缓冲区大小。
int32_t* writeLength	返回ARKUI_ERROR_CODE_NO_ERROR时，表示实际写入缓冲区的字符串长度。 返回ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR时，表示字符串完整写入缓冲区所需要的最小长度。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 缓冲区大小不足。

OH_ArkUI_ImageAttachment_SetSizeWidth()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetSizeWidth(OH_ArkUI_ImageAttachment* imageAttachment, float width)

描述

设置图片样式中的图片宽度。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
float width	图片宽度，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_GetSizeWidth()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetSizeWidth(const OH_ArkUI_ImageAttachment* imageAttachment, float* width)

描述

获取图片样式中的图片宽度。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
float* width	图片宽度，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_SetSizeHeight()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetSizeHeight(OH_ArkUI_ImageAttachment* imageAttachment, float height)

描述

设置图片样式中的图片高度。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
float height	图片高度，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_GetSizeHeight()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetSizeHeight(const OH_ArkUI_ImageAttachment* imageAttachment, float* height)

描述

获取图片样式中的图片高度。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
float* height	图片高度，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_SetVerticalAlign()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetVerticalAlign(OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_ImageSpanAlignment verticalAlign)

描述

设置图片样式中的图片对齐方式。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
ArkUI_ImageSpanAlignment verticalAlign	图片对齐方式。取值为ArkUI_ImageSpanAlignment中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_GetVerticalAlign()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetVerticalAlign(const OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_ImageSpanAlignment* verticalAlign)

描述

获取图片样式中的图片对齐方式。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
ArkUI_ImageSpanAlignment* verticalAlign	图片对齐方式。取值为ArkUI_ImageSpanAlignment中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_SetObjectFit()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetObjectFit(OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_ObjectFit objectFit)

描述

设置图片样式中的图片缩放类型。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
ArkUI_ObjectFit objectFit	图片缩放类型。取值为ArkUI_ObjectFit中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_GetObjectFit()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetObjectFit(const OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_ObjectFit* objectFit)

描述

获取图片样式中的图片缩放类型。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
ArkUI_ObjectFit* objectFit	图片缩放类型。取值为ArkUI_ObjectFit中的枚举。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_SetMargin()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetMargin(OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_Margin margin)

描述

设置图片样式中的图片外边距。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
ArkUI_Margin margin	图片外边距，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_GetMargin()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetMargin(const OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_Margin* margin)

描述

获取图片样式中的图片外边距。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
ArkUI_Margin* margin	图片外边距，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_SetPadding()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetPadding(OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_Margin padding)

描述

设置图片样式中的图片内边距。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
ArkUI_Margin padding	图片内边距，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_GetPadding()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetPadding(const OH_ArkUI_ImageAttachment* imageAttachment, ArkUI_Margin* padding)

描述

获取图片样式中的图片内边距。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
ArkUI_Margin* padding	图片内边距，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_SetBorderRadiuses()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetBorderRadiuses(OH_ArkUI_ImageAttachment* imageAttachment, float topLeft, float topRight, float bottomLeft, float bottomRight)

描述

设置图片样式中的图片圆角。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
float topLeft	左上角圆角半径，单位为vp。
float topRight	右上角圆角半径，单位为vp。
float bottomLeft	左下角圆角半径，单位为vp。
float bottomRight	右下角圆角半径，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_GetBorderRadiuses()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetBorderRadiuses(const OH_ArkUI_ImageAttachment* imageAttachment, float* topLeft, float* topRight, float* bottomLeft, float* bottomRight)

描述

获取图片样式中的图片圆角。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
float* topLeft	左上角圆角半径，单位为vp。
float* topRight	右上角圆角半径，单位为vp。
float* bottomLeft	左下角圆角半径，单位为vp。
float* bottomRight	右下角圆角半径，单位为vp。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_SetColorFilter()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetColorFilter(OH_ArkUI_ImageAttachment* imageAttachment, const float* colorFilter, uint32_t size)

描述

设置图片样式中的图片颜色过滤器。

说明：

与OH_ArkUI_ImageAttachment_SetDrawingColorFilter同时设置时，后设置的生效。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
const float* colorFilter	图片颜色过滤器。
uint32_t size	过滤器数组大小。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_GetColorFilter()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetColorFilter(const OH_ArkUI_ImageAttachment* imageAttachment, float** colorFilter, uint32_t colorFilterSize, uint32_t* writeLength)

描述

获取图片样式中的图片颜色过滤器。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
float** colorFilter	图片颜色过滤器写入内存的缓冲区，内存空间需由开发者分配。
uint32_t colorFilterSize	缓冲区大小。
uint32_t* writeLength	图片颜色过滤器数组的实际大小。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。 ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR 缓冲区大小不足。

OH_ArkUI_ImageAttachment_SetDrawingColorFilter()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetDrawingColorFilter(OH_ArkUI_ImageAttachment* imageAttachment, const OH_Drawing_ColorFilter* drawingColorFilter)

描述

设置图片样式中的图片颜色滤镜。

说明：

与OH_ArkUI_ImageAttachment_SetColorFilter同时设置时，后设置的生效。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
const OH_Drawing_ColorFilter* drawingColorFilter	图片颜色滤镜。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_GetDrawingColorFilter()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetDrawingColorFilter(const OH_ArkUI_ImageAttachment* imageAttachment, OH_Drawing_ColorFilter* drawingColorFilter)

描述

获取图片样式中的图片颜色滤镜。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
OH_Drawing_ColorFilter* drawingColorFilter	图片颜色滤镜。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_SetSyncLoad()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetSyncLoad(OH_ArkUI_ImageAttachment* imageAttachment, bool syncLoad)

描述

设置图片样式中是否同步加载图片。

说明：

此属性仅在通过OH_ArkUI_ImageAttachment_SetResource设置图片源为资源地址时生效。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
bool syncLoad	是否同步加载图片。true表示同步加载；false表示异步加载。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_GetSyncLoad()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetSyncLoad(const OH_ArkUI_ImageAttachment* imageAttachment, bool* syncLoad)

描述

获取图片样式中是否同步加载图片。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
bool* syncLoad	是否同步加载图片。true表示同步加载；false表示异步加载。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_SetSupportSvg()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_SetSupportSvg(OH_ArkUI_ImageAttachment* imageAttachment, bool supportSvg)

描述

设置图片样式中是否开启SVG标签解析能力增强功能。

起始版本： 24

参数：

参数项	描述
OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
bool supportSvg	是否开启SVG标签解析能力增强功能。true表示开启；false表示不开启。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ImageAttachment_GetSupportSvg()

ArkUI_ErrorCode OH_ArkUI_ImageAttachment_GetSupportSvg(const OH_ArkUI_ImageAttachment* imageAttachment, bool* supportSvg)

描述

获取图片样式中是否开启SVG标签解析能力增强功能。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_ImageAttachment* imageAttachment	指向OH_ArkUI_ImageAttachment对象的指针。
bool* supportSvg	是否开启SVG标签解析能力增强功能。true表示开启；false表示未开启。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextEditorChangeEvent_GetRangeBefore()

ArkUI_ErrorCode OH_ArkUI_TextEditorChangeEvent_GetRangeBefore(const OH_ArkUI_TextEditorChangeEvent* event, uint32_t* start, uint32_t* end)

描述

获取文本变化信息中的待替换内容的范围。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_TextEditorChangeEvent* event	指向OH_ArkUI_TextEditorChangeEvent对象的指针。
uint32_t* start	待替换内容范围的起始索引。
uint32_t* end	待替换内容范围的结束索引。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextEditorChangeEvent_GetReplacementStyledString()

ArkUI_ErrorCode OH_ArkUI_TextEditorChangeEvent_GetReplacementStyledString(const OH_ArkUI_TextEditorChangeEvent* event, ArkUI_StyledString_Descriptor* descriptor)

描述

获取文本变化信息中的用于替换的属性字符串。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_TextEditorChangeEvent* event	指向OH_ArkUI_TextEditorChangeEvent对象的指针。
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextEditorChangeEvent_GetPreviewStyledString()

ArkUI_ErrorCode OH_ArkUI_TextEditorChangeEvent_GetPreviewStyledString(const OH_ArkUI_TextEditorChangeEvent* event, ArkUI_StyledString_Descriptor* descriptor)

描述

获取文本变化信息中的预览内容属性字符串。

起始版本： 24

参数：

参数项	描述
const OH_ArkUI_TextEditorChangeEvent* event	指向OH_ArkUI_TextEditorChangeEvent对象的指针。
ArkUI_StyledString_Descriptor* descriptor	指向ArkUI_StyledString_Descriptor对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果码。 ARKUI_ERROR_CODE_NO_ERROR 操作成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextLayoutManager_Dispose()

void OH_ArkUI_TextLayoutManager_Dispose(ArkUI_TextLayoutManager* layoutManager)

描述

释放被文本布局管理器对象占据的内存。

起始版本： 22

参数：

参数项	描述
ArkUI_TextLayoutManager* layoutManager	指向ArkUI_TextLayoutManager对象的指针。

OH_ArkUI_TextLayoutManager_GetLineCount()

ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetLineCount(ArkUI_TextLayoutManager* layoutManager, int32_t* outLineCount)

描述

获取文本行数。

起始版本： 22

参数：

参数项	描述
ArkUI_TextLayoutManager* layoutManager	指向ArkUI_TextLayoutManager对象的指针。
int32_t* outLineCount	文本行数。

返回：

类型	说明
ArkUI_ErrorCode	返回结果。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextLayoutManager_GetRectsForRange()

ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetRectsForRange(ArkUI_TextLayoutManager* layoutManager, int32_t start, int32_t end, OH_Drawing_RectWidthStyle widthStyle, OH_Drawing_RectHeightStyle heightStyle, OH_Drawing_TextBox** outTextBoxes)

描述

获取给定的矩形区域宽度样式以及高度样式的规格下，文本中任意区间范围内的字符或占位符所占的绘制区域信息。

起始版本： 22

参数：

参数项	描述
ArkUI_TextLayoutManager* layoutManager	指向ArkUI_TextLayoutManager对象的指针。
int32_t start	起始位置索引，start取值需要大于等于0，否则会返回参数异常。
int32_t end	结束位置索引，end取值需要大于等于start，否则会返回参数异常。
OH_Drawing_RectWidthStyle widthStyle	矩形区域宽度样式。
OH_Drawing_RectHeightStyle heightStyle	矩形区域高度样式。
OH_Drawing_TextBox** outTextBoxes	指向OH_Drawing_TextBox对象的二级指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextLayoutManager_GetGlyphPositionAtCoordinate()

ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetGlyphPositionAtCoordinate(ArkUI_TextLayoutManager* layoutManager, double dx, double dy, OH_Drawing_PositionAndAffinity** outPos)

描述

获取距离给定坐标最近的字形的位置信息。

起始版本： 22

参数：

参数项	描述
ArkUI_TextLayoutManager* layoutManager	指向ArkUI_TextLayoutManager对象的指针。
double dx	相对于控件的x坐标，单位为px。
double dy	相对于控件的y坐标，单位为px。
OH_Drawing_PositionAndAffinity** outPos	指向OH_Drawing_PositionAndAffinity对象的二级指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextLayoutManager_GetLineMetrics()

ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetLineMetrics(ArkUI_TextLayoutManager* layoutManager, int32_t lineNumber, OH_Drawing_LineMetrics* outMetrics)

描述

获取指定行的行信息、文本样式信息、以及字体属性信息。

起始版本： 22

参数：

参数项	描述
ArkUI_TextLayoutManager* layoutManager	指向ArkUI_TextLayoutManager对象的指针。
int32_t lineNumber	指定行的行号索引，行号索引从0开始计数，lineNumber小于0或大于等于文本行数时会返回参数异常。
OH_Drawing_LineMetrics* outMetrics	指向OH_Drawing_LineMetrics对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextLayoutManager_GetCharacterPositionAtCoordinate()

ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetCharacterPositionAtCoordinate(ArkUI_TextLayoutManager* layoutManager, double dx, double dy, OH_Drawing_PositionAndAffinity** outPos)

描述

获取距离指定坐标最近的字符的位置信息。

起始版本： 24

参数：

参数项	描述
ArkUI_TextLayoutManager* layoutManager	指向ArkUI_TextLayoutManager对象的指针。
double dx	相对于控件的x坐标，单位为px。
double dy	相对于控件的y坐标，单位为px。
OH_Drawing_PositionAndAffinity** outPos	指向OH_Drawing_PositionAndAffinity对象的二级指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextLayoutManager_GetGlyphRangeForCharacterRange()

ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetGlyphRangeForCharacterRange(ArkUI_TextLayoutManager* layoutManager, OH_Drawing_Range* charRange, OH_Drawing_Range** outGlyphRange,
OH_Drawing_Range** outActualCharRange);

描述

获取由指定字符索引范围所生成的字形索引范围以及实际的字符索引范围。例如文本为"世界Hello"，其中文本"世"的字形索引范围为[0, 1]，一个汉字占三个字符，所以其对应的字符索引范围为[0, 3]。如果指定的字符索引范围是[0, 1]，但无法解析出三分之一个汉字，所以实际的字符索引范围是[0, 3]。outGlyphRange、outActualCharRange返回的OH_Drawing_Range对象在使用完成后，需通过OH_Drawing_ReleaseRangeBuffer释放。

起始版本： 24

参数：

参数项	描述
ArkUI_TextLayoutManager* layoutManager	指向ArkUI_TextLayoutManager对象的指针。
OH_Drawing_Range* charRange	指向OH_Drawing_Range对象的指针，表示字符索引范围。
OH_Drawing_Range** outGlyphRange	指向OH_Drawing_Range对象的二级指针，表示字形索引范围。
OH_Drawing_Range** outActualCharRange	指向OH_Drawing_Range对象的二级指针，表示实际的字符索引范围。

返回：

类型	说明
ArkUI_ErrorCode	返回结果。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_TextLayoutManager_GetCharacterRangeForGlyphRange()

ArkUI_ErrorCode OH_ArkUI_TextLayoutManager_GetCharacterRangeForGlyphRange(ArkUI_TextLayoutManager* layoutManager, OH_Drawing_Range* glyphRange, OH_Drawing_Range** outCharRange,
OH_Drawing_Range** outActualGlyphRange)

描述

获取由指定字形索引范围所生成的字符索引范围以及实际的字形索引范围。例如文本为"世界Hello"，其字形索引范围为[0, 7]，一个汉字占三个字符，所以其对应的字符索引范围为[0, 11]。如果指定的索引范围是[0, 11]，但字形一共只有7个，所以实际的字形索引范围是[0, 7]。outCharRange、outActualGlyphRange返回的OH_Drawing_Range对象在使用完成后，需通过OH_Drawing_ReleaseRangeBuffer释放。

起始版本： 24

参数：

参数项	描述
ArkUI_TextLayoutManager* layoutManager	指向ArkUI_TextLayoutManager对象的指针。
OH_Drawing_Range* glyphRange	指向OH_Drawing_Range对象的指针，表示字形索引范围。
OH_Drawing_Range** outCharRange	指向OH_Drawing_Range对象的二级指针，表示字符索引范围。
OH_Drawing_Range** outActualGlyphRange	指向OH_Drawing_Range对象的二级指针，表示实际的字形索引范围。

返回：

类型	说明
ArkUI_ErrorCode	返回结果。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_SetLinearGradient()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetLinearGradient(OH_ArkUI_ParagraphStyle* paragraphStyle, const OH_ArkUI_LinearGradientOptions* linearGradient)

描述

设置段落样式的线性渐变。

起始版本： 26.0.0

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
const OH_ArkUI_LinearGradientOptions* linearGradient	指向OH_ArkUI_LinearGradientOptions对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_GetLinearGradient()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetLinearGradient(const OH_ArkUI_ParagraphStyle* paragraphStyle, OH_ArkUI_LinearGradientOptions* linearGradient)

描述

获取段落样式的线性渐变。

起始版本： 26.0.0

参数：

参数项	描述
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
OH_ArkUI_LinearGradientOptions* linearGradient	指向OH_ArkUI_LinearGradientOptions对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_SetRadialGradient()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_SetRadialGradient(OH_ArkUI_ParagraphStyle* paragraphStyle, const OH_ArkUI_RadialGradientOptions* radialGradient)

描述

设置段落样式的径向渐变。

起始版本： 26.0.0

参数：

参数项	描述
OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
const OH_ArkUI_RadialGradientOptions* radialGradient	指向OH_ArkUI_RadialGradientOptions对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。

OH_ArkUI_ParagraphStyle_GetRadialGradient()

ArkUI_ErrorCode OH_ArkUI_ParagraphStyle_GetRadialGradient(const OH_ArkUI_ParagraphStyle* paragraphStyle, OH_ArkUI_RadialGradientOptions* radialGradient)

描述

获取段落样式的径向渐变。

起始版本： 26.0.0

参数：

参数项	描述
const OH_ArkUI_ParagraphStyle* paragraphStyle	指向OH_ArkUI_ParagraphStyle对象的指针。
OH_ArkUI_RadialGradientOptions* radialGradient	指向OH_ArkUI_RadialGradientOptions对象的指针。

返回：

类型	说明
ArkUI_ErrorCode	返回结果。 ARKUI_ERROR_CODE_NO_ERROR 成功。 ARKUI_ERROR_CODE_PARAM_INVALID 函数参数异常。