Compartir a través de

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

  • Artículo

 

Publicado: enero de 2017

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

Xrm.Page.ui contiene propiedades y métodos para recuperar información acerca de la interfaz de usuario, así como recopilaciones para varios subcomponentes del formulario.

Propiedades y métodos de Xrm.Page.ui

  • Cerrar
    Método para cerrar el formulario.

  • controles
    Una colección de todos los controles de la página.

  • formSelector
    Use el método formSelector.getCurrentItem para recuperar la información acerca del formulario actualmente en uso y la colección formSelector.items que contiene la información de todos los formularios disponibles para el usuario.

  • getCurrentControl
    Método para obtener el objeto del control que actualmente tiene el enfoque en el formulario.

    Nota

    Este método ha quedado obsoleto en Paquete acumulativo de actualizaciones 2 de Microsoft Dynamics CRM 2013.

  • getFormType
    Método para obtener el contexto de formulario del registro.

  • navigation.items
    Una colección de todos los elementos de navegación de la página.

  • Notificación de formulario
    Use setFormNotification para mostrar notificaciones de nivel de formulario y clearFormNotification para quitar notificaciones.

  • quickForms
    Una colección de todos los controles de vista rápida de la página.

  • refreshRibbon
    Método para hacer que la cinta de opciones reevalúe los datos que controlan qué se muestra en ella.

  • tabs
    Una colección de todas las pestañas de la página.

  • Métodos ViewPort
    ViewPort es el área de la página que contiene datos de formulario. Corresponde al cuerpo del formulario y no incluye las áreas de navegación, encabezado, pie de página o asistente de formulario de la página. Use los métodos de getViewPortHeight y getViewPortWidth para obtener el tamaño actual de ViewPort.

Cerrar

Método para cerrar el formulario.

Xrm.Page.ui.close()

Comentarios:

Se suprime el método HTML Window.close. Para cerrar una ventana de formulario debe usar este método. Si hay cambios sin guardar en el formulario se le preguntará al usuario si desea guardar los cambios antes de cerrar la ventana.

Con Microsoft Dynamics 365 para tabletas, este método imita el comportamiento del botón atrás de navegación.

controles

Una colección de todos los controles de la página.

Vea Colecciones (referencia del lado del cliente) para obtener información sobre los métodos de colección y Control Xrm.Page.ui (referencia de cliente) para obtener información sobre los objetos de control en la colección.

formSelector

Use el método formSelector.getCurrentItem para recuperar la información acerca del formulario actualmente en uso y la colección formSelector.items que contiene la información de todos los formularios disponibles para el usuario.

Nota

La colección de formSelectoritems no existe y el método formSelector.getCurrentItem no es compatible con los clientes móviles de Dynamics 365 (teléfonos y tabletas) y el centro de servicio interactivo.

formSelector.getCurrentItem

Método para devolver una referencia al formulario mostrado actualmente.

Nota

Cuando solo un formulario está disponible este método devolverá null.

  • Valor devuelto
    Tipo:Objeto

formSelector.items

Una colección de todos los elementos de formulario accesibles al usuario actual.

Nota

Sólo los formularios que comparten una asociación con uno de los roles de seguridad del usuario están disponibles en esta colección.

Vea Colecciones (referencia del lado del cliente) para obtener información sobre los métodos de colección y Elemento Xrm.Page.ui.formSelector (referencia del lado del cliente) para obtener información sobre los elementos en la colección.

getCurrentControl

Método para obtener el objeto del control que actualmente tiene el enfoque en el formulario. No se devuelven controles de IFRAME y recursos web con este método.

Nota

Este método ha quedado obsoleto en Paquete acumulativo de actualizaciones 2 de Microsoft Dynamics CRM 2013.

Este método no devuelve una referencia al control actual cuando el último campo modificado por el usuario era un atributo booleano con formato de botón de radio o control de casilla. Este método tampoco puede devolver una referencia inmediatamente después de usar el método setFocus del control Xrm.Page.ui.

Xrm.Page.ui.getCurrentControl()
  • Valor devuelto
    Tipo:Objeto

getFormType

Método para obtener el contexto de formulario del registro.

