Display Fetch in IFRAME – Part 2

My first post about displaying fetch inside an IFRAME has two disadvantages. The first is that the context of the parent window does not follow to the new entity window when you click on add new record (grid) button. This is might be annoying if you’re counting on the default mapping between the two entities. The second problem is that the grid does not refresh after you add (new button) or remove (delete button) a record. This means you are not able to see the changes unless you press on the grid refresh button your self.

I made piece with the fact that the parent context did not follow through to the child window since I was using advanced find. But the fact that the gird does not refresh automatically came as a surprise since I remember this feature working “AS IS” in v3.0. I guess ms did a few changes to the auto function which searched and refreshed the grid. Thanks to Dave Berry who commented / Posted about this and brought it to my attention.

In order to overcome this issue I added two new properties to the FetchViewer class.

The first parameter is called WithParentContext. This property allows you to decide whether the parent window object id is passed to the child window. I made it a public (as opposed to internal) choice since I figured you can display any type of query inside the FetchViewer including a query that does not reflect a direct parent child relationship.

The second parameter is the EntityCode (ObjectTypeCode) of the entity being fetched. If you want the grid to refresh automatically you must supply this value. This is important since the value is eventually passed to MS original auto function which expects this value.

The rest of the fetch viewer class was not changed and you can read all about it here.

function OnCrmPageLoad()
{
    window.fetchContacts = new FetchViewer("IFRAME_test");
    fetchContacts.WithParentContext = true;
    fetchContacts.EntityCode = 2;
    fetchContacts.FetchXml  = getFetchXml();
    fetchContacts.LayoutXml = getLayoutXml();
    fetchContacts.Entity    = "contact";
    fetchContacts.QueryId   = "{00000000-0000-0000-00AA-000000666400}";
    fetchContacts.RegisterOnTab(0); //IFRAME ON THE FIRST TAB
}

function getFetchXml()
{
    return '<fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false"><entity name="contact"><attribute name="fullname"/><attribute name="telephone1"/><attribute name="contactid"/><order attribute="fullname" descending="false"/><filter type="and"><condition attribute="parentcustomerid" operator="eq" uitype="account" value="' + crmForm.ObjectId + '"/></filter></entity></fetch>';
}

function getLayoutXml()
{
    return '<grid name="resultset" object="2" jump="lastname" select="1" icon="1" preview="1"><row name="result" id="contactid"><cell name="fullname" width="300" /><cell name="telephone1" width="125" /></row></grid>';
}

