編集可能グリッドの使用

[アーティクル]
02/23/2023

編集可能グリッドは Web およびモバイルクライアント (Dynamics 365 for phones および Dynamics 365 for tablets) 上で、インライン編集機能を提供するカスタムコントロールです。これは同じグリッド内でデータをグループ化、並べ替えおよびフィルタする機能を含み、レコードやビューを切り替える必要がありません。編集可能グリッドコントロールは、Web クライアントおよびダッシュボードのフォームでのメイングリッドやサブグリッド、およびモバイルクライアントでのフォームグリッドでサポートされます。編集可能グリッドコントロールでは編集機能を提供しますが、読み取り専用グリッドメターデータおよびフィールドレベルのセキュリティ設定に従います。編集可能グリッドは、業務ルールおよびフォームスクリプトもサポートするので、組織の要件に従ってカスタムビジネスロジックを適用することができます。

注意

従来のフォーム (Dynamics CRM 2016 より前のバージョン) を使用している場合、サブグリッドで編集可能なグリッドを有効にした場合、編集可能なサブグリッドが表示されません。システム管理者は、必要に応じてシステム設定で従来のフォームをオフにできます。

編集可能グリッドの有効化

テーブルレベルで編集可能グリッドを有効にしてメイングリッドで使用したり、フォームレベルで読み取り専用サブグリッド (関連グリッド) を編集可能グリッドに置き換えることができます。

ソリューションエクスプローラーを開きます。
テーブルリストで、適切なテーブルをオープンし、コントロールタブを選択し、コントロールの追加を選択します。
コントロールの追加ダイアログボックスで、編集可能グリッドを選択してから、追加を選択します。
追加された 編集可能なグリッド 行で、グリッドを適用するフォームファクターを選択します。これにより、編集可能なグリッドコントロールが、選択されたフォームファクターの既定のコントロールになります。

注意

実行時に、ユーザーは、編集可能なグリッドと読み取り専用グリッドを切り替えることができます。

フォームでグリッドに対して編集可能グリッドを有効にするには、フォームエディターを開いて、編集可能グリッドに置き換えたい読み取り専用グリッドをダブルクリックしてから、コントロール タブをクリックし,コントロールのリストから編集可能なグリッドを選択します。

編集不可能なグリッドをメイングリッドと関連グリッドに、必要に応じていつでも戻すことができます。さらに実行時に、ユーザーは、編集可能なグリッドと読み取り専用グリッドを切り替えることができます。

詳細: 編集可能グリッドのカスタムコントロールを使用して、モデル駆動型アプリのグリッド (リスト) を編集可能にする

フォームスクリプトのサポート

編集可能グリッドでは、クライアント側のイベントと、ビジネスニーズに応じてカスタムクライアント拡張の作成に使用できるメソッドがサポートされています。詳細: モデル駆動型アプリ (クライアント API リファレンス) におけるグリッドおよびサブグリッド

編集可能グリッドでサポートされているテーブルとビュー

すべてのテーブルとビューが編集可能グリッドの使用をサポートしているわけではありません。

Web クライアントで、テーブルは次のすべての条件が成り立つ場合に編集可能グリッドをサポートします:

テーブルはカスタマイズ可能である (IsCustomizable = true)
テーブルが更新されている (IsAIRUpdated = true) またはカスタムテーブルである (IsCustomEntity = true)
テーブルは、子テーブルではない (IsChildEntity = false)

モバイルクライアントでは、テーブルがモバイルクライアントのサイトマップに表示できる場合、テーブルは編集可能グリッドをサポートします。

編集可能グリッドをサポートするテーブルの詳細については、編集可能グリッドのカスタムコントロールを使用して、モデル駆動型アプリのグリッド (リスト) を編集可能にするの サポートされている標準のテーブル セクションを参照してください

編集可能グリッドでは、ロールアップ関連ビューはサポートされません (ロールアップタイプ = Related)。

編集可能なコントロールのテーブルサポート情報を表示するために、次のサンプルコードを使用して Excel を XML テーブルとして開くことができる XML ファイルを生成します。 Excel はスキーマを自動的に判断して次に示す列に情報を表示します。

LogicalName: テーブルの論理名。
DisplayName: テーブルの表示名。
CanEnableEditableGridWeb: Web クライアントでテーブルの編集可能グリッドがサポートされているかどうかの状態 (True または False) を表示します。
CanEnableEditableGridMobile: モバイルクライアントでテーブルの編集可能グリッドがサポートされているかどうかの状態 (True または False) を表示します。 (Dynamics 365 for phones および Dynamics 365 for tablets)。

