Objets JavaScript provenant d’Acrobat pris en charge dans Designer

Le tableau suivant répertorie la disponibilité des objets, des propriétés et des méthodes Acrobat les plus fréquemment utilisés dans Designer, et décrit les fonctions équivalentes dans Designer. Bien que le tableau présente la plupart des objets, propriétés et méthodes Acrobat, ceux qui sont rarement utilisés dans les formulaires (comme les objets multimédias) ont été volontairement omis.

Lorsqu’aucune fonctionnalité équivalente n’est pas répertoriée, cela signifie qu’il n’existe pas de propriété ou méthode directe pour reproduire le comportement d’Acrobat. Il est toutefois toujours possible de créer des fonctions ou des scripts personnalisés pour répliquer la fonction d’Acrobat.

JavaScript dans Acrobat

Prise en charge de Designer

Equivalent JavaScript dans Designer

Commentaires

Propriétés et méthodes d’objet Annot

Toutes les propriétés et les méthodes

Oui

Aucun

Seuls les formulaires avec une disposition fixe prennent en charge le calque des annotations.

Propriétés de l’objet app

calculate

Non

Aucun

Designer inclut la méthode execCalculate, qui initie l’événement calculate.

execCalculate

language

Oui

xfa.host.language

Voir la propriété language.

language

monitors

Oui

Aucun

 

platform

Oui

xfa.host.platform

Voir la propriété platform.

platform

plugins

Oui

Aucun

 

toolbar

Oui

Aucun

 

viewerType

Oui

xfa.host.appType

Voir la propriété appType.

appType

viewerVariation

Oui

xfa.host.variation

Voir la propriété variation.

variation

viewerVersion

Oui

xfa.host.version

Voir la propriété version.

version

Méthodes de l’objet app

addMenuItem

Oui

Aucun

 

addSubMenu

Oui

Aucun

 

addToolButton

Oui

Aucun

 

alert

Oui

xfa.host.messageBox()

Voir la méthode messageBox.

messageBox

beep

Oui

xfa.host.beep()

Voir la méthode beep.

beep

browseForDoc

Oui

Aucun

 

clearInterval

Oui

Aucun

 

clearTimeOut

Oui

Aucun

 

execDialog

Oui

Aucun

 

execMenuItem

Oui

Aucun

Exécute la commande de menu spécifiée. Utilisez cette méthode dans Designer pour les commandes du menu Fichier.

getNthPluginName

Oui

Aucun

 

getPath

Oui

Aucun

 

goBack

Oui

Aucun

 

goForward

Oui

Aucun

 

hideMenuItem

Oui

Aucun

 

hideToolbarButton

Oui

Aucun

 

launchURL

Oui

Aucun

Designer inclut la méthodegotoURL, qui charge une URL spécifiée dans l’application cliente, comme Acrobat ou Adobe Reader.

gotoURL

listMenuItems

Oui

Aucun

 

listToolbarButtons

Oui

Aucun

 

mailGetAddrs

Oui

Aucun

 

mailMsg

Oui

Aucun

 

newDoc

Oui

Aucun

Cette méthode ne peut être exécutée que lors des événements de traitement par lot, de console ou de menu.

newFDF

Non

Aucun

 

openDoc

Oui

Aucun

 

openFDF

Non

Aucun

 

popUpMenuEx

Oui

Aucun

 

popUpMenu

Oui

Aucun

 

removeToolButton

Oui

Aucun

 

response

Oui

xfa.host.response()

Voir la méthode response.

response

setInterval

Oui

Aucun

 

setTimeOut

Oui

Aucun

 

trustedFunction

Oui

Aucun

 

trustPropagatorFunction

Oui

Aucun

Cette méthode est disponible uniquement lors de l’initialisation du traitement par lot, de la console et de l’application.

Propriétés et méthodes d’objet de signet

Toutes les propriétés et les méthodes

Oui

Aucun

 

Propriétés de l’objet doc

author

Oui

Aucun

 

baseURL

Oui

Aucun

 

bookmarkRoot

Oui

Aucun

 

calculate

Non

Aucun

 

dataObjects

Oui

Aucun

 

delay

Non

Aucun

 

dirty

Oui

Aucun

Ce script Javascript pour Designer enregistre une copie d’un formulaire et vérifie si le formulaire a été modifié :

var sOrigXML = xfa.data.saveXML; si (sOrigXML != xfa.data.saveXML) {...}

