Partekatu honen bidez:

Xrm.Page.ui quickForms (referencia del lado del cliente)

  • Artikulua

 

Publicado: enero de 2017

Se aplica a: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

La colección Xrm.Page.ui.quickForms proporciona métodos para obtener acceso a todos los controles de vista rápida y sus controles constituyentes en los formularios de Microsoft Dynamics 365 cuando usan el nuevo motor de representación de formularios (también denominados "formularios turbo"). Un control de vista rápida es un formulario de vista rápida agregado a un formulario principal en Microsoft Dynamics 365 que le permita ver información sobre un registro de entidad relacionado en el formulario principal. Los datos de los controles constituyentes de un control de vista rápida no se pueden editar. Para obtener más información acerca de los controles de vista rápida y formularios de vista rápida, vea TechNet: Creación y edición de formularios de vista rápida

Nota

Esta característica se introdujo en la Actualización 1 de CRM Online 2016 y CRM 2016 Service Pack 1 (local).

Este tema es aplicable solo si está usando el nuevo motor de representación de formularios en Dynamics 365. Si usa la representación de formularios heredados (también denominados "formularios de actualización") en Dynamics 365, puede tener acceso al control de vista rápida y sus controles constituyentes mediante el objeto de control estándar; vea Control Xrm.Page.ui (referencia de cliente).

Importante

Con el anuncio de la degradación de los formularios heredados en Dynamics 365, pronto debe planear usar el nuevo motor de representación de formularios si usa la representación de formularios heredados. Dado que hay una diferencia entre cómo tiene acceso a los controles de vista rápida en la representación de formularios nueva y heredada, debe actualizar y comprobar el código existente que apunta a los controles de vista rápida para usar los métodos descritos en este tema cuando cambia al nuevo motor de representación de formularios. Para obtener más información acerca de la degradación de la representación de formularios heredados, consulte Eliminación de la opción de representación de formularios heredados

En este tema

Métodos de colección de quickForms

Métodos de objetos de quickForms

Métodos de colección de quickForms

La colección quickForms proporciona acceso a todos los controles de vista rápida de un formulario. La colección quickForms es compatible con todos los métodos estándar de las colecciones de Dynamics 365. Consulte Colecciones (referencia del lado del cliente)

El siguiente ejemplo muestra cómo recuperar una instancia de control de vista rápida en la colección quickForms mediante el método 9b85e46f-ca6e-4313-af04-4290e3c6ab8b#BKMK_get especificando el valor de índice (entero) o el nombre (cadena) de la instancia de control de vista rápida como argumento.

quickViewControl = Xrm.Page.ui.quickForms.get(arg)

Métodos de objetos de quickForms

Un objeto quickForms representa una instancia de control de vista rápida. Los siguientes métodos se admiten para las instancias de control de vista rápida de un formulario.

  • getControl

  • getControlType

  • getName

  • getParent

  • getVisible

  • Métodos para etiqueta

  • isLoaded

  • actualizar

getControl

Obtenga controles constituyentes en un control de vista rápida.

quickViewControl.getControl()

Puede obtener acceso a un único control en la colección de controles constituyentes pasando un argumento como nombre o valor de índice del control constituyente en un control de vista rápida. Por ejemplo, quickViewControl.getControl("firstname") o quickViewControl.getControl(0)

  • Valor de retorno
    Tipo: Colección de objetos si usa el método sin ningún argumento; objeto si usa el método con un argumento.

  • Comentarios
    Tras recuperar un control constituyente en un control de vista rápida, puede usar cualquiera de los métodos admitidos para un control de Dynamics 365 en el control constituyente que no modifique los datos del control constituyente. Esto se debe a que los controles constituyentes en un control de vista rápida son de solo lectura. Por ejemplo, puede usar: quickViewControl.getControl(0).getAttribute() Para obtener más información sobre los métodos admitidos para un control de Dynamics 365, consulte Control Xrm.Page.ui (referencia de cliente)

    Importante

    El 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute o cualquier método relacionado con datos de un control constituyente puede no funcionar en el formulario principal f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent porque el formulario de vista rápida que está ligado puede no haberse cargado completamente cuando el formulario principal se cargó. Debe usar el método isLoaded para que la instancia de control de vista rápida le ayude a determinar si el formulario de vista rápida limitado se ha cargado completamente. Más información: isLoaded

    Además, la forma en que recupera los controles constituyentes en un control de vista rápida de formularios utilizando el nuevo motor de representación de formularios es diferente de los formularios heredados. Por lo tanto, si está usando formularios heredados y tiene controles constituyentes que apuntan a código en un control de vista rápida, debe actualizar el código cuando decida usar el nuevo motor de representación de formularios en Dynamics 365.