using System;  
using System.Linq;  
using System.Xml.Linq;  
using System.ServiceModel;  
using System.ServiceModel.Description;  
using System.Collections.Generic;  
using System.Xml.Serialization;  
using System.Xml;  
using System.IO;  
  
// These namespaces are found in the Microsoft.Xrm.Sdk.dll assembly  
// found in the SDK\bin folder.  
using Microsoft.Xrm.Sdk;  
using Microsoft.Xrm.Sdk.Query;  
using Microsoft.Xrm.Sdk.Metadata;  
using Microsoft.Xrm.Sdk.Client;  
using Microsoft.Xrm.Sdk.Messages;  
  
// This namespace is found in Microsoft.Crm.Sdk.Proxy.dll assembly  
// found in the SDK\bin folder.  
using Microsoft.Crm.Sdk.Messages;  
  
namespace Microsoft.Crm.Sdk.Samples  
{  
    /// <summary>  
    /// This sample generates an XML table to display the table-support information for   
    ///  editable controls.  
    /// </summary>  
    public class DumpEditableGridEntityInfo  
    {  
        #region Class Level Members  
  
        /// <summary>  
        /// Stores the organization service proxy.  
        /// </summary>  
        OrganizationServiceProxy _serviceProxy;  
  
        // Create storage for new columns being created  
        public List<AttributeMetadata> addedAttributes;  
  
        // Specify which language code to use in the sample. If you are using a language  
        // other than US English, you will need to modify this value accordingly.  
        // See https://msdn.microsoft.com/library/0h88fahh.aspx  
        public const int _languageCode = 1033;  
  
        // Define the IDs/variables needed for this sample.  
        public int _insertedStatusValue;  
  
        #endregion Class Level Members  
  
        #region How To Sample Code  
        /// <summary>  
        /// </summary>  
        /// <param name="serverConfig">Contains server connection information.</param>  
        /// <param name="promptForDelete">When True, the user will be prompted to delete all  
        /// created entities.</param>  
        public void Run(ServerConnection.Configuration serverConfig, bool promptForDelete)  
        {  
            try  
            {  
  
                // Connect to the Organization service.   
                // The using statement assures that the service proxy will be properly disposed.  
                using (_serviceProxy = new OrganizationServiceProxy(serverConfig.OrganizationUri, serverConfig.HomeRealmUri, serverConfig.Credentials, serverConfig.DeviceCredentials))  
                {  
                    // This statement is required to enable early-bound type support.  
                    _serviceProxy.EnableProxyTypes();  
  
                    //<snippetDumpEditableGridEntityInfo1>  
                    RetrieveAllEntitiesRequest request = new RetrieveAllEntitiesRequest()  
                    {  
                        EntityFilters = EntityFilters.Entity,  
                        RetrieveAsIfPublished = true  
                    };  
  
                    // Retrieve the MetaData.  
                    RetrieveAllEntitiesResponse response = (RetrieveAllEntitiesResponse)_serviceProxy.Execute(request);  
  
                    // Create an instance of StreamWriter to write text to a file.  
                    // The using statement also closes the StreamWriter.  
                    // To view this file, right click the file and choose open with Excel.   
                    // Excel will figure out the schema and display the information in columns.  
  
                    String filename = String.Concat("EditableGridEntityInfo.xml");  
                    using (StreamWriter sw = new StreamWriter(filename))  
                    {  
                        // Create Xml Writer.  
                        XmlTextWriter metadataWriter = new XmlTextWriter(sw);  
  
                        // Start Xml File.  
                        metadataWriter.WriteStartDocument();  
  
                        // Metadata Xml Node.  
                        metadataWriter.WriteStartElement("Metadata");  
  
                        foreach (EntityMetadata currentEntity in response.EntityMetadata)  
                        {  
                            // Start Entity Node  
                            metadataWriter.WriteStartElement("Entity");  
  
                            bool canBeDisplayedInSitemap = currentEntity.IsCustomizable.Value;  
  
                            if (canBeDisplayedInSitemap)  
                            {  
                                metadataWriter.WriteElementString("LogicalName", currentEntity.LogicalName);  
                                metadataWriter.WriteElementString("DisplayName", currentEntity.DisplayName.UserLocalizedLabel?.Label);  
                                metadataWriter.WriteElementString("CanEnableEditableGridWeb", (!(bool)currentEntity.IsChildEntity && ((bool)currentEntity.IsAIRUpdated || (bool)currentEntity.IsCustomEntity)).ToString());  
                                metadataWriter.WriteElementString("CanEnableEditableGridMobile", (currentEntity.IsVisibleInMobileClient.Value || currentEntity.IsVisibleInMobileClient.CanBeChanged).ToString());  
                            }  
  
                            // Write the Entity's Information.  
  
                            //End Entity Node  
                            metadataWriter.WriteEndElement();  
                        }  
  
                        // End Metadata Xml Node  
                        metadataWriter.WriteEndElement();  
                        metadataWriter.WriteEndDocument();  
  
                        // Close xml writer.  
                        metadataWriter.Close();  
                        Console.WriteLine("Dumped information in the EditableGridEntityInfo.xml file");  
                    }  
                }  
            }  
  
            // Catch any service fault exceptions that Microsoft Dynamics CRM throws.  
            catch (FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault>)  
            {  
                // You can handle an exception here or pass it back to the calling method.  
                throw;  
            }  
        }  
        #endregion How To Sample Code  
  