disclosed

Oui

Aucun

 

documentFileName

Oui

Aucun

 

dynamicXFAForm

Oui

Aucun

 

external

Oui

Aucun

 

filesize

Oui

Aucun

 

hidden

Oui

Aucun

 

icons

Oui

Aucun

 

keywords

Oui

Aucun

 

layout

Oui

Aucun

 

media

Oui

Aucun

 

metadata

Oui

xfa.form.desc

Voir l’objet desc.

desc

modDate

Oui

Aucun

 

mouseX mouseY

Oui

Aucun

 

noautocomplete

Oui

Aucun

 

nocache

Oui

Aucun

 

numFields

Oui

xfa.layout.pageContent()

La méthode pageContent renvoie une liste de tous les objets d’un type particulier. Cependant, vous devez exécuter la méthode pour les vues de conception et les gabarits afin de numériser la totalité du formulaire.

pageContent

numPages

Oui

xfa.host.numPages

ou

xfa.layout.absPageCount() xfa.layout.pageCount()

La propriété numPages renvoie le nombre de pages du formulaire généré dans l’application cliente. Voir aussi les méthodes absPageCount et pageCount.

numPages

absPageCount

pageCount

pageNum

Oui

xfa.host.currentPage

Voir la propriété currentPage.

currentPage

pageNum--

Oui

xfa.host.currentPage--

ou

xfa.host.pageUp()

Voir la propriété currentPage ou la méthode pageUp.

currentPage

pageUp

pageNum++

Oui

xfa.host.currentPage++

ou

xfa.host.pageDown()

Voir la propriété currentPage ou la méthode pageDown.

currentPage

pageDown

path

Oui

Aucun

 

securityHandler

Oui

Aucun

 

templates

Non

Aucun

Utilisez les objets de sous-formulaire dans Designer, et faites appels aux propriétés et aux méthodes pour ajouter, supprimer, déplacer et configurer les instances de sous-formulaire.

Ajout et suppression des instances de sous-formulaire à l’aide de scripts

title

Oui

xfa.host.title

Voir title.

Méthodes de l’objet doc

addAnnot

Oui

Aucun

 

addField

Non

Aucun

Vous devez utiliser impérativement des formulaires avec une mise en page fixe dans Designer, puis utiliser l’objetinstanceManager pour ajouter, supprimer et configurer le nombre d’instances d’un objet spécifique.

instanceManager

Pour plus d’informations, voir Ajout et suppression des instances de sous-formulaire à l’aide de scripts.

addIcon

Oui

Aucun

 

addLink

Non

Aucun

 

addRecipientListCryptFilter

Oui

Aucun

 

addScript

Oui

Aucun

 

addThumbnails

Non

Aucun

 

addWatermarkFromFile

Oui

Aucun

 

addWatermarkFromText

Oui

Aucun

 

addWeblinks

Oui

Aucun

 

appRightsSign

Oui

Aucun

 

appRightsValidate

Oui

Aucun

 

bringToFront

Oui

Aucun

 

calculateNow

Non

xfa.form.recalculate(1);

ou

execCalculate()

recalculate

La méthoderecalculate force l’exécution d’un jeu spécifique de scripts sur des événements calculate à lancer. La valeur booléenne indique si la condition est True (valeur par défaut) (tous les scripts de calcul sont exécutés) ou False (seuls les scripts de calcul en attente sont exécutés).

L’objet calculate de Designer vérifie si la personne remplissant le formulaire peut écraser ou non la valeur calculée d’un champ.

execCalculate

Vous pouvez également utiliser la méthode execCalculate pour chaque objet pour lequel vous souhaitez forcer un recalcul.

closeDoc

Oui

Aucun

 

createDataObject

Oui

Aucun

 

createTemplate

Non

Aucun

Les formulaires Designer n’ont pas d’équivalent au concept de modèle d’Acrobat. Vous devez utiliser des objets de sous-formulaire dans Designer.

deletePages

Non

Aucun

instanceManager

Dans Designer, vous pouvez utiliser l’objet instanceManager pour supprimer l’objet de sous-formulaire qui représente une page de votre formulaire.

Pour plus d’informations, voir Ajout et suppression des instances de sous-formulaire à l’aide de scripts.

embedDocAsDataObject

Oui

Aucun

 

encryptForRecipients

Oui

Aucun

 

encryptUsingPolicy

