モデル駆動型アプリでビューをカスタマイズする

モデル駆動型アプリのビューをプログラムでカスタマイズして、ユーザーが取得するデータとその表示方法を制御します。ビューは、特定のフィルターと表示設定を使用する SavedQuery レコードです。これらをコードで作成したり、XML として定義したり、アンマネージドソリューションでインポートしたりできます。

SavedQuery ビューは UserQuery とは異なります。モデル駆動型アプリの 保存済みビュー と呼ばれるユーザークエリは、個々のユーザーが所有し、他のユーザーに割り当てて共有したり、クエリのアクセス権限に応じて他のユーザーが表示したりできます。このビューの種類は、集計を実行するテーブルの種類とクエリにまたがる頻繁に使用されるクエリに適しています。詳細については、「保存されたクエリ」を参照してください。

カスタマイズツールを使用して、ビューをカスタマイズすることもできます。詳細については、「ビューの作成と編集」を参照してください。

ビューの種類

次の表に、カスタマイズできる 5 種類のビューを示します。ビューのタイプコードは、SavedQuery.QueryType パラメーターに保存されます。

特定のテーブルのビューを定義すると、 SavedQuery.ReturnedTypeCode パラメーターはテーブルの論理名を返します。

ビューの種類	種類コード	内容
公開	0	- 出現回数: 複数 - アクション: 作成、更新、削除 - コメント: `SavedQuery.IsDefault` を true に設定して、これらのビューのいずれかを既定のパブリックビューとして設定します。
高度な検索	1	- 出現回数: 1 - アクション: 更新のみ。 - コメント: 既定では、このビューは結果が高度な検索に表示されるときに表示されます。
関連	2	- 出現回数: 1 - アクション: 更新のみ。 - コメント: 既定では、このビューは関連するレコードのグリッドがレコードのナビゲーションウィンドウに表示されるときに表示されます。
簡易検索	4	- 出現回数: 1 - アクション: 更新のみ。 - コメント: このビューは、ユーザーがリストビューの検索列を使用してレコードを検索するときに検索される列を定義します。
検索	64	- 出現回数: 1 - アクション: 更新のみ。 - コメント: これは、ルックアップ列に対して他のビューが構成されていない場合にレコードを検索するために使用される既定のビューです。

ソリューションコンポーネントとしてビューを管理する

ビューはソリューションコンポーネントです。ソリューションコンポーネントを作成、更新、または削除するときは、そのコンポーネントを含むソリューションに変更を適用します。ソリューションを明示的に指定しない場合、変更はコードを実行するユーザーの優先ソリューションに設定されます。そのユーザーが優先ソリューションを持っていない場合、変更は既定のソリューションのいずれかに移動します。

開発者は、 SolutionUniqueName 省略可能なパラメーターを使用して、これらのデータ変更を特定のアンマネージドソリューションに明示的に関連付けます。

ビューの作成

パブリックビューを作成するには、次の SavedQuery プロパティを指定します。

財産	内容
`Name`	保存されたクエリの一意の識別子。
`ReturnedTypeCode`	テーブルの論理名と一致します。
`FetchXml`	フィルター条件を編集するか、並べ替えを構成します。 FetchXml を使用したデータのクエリを参照してください。
`LayoutXml`	有効な要素については、カスタマイズソリューションファイルスキーマの `layoutxml` 要素を参照してください。
`QueryType`	常にゼロ (0) にする必要があります。

次の例では、営業案件テーブルの新しいパブリックビューを作成します。

.NET 向け SDK
Dataverse CLI

このサンプルでは、CreateRequest クラスと省略可能なパラメーターSolutionUniqueNameIOrganizationService.Execute メソッドを使用します。

System.String layoutXml =
@"<grid name='resultset' object='3' jump='name' select='1'
   preview='1' icon='1'>
   <row name='result' id='opportunityid'>
   <cell name='name' width='150' />
   <cell name='customerid' width='150' />
   <cell name='estimatedclosedate' width='150' />
   <cell name='estimatedvalue' width='150' />
   <cell name='closeprobability' width='150' />
   <cell name='opportunityratingcode' width='150' />
   <cell name='opportunitycustomeridcontactcontactid.emailaddress1'
      width='150' disableSorting='1' />
   </row>
</grid>";

