Desarrollo JavaScript para Acrobat

JavaScript se creó para descargar el procesamiento de páginas web de un servidor a un cliente en

aplicaciones basadas en web. Acrobat amplía el lenguaje principal al agregar nuevos objetos y sus
métodos y propiedades adjuntos al lenguaje JavaScript. Estos objetos específicos de Acrobat
permiten a un desarrollador administrar la seguridad de los documentos, comunicarse con una base
de datos, manejar archivos adjuntos, manipular un archivo PDF para que se comporte como un
formulario interactivo habilitado para la web, etc. Debido a que los objetos específicos de Acrobat
se agregan sobre el núcleo de JavaScript, aún tiene acceso a sus clases estándar,
incluidas Math, String, Datey RegExp.

Los documentos PDF tienen una gran versatilidad ya que pueden mostrarse tanto en el software
Acrobat como en un navegador web. Por lo tanto, es importante conocer las diferencias entre
JavaScript utilizado en un archivo PDF y JavaScript utilizado en una página web:

JavaScript en un archivo PDF no tiene acceso a los objetos dentro de una página HTML. De
manera similar, JavaScript en una página web no puede acceder a objetos dentro de un archivo
PDF.
En HTML, JavaScript puede manipular objetos como Window. JavaScript para Acrobat no
puede acceder a este objeto en particular, pero puede manipular objetos específicos de PDF.
La mayoría de la gente conoce Acrobat como un medio para intercambiar y visualizar documentos
electrónicos de forma fácil y fiable, independientemente del entorno en el que se hayan creado; sin
embargo, Acrobat ofrece muchas más funciones que un simple visor de documentos.

Puede mejorar un documento PDF para que contenga campos de formulario para capturar datos
ingresados por el usuario, así como botones para iniciar acciones del usuario. Este tipo de
documento PDF puede reemplazar los formularios en papel existentes, lo que permite a los
empleados de una empresa completar formularios y enviarlos a través de archivos PDF, y conectar
sus soluciones a los flujos de trabajo de la empresa en virtud de su estructura basada en XML y la
compatibilidad con SOAP. servicios web.

Acrobat también contiene funciones para admitir la revisión en línea del equipo . Los documentos
que están listos para su revisión se convierten a PDF. Cuando un revisor ve un documento PDF en
Acrobat y le agrega comentarios, esos comentarios (o anotaciones ). constituyen una capa adicional
de información sobre el documento base. Acrobat admite una amplia variedad de tipos de
comentarios estándar, como una nota, un gráfico, un sonido o una película. Para compartir
comentarios sobre un documento con otros, como el autor y otros revisores, un revisor puede
exportar solo la "capa" de comentarios a un depósito de comentarios separado.
En cualquiera de estos escenarios, así como en otros que no se mencionan aquí, puede personalizar
el comportamiento de un documento PDF en particular, implementar políticas de seguridad,
interactuar con bases de datos y servicios web, y modificar dinámicamente la apariencia de un
documento PDF usando JavaScript. . Puede vincular código JavaScript a un documento PDF
específico, una página particular dentro de un documento PDF o un campo de formulario o botón en
un archivo PDF. Cuando un usuario final interactúa con Acrobat o con un archivo PDF mostrado en
Acrobat que contiene JavaScript, Acrobat supervisa la interacción y ejecuta el código JavaScript
adecuado.

No solo puede personalizar el comportamiento de los documentos PDF en Acrobat, sino que
también puede personalizar el propio Acrobat. En versiones anteriores de Acrobat (anteriores a
Acrobat 5), este tipo de personalización solo se podía realizar escribiendo complementos de Acrobat
en un lenguaje de alto nivel como C o C++. Ahora, gran parte de esa misma funcionalidad está
disponible a través de las extensiones de Acrobat para JavaScript. Encontrará que usar JavaScript
para realizar una tarea como agregar un menú a la interfaz de usuario de Acrobat es mucho más
fácil que escribir un complemento.

Con Acrobat Pro DC, puede crear secuencias por lotes para procesar varios documentos, procesar
dentro de un solo documento, procesar para una página determinada y procesar para un solo campo
de formulario. Para el procesamiento por lotes, es posible ejecutar JavaScript en un conjunto de
archivos PDF, lo que permite tareas como la extracción de comentarios de un repositorio de
comentarios, la identificación de errores ortográficos y la impresión automática de archivos PDF.

