ページ モジュール
重要
財務と運用 (Dynamics 365) モバイル アプリおよびプラットフォームは、サポートされなくなりました。 モバイル アプリをサポートするプラットフォーム コンポーネントは、将来の更新で削除される予定です。 モバイル アプリは、アプリストアからも削除されました。 以前にインストールしたアプリのインスタンスは引き続き動作します。 詳細については、削除済みまたは非推奨のプラットフォーム機能を参照してください。
IPage インターフェイスは、さまざまなプロパティ、ライフ サイクル、およびワークスペース内のページに関連付けられているイベント フックをカプセル化します。
ページ データ同期
変更を送信できるページ (アクションとも呼ばれる) は、サーバーと完全に同期される前にさまざまなステージを通過します。 ページが 送信 されるとすぐに、起こり得る結果が 3 つあります。
- クライアント側の検証に失敗する場合: クライアント ロジックによってページを送信できない可能性があります。
- クライアントはオンラインです。アプリケーション全体の同期キューがクリアされるとすぐに、送信が処理されます。
- クライアントはオフラインです。送信はアプリケーション全体の同期キューに追加され、クライアントがオフラインである限り、そこにとどまります。
送信の同期の待機中は、以下のいずれかの状態にあります。
- 保留中: 送信が保留中ですが、編集することはできます。
- 処理: 送信は現在同期中です。 この状態では、ページをこれ以上編集できません。
送信がサーバーに送られた後、次のいずれかの状態になります。
- 同期済み: 送信はサーバーに受け入れられて同期されます。
- エラー: サーバーは、送信を拒否およびページがエラー状態を入力します。
特定のページおよびコンテキストにおいて保留中の送信が複数あり、ページが冪等であるとみなされる場合、集められる (かつ送信される) 場合があります。 これは、サーバーがすべての送信をさまざまな順序で処理する必要はなく、サーバー上のページの設計に依存することを意味します。
指数
列挙
種類
列挙
PageState
列挙型メンバー
| 氏名 | 署名 | 説明 |
|---|---|---|
| エラー | エラー: 10 |
ページは現在、エラー状態にありますが、更新することでこの状態から抜け出すことができます。 |
| loaded | 積込済: 3 |
ページが完全に読み込まれ、更新可能であり、可能ならば送信できます。 |
| loading | 読み込み中: 2 |
ページが現在読み込まれています。 |
| オフライン | オフライン: 1 |
ページはオフライン モードで読み込まれたので更新できません。 |
| 更新中 | 更新中: 4 |
ページは現在データを更新中です。 |
種類
CompleteEventArgs
階層
CompleteEventArgs
プロパティ
| 氏名 | 署名 | 説明 |
|---|---|---|
| エラー | エラー: ブール値 (省略可) |
|
| ナビゲーション | navigation: NavigationArgs (省略可) |
|
| 処理済 | processed: ブール値 (省略可) |
デザイン
階層
デザイン
└─ PageLinkDesign
└─ ContainerControlDesign
└─ InputControlDesign
└─ ImageDesign
プロパティ
| 氏名 | 署名 | 説明 |
|---|---|---|
| alignItems | alignItems: 文字列 (省略可) |
このプロパティは、CSS プロパティ「align-items」のエイリアスです。 |
| alignSelf | alignSelf: 文字列 (省略可) |
|
| バインディング | bindings: 任意 (省略可) |
|
| border | border: "none" | "solid" | "left" | "right" | "top" | "bottom" (オプション) |
コントロールの境界動作。 このプロパティは、子によって継承されません。 |
| 色 | color: 文字列 (省略可) |
コンテナーの前景色。 |
| flexFlow | flexFlow: 文字列 (省略可) |
このプロパティを指定すると、コンポーネントがフレックス コンテナー コンポーネントになります。 |
| flexSize | flexSize: 文字列 (省略可) |
1 つの番号または 2 つの番号が文字列として書き込まれています。 たとえば、「(サイズを拡大) [(サイズを縮小)]」して、即時フレックス コンテナーの使用可能領域に対応します。 |
| fontSize | fontSize: "medium" | "xx-small" | "x-small" | "small" | "large" | "x-large" | "xx-large" (省略可) |
比例テキスト サイズ |
| fontWeight | fontWeight: "normal" | "bold" (省略可) |
標準または太字のテキスト。 |
| justifyItems | justifyItems: "flex-start" | "flex-end" | "center" | "space-between" (省略可) |
このプロパティは CSS プロパティ「justify-content」のエイリアスです。 |
| ラベル | label: 文字列 (省略可) |
|
| labelPosition | labelPosition: "stacked" | "hidden" | "inline" (省略可) |
ラベルの配置方法を決定します (行われる場合)。 既定では、labelPosition が stacked に設定されています。 |
| 名前 | name: 文字列 (省略可) |
|
| padding | padding: "none" | "small" | "std" (省略可) |
コンポーネントのスペース動作を指定できるように許可します。 |
| タイプ | type: ControlType (省略可) |
文字列としてのコントロールのタイプ。 |
NavigationArgs
階層
PageTarget
└─ NavigationArgs
プロパティ
| 氏名 | 署名 | 説明 |
|---|---|---|
| ラベル | label: 文字列 (省略可) |
|
| オプション | options: any (省略可) |
|
| パラメーター | params: PageOptions (省略可) |
PageTarget.params から継承 |
| 置換 | replace: ブール値 (省略可) |
true と設定されている場合は、ナビゲーション履歴スタックから現在のビューの起動ナビゲーションを削除します。 |
| to | to: 文字列 (省略可) |
PageTarget.to から継承 |
| url | url: 文字列 (省略可) |
指定した場合、このリンクは直接開かれます。 |
ページ
階層
ページ
プロパティ
| 氏名 | 署名 | 説明 |
|---|---|---|
| 子 | children: Control [ ] |
ページのすべての直接の子コントロールの一覧。 |
| dataLoadedInitially | dataLoadedInitially: Promise <void> |
初めてデータが読み込まれたときに解決する約束。 |
| 初期化済み | initialized: ブール値 |
ページ インスタンスが初期化されている場合は、true です。 |
| メタデータ | metadata: PageMetadata |
ページ メタデータ。 |
| metadataLoaded | metadataLoaded: Promise <void> |
メタデータが読み込みを完了したときに解決する約束。 |
| pageContext | pageContext: string |
現在のページ コンテキスト。 |
| pageFilter | pageFilter: DataFilter |
ページに適用されている現在のフィルター。 |
| 状態 | state: PageState |
ページの現在のステータス。 |
| syncError | syncError: ブール値 |
ページの送信がエラー状態の場合、true です。 これは通常、検証エラーのためにサーバーが送信を拒否した場合に発生します。 |
| syncPending | syncPending: ブール値 |
ページの送信が同期の待機中の場合、true です。 |
| syncProcessing | syncProcessing: ブール値 |
ページ インスタンスが現在送信を同期している場合は true です。 |
| syncUnitEditable | syncUnitEditable: ブール値 |
同期の待機中に送信が編集可能な場合、true です。 |
| タイトル | タイトル: 文字列 |
ページのタイトル。 |
メソッド
| 氏名 | 署名 | 説明 |
|---|---|---|
| canSubmit | canSubmit(): boolean | アクション ページが送信可能で、検証エラー メッセージが存在しない場合は、true を返します。 |
| 閉じる | close(): void | ページ インスタンスとすべてのライフ サイクルイベントを破棄します。 |
| getAction | getAction(actionName: string): PageLink | 名前でページ アクションを取得します。 |
| getActions | getActions(): PageLink [ ] | すべてのページ アクションを取得します。 |
| getControl | getControl(controlName: string): Control | 名前でページ コントロールを取得します。 |
| getDesign | getDesign(): Design | ページに関連付けられているデザイン オブジェクトを取得します。 |
| getEntityContext | getEntityContext(): EntityRef | 現在のエンティティ コンテキストを取得します。 |
| isEditable | isEditable(): boolean | ページがアクション ページの場合は true を返します |
| refreshData | refreshData(): Promise <void> | ページ データを強制更新します。 |
| 経歴 | resume(): Promise <void> | 一時的停止されたページを再開します。 |
| 送信 | submit(): Promise <CompleteEventArgs> | アクションを送信します。 |
| 中断 | suspend(): void | ページを一時的に中断します。 |
イベント
| 氏名 | 署名 | 説明 |
|---|---|---|
| onClose | onClose: EventHook<null> |
ページを閉じるときに発生するイベント。 |
| onComplete | onComplete: EventHook<any> |
アクションが完了したときに発生するイベント。 |
| onDataLoaded | onDataLoaded: EventHook<any> |
ページ データが読み込まれたときに発生するイベント。 |
| onInit | onInit: EventHook<any> |
ページ インスタンスが初期化され、メタデータがロードされたときに発生するイベント。 |
| onPreInit | onPreInit: EventHook<any> |
ページ インスタンスが初期化されたときに発生するイベント。 |
| onRefresh | onRefresh: EventHook<null> |
新しいデータが読み込まれる前に、強制的なページ更新で発生するイベント。 |
| onStateChange | onStateChange: EventHook<null> |
ページ状態が変更するときに発生するイベント。 |
| onSubmit | onSubmit: EventHook<PageSubmitArgs> |
アクションが送信される前に発生するイベント。 これは、アクションの検証遅延について中断できます。 |
| onSyncStatusChange | onSyncStatusChange: EventHook<null> |
ページの同期状態が変更するときに発生するイベント。 |
PageMetadata
階層
PageMetadata
プロパティ
| 氏名 | 署名 | 説明 |
|---|---|---|
| コントロール | コントロール: ControlMetadata [ ] (オプション) |
|
| 設計 | デザイン: デザイン (オプション) |
|
| ID | ID: 文字列 (オプション) |
|
| QuickSubmit | QuickSubmit: ブール値 (省略可) |
|
| SourcePageId | SourcePageId: 文字列 (省略可) |
|
| SubmitButtonDesign | SubmitButtonDesign: デザイン (省略可) |
|
| タスク | タスク: PageMetadata [ ] (省略可) |
|
| 肩書き | タイトル: 文字列 (省略可) |
イベント
| 名前 | 署名 | 説明 |
|---|---|---|
| OnDataLoaded | OnDataLoaded: 機能 (送信者: ページ、dataWrapper: すべて) : 無効 (オプション) |
|
| OnInit | OnInit: 機能 (送信者: ページ): 無効 (オプション) |
|
| OnPreInit | OnInit: 機能 (送信者: ページ): 無効 (オプション) |
|
| OnSubmit | OnSubmit: 機能 (dataValues: すべて、args: すべて): 無効 (オプション) |
|
| OnTaskSubmitted | OnTaskSubmitted: 機能 (taskHandle: すべて、taskOptions: すべて): すべて (オプション) |
|
| OnTaskSubmitting | OnTaskSubmitted: 機能 (taskOptions: すべて): すべて (オプション) |
PageOptions
階層
PageOptions
プロパティ
| 氏名 | 署名 | 説明 |
|---|---|---|
| appId | appId: 文字列 (オプション) |
|
| デザイン | design: Design (optional) |
|
| excludeContext | excludeContext: ブール値 (省略可) |
|
| フィルター | filter: DataFilter (省略可) |
|
| filterLocalOnly | filterLocalOnly: ブール値 (省略可) |
|
| pageContext | pageContext: 文字列 (省略可) |
|
| pageId | pageId: 文字列 (省略可) |
|
| readOptions | readOptions: IReadOptions (省略可) |
PageSubmitArgs
階層
PageSubmitArgs
プロパティ
| 氏名 | 署名 | 説明 |
|---|---|---|
| dataValues | dataValues: any |
送信アクションの伝送データを取得します。 |
| sender | sender: Page |
送信アクションの送信者ページ インスタンスを取得します。 |
メソッド
| 氏名 | 署名 | 説明 |
|---|---|---|
| addMessage | addMessage(message: string, type: any): any | 表示される検証エラー メッセージを追加します。 |
| キャンセル | cancel(): any | アクションの送信を禁止します。 |
| getMessages | getMessages(): string [ ] | 以前に追加されたすべてのメッセージを取得します |
| isCancelled | isCancelled(): boolean | 送信アクションがキャンセルされているかどうかを確認します。 |
| 待機 | wait(promise: Promise <any>): any | 送信を続行する前に、指定された約束を待ちます。 |
PageTarget
階層
PageTarget
└─ NavigationArgs
プロパティ
| 氏名 | 署名 | 説明 |
|---|---|---|
| パラメーター | params: PageOptions (省略可) |
|
| to | to: 文字列 (省略可) |