harmonyos 华为 ArkUI android 鸿蒙系统鸿蒙Harmony应用开发—ArkTS声明式开发（通用属性：组件标识）

id为组件的唯一标识，在整个应用内唯一。本模块提供组件标识相关接口，可以获取指定id组件的属性，也提供向指定id组件发送事件的功能。

说明：

从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

属性

名称参数说明描述idstring组件的唯一标识，唯一性由使用者保证。默认值：'' 从API version 9开始，该接口支持在ArkTS卡片中使用。

接口

getInspectorByKey9+

getInspectorByKey(id: string): string

获取指定id的组件的所有属性，不包括子组件信息。

此接口仅用于对应用的测试。由于耗时长，不建议使用。

参数:

参数类型必填描述idstring是要获取属性的组件id。

返回值:

类型描述string组件属性列表的JSON字符串。说明：字符串信息包含组件的tag、id、位置信息(相对于窗口左上角的坐标)以及用于测试检查的组件所包含的相关属性信息。

getInspectorTree9+

getInspectorTree(): Object

获取组件树及组件属性。

此接口仅用于对应用的测试。由于耗时长，不建议使用。

返回值:

类型描述Object组件树及组件属性列表的JSON对象。

sendEventByKey9+

sendEventByKey(id: string, action: number, params: string): boolean

给指定id的组件发送事件。

此接口仅用于对应用的测试。由于耗时长，不建议使用。

参数:

参数类型必填描述idstring是要触发事件的组件的id。actionnumber是要触发的事件类型，目前支持取值： - 点击事件Click: 10 - 长按事件LongClick: 11。paramsstring是事件参数，无参数传空字符串 ""。

返回值:

类型描述boolean找不到指定id的组件时返回false，其余情况返回true。

sendTouchEvent9+

sendTouchEvent(event: TouchObject): boolean

发送触摸事件。

此接口仅用于对应用的测试。由于耗时长，不建议使用。

参数:

参数类型必填描述eventTouchObject是触发触摸事件的位置，event参数见TouchEvent中TouchObject的介绍。

返回值:

类型描述boolean事件发送失败时返回false，其余情况返回true。

sendKeyEvent9+

sendKeyEvent(event: KeyEvent): boolean

发送按键事件。

此接口仅用于对应用的测试。由于耗时长，不建议使用。

参数:

参数类型必填描述eventKeyEvent是按键事件，event参数见KeyEvent介绍。

返回值:

类型描述boolean事件发送失败时时返回false，其余情况返回true。

sendMouseEvent9+

sendMouseEvent(event: MouseEvent): boolean

发送鼠标事件。

此接口仅用于对应用的测试。由于耗时长，不建议使用。

参数：

参数类型必填描述eventMouseEvent是鼠标事件，event参数见MouseEvent介绍。

返回值：

类型描述boolean事件发送失败时返回false，其余情况返回true。

示例

// xxx.ets

import { IntentionCode } from '@ohos.multimodalInput.intentionCode'

class Utils {

static rect_left: number

static rect_top: number

static rect_right: number

static rect_bottom: number

static rect_value: Record

//获取组件所占矩形区域坐标

static getComponentRect(key:string):Record {

let strJson = getInspectorByKey(key)

let obj:Record = JSON.parse(strJson)

console.info("[getInspectorByKey] current component obj is: " + JSON.stringify(obj))

let rectInfo:string[] = JSON.parse('[' + obj.$rect + ']')

console.info("[getInspectorByKey] rectInfo is: " + rectInfo)

Utils.rect_left = JSON.parse('[' + rectInfo[0] + ']')[0]

Utils.rect_top = JSON.parse('[' + rectInfo[0] + ']')[1]

Utils.rect_right = JSON.parse('[' + rectInfo[1] + ']')[0]

Utils.rect_bottom = JSON.parse('[' + rectInfo[1] + ']')[1]

return Utils.rect_value = {

"left": Utils.rect_left, "top": Utils.rect_top, "right": Utils.rect_right, "bottom": Utils.rect_bottom

}

@Entry

@Component

struct IdExample {

@State text: string = ''

build() {

Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {

Button() {

Text('onKeyTab').fontSize(25).fontWeight(FontWeight.Bold)

}.margin({ top: 20 }).backgroundColor('#0D9FFB')

.onKeyEvent(() => {

this.text = "onKeyTab"

})

Button() {

Text('click to start').fontSize(25).fontWeight(FontWeight.Bold)

}.margin({ top: 20 })

.onClick(() => {

console.info(getInspectorByKey("click"))

console.info(JSON.stringify(getInspectorTree()))

this.text = "Button 'click to start' is clicked"

setTimeout(() => {

sendEventByKey("longClick", 11, "") // 向id为"longClick"的组件发送长按事件

}, 2000)

}).id('click')

Button() {

Text('longClick').fontSize(25).fontWeight(FontWeight.Bold)

}.margin({ top: 20 }).backgroundColor('#0D9FFB')

.gesture(

LongPressGesture().onActionEnd(() => {

console.info('long clicked')

this.text = "Button 'longClick' is longclicked"

setTimeout(() => {

let rect = Utils.getComponentRect('onTouch') // 获取id为"onTouch"组件的矩形区域坐标

let touchPoint: TouchObject = {

id: 1,

type: TouchType.Down,

x: rect.left + (rect.right - rect.left) / 2, // 相对于组件左上角的水平方向坐标

y: rect.top + (rect.bottom - rect.top) / 2, // 相对于组件左上角的垂直方向坐标

screenX: rect.left + (rect.right - rect.left) / 2, // 相对于应用窗口左上角的水平方向坐标，API10已废弃，采用windowX替代

screenY: rect.left + (rect.right - rect.left) / 2, // 相对于应用窗口左上角的垂直方向坐标，API10已废弃，采用windowY替代

windowX: rect.left + (rect.right - rect.left) / 2, // 相对于应用窗口左上角的水平方向坐标

windowY: rect.left + (rect.right - rect.left) / 2, // 相对于应用窗口左上角的垂直方向坐标

displayX: rect.left + (rect.right - rect.left) / 2, // 相对于设备屏幕左上角的水平方向坐标

displayY: rect.left + (rect.right - rect.left) / 2, // 相对于设备屏幕左上角的垂直方向坐标

}

sendTouchEvent(touchPoint) // 发送触摸事件

touchPoint.type = TouchType.Up

sendTouchEvent(touchPoint) // 发送触摸事件

}, 2000)

})).id('longClick')

Button() {

Text('onTouch').fontSize(25).fontWeight(FontWeight.Bold)

}.type(ButtonType.Capsule).margin({ top: 20 })

.onClick(() => {

console.info('onTouch is clicked')

this.text = "Button 'onTouch' is clicked"

setTimeout(() => {

let rect = Utils.getComponentRect('onMouse') // 获取id为"onMouse"组件的矩形区域坐标

let mouseEvent: MouseEvent = {

button: MouseButton.Left,

action: MouseAction.Press,