Referencia de la API de JavaScript para Acrobat

El documento complementario a este documento es la Referencia de la API de JavaScript de
Acrobat . Además de una lista de API, proporciona detalles sobre las restricciones de seguridad
impuestas a algunos de los métodos.

Estas características son de particular importancia:

 La barra rápida . En la Referencia de la API de JavaScript de Acrobat , cada objeto, propiedad y

método tiene una barra rápida, una tabla de iconos de una fila que proporciona un resumen de la
disponibilidad del elemento y las recomendaciones de uso. Se pueden evitar muchas horas de
tiempo perdidas prestando atención a esta barra rápida. Consulte la referencia de la API de
JavaScript de Acrobat para obtener más información.
 Contexto privilegiado . Esta guía contiene información detallada sobre la ejecución de JavaScript
en un contexto privilegiado, además de la proporcionada en la referencia de la API de JavaScript
 de Acrobat < https://www.adobe.com/go/acrobatsdk_jsapiref >`__, consulte Contexto
privilegiado frente a contexto no privilegiado .
 Camino seguro . Acrobat 6.0 introdujo el concepto de una ruta segura para los métodos de
JavaScript que escriben datos en el disco duro local en función de una ruta que le pasa uno de sus
parámetros. Generalmente, cuando se considera que una ruta no es segura, NotAllowedErrorse
lanza una excepción. Consulte la referencia de la API de JavaScript de Acrobat para obtener más
información acerca de las rutas seguras .
Nota
Muchos scripts de muestra presentados en esta guía hacen referencia al sistema de archivos
local. Estos scripts generalmente usan la ruta "/c/temp/", que es una ruta segura.

Resumen de objetos
La extensión de Acrobat para JavaScript básico define muchos objetos que permiten que su código
interactúe con la aplicación Acrobat, un documento PDF o campos de formulario dentro de un
documento PDF. Esta sección le presenta los objetos principales utilizados para acceder y controlar
la aplicación y el documento, el propio entorno de desarrollo y la funcionalidad de JavaScript de
uso general.

A continuación se muestra una breve lista de algunos de los principales objetos utilizados en el
documento y en los archivos de muestra. Una breve descripción de cada uno de los objetos sigue a
la tabla.

Obje
Objetivo
to
aplicaci
Acróbata
ón
consola Depurador de JavaScript
dbg depurador
diálogo Cuadros de diálogo modales
Doc documento PDF
evento Eventos de JavaScript
Información persistente y entre
global
documentos
búsqued
Búsqueda e indexación
a
segurida
Cifrado y firmas digitales
d
JABÓN servicios web
útil Métodos de utilidad de JavaScript
aplicación
El appobjeto es un objeto estático que representa la propia aplicación de Acrobat. Ofrece una serie
de funciones específicas de Acrobat además de una variedad de rutinas de utilidad y funciones
prácticas. Al interactuar con el appobjeto, puede abrir o crear documentos PDF y FDF, y
personalizar la interfaz de Acrobat configurando sus modos de visualización, mostrando menús
emergentes, alertas y termómetros, mostrando un cuadro de diálogo modal, controlando intervalos
de tiempo, controlando si los cálculos se realizarán. realizarse, realizar operaciones de correo
electrónico y modificar su colección de botones de barra de herramientas, menús y elementos de
menú. También puede consultar apppara determinar qué producto y versión de Adobe está utilizando
el usuario final (como Acrobat Reader 8 o Acrobat Pro DC 7.0), así como qué nombres de
impresora y espacios de color están disponibles.
Doc

El objeto Doc es la interfaz principal del documento PDF y se puede utilizar para acceder a su
contenido y manipularlo. El objeto Doc proporciona las interfaces entre un documento PDF abierto
en el visor y el intérprete de JavaScript. Al interactuar con el objeto Doc, puede obtener
información general sobre el documento, navegar dentro del documento, controlar su estructura,
comportamiento y formato, crear contenido nuevo dentro del documento y acceder a los objetos
incluidos en el documento, incluidos marcadores, campos de formulario, plantillas, anotaciones y
sonidos.

El siguiente gráfico representa la jerarquía de contención de objetos relacionados con el objeto Doc.

Jerarquía de contención de objetos de documento