System.String fetchXml =
@"<fetch>
   <entity name='opportunity'>
   <order attribute='estimatedvalue' descending='false' />
   <filter type='and'>
      <condition attribute='statecode' operator='eq'
      value='0' />
   </filter>
   <attribute name='name' />
   <attribute name='estimatedvalue' />
   <attribute name='estimatedclosedate' />
   <attribute name='customerid' />
   <attribute name='opportunityratingcode' />
   <attribute name='closeprobability' />
   <link-entity alias='opportunitycustomeridcontactcontactid'
      name='contact' from='contactid' to='customerid'
      link-type='outer' visible='false'>
      <attribute name='emailaddress1' />
   </link-entity>
   <attribute name='opportunityid' />
   </entity>
</fetch>";

var sq = new SavedQuery
   {
   Name = "A New Custom Public View",
   Description = "A Saved Query created in code",
   ReturnedTypeCode = "opportunity",
   FetchXml = fetchXml,
   LayoutXml = layoutXml,
   QueryType = 0
   };

var request = new CreateRequest
{
   Target = sq
};
request["SolutionUniqueName"] = "< Your Solution Unique Name >";

var response = (CreateResponse)service.Execute(request);
_customViewId = response.id;
Console.WriteLine("A new view with the name {0} was created.", sq.Name);

Dataverse SDK for .NETの詳細を確認する

この例では、dataverse CLI api 要求を省略可能なパラメーターMSCRM.SolutionUniqueName使用します。

$solutionUniqueName = "< Your Solution Unique Name >"

$layoutXml = @"
<grid name='resultset' object='3' jump='name' select='1'
  preview='1' icon='1'>
  <row name='result' id='opportunityid'>
    <cell name='name' width='150' />
    <cell name='customerid' width='150' />
    <cell name='estimatedclosedate' width='150' />
    <cell name='estimatedvalue' width='150' />
    <cell name='closeprobability' width='150' />
    <cell name='opportunityratingcode' width='150' />
    <cell name='opportunitycustomeridcontactcontactid.emailaddress1'
      width='150' disableSorting='1' />
  </row>
</grid>
"@

$fetchXml = @"
<fetch>
  <entity name='opportunity'>
    <order attribute='estimatedvalue' descending='false' />
    <filter type='and'>
      <condition attribute='statecode' operator='eq' value='0' />
    </filter>
    <attribute name='name' />
    <attribute name='estimatedvalue' />
    <attribute name='estimatedclosedate' />
    <attribute name='customerid' />
    <attribute name='opportunityratingcode' />
    <attribute name='closeprobability' />
    <link-entity alias='opportunitycustomeridcontactcontactid'
      name='contact' from='contactid' to='customerid'
      link-type='outer' visible='false'>
      <attribute name='emailaddress1' />
    </link-entity>
    <attribute name='opportunityid' />
  </entity>
</fetch>
"@

$body = @{
  name             = "A New Custom Public View"
  description      = "A Saved Query created in code"
  returnedtypecode = "opportunity"
  fetchxml         = $fetchXml
  layoutxml        = $layoutXml
  querytype        = 0
}

$jsonBody = ConvertTo-Json $body -Depth 5 -Compress

$response = dataverse api request `
  --target dataverse `
  --path "/api/data/v9.2/savedqueries" `
  --method POST `
  --header "MSCRM.SolutionUniqueName:$solutionUniqueName" `
  --body $jsonBody `
  --include

$entityIdHeader = $response |
  Select-String -Pattern 'OData-EntityId:\s*(?<url>\S+)' |
  Select-Object -First 1

if (-not $entityIdHeader) {
  throw 'The response did not contain an OData-EntityId header.'
}

$entityUrl = $entityIdHeader.Matches[0].Groups['url'].Value
$idMatch = Select-String -InputObject $entityUrl -Pattern '(?<=\().*?(?=\))'

if (-not $idMatch.Matches.Success) {
  throw "The OData-EntityId header did not contain a record ID: $entityUrl"
}

$customViewId = [guid]::New($idMatch.Matches.Value.ToString())

Write-Host "A new view with the name "$($body.name)" and ID {$customViewId} was created."

Dataverse CLI の詳細

ビューの更新

IsCustomizable管理プロパティでビューの更新が許可されている場合は、UpdateRequest クラスメッセージを使用してビューを更新します。ソリューションのコンテキストでビューを常に更新します。 SolutionUniqueName省略可能なパラメーターを使用して、ビューに変更をソリューションに関連付けます。

更新の例については、「ビューの非アクティブ化」を参照してください。

ビューの削除

削除する必要があるのは、作成した保存済みクエリのみです。ソリューションコンポーネントまたはアプリケーションの一部は、保存された特定のクエリに依存する場合があります。アプリケーションに表示したくないクエリがある場合は、それらを非アクティブ化します。ソリューションのコンテキストでビューを常に削除します。 SolutionUniqueName省略可能なパラメーターを使用して、ビューの削除をソリューションに関連付けます。