Oui

Aucun

 

exportAsText

Oui

Aucun

Cette méthode est uniquement disponible dans la console JavaScript de l’outil JavaScript Debugger dans Acrobat ou au cours d’un traitement par lot.

exportAsFDF

Non

xfa.host.exportData()

exportData

La méthode exportData exporte un fichier XML ou XDP et non un fichier PDF.

exportAsXFDF

Non

xfa.host.exportData()

exportData

La méthode exportData exporte un fichier XML ou XDP et non un fichier PDF.

exportDataObject

Oui

Aucun

 

exportXFAData

Non

xfa.host.exportData()

exportData

La méthode exportData exporte un fichier XML ou XDP et non un fichier PDF.

extractPages

Non

Aucun

 

flattenPages

Non

Aucun

 

getAnnot

Oui

Aucun

 

getAnnots

Oui

Aucun

 

getDataObjectContents

Oui

Aucun

 

getField("FieldName")

Oui

xfa.resolveNode ("FieldName")

resolveNode

La méthode resolveNode accède à l’objet spécifié dans le fichier XML source du formulaire.

getLegalWarnings

Oui

Aucun

 

getLinks

Non

Aucun

 

getNthFieldName

Oui

Vous devez effectuer une boucle à travers tous les objets ayant un nom de classe similaire jusqu’à ce que vous atteigniez l’occurrence nth.

className

Voir la propriété className.

getNthTemplate

Non

Aucun

 

getOCGs

Oui

Aucun

 

getOCGOrder

Oui

Aucun

 

getPageBox

Oui

Aucun

 

getPageLabel

Oui

Aucun

 

getPageNthWord

Oui

Aucun

 

getPageNthWordQuads

Oui

Aucun

 

getPageNumWords

Oui

Aucun

 

getPageRotation

Oui

Aucun

 

getPrintParams

Oui

Aucun

 

getTemplate

Non

Aucun

 

getURL

Oui

xfa.host.gotoURL( "http://www.adobe.com");

Voir la méthode gotoURL.

gotoURL

 

gotoNamedDest

Non

Aucun

 

importAnFDF

Non

Aucun

 

importAnXFDF

Oui

Aucun

 

importDataObject

Oui

Aucun

 

importIcon

Oui

Aucun

 

importTextData

Oui

Aucun

 

importXFAData

Non

xfa.host.importData ("filename.xdp");

Voir la méthode importData.

importData

insertPages

Non

Aucun

 

mailDoc

Oui

Aucun

 

mailForm

Non

Aucun

 

movePage

Non

Aucun

 

newPage

Non

Aucun

 

openDataObject

Oui

Aucun

 

print

Oui

xfa.host.print();

Voir la méthode print.

print

 

removeDataObject

Oui

Aucun

 

removeField

Non

Aucun

 

removeIcon

Oui

Aucun

 

removeLinks

Non

Aucun

 

removeScript

Oui

Aucun

 

removeTemplate

Non

Aucun

 

removeThumbnails

Non

Aucun

 

removeWeblinks

Oui

Aucun

 

replacePages

Non

Aucun

 

resetForm

Non

xfa.host.resetData()

ou

xfa.event.reset()

La méthode resetDatae réinitialise toutes les valeurs des champs d’un formulaire à leurs valeurs par défaut. La méthode reset réinitialise toutes les propriétés au sein d’un modèle d’événement.

resetData

reset

saveAs

Oui

Aucun

Dans Designer, le fichier doit être enregistré au niveau de l’application. Ces scripts sont des exemples d’enregistrement au niveau de application :

app.executeMenuItem ("SaveAs");

ou

var myDoc = event.target; myDoc.saveAs();

spawnPageFromTemplate

Non

Aucun

 

setAction

Non

Aucun

 

setPageLabel

Oui

Aucun

 

setPageRotation

Non

Aucun

 

setPageTabOrder

Non

Aucun

Dans Designer, sélectionnez Edition > Ordre de tabulation pour définir l’ordre de tabulation.

setScript

Non

Aucun

 

submitForm

Oui

Utilisez l’un des objets de bouton d’envoi dans Designer.

 

Propriétés de l’objet event

change

Oui

xfa.event.change

change

Voir la propriété change.

targetName

Oui

xfa.event.target

target

Voir la propriété target.

Propriétés de l’objet field

comb

Non

Aucun

 

charLimit

Non