El acceso al objeto Doc desde JavaScript se puede hacer de varias maneras. El método más común
es usar el thisobjeto, que normalmente es equivalente al objeto Doc del documento subyacente
actual.
dbg

Puede usar el dbgobjeto, disponible solo en Acrobat Pro DC, para controlar el depurador de
JavaScript desde una línea de comando mientras la aplicación no está ejecutando un cuadro de
diálogo modal. Los dbgmétodos de objeto ofrecen la misma funcionalidad que los botones de la
barra de herramientas del cuadro de diálogo del depurador de JavaScript, que permiten la ejecución
paso a paso, establecer, eliminar e inspeccionar puntos de interrupción y salir del depurador.
consola

El consoleobjeto es un objeto estático que se utiliza para acceder a la consola de JavaScript para
mostrar mensajes de depuración y ejecutar JavaScript. Es útil como ayuda para la depuración y
como medio para probar el código de forma interactiva y solo está disponible en Acrobat Pro DC.
global

El globalobjeto se utiliza para almacenar datos persistentes entre invocaciones de Acrobat o

compartidos por varios documentos. El intercambio de datos globales y la notificación a través de
múltiples documentos se realiza a través de un mecanismo de suscripción, que permite monitorear
variables globales y reportar sus valores a todos los documentos de suscripción. Además, globalse
puede utilizar para almacenar información que pertenece a un grupo de documentos, situación que
ocurre cuando se ejecuta una secuencia por lotes. Por ejemplo, el código de secuencia de lotes suele
almacenar el número total de documentos que se van a procesar como una propiedad de global. Si la
información sobre los documentos debe almacenarse en un Reportobjeto, se asigna a un conjunto de
propiedades dentro globalpara que sea accesible para el Reportobjeto.
útil

El utilobjeto es un objeto JavaScript estático que define una serie de métodos de utilidad y funciones
convenientes para el formato y análisis de números y fechas. También se puede utilizar para
convertir información entre contenido enriquecido y representaciones XML.
diálogo

El dialogobjeto es un objeto literal utilizado por el método appdel objeto execDialogpara presentar un

cuadro de diálogo modal idéntico en apariencia y comportamiento a los utilizados en todas las
aplicaciones de Adobe. El dialogobjeto literal consta de un conjunto de controladores de eventos y
propiedades que determinan el comportamiento y el contenido del cuadro de diálogo, y puede estar
compuesto por los siguientes elementos: botones, casillas de verificación, botones de radio, cuadros
de lista, cuadros de texto, controles emergentes, y contenedores y marcos para juegos de controles.
seguridad

El securityobjeto es un objeto JavaScript estático, disponible sin restricciones en todas las

aplicaciones de Acrobat, incluido Acrobat Reader, que emplea un modelo de seguridad basado en
tokens para facilitar la creación y gestión de firmas digitales y cifrado en documentos PDF,
proporcionando así un medio de autenticación de usuarios y gestión de directorios. Se puede
acceder a sus métodos y propiedades durante los eventos de inicialización de lote, consola, menú o
aplicación. lossecurityEl objeto se puede usar para agregar contraseñas y establecer opciones de
seguridad, agregar derechos de uso a un documento, cifrar archivos PDF para una lista de
destinatarios, aplicar y asignar políticas de seguridad, crear políticas de seguridad personalizadas,
agregar seguridad a documentos adjuntos, crear y administrar identificaciones digitales usando
certificados, cree una lista de identidades confiables y verifique la información en los certificados.
JABÓN

El SOAPobjeto se puede utilizar para realizar llamadas a procedimientos remotos a un servidor e

invocar servicios web descritos por WSDL, y es compatible con la codificación SOAP 1.1 y
1.2. Sus métodos están disponibles en Acrobat Pro DC, Acrobat Standard DC y para documentos
con derechos de exportación de formulario abiertos en Acrobat Reader 6.0 o
posterior. El SOAPobjeto permite compartir comentarios de forma remota e invocar servicios web
en eventos de campo de formulario. Brinda soporte para respuestas y consultas de texto
enriquecido, autenticación HTTP y WS-Security, encabezados SOAP, manejo de errores, envío o
conversión de archivos adjuntos, intercambio de datos binarios comprimidos, codificación literal de
documentos, serialización de objetos, flujos XML y aplicación de detección de servicios DNS a
encontrar repositorios colaborativos en una intranet. Además, elXMLDataEl objeto se puede utilizar
para evaluar expresiones XPath y realizar conversiones XSLT en documentos XML.
búsqueda

