• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 自定义组件内置方法
2
3自定义组件内置方法是由ArkUI开发框架提供给应用开发者的,定义在自定义组件基类上的API。应用开发者可以在自定义组件的实例上调用对应的API以获取当前自定义组件实例相关的信息。例如,查询当前自定组件上下文的UIContext信息。
4
5> **说明:**
6>
7> 本模块首批接口从API version 11开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
8>
9
10## getUIContext
11
12getUIContext(): UIContext
13
14获取UIContext对象。
15
16**系统能力:** SystemCapability.ArkUI.ArkUI.Full
17
18**返回值:**
19
20| 类型                                                      | 说明                    |
21| --------------------------------------------------------- | ----------------------- |
22| [UIContext](../js-apis-arkui-UIContext.md#uicontext) | 返回UIContext实例对象。 |
23
24**示例:**
25
26```ts
27import { UIContext } from '@ohos.arkui.UIContext';
28
29@Entry
30@Component
31struct MyComponent {
32  aboutToAppear() {
33    let uiContext: UIContext = this.getUIContext();
34  }
35
36  build() {
37    // ...
38  }
39}
40```
41
42## queryNavDestinationInfo
43
44queryNavDestinationInfo(): NavDestinationInfo | undefined;
45
46获取NavDestinationInfo实例对象。
47
48**系统能力:** SystemCapability.ArkUI.ArkUI.Full
49
50**返回值:**
51
52| 类型                                                                       | 说明      |
53| -------------------------------------------------------------------------- | --------- |
54| [NavDestinationInfo](../js-apis-arkui-observer.md#navdestinationinfo) \| undefined | 返回NavDestinationInfo实例对象。 |
55
56**示例:**
57
58```ts
59import observer from '@ohos.arkui.observer';
60
61@Entry
62@Component
63struct MyComponent {
64  aboutToAppear() {
65    let info: observer.NavDestinationInfo | undefined = this.queryNavDestinationInfo();
66  }
67
68  build() {
69    // ...
70  }
71}
72```
73