getControlType

Devuelve un valor de cadena que categoriza los controles de vista rápida.

quickViewControl.getControlType()

Para un control de vista rápida, el método devuelve quickform.

Para un control constituyente en un control de vista rápida, el método devuelve la categoría real del control. Para obtener más información sobre otros valores devueltos, consulte 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getControlType.

getName

Devuelve el nombre asignado al control de vista rápida.

quickViewControl.getName()
  • Valor devuelto
    Tipo: Cadena. El nombre del control de vista rápida.

getParent

Devuelve una referencia al objeto de sección que contiene el control.

Tipos de control: todos.

quickViewControl.getParent()

getVisible

Devuelve un valor que indica si el control de vista rápida está visible actualmente.

Nota

Si la sección o la pestaña que contiene este control no está visible, este método aún puede devolver true. Para asegurarse de que el control realmente sea visible; también debe comprobar la visibilidad de los elementos que contiene.

quickViewControl.getVisible()
  • Valor devuelto
    Tipo: Booleano.True si el control de vista rápida está visible; false de lo contrario.

Métodos para etiqueta

Obtenga o cambie la etiqueta de un control de vista rápida con los métodos getLabel y setLabel.

getLabel

Devuelve la etiqueta del control de vista rápida.

quickViewControl.getLabel()
  • Valor devuelto
    Tipo: Cadena. La etiqueta del control de vista rápida.

setLabel

Establece la etiqueta del control de vista rápida.

quickViewControl.setLabel("label")
  • Argumentos
    Tipo: Cadena. La nueva etiqueta del control de vista rápida.

isLoaded

Devuelve si el enlace de datos para los controles constituyentes en un control de vista rápida está completo.

quickViewControl.isLoaded()

  • Valor devuelto
    Tipo: Booleano. True significa que el enlace de datos para un control constituyente está completo, si no false.

  • Comentarios
    El enlace de datos para los controles constituyentes en un control de vista rápida puede no estar completo durante el formulario principal f451f339-bcee-4260-9904-abc8c0efa153#BKMK_OnloadEvent porque el formulario de vista de rápida al que está enlazado el control puede no haberse cargado completamente. Como resultado, es posible que no funcione el uso del 51828fe3-f6ff-4f97-80ed-b06b3a354955#BKMK_getAttribute o cualquiera de los métodos relacionados con datos de un control constituyente. El método isLoaded para el control de vista rápida ayuda a determinar el estado del enlace de datos para los controles constituyentes en un control de vista rápida.

El siguiente código de ejemplo demuestra cómo puede usar el método isLoaded para comprobar el estado de enlace, y después recuperar el valor del atributo al que está enlazado un control constituyente en un control de vista rápida.

function getAttributeValue() {
    var quickViewControl = Xrm.Page.ui.quickForms.get("<QuickViewControlName>");
    if (quickViewControl != undefined)
    {
        if (quickViewControl.isLoaded())
        {
            // Access the value of the attribute bound to the constituent control
            var myValue = quickViewControl.getControl(0).getAttribute().getValue();
            console.log(myValue);
            return;
        }
        else
        {
            // Wait for some time and check again
            setTimeout(getAttributeValue, 10);
        }
    }
    else
    {
        console.log("No data to display in the quick view control.");
        return;
    }    
}

actualizar

Actualiza los datos visualizados en un control de vista rápida.

quickViewControl.refresh()

Ver también

Referencia de programación del lado del cliente
Referencia de scripting de formularios
Xrm.Page.ui (referencia del lado del cliente)
Control Xrm.Page.ui (referencia de cliente)
Escriba código para formularios de Microsoft Dynamics 365
Use el modelo de objeto Xrm.Page

Microsoft Dynamics 365

© 2017 Microsoft. Todos los derechos reservados. Copyright