        #region Main  
        /// <summary>  
        /// Standard Main() method used by most SDK samples.  
        /// </summary>  
        /// <param name="args"></param>  
        static public void Main(string[] args)  
        {  
            try  
            {  
                // Obtain the target organization's Web address and client logon   
                // credentials from the user.  
                ServerConnection serverConnect = new ServerConnection();  
                ServerConnection.Configuration config = serverConnect.GetServerConfiguration();  
                DumpEditableGridEntityInfo app = new DumpEditableGridEntityInfo();  
                app.Run(config, false);                  
            }  
            catch (FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault> ex)  
            {  
                Console.WriteLine("The application terminated with an error.");  
                Console.WriteLine("Timestamp: {0}", ex.Detail.Timestamp);  
                Console.WriteLine("Code: {0}", ex.Detail.ErrorCode);  
                Console.WriteLine("Message: {0}", ex.Detail.Message);  
                Console.WriteLine("Plugin Trace: {0}", ex.Detail.TraceText);  
                Console.WriteLine("Inner Fault: {0}",  
                    null == ex.Detail.InnerFault ? "No Inner Fault" : "Has Inner Fault");  
            }  
            catch (System.TimeoutException ex)  
            {  
                Console.WriteLine("The application terminated with an error.");  
                Console.WriteLine("Message: {0}", ex.Message);  
                Console.WriteLine("Stack Trace: {0}", ex.StackTrace);  
                Console.WriteLine("Inner Fault: {0}",  
                    null == ex.InnerException.Message ? "No Inner Fault" : ex.InnerException.Message);  
            }  
            catch (System.Exception ex)  
            {  
                Console.WriteLine("The application terminated with an error.");  
                Console.WriteLine(ex.Message);  
  
                // Display the details of the inner exception.  
                if (ex.InnerException != null)  
                {  
                    Console.WriteLine(ex.InnerException.Message);  
  
                    FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault> fe  
                        = ex.InnerException  
                        as FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault>;  
                    if (fe != null)  
                    {  
                        Console.WriteLine("Timestamp: {0}", fe.Detail.Timestamp);  
                        Console.WriteLine("Code: {0}", fe.Detail.ErrorCode);  
                        Console.WriteLine("Message: {0}", fe.Detail.Message);  
                        Console.WriteLine("Plugin Trace: {0}", fe.Detail.TraceText);  
                        Console.WriteLine("Inner Fault: {0}",  
                            null == fe.Detail.InnerFault ? "No Inner Fault" : "Has Inner Fault");  
                    }  
                }  
            }  
            // Additional exceptions to catch: SecurityTokenValidationException, ExpiredSecurityTokenException,  
            // SecurityAccessDeniedException, MessageSecurityException, and SecurityNegotiationException.  
  
            finally  
            {  
  
                Console.WriteLine("Press <Enter> to exit.");  
                Console.ReadLine();  
            }  
  
        }  
        #endregion Main  
  
    }  
}

次の方法で共有

編集可能グリッドの使用

編集可能グリッドの有効化

フォームスクリプトのサポート

編集可能グリッドでサポートされているテーブルとビュー

関連項目

フィードバック

その他のリソース

次の方法で共有

編集可能グリッドの使用

編集可能グリッドの有効化

フォーム スクリプトのサポート

編集可能グリッドでサポートされているテーブルとビュー

関連項目

フィードバック

その他のリソース

フォームスクリプトのサポート