function FetchViewer( iframeId )
{
    var Instance = this;
    var vDynamicForm;
    var m_iframeTab;
    var m_iframeDoc;
    var m_iframeShowModalDialogFunc = null;
    var m_windowAutoFunc = null;
 
    Instance.WithParentContext = false;
    Instance.EntityCode = 0;
    Instance.Entity    = "";
    Instance.Iframe    = null;
    Instance.FetchXml  = "";
    Instance.QueryId   = "";
    Instance.LayoutXml = "";

    Instance.RegisterOnTab  = function( tabIndex )
    { 
        Instance.Iframe = document.getElementById( iframeId );  

        if( !Instance.Iframe )
        {
            return alert( "Iframe " + iframeId + " is undefined" );
        }
  
        m_iframeDoc = getIframeDocument();
        var loadingGifHTML  = "<table height='100%' width='100%' style='cursor:wait'>";
        loadingGifHTML += "<tr>";
        loadingGifHTML += "<td valign='middle' align='center'>";
        loadingGifHTML += "<img alt='' src='/_imgs/AdvFind/progress.gif'/>";
        loadingGifHTML += "<div/><b>Loading View...</b>";
        loadingGifHTML += "</td></tr></table>";
        m_iframeDoc.body.innerHTML = loadingGifHTML;

        if( parseInt( "0" + tabIndex ) == 0 ) 
        {
            Instance.Refresh();
        }
        else 
        {
            Instance.Iframe.attachEvent( "onreadystatechange" , RefreshOnReadyStateChange ); 
        }
    }

    function RefreshOnReadyStateChange()
    {
        if( Instance.Iframe.readyState != 'complete' )
        {
            return;
        }
  
        Instance.Refresh();
    }

    Instance.Refresh = function()
    {
        if( !Instance.Iframe )
        {
            return alert( "Iframe " + iframeId + " is undefined" );
        }
 
        m_iframeDoc = getIframeDocument();  

        Instance.Iframe.detachEvent( "onreadystatechange" , RefreshOnReadyStateChange );

        var create  = m_iframeDoc.createElement;
        var append1 = m_iframeDoc.appendChild; 
        vDynamicForm = create("<FORM name='vDynamicForm' method='post'>");

        var append2 = vDynamicForm.appendChild;
        append2(create("<INPUT type='hidden' name='FetchXml'>"));
        append2(create("<INPUT type='hidden' name='LayoutXml'>"));
        append2(create("<INPUT type='hidden' name='EntityName'>"));
        append2(create("<INPUT type='hidden' name='DefaultAdvFindViewId'>"));
        append2(create("<INPUT type='hidden' name='ViewType'>"));
        append1( vDynamicForm );

        vDynamicForm.action = "/" + ORG_UNIQUE_NAME + "/AdvancedFind/fetchData.aspx";
        vDynamicForm.FetchXml.value   = Instance.FetchXml;
        vDynamicForm.LayoutXml.value  = Instance.LayoutXml;
        vDynamicForm.EntityName.value = Instance.Entity;
        vDynamicForm.DefaultAdvFindViewId.value = Instance.QueryId;
        vDynamicForm.ViewType.value = 1039;
        vDynamicForm.submit();

        Instance.Iframe.attachEvent( "onreadystatechange" , OnViewReady );
    }

    function OnViewReady()
    {
        if( Instance.Iframe.readyState != 'complete' ) 
        {
            return;
        }
  
        Instance.Iframe.style.border = 0;
        Instance.Iframe.detachEvent( "onreadystatechange" , OnViewReady );
   
        if (Instance.WithParentContext == true)
        {
            getIframeWindow().open = OnWindowOpen;
        }
  
        if (m_iframeShowModalDialogFunc == null)
        {
            m_iframeShowModalDialogFunc = getIframeWindow().showModalDialog;
            getIframeWindow().showModalDialog = OnIframeShowModalDialog;
        }
  
        if (Instance.EntityCode > 0)
        { 
            if (m_windowAutoFunc == null)
            {
                m_windowAutoFunc = window.auto;
                window.auto = OnWindowAuto;
            }
        }
  
        m_iframeDoc = getIframeDocument();
        m_iframeDoc.body.scroll = "no";
        m_iframeDoc.body.style.padding = "0px";   
    }

    function OnWindowOpen(url, name, features) 
    {
        //new window
        if (url.indexOf('?') == -1)
        {
            if (url.indexOf('userdefined') == -1 ) 
            {
                url = url + "?_CreateFromType=" + crmForm.ObjectTypeCode + "&_CreateFromId=" + crmForm.ObjectId;
            }
            else 
            {
                url = url + "?_CreateFromType=" + crmForm.ObjectTypeCode + "&_CreateFromId=" + crmForm.ObjectId + "&etc=" + Instance.EntityCode + "#";
            }
      } 
   
        return window.open(url, name, features);
    }
 
    function OnIframeShowModalDialog(sUrl, vArguments, sFeatures)
    {
        m_iframeShowModalDialogFunc(sUrl, vArguments, sFeatures);
        Instance.Refresh();
    }
 
    function OnWindowAuto(otc)
    {
        if ( otc == Instance.EntityCode )
        {
            getIframeDocument().all.crmGrid.Refresh();
        }

        m_windowAutoFunc(otc);
    }

    function getIframeDocument()
    {
        return getIframeWindow().document;
    }
 
    function getIframeWindow()
    {
        return Instance.Iframe.contentWindow;
    }
}

OnCrmPageLoad();