次の方法で共有

MetadataService タイプ

  • [アーティクル]

重要

財務と業務 (Dynamics 365) モバイル アプリケーションおよびプラットフォームはサポートされなくなりました。 モバイル アプリケーションをサポートするプラットフォーム コンポーネントは、将来の更新で削除される予定です。 モバイル アプリケーションは、アプリケーション 店舗でも削除されました。 以前にインストールしたアプリケーションのインスタンスは引き続き動作します。 詳細については、削除済みまたは非推奨のプラットフォーム機能を参照してください。

アプリケーション ワークスペースでさまざまなメタデータ要素にアクセスして構成する機能を提供します。

階層

MetadataService

指数

プロパティ

メソッド

プロパティ

のバージョン

version: string

(読み取り専用) 現在実行中のプラットフォームのバージョンを取得します。

メソッド

addControl

addControl(componentName: string, controlName: string, controlType: ControlType, parentContainerName?: string, options?: ControlMetadata): any

パラメーター

氏名 種類 説明
componentName string
controlName string
controlType ControlType
parentContainerName? string
options? ControlMetadata

any を返します

compareVersion

compareVersion(versionToCompare: string): 1 | -1

現在のプラットフォームのバージョンと参照バージョンを比較します。

パラメーター

氏名 種類 説明
versionToCompare 文字列 比較する参照バージョン

1 | -1 を返す

1 はプラットフォーム バージョンが参照バージョンより古いことを示し、-1 はプラットフォーム バージョンが参照バージョンより新しいか、または同じであることを示す

configureAction

configureAction(actionName: string, options: PageMetadata): any

アクションをコンフィギュレーションすると、そのアクションに固有の特定の動作を指定または上書きできます。 例 :

metadataService.configureAction('Edit-Reservation', { properties-to-set });

パラメーター

氏名 種類 説明
actionName string 動作が変更されるアクション
オプション PageMetadata アクションに設定するプロパティを含むプロパティ バッグ

any を返します

configureControl

configureControl(componentName: string, controlName: string, options: ControlMetadata): any

コントロールをコンフィギュレーションすると、そのコントロールに固有の特定の動作を指定または上書きできます。 使用可能な動作はコントロール タイプで異なることに注意してください。 例 :

metadataService.configureControl('All-Customers', 'FMCustomer_RecId', { properties-to-set });

パラメーター

氏名 種類 説明
componentName string コントロールを含むページまたはアクション
controlName string 動作を変更するコントロール
オプション ControlMetadata コントロールに設定するプロパティを含むプロパティ バッグ

any を返します

configureEntity

configureEntity(entityName: string, options: any): any

エンティティをコンフィギュレーションすると、そのエンティティに固有の特定の動作を指定または上書きできます。 例 :

metadataService.configureEntity("FMCustomer", { properties-to-set });

パラメーター

氏名 種類 説明
entityName string エンティティ名
オプション any エンティティに設定するプロパティを含むプロパティ バッグ

any を返します

configureLookup

configureLookup(taskName: string, lookupControlName: string, options: LookupMetadata): any

アクションのフィールドをルックアップとして動作するようにコンフィギュレーションします。 リスト コントロールを含む既存のページを使用する必要があります。 例 :

metadataService.configureLookup('Add-Reservation', 'FMRental_Customer', { lookupPage: 'All-Customers', valueField: 'FMCustomer_RecId', displayField: 'FMCustomer_FullName'});

パラメーター

氏名 種類 説明
taskName string アクション名
lookupControlName string ルックアップの動作を指定するフィールドのコントロール名
オプション LookupMetadata ルックアップ コンフィギュレーション オブジェクト

any を返します

configurePage

configurePage(pageName: string, options: PageMetadata): any

ページをコンフィギュレーションすると、そのページに固有の特定の動作を指定または上書きできます。 例 :

metadataService.configurePage('Reservation-details', { properties-to-set });

パラメーター

氏名 種類 説明
pageName string コントロールを含むページ
オプション PageMetadata ページに設定するプロパティを含むプロパティ バッグ

any を返します

configureWorkspace

configureWorkspace(options: PageMetadata): any

ワークスペースをコンフィギュレーションすると、そのワークスペースに固有の特定の動作を指定または上書きできます。 例 :

metadataService.configureWorkspace({ properties-to-set });

パラメーター

氏名 種類 説明
オプション PageMetadata ワークスペースに設定するプロパティを含むプロパティ バッグ

any を返します

findAction

findAction(actionName: string): PageMetadata

メタデータ (メタデータを変更するために使用されない) を検査するため、指定されたアクションの現在のメタデータ インスタンスのコピーを取得します。 注記: メタデータはビジネス ロジックによっていつでも変更でき、呼び出された時点でメタデータの状態を反映するため、この API を使用してコピーを取得するタイミングに注意する必要があります。

例 :

var newCustomerTaskMetadata = metadataService.findTask("New-customer");

パラメーター

氏名 種類 説明
actionName string アクション名

PageMetadata を返します

findControl

findControl(componentMetadata: any, controlName: string): ControlMetadata

メタデータ (メタデータを変更するために使用されない) を検査するため、指定されたコントロールの現在のメタデータ インスタンスのコピーを取得します。 注記: メタデータはビジネス ロジックによっていつでも変更でき、呼び出された時点でメタデータの状態を反映するため、この API を使用してコピーを取得するタイミングに注意する必要があります。

例 :

var firstNameControl = metadataService.findControl(newCustomerTaskMetadata, 'FMCustomer_FirstName');

パラメーター

氏名 種類 説明
componentMetadata any ページまたはアクションのメタデータ インスタンス
controlName string コントロール名

ControlMetadata を返します

findPage

findPage(pageName: string): PageMetadata

メタデータ (メタデータを変更するために使用されない) を検査するため、指定されたページの現在のメタデータ インスタンスのコピーを取得します。 注記: メタデータはビジネス ロジックによっていつでも変更でき、呼び出された時点でメタデータの状態を反映するため、この API を使用してコピーを取得するタイミングに注意する必要があります。

例 :

var reservationDetailsMetadata = metadataService.findPage("Reservation-details");

パラメーター

氏名 種類 説明
pageName string ページ名

PageMetadata を返します

getFilterExpression

getFilterExpression(pageName: string, listControlName: string, controlName: string, operator: ExpressionOperator, value: string): DataFilter

指定されたオプションに基づいてリスト コントロール用の DataFilter オブジェクトを作成します。 例 :

var filter = metadataService.getFilterExpression(
 pageNames.AllCustomers, controlNames.CustomerList, controlNames.CustomerFullName, "Is", firstCustomerName),

パラメーター

氏名 種類 説明
pageName string
listControlName string
controlName string
演算子 式の操作者
値 string

DataFilter を返します

getFormReference

getFormReference(componentName: string, filterContext: DataFilter, excludeContext: boolean, filterLocalOnly?: boolean): NavigationArgs

ナビゲーション コントロールで使用する特定のページ/アクションに対し INavigationArgs オブジェクトを作成します。

パラメーター

氏名 種類 説明
componentName string アクション/ページの名前
filterContext DataFilter
excludeContext ブール値
filterLocalOnly? ブール値

NavigationArgs を返します

hideNavigation

hideNavigation(pageNamesToHide: string [ ]): any

既定のランディング ページから指定されたページを非表示にします。 例 :

metadataService.hideNavigation('Select-a-customer', 'Select-a-vehicle');

パラメーター

氏名 種類 説明
pageNamesToHide string [ ] ページ名

any を返します