this.value.#text.maxChars

Dans les formulaires ayant une mise en page fixe, le nombre maximum de caractères peut être défini dans l’espace de travail de Designer. Vous pouvez configurer des champs sur les formulaires prévus pour évoluer en fonction du volume de données.

maxChars

display = display.noView

Non

Voir Modification de la visibilité d’un objet de conception de formulaire.

presence

Vous pouvez également définir la propriété presence dans l’espace de travail de Designer.

Vous ne pouvez pas utiliser l’événement prePrint pour modifier la visibilité d’un objet avant l’impression.

display = display.noPrint

Non

Voir Modification de la visibilité d’un objet de conception de formulaire.

presence

Vous pouvez également définir la propriété presence dans l’espace de travail de Designer.

Vous ne pouvez pas utiliser l’événement prePrint pour modifier la visibilité d’un objet avant impression.

defaultValue

Non

Aucun

Définissez la valeur de champ par défaut dans l’espace de travail de Designer.

exportValues

Non

Aucun

Définissez la valeur d’exportation dans l’espace de travail de Designer.

fillColor

Non

xfa.form.Form1. NumericField1.fillColor

fillColor

Voir la propriété fillColor.

hidden

Non

this.presence = "invisible" this. presence = "visible"

presence

Vous pouvez également définir la propriété presence dans l’espace de travail de Designer.

multiLine

Non

this.ui.textEdit.multiLine = "1";

multiLine

Voir la propriété multiLine.

password

Non

Aucun

Designer contient un champ Mot de passe utilisable sur un formulaire.

page

Non

Aucun

Ne s’applique pas aux formulaires Designer.

print

Non

this.relevant = "-print";

relevant

Voir la propriété relevant.

radiosInUnison

Non

Aucun

Les boutons radio groupés dans Designer s’excluent mutuellement par défaut.

rect

Oui

Vous pouvez obtenir la hauteur et la largeur d’un champ de formulaire Designer à l’aide de la syntaxe de référence suivante :

this.h; this.w;

Vous pouvez également obtenir les coordonnées x et y d’un objet à l’aide de la syntaxe de référence suivante :

this.x; this.y;

h, x, y

Voir les propriétés h, w, x et y.

required

Non

this.mandatory = "error";

ou

this.validate.nullTest = "error";

mandatory, nullTest

Voir les propriétés mandatory et nullTest.

textColor

Non

this.fontColor

fontColor

Voir la propriété fontColor.

textSize

Non

this.font.size

size

Voir la propriété size.

textFont

Non

this.font.typeface

typeface

Voir la propriété typeface.

value

Non

this.rawValue

rawValue

Voir la propriété rawValue.

value

Les champs Designer ont une propriété value ; il s’agit de l’équivalent de la propriété value d’Acrobat.

Méthodes de l’objet field

clearItems

Non

DropDownList1.clearItems();

clearItems

La méthode clearitems s’applique uniquement aux objets de liste déroulante et aux objets de zones de liste dans Designer.

deleteItemAt

Non

Aucun

 

getItemAt

Non

Aucun

 

insertItemAt

Non

DropDownList1.addItem .....)

addItem

Voir la méthode addItem.

isBoxChecked

Non

if(CheckBox1.rawValue == 1)....

rawValue

Voir la propriété rawValue.

isDefaultChecked

Non

Aucun

 

setAction

Non

Aucun

Ne s’applique pas aux formulaires Designer.

setFocus

Oui

xfa.host.setFocus ("TextField1.somExpression")

setFocus

La méthode setFocus exige que le nom de l’objet spécifié soit unique par rapport aux autres objets de votre formulaire.

setItems

Non

Aucun

 

setLock

Oui

Aucun

 

signatureGetModifications

Oui

Aucun

 

signatureGetSeedValue

Oui

Aucun

 

signatureInfo

Oui

Aucun

 

signatureSetSeedValue

Oui

Aucun

 

signatureSign

Oui

Aucun

 

signatureValidate

Oui

Aucun

 

Méthode de l’objet search

search.query("<votre texte>");

Oui

Aucun

Ce “..” syntaxe FormCalc abrégée (..) vous permet de rechercher des objets au sein du modèle d’objet de formulaire XML.

Pour plus d’informations, voir Raccourcis de la syntaxe de référence FormCalc.

Méthode de l’objet SOAP

Toutes les propriétés et les méthodes

Oui

Aucun