鸿蒙OpenHarmony【自定义属性设置】ArkTS组件通用属性

customProperty

customProperty(name: string, value: Optional)

设置组件的自定义属性。[自定义组件](不支持设置自定义属性。

卡片能力：  从API version 12开始，该接口支持在ArkTS卡片中使用。

元服务API：  从API version 12开始，该接口支持在元服务中使用。

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

参数：

参数名	类型	必填	说明
name	string	是	自定义属性的名称。
value	Optional	是	自定义属性的值。

Optional12+

Optional

定义可选类型，其值可以是undefined。

元服务API：  从API version 12开始，该接口支持在元服务中使用。

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

卡片能力：  从API version 12开始，该接口支持在ArkTS卡片中使用。

示例

// xxx.ets
import { FrameNode, UIContext } from '@kit.ArkUI';

@Entry
@Component
struct CustomPropertyExample {
  build() {
    Column() {
      Text('text')
      Button('print').onClick(() => {
        const uiContext: UIContext = this.getUIContext();
        if (uiContext) {
          const node: FrameNode | null = uiContext.getFrameNodeById("Test_Column") || null;
          if (node) {
            for (let i = 1; i < 4; i++) {
              const key = 'customProperty' + i;
              const property = node.getCustomProperty(key);
              console.log(key, JSON.stringify(property));
            }
          }
        }
      })
    }
    .id('Test_Column')
    .customProperty('customProperty1', {
      'number': 10,
      'string': 'this is a string',
      'bool': true,
      'object': {
        'name': 'name',
        'value': 100
      }
    })
    .customProperty('customProperty2', {})
    .customProperty('customProperty2', undefined)
    .width('100%')
    .height('100%')
  }
}