Xrm.Page.ui.getFormType()

  • Valor devuelto
    Tipo:Número

    La siguiente tabla muestra los tipos de formulario que corresponden al valor de devolución.

    Valor

    Tipo de formulario

    0

    Indefinido

    1

    Crear

    2

    Actualización

    3

    Solo lectura

    4

    Deshabilitado

    6

    Edición masiva

    Nota

    Formularios de creación rápida devuelven 1. El valor 5 se usó para un tipo anterior de formulario de creación rápida que se quitó.

Una colección de todos los elementos de navegación de la página.

Nota

Esta colección no existe con Microsoft Dynamics 365 para tabletas.

Vea Colecciones (referencia del lado del cliente) para obtener información sobre los métodos de colección y Elemento Xrm.Page.ui.navigation (referencia del lado del cliente) para obtener información sobre los elementos en la colección.

Notificación de formulario

Use setFormNotification para mostrar notificaciones de nivel de formulario y clearFormNotification para quitar notificaciones.

clearFormNotification

Use este método para quitar notificaciones en el nivel del formulario.

Xrm.Page.ui.clearFormNotification(uniqueId)

  • Parámetros

    • uniqueId
      Tipo: Cadena. Un identificador único para el mensaje usado con setFormNotification para establecer la notificación.

  • Valor devuelto
    Tipo: Booleano. True si el elemento es correcto, false de lo contrario.

  • Comentarios
    Este método solo está disponible para Entidades actualizadas.

setFormNotification

Use este método para mostrar notificaciones en el nivel del formulario. Puede mostrar cualquier número de notificaciones y se mostrarán hasta que se quiten mediante clearFormNotification. El alto del área de notificación está limitado por lo que cada nuevo mensaje se agregará al principio. Los usuarios pueden desplazarse hacia abajo para ver mensajes más antiguos que aún no se han quitado.

Xrm.Page.ui.setFormNotification(message, level, uniqueId);

  • Parámetros

    • message
      Tipo: Cadena. El texto del mensaje.

    • level
      Tipo:Cadena. El nivel del mensaje.

      El nivel define cómo se mostrará el mensaje.

      • ERROR : Notificación usará el icono de error del sistema.

      • WARNING : Notificación usará el icono de advertencia del sistema.

      • INFO : Notificación usará el icono de información del sistema.

    • uniqueId
      Tipo:Cadena. Un identificador único para el mensaje usado con clearFormNotification para quitar la notificación.

  • Valor devuelto
    Tipo:Booleano. True si el elemento es correcto, false de lo contrario.

  • Comentarios
    Este método solo está disponible para Entidades actualizadas.

quickForms

Una recopilación de todos los controles de vista rápida de un formulario que utilizan el nuevo motor de representación de formularios (también denominado "formularios turbo"). Para obtener información acerca de las propiedades y métodos compatibles para esta colección y los objetos de la colección, vea Xrm.Page.ui quickForms (referencia del lado del cliente)

refreshRibbon

Método para hacer que la cinta de opciones reevalúe los datos que controlan qué se muestra en ella.

Xrm.Page.ui.refreshRibbon()

  • Valor devuelto
    Tipo: Ninguno

    Comentarios: Esta funcionalidad se suele usar cuando una cinta de opciones <EnableRule> (RibbonDiffXml) depende de un valor en el formulario. Después de que el código cambie un valor usado por una regla, use este método para forzar a la cinta de opciones a reevaluar los datos del formulario para poder aplicar la regla.

tabs

Una colección de todas las pestañas de la página.

Vea Colecciones (referencia del lado del cliente) para obtener información sobre los métodos de colección y Pestaña Xrm.Page.ui (referencia del lado del cliente) para obtener información sobre los elementos en la colección.

Métodos ViewPort

ViewPort es el área de la página que contiene datos de formulario. Corresponde al cuerpo del formulario y no incluye las áreas de navegación, encabezado, pie de página o asistente de formulario de la página. Use los métodos de getViewPortHeight y getViewPortWidth para obtener el tamaño actual de ViewPort.

Nota

Estos métodos no funcionan con Microsoft Dynamics 365 para tabletas.

getViewPortHeight

Método para obtener la altura de la ventana gráfica en píxeles.

Xrm.Page.ui.getViewPortHeight()
  • Valor devuelto
    Tipo:Número

getViewPortWidth

Método para obtener el ancho de la ventana gráfica en píxeles.

Xrm.Page.ui.getViewPortWidth()
  • Valor devuelto
    Tipo:Número

Ver también

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

Microsoft Dynamics 365

© 2017 Microsoft. Todos los derechos reservados. Copyright