El searchobjeto es un objeto estático que se puede usar para realizar búsquedas simples y avanzadas
de texto en uno o más documentos PDF o archivos de índice, crear, actualizar, reconstruir o depurar
índices para uno o más documentos PDF y buscar a nivel de documento. y metadatos a nivel de
objeto. El searchobjeto tiene propiedades que se pueden usar para afinar la consulta, como un
diccionario de sinónimos, palabras con sonidos similares, mayúsculas y minúsculas y
configuraciones para buscar el texto tanto en anotaciones como en metadatos EXIF contenidos en
imágenes JPEG.
evento

Todas las acciones de JavaScript se ejecutan cuando ocurre un evento en particular. Para cada
evento, eventse crea un objeto. Cuando ocurre un evento, el eventobjeto se puede usar para obtener y
administrar cualquier información asociada con el estado de ese evento en particular. Se eventcrea
un objeto para cada uno de los siguientes tipos de eventos: inicialización de Acrobat, secuencias por
lotes, eventos de mouse en marcadores, acciones de consola de JavaScript, acciones de impresión,
guardado, apertura o cierre de documentos, eventos de apertura y cierre de página, mouse de campo
de formulario, pulsación de tecla , eventos de cálculo, formato y validación, y eventos de selección
de elementos de menú.

Aplicaciones JavaScript
JavaScript para Acrobat le permite hacer una amplia variedad de cosas dentro de Acrobat y Acrobat
Reader, y dentro de documentos PDF. Las extensiones de Acrobat para JavaScript pueden ayudar
con los siguientes flujos de trabajo:

 Creación de documentos PDF

 Crear nuevos archivos PDF
 Controle la apariencia y el comportamiento de los archivos PDF
 Convierte archivos PDF a formato XML
 Crear y generar plantillas
 Adjuntar archivos a documentos PDF
 Creación de formularios de Acrobat
 Cree, modifique y rellene formularios interactivos que cambian dinámicamente
 Importación y exportación de formularios, datos adjuntos e imágenes
 Guarde los datos del formulario en formato XML, XDP o Microsoft Excel
 Formularios completados por correo electrónico
 Hacer que los formularios sean accesibles para usuarios con discapacidades visuales
 Haga que los formularios estén listos para la web
 Migrar formularios heredados a XFA dinámico
 formularios seguros
 Facilitar la revisión, el marcado y la aprobación
 Establecer las preferencias del repositorio de comentarios
 Crear y administrar comentarios
 Aprobar documentos usando sellos
 Integración de medios digitales en documentos
 Controle y administre reproductores multimedia y monitores
 Agregar clips de película y sonido
 Agregar y administrar representaciones
 Establecer preferencias multimedia
 Modificación de la interfaz de usuario
 Crear cuadros de diálogo
 Agregar navegación a documentos PDF
  Administrar capas de PDF
 Gestionar la producción de impresión
 Búsqueda e indexación de documentos y metadatos de documentos
 Realizar búsquedas de texto en uno o más documentos
 Crear, actualizar, reconstruir y purgar índices
 Buscar metadatos de documentos
 Asegurar documentos
 Crear y gestionar firmas digitales
 Agregar y administrar contraseñas
 Agregar derechos de uso
 Cifrar archivos
 Administrar certificados digitales
 Administrar los derechos de uso
 Escribir JavaScript para Acrobat Reader
 Habilitar colaboración
 Interactuando con bases de datos
 Establecer una conexión ADBC
 Ejecutar sentencias SQL
 Compatibilidad con ADO (solo Windows)
 Interactuar con los servicios web
 Invocación de conexión y método
 Autenticación HTTP y WS-Security
 Compatibilidad con encabezados SOAP
 Manejo de errores
 Manejar archivos adjuntos
 Intercambiar datos binarios comprimidos
 Codificación literal del documento
 Serializar objetos
 flujos XML
 Aplique el descubrimiento de servicios DNS para encontrar repositorios colaborativos en una
intranet
 XML
 Realizar conversiones XSLT en documentos XML
 Evaluar expresiones XPath