当开发者希望在组件上设置自定义的属性时,可以使用自定义属性设置功能,在组件上设置自定义的属性。而这些自定义属性可以在其对应的FrameNode上获取,从而实现更自由的组件管理。
customProperty
customProperty(name: string, value: Optional<Object>)
设置组件的自定义属性。自定义组件不支持设置自定义属性。
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
name | string | 是 | 自定义属性的名称。 |
value | Optional<Object> | 是 | 自定义属性的值。 |
Optional
Optional<T>
定义可选类型,其值可以是undefined。
示例
// 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%')
}
}
参考:文档中心