ビューの取得

次のサンプルでは、営業案件テーブルのすべてのパブリックビューを取得します。

.NET 向け SDK
Dataverse CLI

この例では、IOrganizationService.Execute メソッドと共に RetrieveMultipleRequest クラスを使用して、保存されたクエリレコードを取得します。

var mySavedQuery = new QueryExpression
{
   ColumnSet = new ColumnSet(
       "savedqueryid",
       "name",
       "querytype",
       "isdefault",
       "returnedtypecode",
       "isquickfindquery"),
   EntityName = SavedQuery.EntityLogicalName,
   Criteria = new FilterExpression
   {
       Conditions =
       {
           new ConditionExpression
           {
               AttributeName = "querytype",
               Operator = ConditionOperator.Equal,
               Values = { 0 }
           },
           new ConditionExpression
           {
               AttributeName = "returnedtypecode",
               Operator = ConditionOperator.Equal,
               Values = { Opportunity.EntityTypeCode }
           }
       }
   }
};
RetrieveMultipleRequest retrieveSavedQueriesRequest = new RetrieveMultipleRequest { Query = mySavedQuery };

RetrieveMultipleResponse retrieveSavedQueriesResponse =
   (RetrieveMultipleResponse)service.Execute(retrieveSavedQueriesRequest);

DataCollection<Entity> savedQueries = retrieveSavedQueriesResponse.EntityCollection.Entities;

// Display the retrieved views
foreach (Entity ent in savedQueries)
{
   SavedQuery rsq = (SavedQuery)ent;
   Console.WriteLine(
       "{0} : {1} : {2} : {3} : {4} : {5},",
       rsq.SavedQueryId,
       rsq.Name,
       rsq.QueryType,
       rsq.IsDefault,
       rsq.ReturnedTypeCode,
       rsq.IsQuickFindQuery);
}

Dataverse SDK for .NETの詳細を確認する

この例では、 data query コマンドを使用して、保存されたクエリレコードを取得します。

$selectColumns = @(
  'savedqueryid'
  'name'
  'querytype'
  'isdefault'
  'returnedtypecode'
  'isquickfindquery'
) -join ','

$filter = "querytype eq 0 and returnedtypecode eq 'opportunity'"

$response = dataverse data query `
  --target dataverse `
  --table savedqueries `
  --select $selectColumns `
  --filter $filter `
  --json | ConvertFrom-Json

$response.value | Select-Object `
  savedqueryid, `
  name, `
  querytype, `
  isdefault, `
  returnedtypecode, `
  isquickfindquery | Format-Table -AutoSize

Dataverse CLI の詳細

ビューの非アクティブ化

パブリックビューをアプリケーションに表示しない場合は、非アクティブ化します。既定のビューとして設定されているパブリックビューを非アクティブ化することはできません。

非アクティブ化は更新操作です。ソリューションのコンテキストでビューを常に更新します。 SolutionUniqueName省略可能なパラメーターを使用して、ビューに変更をソリューションに関連付けます。

次の例では、 営業案件テーブルの [現在の会計年度] ビューの [終了 した営業案件] を非アクティブ化します。

.NET 向け SDK
Dataverse CLI

このサンプルでは、UpdateRequest クラスと省略可能なパラメーターSolutionUniqueNameIOrganizationService.Execute メソッドを使用します。

System.String SavedQueryName = "Closed Opportunities in Current Fiscal Year";
QueryExpression ClosedOpportunitiesViewQuery = new QueryExpression
{
   ColumnSet = new ColumnSet("savedqueryid", "statecode", "statuscode"),
   EntityName = SavedQuery.EntityLogicalName,
   Criteria = new FilterExpression
   {
       Conditions =
       {
           new ConditionExpression
           {
               AttributeName = "querytype",
               Operator = ConditionOperator.Equal,
               Values = { 0 }
           },
           new ConditionExpression
           {
               AttributeName = "returnedtypecode",
               Operator = ConditionOperator.Equal,
               Values = { Opportunity.EntityTypeCode }
           },
           new ConditionExpression
           {
               AttributeName = "name",
               Operator = ConditionOperator.Equal,
               Values = { SavedQueryName }
           }
       }
   }
};

RetrieveMultipleRequest retrieveOpportuntiesViewRequest = new RetrieveMultipleRequest
{
   Query = ClosedOpportunitiesViewQuery
};

RetrieveMultipleResponse retrieveOpportuntiesViewResponse =
   (RetrieveMultipleResponse)service.Execute(retrieveOpportuntiesViewRequest);

SavedQuery OpportunityView =
   (SavedQuery)retrieveOpportuntiesViewResponse.EntityCollection.Entities[0];

var updateRequest = new UpdateRequest
{
  Target = new SavedQuery
  {
    Id = OpportunityView.Id,
    StateCode = new OptionSetValue(1), // Inactive
    StatusCode = new OptionSetValue(2) // Inactive
  }
};
updateRequest["SolutionUniqueName"] = "< Your Solution Unique Name >";

service.Execute(updateRequest);

Dataverse SDK for .NETの詳細を確認する

この例では、dataverse CLI api 要求を省略可能なパラメーターMSCRM.SolutionUniqueName使用します。

$solutionUniqueName = "< Your Solution Unique Name >"

$savedQueryName = "Closed Opportunities in Current Fiscal Year"
$escapedSavedQueryName = $savedQueryName.Replace("'", "''")

$selectColumns = @(
  'savedqueryid'
  'statecode'
  'statuscode'
) -join ','

$filter = @(
  'querytype eq 0'
  "returnedtypecode eq 'opportunity'"
  "name eq '$escapedSavedQueryName'"
) -join ' and '

$queryOutput = dataverse data query `
  --target dataverse `
  --table savedqueries `
  --select $selectColumns `
  --filter $filter `
  --top 1 `
  --json 2>&1

if ($LASTEXITCODE -ne 0) {
  $errorDetails = $queryOutput -join [Environment]::NewLine
  throw "Failed to retrieve view '$savedQueryName':`n$errorDetails"
}

