getContentWindow (referencia de API de cliente)

Artigo
10/05/2023

Devuelve la ventana de contenido que representa un IFRAME o un recurso web.

Nota

Este método sólo se admite en la Interfaz unificada.

Tipos de control admitidos

iframe, recurso web

Sintaxis

formContext.getControl(arg).getContentWindow().then(successCallback, errorCallback);

Parámetros

Name	Type	Obligatorio	Description
`successCallback`	Function	No	Función para llamar cuando la operación se ejecuta correctamente. Se pasa a la función una instancia de la ventana de contenido que representa el IFRAME o el recurso web.
`errorCallback`	Function	No	Una función a la que se llama cuando la operación tiene error.

Valor devuelto

En caso de éxito, devuelve una promesa que contiene una instancia de ventana de contenido que representa un IFRAME o recurso web.

Ejemplo

El siguiente ejemplo muestra cómo puede utilizar este método con un recurso web HTML (new_myWebResource.htm).

Primero, agregue el siguiente código a su recurso web HTML:

// This script should be in the HTML web resource.
// No usage of Xrm or formContext should happen until this method is called.
function setClientApiContext(xrm, formContext) {
    // Optionally set Xrm and formContext as global variables on the page.
    window.Xrm = xrm;
    window._formContext = formContext;
     
    // Add script logic here that uses xrm or the formContext.
}

A continuación, agregue el siguiente código en el controlador de eventos OnLoad del formulario:

// This should be in a script loaded on the form. 
// form_onload is a handler for the form onload event.
function form_onload(executionContext) {
    var formContext = executionContext.getFormContext();
    var wrControl = formContext.getControl("WebResource_CustomName");
    if (wrControl) {
        wrControl.getContentWindow().then(
            function (contentWindow) {
                contentWindow.setClientApiContext(Xrm, formContext);
            }
        )
    }
}

Se debe agregar un código de inicialización similar a un controlador de eventos TabStateChange si dicha inicialización es necesaria. Cualquier código de inicialización debe ser idempotente si se reutiliza. Por motivos de rendimiento, el formulario puede destruir y reinicializar el control durante la navegación por pestañas.

Nota

¿Puede indicarnos sus preferencias de idioma de documentación? Realice una breve encuesta. (tenga en cuenta que esta encuesta está en inglés)

La encuesta durará unos siete minutos. No se recopilan datos personales (declaración de privacidad).

Compartir por