Dynamics crm: use setfilterxml to filter the records that need to be displayed in the subgrid control of the form

We often use... In forms subgrid Control , Usually insert... In a form subgrid Used to display records in another entity , The displayed content is displayed by defining different views , It can also be done through javascript To do some control .

In today's blog post, we use another method to achieve flexible in subgrid Up to display customized records , That's what we need today setFilterXml.

Note: It needs to be explained in advance , This setFilterXml It doesn't appear in Microsoft's official documents , So I'm not sure which versions support , Which versions do not support , What I tried was Dynamics 365 9.0 On-premises and Dynamcis 365 9.2 online These two versions .

The following is an example , We are in the entity contact Has been inserted into the form Account The entity's Subgrid

  And then we open up contact After a record of , Will see Account Of subgrid Control Account

open F12 Browser debug mode for , First get this Subgrid Control

var subgrid = Xrm.Page.getControl("AccountsSubgridTest")

  Through this control, we can view its existing filter

subgrid.getFetchXml()

For example, we just want to subgrid It shows that Account Name by A All the records at the beginning , So we use the advanced search function to put this FetchXML download .

But notice that we need to replace the double quotation marks inside with the single quotation marks , And as long as filter Content in Tags .

<fetch version='1.0' output-format='xml-platform' mapping='logical' distinct='false'>
  <entity name='account'>
    <attribute name='name' />
    <attribute name='primarycontactid' />
    <attribute name='telephone1' />
    <attribute name='accountid' />
    <order attribute='name' descending='false' />
    <filter type='and'>
      <condition attribute='name' operator='like' value='A%' />
    </filter>
  </entity>
</fetch>

That is to say

<filter type='and'><condition attribute='name' operator='like' value='A%' /></filter>

Then run the following code to set this subgrid Of filter

subgrid.setFilterXml("<filter type='and'><condition attribute='name' operator='like' value='A%' /></filter>");

Last refresh

subgrid.refresh();

Finally, we can see the display effect

Usually we can use setFilterXml This method is onload Event to realize the custom function of displaying records , It will have a higher degree of freedom than we use the filter conditions in the view , And you can display different records according to different conditions in your code , To achieve the effect we want .