try {
  $response = $queryOutput | ConvertFrom-Json -ErrorAction Stop
}
catch {
  throw "Failed to parse the query response: $($_.Exception.Message)"
}

$opportunityView = $response.value | Select-Object -First 1
if ($null -eq $opportunityView) {
  throw "The view '$savedQueryName' wasn't found."
}

$body = @{
  statecode  = 1
  statuscode = 2
} | ConvertTo-Json

$updateOutput = dataverse api request `
  --target dataverse `
  --path "/api/data/v9.2/savedqueries($($opportunityView.savedqueryid))" `
  --method PATCH `
  --header "MSCRM.SolutionUniqueName:$solutionUniqueName" `
  --body $body 2>&1

if ($LASTEXITCODE -ne 0) {
  $errorDetails = $updateOutput -join [Environment]::NewLine
  throw "Failed to update view '$savedQueryName':`n$errorDetails"
}

Write-Host "The state of view '$savedQueryName' was updated."

Dataverse CLI の詳細

ヒント

ビューステート: active または inactive は、ソリューションに追加するときにビューに含まれません。そのため、ソリューションをターゲット組織にインポートすると、状態は既定でアクティブに設定されます。

列の編集

テーブルまたは関連テーブルのビューに表示する列を選択できます。表示する列の指定方法の詳細については、layoutxml の要素を参照してください。

カスタムアイコンとツールヒントを追加して列を表示する

列の値に応じて、ツールヒントテキストを含むカスタムアイコンを追加して列に表示できます。ローカライズされたヒントテキストを指定することもできます。カスタムアイコンをイメージ Web リソースとしてインスタンスに追加し、JavaScript Web リソースを使用して列の JavaScript コードを追加し、列の値に応じてアイコンを表示します。

ヒント

ツールヒントを含むカスタムアイコンは、読み取り専用グリッドにのみ追加できます。この機能は、編集可能なグリッドではサポートされていません。編集可能なグリッドの詳細については、「編集可能グリッドの使用」を参照してください。

imageproviderwebresourceとimageproviderfunctionnameの 2 つの新しいパラメーターが、savedquery の layoutxml のcell要素に追加されます。これらのパラメーターを使用すると、Web リソースの名前と JavaScript 関数名を指定して、列のカスタムアイコンとヒントテキストを表示できます。 JavaScript コードは、ページが読み込まれるときに実行されます。

新しい Web リソースと列のプロパティページ内の関数名を使用しながら、Web クライアント名と JavaScript 関数名の定義を表示する列のプロパティを変更することができます。

次のサンプルコードは、layoutxml の opportunityratingcode 列にカスタムアイコンとヒントを追加するための Web リソースと JavaScript 関数名をプログラムで指定する方法を示しています。

