getFetchXml (クライアント API 参照)

グリッド コントロールで、フィルター処理したデータおよび並べ替えたデータを含む、現在のデータを表す FetchXML クエリを取得します。

サポートされるグリッドの種類

読み取り専用および編集可能なグリッド

構文

var result = gridContext.getFetchXml();

戻り値

種類: 文字列

説明: FetchXML クエリ。

注釈

gridContext を取得するには、「グリッド コンテキストの取得」を参照してください

例

次の例は、取引先担当者サブグリッドの取得された Fetch XML をコンソールに表示します:

function myFunction(executionContext) {
    var formContext = executionContext.getFormContext(); // get the form context
    var gridContext = formContext.getControl("Contacts"); // get the grid context
    var retrieveFetchXML = function (exeCtx) {
        var gridCtx = exeCtx.getFormContext().getControl("Contacts");
        var result = gridCtx.getFetchXml();
        console.log(result)
    };
    gridContext.addOnLoad(retrieveFetchXML);
}