<grid name='resultset' object='3' jump='name' select='1'
  preview='1' icon='1'>
  <row name='result' id='opportunityid'>
    <cell name='name' width='150' />
    <cell name='customerid' width='150' />
    <cell name='estimatedclosedate' width='150' />
    <cell name='estimatedvalue' width='150' />
    <cell name='closeprobability' width='150' />
    <cell name='opportunityratingcode' width='150' 
          imageproviderwebresource='new_SampleWebResource'
          imageproviderfunctionname='displayIconTooltip' />
    <cell name='opportunitycustomeridcontactcontactid.emailaddress1'
        width='150' disableSorting='1' />
  </row>
</grid>

ユーザー定義アイコンとツールヒントのテキストを表示する JavaScript 関数には、次の 2 つの引数が表示されます: layoutxml で指定された行オブジェクト全体と呼び出し側ユーザーのロケール ID (LCID)。 LCID パラメーターでは、複数の言語でアイコンのツールヒントのテキストを指定できます。サポートされている言語の詳細については、「環境の地域と言語のオプション」を参照してください。コードで使用できるロケール ID (LCID) 値の一覧については、「Microsoft によって割り当てられるロケール ID」を参照してください。

列の選択肢の種類にカスタムアイコンを追加する場合は、定義済みのオプションのセットが限られているため、ラベルの代わりにオプションの整数値を使用して、ローカライズされたラベル文字列の変更によるコードの中断を回避します。 JavaScript 関数で、列の値のアイコンとして使用するイメージ Web リソースの名前のみを指定します。イメージは 16 x 16 ピクセルである必要があります。大きな画像は自動的に 16 x 16 ピクセルに縮小されます。

次のサンプルコードは、opportunityratingcode (Rating) 列内の値 (1: 高、2: 中、3: 低) のいずれかに基づき、異なるアイコンとヒントテキストを表示します。サンプルコードは、ローカライズしたツールヒントのテキストを表示する方法についても示します。このサンプルを機能させるには、インスタンスにそれぞれ 16 x 16 の画像 ( 、、および ) を持つ 3 つのイメージ Web リソース ( new_Hot、 new_Warm、 new_Cold) を作成する必要があります。

function displayIconTooltip(rowData, userLCID) {
  var str = JSON.parse(rowData);
  var coldata = str.opportunityratingcode_Value;
  var imgName = "";
  var tooltip = "";
  switch (parseInt(coldata, 10)) {
    case 1:
      imgName = "new_Hot";
      switch (userLCID) {
        case 1036:
          tooltip = "French: Opportunity is Hot";
          break;
        default:
          tooltip = "Opportunity is Hot";
          break;
      }
      break;
    case 2:
      imgName = "new_Warm";
      switch (userLCID) {
        case 1036:
          tooltip = "French: Opportunity is Warm";
          break;
        default:
          tooltip = "Opportunity is Warm";
          break;
      }
      break;
    case 3:
      imgName = "new_Cold";
      switch (userLCID) {
        case 1036:
          tooltip = "French: Opportunity is Cold";
          break;
        default:
          tooltip = "Opportunity is Cold";
          break;
      }
      break;
    default:
      imgName = "";
      tooltip = "";
      break;
  }
  var resultarray = [imgName, tooltip];
  return resultarray;
}

この結果、値に基づいた適切なアイコンを含む [Rating] 列の値、およびカーソルを置いたときのアイコンのツールヒントテキストが表示されます。

ビューの [評価] 列に表示されるカスタムアイコンのスクリーンショット。

パブリックビューを既定のビューとして設定する

既定のビューとして設定できるアクティブなパブリックビューは 1 つだけです。ビューを既定のビューにするには、 IsDefault プロパティを true に設定します。

コミュニティツール

これらの API を使用してビューを管理するコミュニティツールがいくつかあります。

ヒント

これらのコミュニティツールは Dataverse の製品ではなく、Microsoftはコミュニティツールのサポートを提供しません。ツールについて質問がある場合は、発行元にお問い合わせください。詳細情報: コミュニティツール

フィードバック

このページはお役に立ちましたか?

Last updated on 2026-08-14

モデル駆動型アプリでビューをカスタマイズする

ビューの種類

ソリューション コンポーネントとしてビューを管理する

ビューの作成

ビューの更新

ビューの削除

ビューの取得

ビューの非アクティブ化

列の編集

カスタム アイコンとツールヒントを追加して列を表示する

パブリック ビューを既定のビューとして設定する

コミュニティ ツール

フィードバック

その他のリソース

ソリューションコンポーネントとしてビューを管理する

カスタムアイコンとツールヒントを追加して列を表示する

パブリックビューを既定のビューとして設定する

コミュニティツール