Manuel du propriétaire | Adobe DREAMWEAVER CS5 Manuel utilisateur

Ajouter à Mes manuels
542 Des pages
R&eacute;f&eacute;rence des API
d’ADOBE&reg; DREAMWEAVER&reg; CS5 &amp; CS5.5
Mentions l&eacute;gales
Mentions l&eacute;gales
Vous trouverez des informations juridiques &agrave; l'adresse http://help.adobe.com/fr_FR/legalnotices/index.html.
Derni&egrave;re mise &agrave; jour le 22/6/2011
iii
Sommaire
Chapitre 1 : Introduction
A propos des extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Extension de Dreamweaver
........................................................................................... 1
Ressources suppl&eacute;mentaires pour les cr&eacute;ateurs d'extensions
Nouvelles fonctions de Dreamweaver CS5
Conventions utilis&eacute;es dans ce manuel
.................................................................................. 3
Chapitre 2 : API d'E/S des fichiers
A propos des dossiers de configuration
A propos de l'API d'E/S des fichiers
Chapitre 3 : API HTTP
Fonctionnement de l'API HTTP
L'API HTTP
............................................................ 2
.............................................................................. 2
................................................................................ 5
..................................................................................... 5
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Chapitre 4 : API de Design Notes
Fonctionnement des Design Notes
L'API JavaScript de Design Notes
L'API C de Design Notes
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Chapitre 5 : Int&eacute;gration de Fireworks
L'API FWLaunch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Chapitre 6 : Int&eacute;gration de Flash
L'API des objets Flash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Fonctions des panneaux et des bo&icirc;tes de dialogue de Flash
Chapitre 7 : Int&eacute;gration de Photoshop
Fonctionnement des objets dynamiques
L'API des objets dynamiques
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Chapitre 8 : API de base de donn&eacute;es
Fonctionnement de l'API de base de donn&eacute;es
Fonctions de connexion &agrave; une base de donn&eacute;es
Fonctions d'acc&egrave;s &agrave; la base de donn&eacute;es
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Chapitre 9 : API de connectivit&eacute; &agrave; une base de donn&eacute;es
S&eacute;lection d'un nouveau type de connexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Cr&eacute;ation d'un nouveau type de connexion
L'API de connexion
Fichier inclus g&eacute;n&eacute;r&eacute;
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Fichier de d&eacute;finition pour votre type de connexion
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Derni&egrave;re mise &agrave; jour le 22/6/2011
iv
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Sommaire
Chapitre 10 : API d'int&eacute;gration de commande source
Fonctionnement de l'int&eacute;gration des commandes source avec Dreamweaver
Ajout d'une fonctionnalit&eacute; de syst&egrave;me de commande source
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Fonctions requises de l'API d'int&eacute;gration de commande source
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Fonctions facultatives de l'API d'int&eacute;gration de commande source
Activateurs
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Chapitre 11 : Application
Fonctions relatives aux applications externes
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Fonctions globales relatives aux applications
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Fonctions de communication avec Bridge
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Chapitre 12 : Espace de travail
Fonctions d'historique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Fonctions d'insertion d'objets
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Fonctions relatives au clavier
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Fonctions relatives aux menus
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Fonctions de la fen&ecirc;tre de r&eacute;sultats
Fonctions de bascule
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Fonctions relatives aux barres d'outils
Fonctions relatives aux fen&ecirc;tres
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Fonctions de la barre d'information
Fonctions des fichiers apparent&eacute;s
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Fonctions du mode Fractionnement vertical
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Fonctions relatives au fractionnement des codes
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Fonctions relatives aux barres d'outils du mode Code
Fonctions des couleurs
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Chapitre 13 : Site
Fonctions relatives aux rapports
Fonctions relatives aux sites
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Chapitre 14 : Document
Fonctions relatives aux conversions
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
Fonctions relatives aux commandes
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Fonctions relatives aux manipulations de fichiers
Fonctions relatives &agrave; l'ensemble d'un document
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Fonctions relatives aux chemins
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Fonctions relatives &agrave; la s&eacute;lection
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Fonctions de manipulation de cha&icirc;nes
Fonctions relatives &agrave; la traduction
Fonctions XSLT
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Chapitre 15 : Contenu de page
Fonctions du panneau Actifs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Fonctions relatives aux comportements
Presse-papiers, fonctions
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Fonctions relatives aux &eacute;l&eacute;ments de biblioth&egrave;que et aux mod&egrave;les
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Derni&egrave;re mise &agrave; jour le 22/6/2011
v
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Sommaire
Fonctions du panneau Fragments de code
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339
Fonctions de modification de widgets Spry
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Insertion de fonctions relatives aux widgets Spry
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345
Fonctions de v&eacute;rification de la compatibilit&eacute; avec les navigateurs
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Chapitre 16 : Documents dynamiques
Fonctions de composants de serveur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Fonctions relatives aux sources de donn&eacute;es
Fonctions de l'Extension Data Manager
Fonctions Live data
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Fonctions relatives au mode En direct
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Fonctions relatives aux comportements de serveur
Fonctions de mod&egrave;le de serveur
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Chapitre 17 : Cr&eacute;ation
Fonctions relatives aux mises en forme CSS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Fonctions relatives aux cadres et aux jeux de cadres
Fonctions relatives aux calques et aux cartes d'images
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Fonctions d'environnement de mise en forme
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
Fonctions relatives au mode de Mise en forme
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Fonctions de gestion de r&eacute;solution
Requ&ecirc;te multim&eacute;dia
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Fonctions relatives aux zooms
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Propri&eacute;t&eacute;s et fonctions de rep&egrave;re
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
Fonctions de modification des tableaux
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Chapitre 18 : Code
Fonctions de code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Fonctions relatives &agrave; la recherche et au remplacement
Fonctions de modifications g&eacute;n&eacute;rales
Fonction relative &agrave; l'impression
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Fonctions relatives &agrave; Quick Tag Editor
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Fonctions relatives au mode Code
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Fonctions du mode Code en direct
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
Fonctions de l'&eacute;diteur de balises et de la biblioth&egrave;que de balises
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Chapitre 19 : Activateurs
Fonctions d'activateur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Derni&egrave;re mise &agrave; jour le 22/6/2011
1
Chapitre 1 : Introduction
Le Guide des API d'Adobe Dreamweaver CS5 d&eacute;crit les interfaces de programmation d'applications (API) qui vous
permettent d'effectuer diverses t&acirc;ches de prise en charge lorsque vous d&eacute;veloppez des extensions Adobe&reg;
Dreamweaver&reg; CS5 et ajoutez des codes de programme &agrave; vos pages Web Dreamweaver. Les API comprennent l'API
JavaScript principale, qui permet d'acc&eacute;der &agrave; la plupart des fonctionnalit&eacute;s essentielles de Dreamweaver. Les
fonctionnalit&eacute;s essentielles de Dreamweaver sont &agrave; peu pr&egrave;s tout ce qui peut &ecirc;tre effectu&eacute; via un menu, et bien plus
encore. Il s'agit aussi de diverses API utilitaires destin&eacute;es &agrave; des t&acirc;ches aussi courantes que la lecture de fichiers et leur
&eacute;criture, le transfert d'informations &agrave; l'aide de HTTP et la communication avec Fireworks et Flash.
L'API JavaScript vous permet d'ex&eacute;cuter un large &eacute;ventail de t&acirc;ches plus r&eacute;duites. L'utilisateur ex&eacute;cute nombre de ces
t&acirc;ches lorsqu'il cr&eacute;e ou modifie des documents Dreamweaver. Ces fonctions d'API sont regroup&eacute;es selon les parties de
l'interface utilisateur de Dreamweaver auxquelles elles se rapportent. Ainsi, l'API JavaScript comprend les fonctions
relatives &agrave; l'espace de travail, aux documents, &agrave; la conception, etc. Les fonctions de l'API permettent de r&eacute;aliser
quelques-unes des t&acirc;ches suivantes, et bien plus encore :
• Ouverture d'un nouveau document
• Obtention ou d&eacute;finition d'une taille de police
• Recherche de l'occurrence d'une cha&icirc;ne de recherche dans le code HTML
• Activation de la visibilit&eacute; d'une barre d'outils
A propos des extensions
Ce manuel suppose une bonne ma&icirc;trise de Dreamweaver, HTML, XML, de la programmation JavaScript et, le cas
&eacute;ch&eacute;ant, de la programmation C. Pour r&eacute;diger vos propres extensions afin de cr&eacute;er des applications Web, vous devez
conna&icirc;tre les langages de script c&ocirc;t&eacute; serveur et au moins l'une des plates-formes suivantes : Active Server Pages (ASP),
ASP.NET, PHP: Hypertext Preprocessor (PHP), Adobe ColdFusion ou Java Server Pages (JSP).
Extension de Dreamweaver
Pour en savoir plus sur la plate-forme Dreamweaver et l'API permettant de d&eacute;velopper des extensions de
Dreamweaver, voir Extension de Dreamweaver. Le manuel Extension de Dreamweaver d&eacute;crit les fonctions des API que
Dreamweaver appelle pour impl&eacute;menter les objets, menus, panneaux flottants, comportements de serveur, etc., qui
composent les diverses fonctionnalit&eacute;s de Dreamweaver. Ces API permettent d'ajouter des objets, des menus, des
panneaux flottants et d'autres fonctions au produit. Extension de Dreamweaver explique &eacute;galement comment
personnaliser Dreamweaver en modifiant et en ajoutant des balises &agrave; diff&eacute;rents fichiers HTML et XML, de fa&ccedil;on &agrave;
ajouter des &eacute;l&eacute;ments de menus ou des types de documents, etc.
Derni&egrave;re mise &agrave; jour le 22/6/2011
2
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Introduction
Ressources suppl&eacute;mentaires pour les cr&eacute;ateurs
d'extensions
Pour entrer en contact avec d'autres d&eacute;veloppeurs d'extensions, rejoignez le forum de discussion consacr&eacute; &agrave;
l'extensibilit&eacute; de Dreamweaver. Vous trouverez ce forum &agrave; l'adresse
http://www.adobe.com/cfusion/webforums/forum/categories.cfm?forumid=12&amp;catid=190&amp;entercat=y.
Nouvelles fonctions de Dreamweaver CS5
Les nouvelles fonctions suivantes ont &eacute;t&eacute; ajout&eacute;es &agrave; l'API JavaScript de Dreamweaver CS5. Les en-t&ecirc;tes d&eacute;signent les
chapitres et les sections qui contiennent les nouvelles fonctions :
Documents dynamiques
Les fonctions suivantes ont &eacute;t&eacute; ajout&eacute;es au chapitre Documents dynamiques.
Fonctions relatives au mode En direct
&laquo; dom.setLiveViewFollowsLinks() &raquo; &agrave; la page 368
&laquo; dom.getLiveViewFollowsLinks() &raquo; &agrave; la page 368
&laquo; dom.isLiveViewBrowsingHomeURI() &raquo; &agrave; la page 369
&laquo; dreamweaver.findSiteForURI() &raquo; &agrave; la page 369
&laquo; dom.browser.isPageNavigationHistoryEnabled() &raquo; &agrave; la page 371
&laquo; dom.browser.enablePageNavigationHistory() &raquo; &agrave; la page 371
&laquo; dom.browser.getPageNavigationHistoryLength() &raquo; &agrave; la page 372
&laquo; dom.browser.getPageNavigationHistoryPosition() &raquo; &agrave; la page 372
&laquo; dom.browser.goToPageNavigationHistoryPosition() &raquo; &agrave; la page 372
&laquo; dom.browser.getPageNavigationHistoryItem() &raquo; &agrave; la page 373
&laquo; dom.browser.setHomePage() &raquo; &agrave; la page 373
&laquo; dom.browser.getHomePage() &raquo; &agrave; la page 374
Espace de travail
Les fonctions suivantes ont &eacute;t&eacute; ajout&eacute;es au chapitre Espace de travail.
Fonctions des fichiers apparent&eacute;s
&laquo; dreamweaver.getRelatedFilesFilter() &raquo; &agrave; la page 195
&laquo; dreamweaver.setRelatedFilesFilter() &raquo; &agrave; la page 196
&laquo; dreamweaver.getQuickRelatedFilesFilterStrings() &raquo; &agrave; la page 196
&laquo; dreamweaver.invokeRelatedFilesCustomFilterDialog() &raquo; &agrave; la page 196
&laquo; dreamweaver.getDynamicRelatedFilesDiscoverySetting() &raquo; &agrave; la page 197
Derni&egrave;re mise &agrave; jour le 22/6/2011
3
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Introduction
&laquo; dreamweaver.setDynamicRelatedFilesDiscoverySetting() &raquo; &agrave; la page 197
&laquo; dreamweaver.refreshRelatedFiles() &raquo; &agrave; la page 198
&laquo; dreamweaver.saveAllRelatedFiles() &raquo; &agrave; la page 198
&laquo; dreamweaver.canSaveAllRelatedFiles() &raquo; &agrave; la page 198
&laquo; document.isRelatedFileViewOpen() &raquo; &agrave; la page 199
&laquo; document.getRelatedFiles() &raquo; &agrave; la page 199
&laquo; document.addRelatedFile() &raquo; &agrave; la page 200
&laquo; document.removeRelatedFile() &raquo; &agrave; la page 201
&laquo; document.getDependentFiles() &raquo; &agrave; la page 201
...et bien d'autres encore.
Document
Les fonctions suivantes ont &eacute;t&eacute; ajout&eacute;es au chapitre Document.
&laquo; DWUri.isValidURI() &raquo; &agrave; la page 282
&laquo; DWUri.isAbsolute() &raquo; &agrave; la page 283
&laquo; DWUri.isRelative() &raquo; &agrave; la page 283
&laquo; DWUri.isDirectory() &raquo; &agrave; la page 283
&laquo; DWUri.isHierarchical() &raquo; &agrave; la page 284
&laquo; DWUri.isOfType() &raquo; &agrave; la page 284
&laquo; DWUri.isOfFileType() &raquo; &agrave; la page 284
...et bien d'autres encore.
Code
Les fonctions suivantes ont &eacute;t&eacute; ajout&eacute;es au chapitre Code.
&laquo; dom.getLiveCodeHighlightsChanges() &raquo; &agrave; la page 495
&laquo; dom.setLiveCodeHighlightsChanges() &raquo; &agrave; la page 495
...et bien d'autres encore.
Conventions utilis&eacute;es dans ce manuel
Conventions typographiques
Ce manuel utilise les conventions typographiques suivantes :
• La police de code indique des fragments de code et des constantes d'API, notamment des noms de classe, des noms
de m&eacute;thodes, des noms de fonctions, des noms de type, des scripts, des instructions SQL et des noms de balises et
d'attributs HTML et XML.
•
La police de code en italique identifie les &eacute;l&eacute;ments rempla&ccedil;ables dans le code.
Derni&egrave;re mise &agrave; jour le 22/6/2011
4
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Introduction
• Le symbole de continuation (&not;) indique qu'une longue ligne de code a &eacute;t&eacute; fractionn&eacute;e sur deux lignes ou plus. En
raison des limites de marge du format de ce manuel,une ligne de code continue doit ici &ecirc;tre coup&eacute;e. Lorsque vous
copiez les lignes de code, supprimez le symbole de continuation et entrez-les comme une seule ligne.
• Les accolades ({ }) plac&eacute;es avant et apr&egrave;s un argument de fonction indiquent que cet argument est facultatif.
• Le nom des fonctions ayant le pr&eacute;fixe dreamweaver.nomfonc peut &ecirc;tre abr&eacute;g&eacute; en dw.nomfonc lorsque vous &eacute;crivez
le code. Ce manuel utilise le pr&eacute;fixe dreamweaver. complet dans les d&eacute;finitions de fonctions et dans l'index.
Toutefois, dans de nombreux exemples, le pr&eacute;fixe dw. est utilis&eacute;.
Conventions de d&eacute;nomination
Ce manuel utilise les conventions de d&eacute;nomination suivantes :
• Vous — le d&eacute;veloppeur responsable de la r&eacute;daction des extensions
• L'utilisateur — la personne utilisant Dreamweaver
Derni&egrave;re mise &agrave; jour le 22/6/2011
5
Chapitre 2 : API d'E/S des fichiers
Adobe&reg; Dreamweaver&reg; CS5 comprend une biblioth&egrave;que partag&eacute;e C, appel&eacute;e DWfile, qui donne aux auteurs d'objets,
de commandes, de comportements, de traducteurs de donn&eacute;es, de panneaux flottants et d'inspecteurs Propri&eacute;t&eacute;s la
possibilit&eacute; de lire et d'&eacute;crire des fichiers sur le syst&egrave;me de fichiers local. Ce chapitre d&eacute;crit l'API d'entr&eacute;e/sortie des
fichiers et son utilisation.
Pour obtenir des informations g&eacute;n&eacute;rales sur la fa&ccedil;on dont les biblioth&egrave;ques C interagissent avec l'interpr&eacute;teur
JavaScript dans Dreamweaver, voir &laquo; Extensibilit&eacute; de niveau C &raquo; dans le manuel Extension de Dreamweaver.
A propos des dossiers de configuration
Sur les plates-formes Microsoft Windows 2000, Windows XP et Mac OS X, les utilisateurs disposent de leur propre
copie des fichiers de configuration. Lorsque Dreamweaver &eacute;crit dans un fichier de configuration, il le fait dans le
dossier Configuration de l'utilisateur. De m&ecirc;me, lorsqu'il lit un fichier de configuration, Dreamweaver commence par
rechercher ce fichier dans le dossier Configuration de l'utilisateur, puis dans le dossier Configuration de l'application.
Les fonctions DWfile proc&egrave;dent de la m&ecirc;me mani&egrave;re. En d'autres termes, si une extension lit ou &eacute;crit un fichier dans
le dossier Configuration de l'application, elle se reporte aussi au dossier Configuration de l'utilisateur. Pour plus
d'informations sur les dossiers Configuration dans un environnement multiutilisateur, voir Extension de
Dreamweaver.
A propos de l'API d'E/S des fichiers
Toutes les fonctions de l'API d'E/S des fichiers sont des m&eacute;thodes associ&eacute;es &agrave; l'objet DWfile.
DWfile.copy()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction copie le fichier sp&eacute;cifi&eacute; vers un nouvel emplacement.
Arguments
originalURL, copyURL
• L'argument originalURL, exprim&eacute; sous la forme d'une URL de type file://, repr&eacute;sente le fichier que vous souhaitez
copier.
• L'argument copyURL, exprim&eacute; sous la forme d'une URL de type file://, repr&eacute;sente l'emplacement o&ugrave; vous souhaitez
enregistrer le fichier copi&eacute;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si la copie r&eacute;ussit, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
6
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
Exemple
Le code suivant copie un fichier appel&eacute; myconfig.cfg vers myconfig_backup.cfg :
var fileURL = &quot;file:///c|/Config/myconfig.cfg&quot;;
var newURL =&quot;file:///c|/Config/myconfig_backup.cfg&quot;;
DWfile.copy(fileURL, newURL);
DWfile.createFolder()
Disponibilit&eacute;
Dreamweaver 2.
Description
Cette fonction cr&eacute;e un dossier &agrave; l'emplacement sp&eacute;cifi&eacute;.
Arguments
folderURL
• L'argument folderURL, exprim&eacute; sous la forme d'une URL de type file://, repr&eacute;sente l'emplacement dans lequel vous
souhaitez cr&eacute;er le dossier.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le dossier est bien cr&eacute;&eacute;, false en cas d'&eacute;chec.
Exemple
Le code suivant tente de cr&eacute;er un dossier nomm&eacute; tempFolder &agrave; la racine du lecteur C et affiche un message
d'avertissement indiquant si l'op&eacute;ration a r&eacute;ussi.
var folderURL = &quot;file:///c|/tempFolder&quot;;
if (DWfile.createFolder(folderURL)){
alert(&quot;Created &quot; + folderURL);
}else{
alert(&quot;Unable to create &quot; + folderURL);
}
DWfile.exists()
Disponibilit&eacute;
Dreamweaver 2.
Description
Cette fonction v&eacute;rifie l'existence du fichier sp&eacute;cifi&eacute;.
Arguments
fileURL
• L'argument fileURL, exprim&eacute; sous la forme d'une URL de type file://, repr&eacute;sente le fichier requis.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le fichier existe, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
7
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
Exemple
Le code suivant recherche le fichier mydata.txt et affiche un message d'avertissement indiquant &agrave; l'utilisateur si le
fichier existe :
var fileURL = &quot;file:///c|/temp/mydata.txt&quot;;
if (DWfile.exists(fileURL)){
alert(fileURL + &quot; exists!&quot;);
}else{
alert(fileURL + &quot; does not exist.&quot;);
}
DWfile.getAttributes()
Disponibilit&eacute;
Dreamweaver 2.
Description
Cette fonction obtient les attributs du fichier ou dossier sp&eacute;cifi&eacute;.
Arguments
fileURL
• L'argument fileURL, exprim&eacute; sous la forme d'une URL de type file://, repr&eacute;sente le fichier ou dossier dont vous
souhaitez obtenir les attributs.
Valeurs renvoy&eacute;es
Cha&icirc;ne repr&eacute;sentant les attributs du fichier ou du dossier sp&eacute;cifi&eacute;. Si le fichier ou le dossier n'existe pas, cette fonction
renvoie la valeur null. Les caract&egrave;res suivants de la cha&icirc;ne repr&eacute;sentent les attributs :
•
R signifie lecture seule.
•
D signifie dossier.
•
H signifie masqu&eacute;.
•
S indique un fichier ou dossier syst&egrave;me.
Exemple
Le code suivant obtient les attributs du fichier mydata.txt et affiche un message d'avertissement si le fichier est en
lecture seule :
var fileURL = &quot;file:///c|/temp/mydata.txt&quot;;
var str = DWfile.getAttributes(fileURL);
if (str &amp;&amp; (str.indexOf(&quot;R&quot;) != -1)){
alert(fileURL + &quot; is read only!&quot;);
}
DWfile.getModificationDate()
Disponibilit&eacute;
Dreamweaver 2.
Derni&egrave;re mise &agrave; jour le 22/6/2011
8
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
Description
Cette fonction renvoie l'heure &agrave; laquelle le fichier a &eacute;t&eacute; modifi&eacute; pour la derni&egrave;re fois.
Arguments
fileURL
• L'argument fileURL, exprim&eacute; sous la forme d'une URL de type file://, repr&eacute;sente le fichier dont vous v&eacute;rifiez l'heure
de la derni&egrave;re modification.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient un nombre hexad&eacute;cimal repr&eacute;sentant le nombre d'unit&eacute;s de temps &eacute;coul&eacute;es depuis une base de
temps donn&eacute;e. La signification exacte des unit&eacute;s de temps et de la base de temps d&eacute;pend de la plate-forme ; sous
Windows, par exemple, une unit&eacute; de temps est &eacute;gale &agrave; 100 ns et la base de temps est le 1 janvier 1600.
Exemple
Comme la valeur renvoy&eacute;e par cette fonction n'est pas une date et une heure identifiables et qu'elle d&eacute;pend de la plateforme employ&eacute;e, il est utile d'appeler la fonction deux fois pour comparer les valeurs renvoy&eacute;es. L'exemple de code
suivant renvoie les dates de modification des fichiers file1.txt et file2.txt et affiche un message d'avertissement
indiquant le fichier le plus r&eacute;cent :
var file1 = &quot;file:///c|/temp/file1.txt&quot;;
var file2 = &quot;file:///c|/temp/file2.txt&quot;;
var time1 = DWfile.getModificationDate(file1);
var time2 = DWfile.getModificationDate(file2);
if (time1 == time2){
alert(&quot;file1 and file2 were saved at the same time&quot;);
}else if (time1 &lt; time2){
alert(&quot;file1 older that file2&quot;);
}else{
alert(&quot;file1 is newer than file2&quot;);
}
DWfile.getCreationDate()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction renvoie l'heure &agrave; laquelle le fichier a &eacute;t&eacute; cr&eacute;&eacute;.
Arguments
fileURL
• L'argument fileURL, exprim&eacute; sous la forme d'une URL de type file://, repr&eacute;sente le fichier dont vous v&eacute;rifiez l'heure
de cr&eacute;ation.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient un nombre hexad&eacute;cimal repr&eacute;sentant le nombre d'unit&eacute;s de temps &eacute;coul&eacute;es depuis une base de
temps donn&eacute;e. La signification exacte des unit&eacute;s de temps et de la base de temps d&eacute;pend de la plate-forme ; sous
Windows, par exemple, une unit&eacute; de temps est &eacute;gale &agrave; 100 ns et la base de temps est le 1 janvier 1600.
Derni&egrave;re mise &agrave; jour le 22/6/2011
9
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
Exemple
Vous pouvez appeler cette fonction ainsi que la DWfile.getModificationDate() pour un fichier afin de comparer
les dates de modification et de cr&eacute;ation :
var file1 = &quot;file:///c|/temp/file1.txt&quot;;
var time1 = DWfile.getCreationDate(file1);
var time2 = DWfile.getModificationDate(file1);
if (time1 == time2){
alert(&quot;file1 has not been modified since it was created&quot;);
}else if (time1 &lt; time2){
alert(&quot;file1 was last modified on &quot; + time2);
}
DWfile.getCreationDateObj()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction obtient l'objet JavaScript repr&eacute;sentant l'heure de cr&eacute;ation du fichier.
Arguments
fileURL
• L'argument fileURL, exprim&eacute; sous la forme d'une URL de type file://, repr&eacute;sente le fichier dont vous v&eacute;rifiez l'heure
de cr&eacute;ation.
Valeurs renvoy&eacute;es
Obtient un objet Date JavaScript repr&eacute;sentant la date et l'heure de cr&eacute;ation du fichier sp&eacute;cifi&eacute;.
DWfile.getModificationDateObj()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction obtient l'objet Date JavaScript repr&eacute;sentant l'heure de la derni&egrave;re modification du fichier.
Arguments
fileURL
• L'argument fileURL, exprim&eacute; sous la forme d'une URL de type file://, repr&eacute;sente le fichier dont vous v&eacute;rifiez l'heure
de modification la plus r&eacute;cente.
Valeurs renvoy&eacute;es
Obtient un objet Date JavaScript repr&eacute;sentant la date et l'heure de la derni&egrave;re modification du fichier sp&eacute;cifi&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
10
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
DWfile.getSize()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction obtient la taille du fichier sp&eacute;cifi&eacute;.
Arguments
fileURL
• L'argument fileURL, exprim&eacute; sous la forme d'une URL de type file://, repr&eacute;sente le fichier dont vous v&eacute;rifiez la taille.
Valeurs renvoy&eacute;es
Nombre entier qui repr&eacute;sente la taille r&eacute;elle du fichier sp&eacute;cifi&eacute;, exprim&eacute;e en octets.
DWfile.listFolder()
Disponibilit&eacute;
Dreamweaver 2.
Description
Cette fonction obtient une liste du contenu du dossier sp&eacute;cifi&eacute;.
Arguments
folderURL, {constraint}
• L'argument folderURL est le dossier dont vous souhaitez obtenir le contenu, exprim&eacute; sous la forme d'une URL de
type file:// et d'un masque de fichier facultatif compos&eacute; de caract&egrave;res g&eacute;n&eacute;riques. Les caract&egrave;res g&eacute;n&eacute;riques valides
sont les ast&eacute;risques (*), qui repr&eacute;sentent un ou plusieurs caract&egrave;res, et les points d'interrogation (?), qui
repr&eacute;sentent un seul caract&egrave;re.
• L'argument constraint, s'il est fourni, doit &ecirc;tre soit &quot;files&quot; (renvoyer uniquement les fichiers), soit
&quot;directories&quot; (renvoyer uniquement les dossiers). Si cet argument n'est pas sp&eacute;cifi&eacute;, la fonction renvoie aussi
bien des fichiers que des dossiers.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes repr&eacute;sentant le contenu du dossier.
Exemple
Le code suivant obtient une liste de tous les fichiers texte (TXT) du dossier C:/Temp et affiche la liste dans un message
d'avertissement.
var folderURL = &quot;file:///c|/temp&quot;;
var fileMask = &quot;*.txt&quot;;
var list = DWfile.listFolder(folderURL + &quot;/&quot; + fileMask, &quot;files&quot;);
if (list){
alert(folderURL + &quot; contains: &quot; + list.join(&quot;\n&quot;));
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
11
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
DWfile.read()
Disponibilit&eacute;
Dreamweaver 2.
Description
Cette fonction lit le contenu du fichier sp&eacute;cifi&eacute; dans une cha&icirc;ne.
Arguments
fileURL
• L'argument fileURL, exprim&eacute; sous la forme d'une URL de type file://, repr&eacute;sente le fichier que vous souhaitez lire.
Valeurs renvoy&eacute;es
Soit une cha&icirc;ne indiquant le contenu du fichier, soit la valeur null si la lecture &eacute;choue.
Exemple
Le code suivant lit le fichier mydata.txt et, s'il r&eacute;ussit, affiche un message d'avertissement renfermant le contenu du
fichier :
var fileURL = &quot;file:///c|/temp/mydata.txt&quot;;
var str = DWfile.read(fileURL);
if (str){
alert(fileURL + &quot; contains: &quot; + str);
}
DWfile.remove()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction permet de supprimer le fichier sp&eacute;cifi&eacute;.
Arguments
fileURL
• L'argument fileURL, exprim&eacute; sous la forme d'une URL de type file://, repr&eacute;sente le fichier que vous souhaitez
supprimer.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si l'op&eacute;ration r&eacute;ussit, false dans le cas contraire.
Exemple
L'exemple suivant utilise la fonction DWfile.getAttributes() pour d&eacute;terminer si le fichier est accessible en lecture
seule et la fonction confirm() pour afficher &agrave; l'utilisateur une bo&icirc;te de dialogue de type Oui/Non :
Derni&egrave;re mise &agrave; jour le 22/6/2011
12
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
function deleteFile(){
var delAnyway = false;
var selIndex = document.theForm.menu.selectedIndex;
var selFile = document.theForm.menu.options[selIndex].value;
if (DWfile.getAttributes(selFile).indexOf('R') != -1){
delAnyway = confirm('This file is read-only. Delete anyway?');
if (delAnyway){
DWfile.remove(selFile);
}
}
}
DWfile.setAttributes()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction d&eacute;finit les attributs syst&egrave;me d'un fichier donn&eacute;.
Arguments
fileURL, strAttrs
• L'argument fileURL, exprim&eacute; sous la forme d'une URL de type file://, identifie le fichier dont vous d&eacute;finissez les
attributs.
• L'argument strAttrs sp&eacute;cifie les attributs syst&egrave;me du fichier identifi&eacute; par l'argument fileURL. Le tableau suivant
d&eacute;crit les valeurs d'attribut valides et leur signification :
Valeur d'attribut
Description
R
Lecture seule
W
Accessible en &eacute;criture (annule R)
H
Masqu&eacute;
V
Visible (annule H)
Les valeurs acceptables pour la cha&icirc;ne strAttrs sont R, W, H, V, RH, RV, WH ou WV.
N'utilisez pas R et W conjointement, car ces attributs s'excluent l'un l'autre. Si vous les associez, R perd tout son sens
et le fichier est d&eacute;fini comme &eacute;tant accessible en &eacute;criture (W). N'utilisez pas H et V conjointement, car ils s'excluent
aussi l'un l'autre. Si vous les associez, H perd tout son sens et le fichier est d&eacute;fini comme &eacute;tant visible (V).
Si vous sp&eacute;cifiez l'attribut H ou V sans indiquer d'attribut de lecture/&eacute;criture R ou W, l'attribut de lecture/&eacute;criture
existant pour le fichier reste inchang&eacute;. De m&ecirc;me, si vous sp&eacute;cifiez l'attribut R ou W sans sp&eacute;cifier un attribut de
visibilit&eacute; H ou V, l'attribut de visibilit&eacute; existant pour le fichier reste inchang&eacute;.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
13
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'E/S des fichiers
DWfile.write()
Disponibilit&eacute;
Dreamweaver 2.
Description
Cette fonction &eacute;crit la cha&icirc;ne sp&eacute;cifi&eacute;e dans le fichier sp&eacute;cifi&eacute;. Si le fichier sp&eacute;cifi&eacute; n'existe pas, il est cr&eacute;&eacute;.
Arguments
fileURL, text, {mode}
• L'argument fileURL, exprim&eacute; sous la forme d'une URL de type file://, repr&eacute;sente le fichier dans lequel vous &eacute;crivez
une cha&icirc;ne.
Remarque : Si le chemin d'acc&egrave;s contient des espaces, cette fonction n'&eacute;crira pas les fichiers.
• L'argument text indique la cha&icirc;ne que la fonction doit &eacute;crire.
• L'argument mode, s'il est fourni, doit &ecirc;tre append. Si cet argument est omis, la cha&icirc;ne &eacute;crase le contenu du fichier.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'&eacute;criture de la cha&icirc;ne dans le fichier a r&eacute;ussi et false dans le cas contraire.
Exemple
Le code suivant tente d'&eacute;crire la cha&icirc;ne xxx dans le fichier mydata.txt et affiche un message d'avertissement si
l'op&eacute;ration d'&eacute;criture r&eacute;ussit. Il essaie ensuite d'annexer la cha&icirc;ne aaa au fichier et affiche un deuxi&egrave;me message
d'avertissement si cette op&eacute;ration r&eacute;ussit. Apr&egrave;s l'ex&eacute;cution de ce script, le fichier mydata.txt contient uniquement le
texte xxxaaa.
var fileURL = &quot;file:///c|/temp/mydata.txt&quot;;
if (DWfile.write(fileURL, &quot;xxx&quot;)){
alert(&quot;Wrote xxx to &quot; + fileURL);
}
if (DWfile.write(fileURL, &quot;aaa&quot;, &quot;append&quot;)){
alert(&quot;Appended aaa to &quot; + fileURL);
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
14
Chapitre 3 : API HTTP
Les extensions ne fonctionnent pas uniquement dans le syst&egrave;me de fichiers local. Adobe&reg; Dreamweaver&reg; permet
d'&eacute;changer des informations avec un serveur Web via le protocole HTTP (Hypertext Transfer Protocol). Ce chapitre
d&eacute;crit l'API HTTP et son utilisation.
Fonctionnement de l'API HTTP
Toutes les fonctions de l'API HTTP sont des m&eacute;thodes associ&eacute;es &agrave; l'objet MMHttp. La plupart d'entre elles acceptent au
moins une URL comme argument et la plupart renvoient un objet. Le port par d&eacute;faut pour les arguments URL est 80.
Pour sp&eacute;cifier un port diff&eacute;rent, ajoutez deux points (:) et le num&eacute;ro de port &agrave; la suite de l'URL, comme dans l'exemple
suivant :
MMHttp.getText(&quot;http://www.myserver.com:8025&quot;);
Pour les fonctions qui renvoient un objet, cet objet poss&egrave;de deux propri&eacute;t&eacute;s : statusCode et data.
La propri&eacute;t&eacute; statusCode indique l'&eacute;tat de l'op&eacute;ration ; les valeurs possibles sont notamment :
• 200 : Etat OK
• 400 : Demande inintelligible
• 404 : URL demand&eacute;e introuvable
• 405 : Le serveur ne prend pas en charge la m&eacute;thode demand&eacute;e
• 500 : Erreur de serveur inconnue
• 503 : Capacit&eacute; du serveur atteinte
Pour obtenir une liste compl&egrave;te des codes d'&eacute;tat pour votre serveur, consultez votre fournisseur d'acc&egrave;s Internet ou
votre administrateur syst&egrave;me.
La valeur de la propri&eacute;t&eacute; data varie selon la fonction ; les valeurs possibles sont sp&eacute;cifi&eacute;es dans les listes des fonctions
individuelles.
Les fonctions qui renvoient un objet ont &eacute;galement une version de rappel (&laquo; callback &raquo;). Les fonctions de rappel
permettent aux autres fonctions de s'ex&eacute;cuter pendant que le serveur Web traite une requ&ecirc;te HTTP. Ceci est utile si
vous effectuez plusieurs requ&ecirc;tes HTTP &agrave; partir de Dreamweaver. La version de rappel d'une fonction transmet
directement son ID et sa valeur de renvoi &agrave; la fonction sp&eacute;cifi&eacute;e sous forme de premier argument.
L'API HTTP
Cette section pr&eacute;sente en d&eacute;tail les fonctions qui sont des m&eacute;thodes de l'objet MMHttp.
MMHttp.clearServerScriptsFolder()
Disponibilit&eacute;
Dreamweaver MX.
Derni&egrave;re mise &agrave; jour le 22/6/2011
15
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API HTTP
Description
Supprime le dossier _mmServerScripts (et tous ses fichiers) sous le dossier racine du site en cours, qu'il soit local ou
distant. Le dossier _mmServerScripts se trouve dans le dossier Configuration/Connections/Scripts/servermodel/_mmDBScripts.
Arguments
serverScriptsfolder
• L'argument serverScriptsfolder est une cha&icirc;ne qui nomme un dossier donn&eacute;, en liaison avec le dossier Configuration
du serveur d'application, &agrave; partir duquel vous pouvez extraire et supprimer les scripts de serveur.
Valeurs renvoy&eacute;es
Un objet repr&eacute;sentant la r&eacute;ponse du serveur. La propri&eacute;t&eacute; data de cet objet est une cha&icirc;ne englobant le contenu des
scripts supprim&eacute;s. Si une erreur se produit, Dreamweaver la consigne dans la propri&eacute;t&eacute; statusCode de l'objet renvoy&eacute;.
Exemple
Le code suivant, dans un fichier de commandes de menu du dossier Configuration/Menus, supprime tous les fichiers
du dossier _mmServerScripts lorsque celle-ci est appel&eacute;e depuis un menu :
&lt;!-- MENU-LOCATION=NONE --&gt;
&lt;html&gt;
&lt;head&gt;
&lt;TITLE&gt;Clear Server Scripts&lt;/TITLE&gt;
&lt;SCRIPT SRC=&quot;ClearServerScripts.js&quot;&gt;&lt;/SCRIPT&gt;
&lt;SCRIPT LANGUAGE=&quot;javascript&quot;&gt;
&lt;/SCRIPT&gt;
&lt;body onLoad=&quot;MMHttp.clearServerScriptsFolder()&quot;&gt;
&lt;/body&gt;
&lt;/html&gt;
MMHttp.clearTemp()
Description
Cette fonction supprime tous les fichiers du dossier Configuration/Temp situ&eacute; dans le dossier de l'application
Dreamweaver.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Le code suivant, lorsqu'il est enregistr&eacute; dans un fichier du dossier Configuration/Shutdown, supprime tous les fichiers
du dossier Configuration/Temp lorsque l'utilisateur quitte Dreamweaver :
Derni&egrave;re mise &agrave; jour le 22/6/2011
16
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API HTTP
&lt;html&gt;
&lt;head&gt;
&lt;title&gt;Clean Up Temp Files on Shutdown&lt;/title&gt;
&lt;/head&gt;
&lt;body onLoad=&quot;MMHttp.clearTemp()&quot;&gt;
&lt;/body&gt;
&lt;/html&gt;
MMHttp.getFile()
Description
Cette fonction obtient le fichier situ&eacute; &agrave; l'URL sp&eacute;cifi&eacute;e et l'enregistre dans le dossier Configuration/Temp situ&eacute; dans le
dossier de l'application Dreamweaver. Dreamweaver cr&eacute;e automatiquement des sous-dossiers qui reproduisent la
structure de dossiers du serveur ; par exemple, si le fichier sp&eacute;cifi&eacute; est dans
www.dreamcentral.com/people/index.html, Dreamweaver enregistre le fichier index.html dans le sous-dossier People
du dossier www.dreamcentral.com.
Arguments
URL, {prompt}, {saveURL}, {titleBarLabel}
• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqu&eacute; dans l'URL, Dreamweaver
consid&egrave;re qu'il s'agit du protocole HTTP.
• L'argument facultatif prompt est une valeur bool&eacute;enne sp&eacute;cifiant s'il faut inviter l'utilisateur &agrave; enregistrer le fichier.
Si saveURL est en dehors du dossier Configuration/Temp, une valeur de prompt &eacute;gale &agrave; false n'est pas prise en
compte pour des raisons de s&eacute;curit&eacute;.
• L'argument facultatif saveURL est l'emplacement sur le disque dur de l'utilisateur o&ugrave; le fichier doit &ecirc;tre enregistr&eacute;,
exprim&eacute; sous la forme d'une URL de type file://. Si l'argument prompt a pour valeur true ou si saveURL est en
dehors du dossier Configuration/Temp, l'utilisateur peut remplacer saveURL dans la bo&icirc;te de dialogue
d'enregistrement.
• L'argument facultatif titleBarLabel est le libell&eacute; qui doit figurer dans la barre de titre de la bo&icirc;te de dialogue
d'enregistrement.
Valeurs renvoy&eacute;es
Un objet repr&eacute;sentant la r&eacute;ponse du serveur. La propri&eacute;t&eacute; data de cet objet est une cha&icirc;ne contenant l'emplacement
o&ugrave; le fichier a &eacute;t&eacute; enregistr&eacute;, exprim&eacute; sous la forme d'une URL de type file://. Normalement, la propri&eacute;t&eacute; statusCode
de l'objet contient le code d'&eacute;tat envoy&eacute; par le serveur. Toutefois, si une erreur de disque se produit lors de
l'enregistrement du fichier sur le lecteur local, la propri&eacute;t&eacute; statusCode contient un entier repr&eacute;sentant l'un des codes
d'erreur suivants en cas d'&eacute;chec de l'op&eacute;ration :
• 1 : Erreur inconnue
• 2 : Fichier introuvable
• 3 : Chemin non valide
• 4 : La limite du nombre de fichiers ouverts est atteinte
• 5 : Acc&egrave;s refus&eacute;
• 6 : Identificateur de fichier non valide
• 7 : Impossible de supprimer le r&eacute;pertoire de travail en cours
• 8 : Plus d'entr&eacute;es de dossier
Derni&egrave;re mise &agrave; jour le 22/6/2011
17
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API HTTP
• 9 : Erreur lors de la d&eacute;finition du pointeur de fichier
• 10 : Erreur mat&eacute;rielle
• 11 : Violation de partage
• 12 : Violation de verrouillage
• 13 : Disque satur&eacute;
• 14 : Fin du fichier atteinte
Exemple
Le code suivant obtient un fichier HTML, enregistre tous les fichiers dans le dossier Configuration/Temp, puis ouvre
la copie locale du fichier HTML dans un navigateur :
var httpReply = MMHttp.getFile(&quot;http://www.dreamcentral.com/people/profiles/scott.html&quot;,
false);
if (Boolean == 200){
var saveLoc = httpReply.data;
dw.browseDocument(saveLoc);
}
MMHttp.getFileCallback()
Description
Cette fonction obtient le fichier situ&eacute; &agrave; l'URL sp&eacute;cifi&eacute;e, l'enregistre dans le dossier Configuration/Temp du dossier de
l'application Dreamweaver, puis appelle la fonction sp&eacute;cifi&eacute;e avec l'ID et le r&eacute;sultat de la requ&ecirc;te. Lorsque le fichier est
enregistr&eacute; localement, Dreamweaver cr&eacute;e automatiquement des sous-dossiers qui reproduisent la structure de dossiers
du serveur ; par exemple, si le fichier sp&eacute;cifi&eacute; est dans www.dreamcentral.com/people/index.html, Dreamweaver
enregistre le fichier index.html dans le sous-dossier People du dossier www.dreamcentral.com.
Arguments
callbackFunction, URL, {prompt}, {saveURL}, {titleBarLabel}
• L'argument callbackFunction est le nom de la fonction JavaScript &agrave; appeler lorsque la requ&ecirc;te HTTP est termin&eacute;e.
• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqu&eacute; dans l'URL, Dreamweaver
consid&egrave;re qu'il s'agit du protocole HTTP.
• L'argument facultatif prompt est une valeur bool&eacute;enne sp&eacute;cifiant s'il faut inviter l'utilisateur &agrave; enregistrer le fichier.
Si l'argument saveURL sp&eacute;cifie un emplacement en dehors du dossier Configuration/Temp, une valeur de prompt
&eacute;gale &agrave; false n'est pas prise en compte pour des raisons de s&eacute;curit&eacute;.
• L'argument facultatif saveURL est l'emplacement sur le disque dur de l'utilisateur o&ugrave; le fichier doit &ecirc;tre enregistr&eacute;,
exprim&eacute; sous la forme d'une URL de type file://. Si l'argument prompt a pour valeur true ou si saveURL est en
dehors du dossier Configuration/Temp, l'utilisateur peut remplacer saveURL dans la bo&icirc;te de dialogue
d'enregistrement.
• L'argument facultatif titleBarLabel est le libell&eacute; qui doit figurer dans la barre de titre de la bo&icirc;te de dialogue
d'enregistrement.
Derni&egrave;re mise &agrave; jour le 22/6/2011
18
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API HTTP
Valeurs renvoy&eacute;es
Un objet repr&eacute;sentant la r&eacute;ponse du serveur. La propri&eacute;t&eacute; data de cet objet est une cha&icirc;ne contenant l'emplacement
o&ugrave; le fichier a &eacute;t&eacute; enregistr&eacute;, exprim&eacute; sous la forme d'une URL de type file://. Normalement, la propri&eacute;t&eacute; statusCode
de l'objet contient le code d'&eacute;tat envoy&eacute; par le serveur. Toutefois, si une erreur disque se produit lors de
l'enregistrement du fichier sur le lecteur local, la propri&eacute;t&eacute; statusCode contient un nombre entier repr&eacute;sentant un
code d'erreur. Voir &laquo; MMHttp.getFile() &raquo; &agrave; la page 16 pour une liste des codes d'erreur possibles.
MMHttp.getText()
Disponibilit&eacute;
Dreamweaver UltraDev 4, am&eacute;lior&eacute; dans Dreamweaver MX.
Description
Extrait le contenu du document situ&eacute; &agrave; l'URL sp&eacute;cifi&eacute;e.
Arguments
URL, {serverScriptsFolder}
• L'argument URL est une URL absolue sur un serveur Web. Si http:// n'est pas indiqu&eacute; dans l'URL, Dreamweaver
consid&egrave;re qu'il s'agit du protocole HTTP.
• L'argument serverScriptsFolder est une cha&icirc;ne facultative qui nomme un dossier sp&eacute;cifique, li&eacute; au dossier
Configuration du serveur d'application, &agrave; partir duquel vous souhaitez extraire les scripts de serveur. Pour extraire
les scripts, Dreamweaver utilise le protocole de transfert appropri&eacute; (par exemple, FTP, WebDAV ou Remote File
System). Dreamweaver copie ces fichiers dans le sous-dossier _mmServerScripts dans le dossier racine du site en
cours.
Si une erreur se produit, Dreamweaver la consigne dans la propri&eacute;t&eacute; statusCode de l'objet renvoy&eacute;.
MMHttp.getTextCallback()
Disponibilit&eacute;
Dreamweaver UltraDev 4, am&eacute;lior&eacute; dans Dreamweaver MX.
Description
Extrait le contenu du document situ&eacute; &agrave; l'URL sp&eacute;cifi&eacute;e et le transmet &agrave; la fonction sp&eacute;cifi&eacute;e.
Arguments
callbackFunc, URL, {serverScriptsFolder}
• L'argument callbackFunc est la fonction JavaScript &agrave; appeler lorsque la requ&ecirc;te HTTP est termin&eacute;e.
• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqu&eacute; dans l'URL, Dreamweaver
consid&egrave;re qu'il s'agit du protocole HTTP.
• L'argument serverScriptsFolder est une cha&icirc;ne facultative qui nomme un dossier sp&eacute;cifique, li&eacute; au dossier
Configuration du serveur d'application, &agrave; partir duquel vous souhaitez extraire les scripts de serveur. Pour extraire
les scripts, Dreamweaver utilise le protocole de transfert appropri&eacute; (par exemple, FTP, WebDAV ou Remote File
System). Dreamweaver extrait ces fichiers et les transmet &agrave; la fonction identifi&eacute;e par callbackFunc.
Si une erreur se produit, Dreamweaver MX la consigne dans la propri&eacute;t&eacute; statusCode de l'objet renvoy&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
19
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API HTTP
MMHttp.postText()
Disponibilit&eacute;
Dreamweaver UltraDev 4, am&eacute;lior&eacute; dans Dreamweaver MX.
Description
Ex&eacute;cute un envoi HTTP des donn&eacute;es d&eacute;finies &agrave; l'URL sp&eacute;cifi&eacute;e. En r&egrave;gle g&eacute;n&eacute;rale, les donn&eacute;es associ&eacute;es &agrave; une op&eacute;ration
d'envoi se pr&eacute;sentent sous la forme de texte cod&eacute; en formulaire, mais il peut s'agir de tout type de donn&eacute;es que le
serveur peut accepter.
Arguments
URL, dataToPost, {contentType}, {serverScriptsFolder}
• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqu&eacute; dans l'URL, Dreamweaver
consid&egrave;re qu'il s'agit du protocole HTTP.
• L'argument dataToPost repr&eacute;sente les donn&eacute;es &agrave; envoyer. Si le troisi&egrave;me argument est &quot;application/x-wwwform-urlencoded&quot; ou s'il n'est pas sp&eacute;cifi&eacute;, dataToPost doit &ecirc;tre cod&eacute; en formulaire conform&eacute;ment &agrave; la section
8.2.1 de la sp&eacute;cification RFC 1866 (disponible &agrave; l'adresse www.faqs.org/rfcs/rfc1866.html).
• L'argument facultatif contentType est le type de contenu des donn&eacute;es &agrave; envoyer. S'il n'est pas sp&eacute;cifi&eacute;, il prend par
d&eacute;faut la valeur &quot;application/x-www-form-urlencoded&quot;.
• L'argument serverScriptsFolder est une cha&icirc;ne facultative qui nomme un dossier sp&eacute;cifique, li&eacute; au dossier
Configuration du serveur d'application, vers lequel vous souhaitez envoyer les donn&eacute;es. Pour envoyer les donn&eacute;es,
Dreamweaver utilise le protocole de transfert appropri&eacute; (par exemple, FTP, WebDAV ou Remote File System).
Si une erreur se produit, Dreamweaver la consigne dans la propri&eacute;t&eacute; statusCode de l'objet renvoy&eacute;.
Exemple
Dans l'exemple suivant d'appel de la fonction MMHttp.postText(), supposons qu'un d&eacute;veloppeur a plac&eacute; le fichier
myScripts.cfm dans un dossier nomm&eacute; DeployScripts, qui se trouve dans le dossier Configuration sur l'ordinateur
local :
MMHttp.postText(
&quot;http://ultraqa8/DeployScripts/myScripts.cfm&quot;,
&quot;arg1=Foo&quot;,
&quot;application/x-www-form-urlencoded&quot;,
&quot;Configuration/DeployScripts/&quot;
)
Voici ce qui se produit lorsque Dreamweaver effectue cet appel de fonction :
1 Le fichier myScripts.cfm du dossier Configuration/DeployScripts de l'ordinateur local est copi&eacute; dans un autre
dossier nomm&eacute; DeployScripts, qui constitue un sous-dossier du dossier racine du site Web ultraqa8. Pour d&eacute;ployer
les fichiers, Dreamweaver utilise le protocole sp&eacute;cifi&eacute; dans les propri&eacute;t&eacute;s de configuration du site.
2 Dreamweaver utilise le protocole HTTP pour envoyer les donn&eacute;es arg1=Foo vers le serveur Web.
3 En r&eacute;ponse &agrave; la requ&ecirc;te d'envoi, le serveur Web sur ultraqa8 ex&eacute;cute le script myScripts.cfm &agrave; l'aide des donn&eacute;es arg1.
Derni&egrave;re mise &agrave; jour le 22/6/2011
20
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API HTTP
MMHttp.postTextCallback()
Disponibilit&eacute;
Dreamweaver UltraDev 4, am&eacute;lior&eacute; dans Dreamweaver MX.
Description
Ex&eacute;cute un envoi HTTP du texte &agrave; l'URL sp&eacute;cifi&eacute;e et transmet la r&eacute;ponse du serveur &agrave; la fonction sp&eacute;cifi&eacute;e. En r&egrave;gle
g&eacute;n&eacute;rale, les donn&eacute;es associ&eacute;es &agrave; une op&eacute;ration d'envoi se pr&eacute;sentent sous la forme de texte cod&eacute; en formulaire, mais
il peut s'agir de tout type de donn&eacute;es que le serveur peut accepter.
Arguments
callbackFunc, URL, dataToPost, {contentType}, {serverScriptsFolder}
• L'argument callbackFunc est le nom de la fonction JavaScript &agrave; appeler lorsque la requ&ecirc;te HTTP est termin&eacute;e.
• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqu&eacute; dans l'URL, Dreamweaver
consid&egrave;re qu'il s'agit du protocole HTTP.
• L'argument dataToPost repr&eacute;sente les donn&eacute;es &agrave; envoyer. Si le troisi&egrave;me argument est &quot;application/x-wwwform-urlencoded&quot; ou s'il n'est pas sp&eacute;cifi&eacute;, data doit &ecirc;tre cod&eacute; en formulaire conform&eacute;ment &agrave; la section 8.2.1 de
la sp&eacute;cification RFC 1866 (disponible &agrave; l'adresse www.faqs.org/rfcs/rfc1866.html).
• L'argument facultatif contentType correspond au type de contenu des donn&eacute;es &agrave; envoyer. S'il n'est pas sp&eacute;cifi&eacute;, il
prend par d&eacute;faut la valeur &quot;application/x-www-form-urlencoded&quot;.
• L'argument serverScriptsFolder est une cha&icirc;ne facultative. Il nomme un dossier donn&eacute;, en liaison avec le dossier
Configuration du serveur d'application sur lequel vous voulez envoyer les donn&eacute;es. Pour envoyer les donn&eacute;es,
Dreamweaver utilise le protocole de transfert appropri&eacute; (par exemple, FTP, WebDAV ou Remote File System).
Dreamweaver extrait ces donn&eacute;es et les transmet &agrave; la fonction identifi&eacute;e par callbackFunc.
Si une erreur se produit, Dreamweaver la consigne dans la propri&eacute;t&eacute; statusCode de l'objet renvoy&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
21
Chapitre 4 : API de Design Notes
Adobe&reg; Dreamweaver&reg; , Adobe&reg; Fireworks&reg; et Adobe&reg; Flash&reg; offrent aux concepteurs et d&eacute;veloppeurs Web une m&eacute;thode
permettant de stocker et de r&eacute;cup&eacute;rer des informations suppl&eacute;mentaires sur les documents. Ces informations sont
stock&eacute;es dans des fichiers baptis&eacute;s &laquo; Design Notes &raquo;. Il peut s'agir d'informations suppl&eacute;mentaires sur les documents,
comme des commentaires de relecture, des notes de modification ou le fichier source d'une image GIF ou JPEG.
Pour plus d'informations sur l'utilisation de la fonctionnalit&eacute; Design Notes dans Dreamweaver, consultez le manuel
Utilisation de Dreamweaver.
Fonctionnement des Design Notes
Chaque fichier Design Notes stocke des informations relatives &agrave; un seul document. Si un fichier Design Notes est
associ&eacute; &agrave; un ou plusieurs documents dans un dossier, Dreamweaver cr&eacute;e un sous-dossier _notes pour y stocker les
fichiers Design Notes. Le dossier _notes et les fichiers Design Notes qu'il contient ne sont pas visibles dans la fen&ecirc;tre
Site, mais ils s'affichent dans le Finder Macintosh ou dans l'Explorateur Windows. Un nom de fichier Design Notes est
compos&eacute; du nom du fichier principal suivi de l'extension .mno. Par exemple, le fichier Design Notes associ&eacute; &agrave;
avocado8.gif est avocado8.gif.mno.
Les fichiers Design Notes sont des fichiers XML stockant des informations sous la forme d'une s&eacute;rie de paires
cl&eacute;/valeur. La cl&eacute; d&eacute;crit le type des informations stock&eacute;es et la valeur repr&eacute;sente les informations. Les cl&eacute;s sont limit&eacute;es
&agrave; 64 caract&egrave;res.
L'exemple suivant illustre le fichier Design Notes associ&eacute; au fichier foghorn.gif.mno :
&lt;?xml version=&quot;1.0&quot; encoding=&quot;iso-8859-1&quot; ?&gt;
&lt;info&gt;
&lt;infoitem key=&quot;FW_source&quot; value=&quot;file:///C|sites/dreamcentral/images/sourceFiles/&not;
foghorn.png&quot; /&gt;
&lt;infoitem key=&quot;Author&quot; value=&quot;Heidi B.&quot; /&gt;
&lt;infoitem key=&quot;Status&quot; value=&quot;Final draft, approved by Jay L.&quot; /&gt;
&lt;/info&gt;
L'API JavaScript de Design Notes
Toutes les fonctions de l'API JavaScript de Design Notes sont des m&eacute;thodes associ&eacute;es &agrave; l'objet MMNotes. MMNotes
est une biblioth&egrave;que C partag&eacute;e qui permet aux auteurs d'extensions de lire et d'&eacute;crire dans les fichiers Design Notes.
Tout comme la biblioth&egrave;que partag&eacute;e DWfile, MMNotes comprend une API JavaScript qui permet d'appeler les
fonctions. Ces fonctions sont appel&eacute;es &agrave; partir d'objets, de commandes, de comportements, de panneaux flottants,
d'inspecteurs Propri&eacute;t&eacute;s et de traducteurs de donn&eacute;es dans la biblioth&egrave;que. La biblioth&egrave;que partag&eacute;e MMNotes peut
&ecirc;tre utilis&eacute;e ind&eacute;pendamment de Dreamweaver, que celui-ci soit install&eacute; ou non.
Derni&egrave;re mise &agrave; jour le 22/6/2011
22
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de Design Notes
MMNotes.close()
Description
Cette fonction ferme le fichier Design Notes sp&eacute;cifi&eacute; et enregistre les modifications &eacute;ventuelles. Si toutes les paires
cl&eacute;/valeur ont &eacute;t&eacute; supprim&eacute;es, Dreamweaver supprime le fichier Design Notes. S'il s'agit du dernier fichier Design
Notes dans le dossier _notes, Dreamweaver supprime &eacute;galement le dossier.
Remarque : Appelez toujours la fonction MMNotes.close() une fois le travail sur les Design Notes termin&eacute;, afin que
Dreamweaver &eacute;crive dans le fichier.
Arguments
fileHandle
• L'argument fileHandle est l'identificateur de fichier renvoy&eacute; par la fonction MMNotes.open().
Valeurs renvoy&eacute;es
Aucune.
Exemple
Voir &laquo; MMNotes.set() &raquo; &agrave; la page 26.
MMNotes.filePathToLocalURL()
Description
Cette fonction convertit le chemin d'acc&egrave;s du lecteur local sp&eacute;cifi&eacute; en une URL de type file://.
Arguments
drivePath
• L'argument drivePath est une cha&icirc;ne contenant le chemin d'acc&egrave;s complet du lecteur.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant l'URL de type file:// du fichier sp&eacute;cifi&eacute;.
Exemple
Un appel &agrave; la fonction MMNotes.filePathToLocalURL('C:/sites/webdev/index.htm') renvoie
&quot;file:///c|sites/webdev/index.htm&quot;.
MMNotes.get()
Description
Cette fonction obtient la valeur de la cl&eacute; sp&eacute;cifi&eacute;e dans le fichier Design Notes indiqu&eacute;.
Arguments
fileHandle, keyName
• L'argument fileHandle est l'identificateur de fichier renvoy&eacute; par MMNotes.open().
• L'argument keyName est une cha&icirc;ne contenant le nom de la cl&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
23
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de Design Notes
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant la valeur de la cl&eacute;.
Exemple
Voir &laquo; MMNotes.getKeys() &raquo; &agrave; la page 23.
MMNotes.getKeyCount()
Description
Cette fonction obtient le nombre de paires cl&eacute;/valeur du fichier Design Notes sp&eacute;cifi&eacute;.
Arguments
fileHandle
• L'argument fileHandle est l'identificateur de fichier renvoy&eacute; par la fonction MMNotes.open().
Valeurs renvoy&eacute;es
Un nombre entier repr&eacute;sentant le nombre de paires cl&eacute;/valeur du fichier Design Notes sp&eacute;cifi&eacute;.
MMNotes.getKeys()
Description
Cette fonction renvoie une liste de toutes les cl&eacute;s d'un fichier Design Notes.
Arguments
fileHandle
• L'argument fileHandle est l'identificateur de fichier renvoy&eacute; par la fonction MMNotes.open().
Valeurs renvoy&eacute;es
Un tableau de cha&icirc;nes, chacune d'elles contenant le nom d'une cl&eacute;.
Exemple
Le code suivant peut &ecirc;tre utilis&eacute; dans un panneau flottant personnalis&eacute; afin d'afficher les informations Design Notes
relatives au document actif :
var
var
var
var
for
noteHandle = MMNotes.open(dw.getDocumentDOM().URL);
theKeys = MMNotes.getKeys(noteHandle);
noteString = &quot;&quot;;
theValue = &quot;&quot;;
(var i=0; i &lt; theKeys.length; i++){
theValue = MMNotes.get(noteHandle,theKeys[i]);
noteString +=0theKeys[i] + &quot; = &quot; theValue + &quot;\n&quot;;
}
document.theForm.bigTextField.value = noteString;
// always close noteHandle
MMNotes.close(noteHandle);
Derni&egrave;re mise &agrave; jour le 22/6/2011
24
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de Design Notes
MMNotes.getSiteRootForFile()
Description
Cette fonction d&eacute;termine la racine du site pour le fichier Design Notes sp&eacute;cifi&eacute;.
Arguments
fileURL
• L'argument fileURL, exprim&eacute; sous la forme d'une URL de type file://, est le chemin d'un fichier local.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant le chemin du dossier racine local pour le site, exprim&eacute; sous la forme d'une URL de type file://,
ou une cha&icirc;ne vide si Dreamweaver n'est pas install&eacute; ou si le fichier Design Notes se trouve en dehors de tout site d&eacute;fini
par Dreamweaver. Cette fonction recherche tous les sites d&eacute;finis dans Dreamweaver.
MMNotes.getVersionName()
Description
Cette fonction renvoie le nom de version de la biblioth&egrave;que partag&eacute;e MMNotes indiquant l'application qui l'a
impl&eacute;ment&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant le nom de l'application qui a impl&eacute;ment&eacute; la biblioth&egrave;que partag&eacute;e MMNotes.
Exemple
L'appel de la fonction MMNotes.getVersionName() &agrave; partir d'une commande, d'un objet, d'un comportement, d'un
inspecteur Propri&eacute;t&eacute;s, d'un panneau flottant ou d'un traducteur de donn&eacute;es Dreamweaver renvoie &quot;Dreamweaver&quot;.
L'appel de la fonction MMNotes.getVersionName() &agrave; partir de Fireworks renvoie &eacute;galement la valeur
&quot;Dreamweaver&quot; &eacute;tant donn&eacute; que Fireworks utilise la m&ecirc;me version de la biblioth&egrave;que (celle qui a &eacute;t&eacute; cr&eacute;&eacute;e par l'&eacute;quipe
technique de Dreamweaver).
MMNotes.getVersionNum()
Description
Cette fonction obtient le num&eacute;ro de version de la biblioth&egrave;que partag&eacute;e MMNotes.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant le num&eacute;ro de version.
Derni&egrave;re mise &agrave; jour le 22/6/2011
25
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de Design Notes
MMNotes.localURLToFilePath()
Description
Cette fonction convertit l'URL de type file:// sp&eacute;cifi&eacute;e en un chemin d'acc&egrave;s du lecteur local.
Arguments
fileURL
• L'argument fileURL, exprim&eacute; sous la forme d'une URL de type file://, est le chemin d'un fichier local.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant le chemin d'acc&egrave;s du lecteur local pour le fichier sp&eacute;cifi&eacute;.
Exemple
Un appel &agrave; la fonction MMNotes.localURLToFilePath('file:///MacintoshHD/images/moon.gif') renvoie
&quot;MacintoshHD:images:moon.gif&quot;.
MMNotes.open()
Description
Cette fonction ouvre le fichier Design Notes associ&eacute; au fichier sp&eacute;cifi&eacute; ou cr&eacute;e un fichier Design Notes s'il n'en existe pas.
Arguments
filePath, {bForceCreate}
• L'argument filePath, exprim&eacute; sous la forme d'une URL de type file://, est le chemin du fichier principal auquel le
fichier Design Notes est associ&eacute;.
• L'argument bForceCreate est une valeur bool&eacute;enne indiquant si la note doit &ecirc;tre cr&eacute;&eacute;e m&ecirc;me si la fonctionnalit&eacute;
Design Notes est d&eacute;sactiv&eacute;e pour le site ou si l'argument filePath n'est associ&eacute; &agrave; aucun site.
Valeurs renvoy&eacute;es
L'identificateur du fichier Design Notes ou z&eacute;ro (0) si le fichier n'a pas &eacute;t&eacute; ouvert ni cr&eacute;&eacute;.
Exemple
Voir &laquo; MMNotes.set() &raquo; &agrave; la page 26.
MMNotes.remove()
Description
Cette fonction supprime la cl&eacute; sp&eacute;cifi&eacute;e (et sa valeur) du fichier Design Notes indiqu&eacute;.
Arguments
fileHandle, keyName
• L'argument fileHandle est l'identificateur de fichier renvoy&eacute; par la fonction MMNotes.open().
• L'argument keyName est une cha&icirc;ne contenant le nom de la cl&eacute; &agrave; supprimer.
Derni&egrave;re mise &agrave; jour le 22/6/2011
26
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de Design Notes
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi, false dans le cas contraire.
MMNotes.set()
Description
Cette fonction cr&eacute;e ou met &agrave; jour une paire cl&eacute;/valeur dans un fichier Design Notes.
Arguments
fileHandle, keyName, valueString
• L'argument fileHandle est l'identificateur de fichier renvoy&eacute; par la fonction MMNotes.open().
• L'argument keyName est une cha&icirc;ne contenant le nom de la cl&eacute;.
• L'argument valueString est une cha&icirc;ne contenant la valeur.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi, false dans le cas contraire.
Exemple
L'exemple suivant ouvre le fichier Design Notes associ&eacute; &agrave; un fichier situ&eacute; sur le site dreamcentral appel&eacute;
peakhike99/index.html, ajoute une nouvelle paire cl&eacute;/valeur, modifie la valeur d'une cl&eacute; existante, puis ferme le fichier
Design Notes :
var noteHandle = MMNotes.open('file:///c|/sites/dreamcentral/peakhike99/
index.html',true);
if(noteHandle &gt; 0){
MMNotes.set(noteHandle,&quot;Author&quot;,&quot;M. G. Miller&quot;);
MMNotes.set(noteHandle,&quot;Last Changed&quot;,&quot;August 28, 1999&quot;);
MMNotes.close(noteHandle);
}
L'API C de Design Notes
Outre l'API JavaScript, la biblioth&egrave;que partag&eacute;e MMNotes affiche une API C permettant aux autres applications de
cr&eacute;er des fichiers Design Notes. Il n'est pas n&eacute;cessaire d'appeler les fonctions C directement si vous utilisez la
biblioth&egrave;que partag&eacute;e MMNotes dans Dreamweaver ; les versions JavaScript de ces fonctions les appellent pour vous.
Cette section d&eacute;crit ces fonctions, leurs arguments et les valeurs qu'elles renvoient. Les d&eacute;finitions de toutes les
fonctions et de tous les types de donn&eacute;es sont disponibles dans le fichier MMInfo.h du dossier Extending/c_files dans
le dossier de l'application Dreamweaver.
void CloseNotesFile()
Description
Cette fonction ferme le fichier Design Notes sp&eacute;cifi&eacute; et enregistre les modifications &eacute;ventuelles. Si toutes les paires
cl&eacute;/valeur ont &eacute;t&eacute; supprim&eacute;es du fichier Design Notes, Dreamweaver supprime ce dernier. Dreamweaver supprime le
dossier _notes lorsque le dernier fichier Design Notes est supprim&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
27
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de Design Notes
Arguments
noteHandle
• L'argument noteHandle est l'identificateur de fichier renvoy&eacute; par la fonction OpenNotesFile().
Valeurs renvoy&eacute;es
Aucune.
BOOL FilePathToLocalURL()
Description
Cette fonction convertit le chemin d'acc&egrave;s du lecteur local sp&eacute;cifi&eacute; en une URL de type file://.
Arguments
const char* drivePath, char* localURLBuf, int localURLMaxLen
• L'argument drivePath est une cha&icirc;ne contenant le chemin d'acc&egrave;s complet du lecteur.
• L'argument localURLBuf est la zone de m&eacute;moire tampon o&ugrave; l'URL de type file:// est stock&eacute;e.
• L'argument localURLMaxLen est la taille maximale de localURLBuf.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi, false dans le cas contraire. L'argument localURLBuf re&ccedil;oit la valeur
de l'URL de type file://.
BOOL GetNote()
Description
Cette fonction obtient la valeur de la cl&eacute; sp&eacute;cifi&eacute;e dans le fichier Design Notes indiqu&eacute;.
Arguments
FileHandle noteHandle, const char keyName[64], char* valueBuf, int valueBufLength
• L'argument noteHandle est l'identificateur de fichier renvoy&eacute; par la fonction OpenNotesFile().
• L'argument keyName[64] est une cha&icirc;ne contenant le nom de la cl&eacute;.
• L'argument valueBuf est la zone de m&eacute;moire tampon o&ugrave; la valeur est stock&eacute;e.
• L'argument valueBufLength est le nombre entier renvoy&eacute; par GetNoteLength(noteHandle, keyName), indiquant
la longueur maximale de la m&eacute;moire tampon des valeurs.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi, false dans le cas contraire. L'argument valueBuf re&ccedil;oit la valeur de la cl&eacute;.
Exemple
Le code suivant obtient la valeur de la cl&eacute; comments dans le fichier Design Notes associ&eacute; au fichier welcome.html :
Derni&egrave;re mise &agrave; jour le 22/6/2011
28
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de Design Notes
FileHandle noteHandle = OpenNotesFile(&quot;file:///c|/sites/avocado8/iwjs/welcome.html&quot;);
if(noteHandle &gt; 0){
int valueLength = GetNoteLength( noteHandle, &quot;comments&quot;);
char* valueBuffer = new char[valueLength + 1];
GetNote(noteHandle, &quot;comments&quot;, valueBuffer, valueLength + 1);
printf(&quot;Comments: %s&quot;,valueBuffer);
CloseNotesFile(noteHandle);
}
int GetNoteLength()
Description
Cette fonction obtient la longueur de la valeur associ&eacute;e &agrave; la cl&eacute; sp&eacute;cifi&eacute;e.
Arguments
FileHandle noteHandle, const char keyName[64]
• L'argument noteHandle est l'identificateur de fichier renvoy&eacute; par la fonction OpenNotesFile().
• L'argument keyName[64] est une cha&icirc;ne contenant le nom de la cl&eacute;.
Valeurs renvoy&eacute;es
Un nombre entier repr&eacute;sentant la longueur de la valeur.
Exemple
Voir &laquo; BOOL GetNote() &raquo; &agrave; la page 27.
int GetNotesKeyCount()
Description
Cette fonction obtient le nombre de paires cl&eacute;/valeur du fichier Design Notes sp&eacute;cifi&eacute;.
Arguments
FileHandle noteHandle
• L'argument noteHandle est l'identificateur de fichier renvoy&eacute; par la fonction OpenNotesFile().
Valeurs renvoy&eacute;es
Un nombre entier repr&eacute;sentant le nombre de paires cl&eacute;/valeur du fichier Design Notes sp&eacute;cifi&eacute;.
BOOL GetNotesKeys()
Description
Cette fonction renvoie une liste de toutes les cl&eacute;s d'un fichier Design Notes.
Arguments
FileHandle noteHandle, char* keyBufArray[64], int keyArrayMaxLen
• L'argument noteHandle est l'identificateur de fichier renvoy&eacute; par OpenNotesFile().
Derni&egrave;re mise &agrave; jour le 22/6/2011
29
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de Design Notes
• L'argument keyBufArray[64] est le tableau en m&eacute;moire tampon o&ugrave; les cl&eacute;s sont stock&eacute;es.
• L'argument keyArrayMaxLen est le nombre entier renvoy&eacute; par GetNotesKeyCount(noteHandle), indiquant le
nombre maximum d'&eacute;l&eacute;ments contenus dans le tableau en m&eacute;moire tampon des cl&eacute;s.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi, false dans le cas contraire. L'argument keyBufArray re&ccedil;oit les noms
de cl&eacute;.
Exemple
Le code suivant imprime les noms de cl&eacute; et les valeurs de toutes les cl&eacute;s du fichier Design Notes associ&eacute; au fichier
welcome.html :
typedef char[64] InfoKey;
FileHandle noteHandle = OpenNotesFile(&quot;file:///c|/sites/avocado8/iwjs/welcome.html&quot;);
if (noteHandle &gt; 0){
int keyCount = GetNotesKeyCount(noteHandle);
if (keyCount &lt;= 0)
return;
InfoKey* keys = new InfoKey[keyCount];
BOOL succeeded = GetNotesKeys(noteHandle, keys, keyCount);
if (succeeded){
for (int i=0; i &lt; keyCount; i++){
printf(&quot;Key is: %s\n&quot;, keys[i]);
printf(&quot;Value is: %s\n\n&quot;, GetNote(noteHandle, keys[i]);
}
}
delete []keys;
}
CloseNotesFile(noteHandle);
BOOL GetSiteRootForFile()
Description
Cette fonction d&eacute;termine la racine du site pour le fichier Design Notes sp&eacute;cifi&eacute;.
Arguments
const char*filePath, char*siteRootBuf, intsiteRootBufMaxLen, {InfoPrefs* infoPrefs}
• L'argument filePath est l'URL de type file:// du fichier dont vous souhaitez obtenir la racine du site.
• L'argument siteRootBuf est la zone de m&eacute;moire tampon o&ugrave; la racine du site est stock&eacute;e.
• L'argument siteRootBufMaxLen est la taille maximale de la m&eacute;moire tampon r&eacute;f&eacute;renc&eacute;e par siteRootBuf.
• L'argument facultatif infoPrefs est une r&eacute;f&eacute;rence &agrave; un struct dans lequel les pr&eacute;f&eacute;rences du site sont stock&eacute;es.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi, false dans le cas contraire. L'argument siteRootBuf re&ccedil;oit l'adresse de
la m&eacute;moire tampon qui stocke la racine du site. Si vous sp&eacute;cifiez l'argument infoPrefs, la fonction renvoie &eacute;galement
les pr&eacute;f&eacute;rences de Design Notes pour le site. La structure InfoPrefs poss&egrave;de deux variables : bUseDesignNotes et
bUploadDesignNotes, toutes deux de type BOOL.
Derni&egrave;re mise &agrave; jour le 22/6/2011
30
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de Design Notes
BOOL GetVersionName()
Description
Cette fonction renvoie le nom de version de la biblioth&egrave;que partag&eacute;e MMNotes indiquant l'application qui l'a
impl&eacute;ment&eacute;e.
Arguments
char* versionNameBuf, intversionNameBufMaxLen
• L'argument versionNameBuf est la zone de m&eacute;moire tampon o&ugrave; le nom de version est stock&eacute;.
• L'argument versionNameBufMaxLen est la taille maximale de la m&eacute;moire tampon r&eacute;f&eacute;renc&eacute;e par versionNameBuf.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi, false dans le cas contraire. Dreamweaver stocke &quot;Dreamweaver&quot; dans
l'argument versionNameBuf.
BOOL GetVersionNum()
Description
Cette fonction renvoie le num&eacute;ro de version de la biblioth&egrave;que partag&eacute;e MMNotes, ce qui vous permet de savoir si
certaines fonctions sont disponibles.
Arguments
char* versionNumBuf, intversionNumBufMaxLen
• L'argument versionNumBuf est la zone de m&eacute;moire tampon o&ugrave; le num&eacute;ro de version est stock&eacute;.
• L'argument versionNumBufMaxLen est la taille maximale de la m&eacute;moire tampon r&eacute;f&eacute;renc&eacute;e par versionNumBuf.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi, false dans le cas contraire. L'argument versionNumBuf stocke le
num&eacute;ro de version.
BOOL LocalURLToFilePath()
Description
Cette fonction convertit l'URL de type file:// sp&eacute;cifi&eacute;e en un chemin d'acc&egrave;s du lecteur local.
Arguments
const char* localURL, char* drivePathBuf, int drivePathMaxLen
• L'argument localURL, exprim&eacute; sous la forme d'une URL de type file://, est le chemin d'un fichier local.
• L'argument drivePathBuf est la zone de m&eacute;moire tampon o&ugrave; le chemin d'acc&egrave;s du lecteur local est stock&eacute;.
• L'argument drivePathMaxLen est la taille maximale de la m&eacute;moire tampon r&eacute;f&eacute;renc&eacute;e par drivePathBuf.
Derni&egrave;re mise &agrave; jour le 22/6/2011
31
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de Design Notes
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi, false dans le cas contraire. L'argument drivePathBuf re&ccedil;oit le chemin
de fichier local.
FileHandle OpenNotesFile()
Description
Cette fonction ouvre le fichier Design Notes associ&eacute; au fichier sp&eacute;cifi&eacute; ou cr&eacute;e un fichier Design Notes s'il n'en existe pas.
Arguments
const char* localFileURL, {BOOL bForceCreate}
• L'argument localFileURL, exprim&eacute; sous la forme d'une URL de type file://, est une cha&icirc;ne contenant le chemin du
fichier principal auquel le fichier Design Notes est associ&eacute;.
• L'argument bForceCreate est une valeur bool&eacute;enne indiquant si le fichier Design Notes doit &ecirc;tre cr&eacute;&eacute; m&ecirc;me si la
fonctionnalit&eacute; Design Notes est d&eacute;sactiv&eacute;e pour le site ou si le chemin sp&eacute;cifi&eacute; par l'argument localFileURL n'est
associ&eacute; &agrave; aucun site.
FileHandle OpenNotesFilewithOpenFlags()
Description
Cette fonction ouvre le fichier Design Notes associ&eacute; au fichier sp&eacute;cifi&eacute; ou cr&eacute;e un fichier Design Notes s'il n'en existe
pas. Vous pouvez ouvrir le fichier en mode lecture seule.
Arguments
const char* localFileURL, {BOOL bForceCreate}, {BOOL bReadOnly}
• L'argument localFileURL, exprim&eacute; sous la forme d'une URL de type file://, est une cha&icirc;ne contenant le chemin du
fichier principal auquel le fichier Design Notes est associ&eacute;.
• L'argument bForceCreate est une valeur bool&eacute;enne indiquant si le fichier Design Notes doit &ecirc;tre cr&eacute;&eacute; m&ecirc;me si la
fonctionnalit&eacute; Design Notes est d&eacute;sactiv&eacute;e pour le site ou si le chemin n'est associ&eacute; &agrave; aucun site. La valeur par d&eacute;faut
est false. Cet argument est facultatif, mais vous devez le d&eacute;finir si vous sp&eacute;cifiez le troisi&egrave;me argument.
• L'argument facultatif bReadOnly est une valeur bool&eacute;enne indiquant si le fichier doit &ecirc;tre ouvert en mode lecture
seule. La valeur par d&eacute;faut est false. Vous pouvez sp&eacute;cifier l'argument bReadOnly disponible &agrave; partir de la version
2 du fichier MMNotes.dll.
BOOL RemoveNote()
Description
Cette fonction supprime la cl&eacute; sp&eacute;cifi&eacute;e (et sa valeur) du fichier Design Notes indiqu&eacute;.
Arguments
FileHandlenoteHandle, const char keyName[64]
• L'argument noteHandle est l'identificateur de fichier renvoy&eacute; par la fonction OpenNotesFile().
• L'argument keyName[64] est une cha&icirc;ne contenant le nom de la cl&eacute; &agrave; supprimer.
Derni&egrave;re mise &agrave; jour le 22/6/2011
32
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de Design Notes
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi, false dans le cas contraire.
BOOL SetNote()
Description
Cette fonction cr&eacute;e ou met &agrave; jour une paire cl&eacute;/valeur dans un fichier Design Notes.
Arguments
FileHandle noteHandle, const char keyName[64], const char* value
• L'argument noteHandle est l'identificateur de fichier renvoy&eacute; par la fonction OpenNotesFile().
• L'argument keyName[64] est une cha&icirc;ne contenant le nom de la cl&eacute;.
• L'argument value est une cha&icirc;ne contenant la valeur.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
33
Chapitre 5 : Int&eacute;gration de Fireworks
FWLaunch est une biblioth&egrave;que C partag&eacute;e qui permet aux auteurs d'objets, de commandes, de comportements et
d'inspecteurs Propri&eacute;t&eacute;s de communiquer avec Adobe&reg; Fireworks&reg;. A l'aide de FWLaunch, vous r&eacute;digez du code
JavaScript pour ouvrir l'interface utilisateur de Fireworks et fournissez des commandes &agrave; Fireworks via sa propre API
JavaScript, au sujet duquel vous trouverez plus d'informations dans Extension de Fireworks. Pour obtenir des
informations g&eacute;n&eacute;rales sur l'interaction des biblioth&egrave;ques avec l'interpr&eacute;teur JavaScript dans Adobe&reg; Dreamweaver&reg;
CS5 et pour plus de d&eacute;tails sur les extensions C, voir Extension de Dreamweaver.
L'API FWLaunch
L'objet FWLaunch permet aux extensions d'ouvrir Fireworks, d'ex&eacute;cuter des op&eacute;rations Fireworks &agrave; l'aide de l'API
JavaScript de Fireworks et de renvoyer les valeurs &agrave; Dreamweaver. Ce chapitre d&eacute;crit l'API de communication
FWLaunch et son utilisation.
FWLaunch.bringDWToFront()
Disponibilit&eacute;
Dreamweaver 3, Fireworks 3.
Description
Cette fonction affiche Dreamweaver au premier plan.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
FWLaunch.bringFWToFront()
Disponibilit&eacute;
Dreamweaver 3, Fireworks 3.
Description
Cette fonction permet d'afficher Fireworks au premier plan s'il est en cours d'ex&eacute;cution.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
34
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Fireworks
FWLaunch.execJsInFireworks()
Disponibilit&eacute;
Dreamweaver 3, Fireworks 3.
Description
Cette fonction transmet l'&eacute;l&eacute;ment JavaScript sp&eacute;cifi&eacute; (ou une r&eacute;f&eacute;rence &agrave; un fichier JavaScript) &agrave; Fireworks en vue de
son ex&eacute;cution.
Arguments
javascriptOrFileURL
• L'argument javascriptOrFileURL, exprim&eacute; sous la forme d'une URL de type file://, est soit une cha&icirc;ne de
JavaScript litt&eacute;ral, soit le chemin d'acc&egrave;s d'un fichier JavaScript.
Valeurs renvoy&eacute;es
Un objet cookie si le code JavaScript a &eacute;t&eacute; transmis avec succ&egrave;s ou un code d'erreur non nul indiquant que l'une des
erreurs suivantes s'est produite :
• Utilisation non valide, ce qui indique que le chemin du fichier JS ou JSF n'est pas valide ou que l'argument
javascriptOrFileURL est sp&eacute;cifi&eacute; comme ayant la valeur null ou comme une cha&icirc;ne vide.
• Erreur d'E/S de fichier, ce qui indique que Fireworks ne peut pas cr&eacute;er de fichier r&eacute;ponse car le disque est satur&eacute;.
• Erreur informant Dreamweaver que l'utilisateur n'ex&eacute;cute pas une version valide de Dreamweaver (version 3 ou
ult&eacute;rieure).
• Erreur lors du d&eacute;marrage de Fireworks, ce qui indique que la fonction n'ouvre pas une version valide de Fireworks
(version 3 ou ult&eacute;rieure).
• L'utilisateur a annul&eacute; l'op&eacute;ration.
FWLaunch.getJsResponse()
Disponibilit&eacute;
Dreamweaver 3, Fireworks 3.
Description
Cette fonction d&eacute;termine si Fireworks est toujours en train d'ex&eacute;cuter le code JavaScript qui lui a &eacute;t&eacute; transmis par la
fonction FWLaunch.execJsInFireworks(), que l'ex&eacute;cution du script se soit termin&eacute;e avec succ&egrave;s ou qu'une erreur se
soit produite.
Arguments
progressTrackerCookie
• L'argument progressTrackerCookie est l'objet cookie renvoy&eacute; par la fonction
FWLaunch.execJsInFireworks().
Derni&egrave;re mise &agrave; jour le 22/6/2011
35
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Fireworks
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant le r&eacute;sultat du script transmis &agrave; FWLaunch.execJsInFireworks() si l'op&eacute;ration se termine avec
succ&egrave;s, la valeur null si Fireworks est toujours en train d'ex&eacute;cuter le code JavaScript, ou un code d'erreur non nul
indiquant que l'une des erreurs suivantes s'est produite :
• Utilisation non valide, ce qui indique qu'une erreur JavaScript s'est produite pendant que Fireworks ex&eacute;cutait le
script.
• Erreur d'E/S de fichier, ce qui indique que Fireworks ne peut pas cr&eacute;er de fichier r&eacute;ponse car le disque est satur&eacute;.
• Erreur informant Dreamweaver que l'utilisateur n'ex&eacute;cute pas une version valide de Dreamweaver (version 3 ou
ult&eacute;rieure).
• Erreur lors du d&eacute;marrage de Fireworks, ce qui indique que la fonction n'ouvre pas une version valide de Fireworks
(version 3 ou ult&eacute;rieure).
• L'utilisateur a annul&eacute; l'op&eacute;ration.
Exemple
Le code suivant transmet la cha&icirc;ne &quot;prompt('Please enter your name:')&quot; &agrave; FWLaunch.execJsInFireworks()
et v&eacute;rifie le r&eacute;sultat :
var progressCookie = FWLaunch.execJsInFireworks(&quot;prompt('Please enter your name:')&quot;);
var doneFlag = false;
while (!doneFlag){
// check for completion every 1/2 second
setTimeout('checkForCompletion()',500);
}
function checkForCompletion(){
if (progressCookie != null) {
var response = FWLaunch.getJsResponse(progressCookie);
if (response != null) {
if (typeof(response) == &quot;number&quot;) {
// error or user-cancel, time to close the window
// and let the user know we got an error
window.close();
alert(&quot;An error occurred.&quot;);
}else{
// got a valid response!
alert(&quot;Nice to meet you, &quot; + response);
window.close();
}
doneFlag = true;
}
}
}
FWLaunch.mayLaunchFireworks()
Disponibilit&eacute;
Dreamweaver 2, Fireworks 2.
Description
Cette fonction d&eacute;termine s'il est possible d'ouvrir une session d'optimisation de Fireworks.
Derni&egrave;re mise &agrave; jour le 22/6/2011
36
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Fireworks
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si la plate-forme est Windows ou Macintosh ; sur Macintosh, la valeur indique si une
autre session d'optimisation de Fireworks est d&eacute;j&agrave; en cours d'ex&eacute;cution.
FWLaunch.optimizeInFireworks()
Disponibilit&eacute;
Dreamweaver 2, Fireworks 2.
Description
Cette fonction ouvre une session d'optimisation de Fireworks pour l'image sp&eacute;cifi&eacute;e.
Arguments
docURL, imageURL, {targetWidth}, {targetHeight}
• L'argument docURL est le chemin d'acc&egrave;s du document actif, exprim&eacute; sous la forme d'une URL de type file://.
• L'argument imageURL est le chemin de l'image s&eacute;lectionn&eacute;e. Si le chemin est relatif, sa r&eacute;f&eacute;rence sera le chemin
sp&eacute;cifi&eacute; dans l'argument docURL.
• L'argument targetWidth (facultatif) d&eacute;finit la largeur par rapport &agrave; laquelle l'image doit &ecirc;tre redimensionn&eacute;e.
• L'argument targetHeight (facultatif) d&eacute;finit la hauteur par rapport &agrave; laquelle l'image doit &ecirc;tre redimensionn&eacute;e.
Valeurs renvoy&eacute;es
Z&eacute;ro (0) si une session d'optimisation de Fireworks a &eacute;t&eacute; lanc&eacute;e avec succ&egrave;s pour l'image sp&eacute;cifi&eacute;e; sinon, un code
d'erreur non nul indiquant que l'une des erreurs suivantes s'est produite :
• Utilisation non valide, ce qui indique que l'argument docURL, l'argument imageURL, ou les deux, ont &eacute;t&eacute; sp&eacute;cifi&eacute;s
comme &eacute;tant null ou sous forme d'une cha&icirc;ne vide.
• Erreur d'E/S de fichier, ce qui indique que Fireworks ne peut pas cr&eacute;er de fichier r&eacute;ponse car le disque est satur&eacute;.
• Erreur informant Dreamweaver que l'utilisateur n'ex&eacute;cute pas une version valide de Dreamweaver (version 2 ou
ult&eacute;rieure).
• Erreur lors du d&eacute;marrage de Fireworks, ce qui indique que la fonction n'ouvre pas une version valide de Fireworks
(version 2 ou ult&eacute;rieure).
• L'utilisateur a annul&eacute; l'op&eacute;ration.
FWLaunch.validateFireworks()
Disponibilit&eacute;
Dreamweaver 2, Fireworks 2.
Description
Cette fonction recherche la version sp&eacute;cifi&eacute;e de Fireworks sur le disque dur de l'utilisateur.
Derni&egrave;re mise &agrave; jour le 22/6/2011
37
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Fireworks
Arguments
{versionNumber}
• L'argument versionNumber est un nombre &agrave; virgule flottante sup&eacute;rieur ou &eacute;gal &agrave; 2 ; il est facultatif et repr&eacute;sente la
version requise de Fireworks. Si cet argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur 2.
Valeurs renvoy&eacute;es
Une valeur bool&eacute;enne indiquant si la version sp&eacute;cifi&eacute;e de Fireworks a &eacute;t&eacute; trouv&eacute;e.
Exemple
Le code suivant v&eacute;rifie si Fireworks est install&eacute; :
if (FWLaunch.validateFireworks(6.0)){
alert(&quot;Fireworks 6.0 or later is installed.&quot;);
}else{
alert(&quot;Fireworks 6.0 is not installed.&quot;);
}
Un exemple simple de communication FWLaunch
La commande suivante demande &agrave; Fireworks d'inviter l'utilisateur &agrave; entrer son nom, puis renvoie le nom &agrave;
Dreamweaver.
&lt;html&gt;
&lt;head&gt;
&lt;title&gt;Prompt in Fireworks&lt;/title&gt;
&lt;meta http-equiv=&quot;Content-Type&quot; content=&quot;text/html; &not;
charset=iso-8859-1&quot;&gt;
&lt;script&gt;
function commandButtons(){
return new Array(&quot;Prompt&quot;, &quot;promptInFireworks()&quot;, &quot;Cancel&quot;, &not;
&quot;readyToCancel()&quot;, &quot;Close&quot;,&quot;window.close()&quot;);
}
var gCancelClicked = false;
var gProgressTrackerCookie = null;
function readyToCancel() {
gCancelClicked = true;
}
function promptInFireworks() {
var isFireworks3 = FWLaunch.validateFireworks(3.0);
if (!isFireworks3) {
alert(&quot;You must have Fireworks 3.0 or later to use this &not;
command&quot;);
return;
}
// Tell Fireworks to execute the prompt() method.
gProgressTrackerCookie = FWLaunch.execJsInFireworks&not;
(&quot;prompt('Please enter your name:')&quot;);
// null means it wasn't launched, a number means an error code
Derni&egrave;re mise &agrave; jour le 22/6/2011
38
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Fireworks
if (gProgressTrackerCookie == null || &not;
typeof(gProgressTrackerCookie) == &quot;number&quot;) {
window.close();
alert(&quot;an error occurred&quot;);
gProgressTrackerCookie = null;
} else {
// bring Fireworks to the front
FWLaunch.bringFWToFront();
// start the checking to see if Fireworks is done yet
checkOneMoreTime();
}
}
function checkOneMoreTime() {
// Call checkJsResponse() every 1/2 second to see if Fireworks
// is done yet
window.setTimeout(&quot;checkJsResponse();&quot;, 500);
}
function checkJsResponse() {
var response = null;
// The user clicked the cancel button, close the window
if (gCancelClicked) {
window.close();
alert(&quot;cancel clicked&quot;);
} else {
// We're still going, ask Fireworks how it's doing
if (gProgressTrackerCookie != null)
response = FWLaunch.getJsResponse(gProgressTrackerCookie);
if (response == null) {
// still waiting for a response, call us again in 1/2 a
// second
checkOneMoreTime();
} else if (typeof(response) == &quot;number&quot;) {
// if the response was a number, it means an error occurred
// the user cancelled in Fireworks
window.close();
alert(&quot;an error occurred.&quot;);
} else {
// got a valid response!This return value might not
// always be a useful one, since not all functions in
// Fireworks return a string, but we know this one does,
// so we can show the user what we got.
window.close();
FWLaunch.bringDWToFront();// bring Dreamweaver to the front
Derni&egrave;re mise &agrave; jour le 22/6/2011
39
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Fireworks
alert(&quot;Nice to meet you, &quot; + response + &quot;!&quot;);
}
}
}
&lt;/script&gt;
&lt;/head&gt;
&lt;body&gt;
&lt;form&gt;
&lt;table width=&quot;313&quot; nowrap&gt;
&lt;tr&gt;
&lt;td&gt;This command asks Fireworks to execute the prompt() &not;
function. When you click Prompt, Fireworks comes forward and &not;
asks you to enter a value into a dialog box. That value is then &not;
returned to Dreamweaver and displayed in an alert.&lt;/td&gt;
&lt;/tr&gt;
&lt;/table&gt;
&lt;/form&gt;
&lt;/body&gt;
&lt;/html&gt;
Derni&egrave;re mise &agrave; jour le 22/6/2011
40
Chapitre 6 : Int&eacute;gration de Flash
Adobe&reg; Dreamweaver&reg; prend en charger l'API d'objet Flash, qui s'appuie sur le mod&egrave;le Flash Generator pour cr&eacute;er de
nouveaux objets Flash. La section L'API des objets Flash fournit des d&eacute;tails sur la cr&eacute;ation d'objets Flash (fichiers SWF)
&agrave; partir de mod&egrave;les Flash Generator (fichiers SWT).
Pour plus d'informations sur l'ajout de contenu Flash &agrave; des objets ou des commandes Dreamweaver, voir Extension de
Dreamweaver.
L'API des objets Flash
L'API des objets Flash permet aux d&eacute;veloppeurs d'extensions de construire des objets pour cr&eacute;er des fichiers SWF
simples via Flash Generator. Cette API fournit un moyen de d&eacute;finir des param&egrave;tres dans un mod&egrave;le Flash Generator
pour r&eacute;aliser un fichier SWF ou d'image. Elle permet de cr&eacute;er de nouveaux objets Flash mais aussi de lire et de
manipuler des objets Flash existants.
Le fichier de mod&egrave;le Flash Generator SWT contient toutes les informations indispensables &agrave; la construction d'un
fichier d'objet Flash. Ces fonctions d'API permettent de cr&eacute;er un fichier SWF (ou un fichier d'image) &agrave; partir d'un
fichier SWT. Le fichier SWF est cr&eacute;&eacute; en rempla&ccedil;ant les param&egrave;tres du fichier SWT par des valeurs r&eacute;elles. Pour plus
d'informations sur Flash, consultez le manuel correspondant. Les fonctions suivantes sont des m&eacute;thodes de l'objet
SWFFile.
SWFFile.createFile()
Description
Cette fonction g&eacute;n&egrave;re un nouveau fichier d'objet Flash &agrave; partir du mod&egrave;le et du tableau des param&egrave;tres sp&eacute;cifi&eacute;s. Elle
cr&eacute;e &eacute;galement des versions GIF, PNG, JPEG et MOV du titre si les noms de fichier sous ces formats sont pr&eacute;cis&eacute;s.
Pour pouvoir sp&eacute;cifier un param&egrave;tre facultatif plac&eacute; apr&egrave;s des param&egrave;tres facultatifs que vous ne voulez pas sp&eacute;cifier,
vous devez ins&eacute;rer des cha&icirc;nes vides dans ces param&egrave;tres. Par exemple, si vous souhaitez sp&eacute;cifier un fichier PNG, mais
pas de fichier GIF, vous devez ins&eacute;rer une cha&icirc;ne vide avant de sp&eacute;cifier le nom du fichier PNG.
Arguments
templateFile, templateParams, swfFileName, {gifFileName}, {pngFileName}, {jpgFileName}, {movFileName},
{generatorParams}
• L'argument templateFile est le chemin d'acc&egrave;s du fichier mod&egrave;le, exprim&eacute; sous la forme d'une URL de type file://. Il
peut s'agir d'un fichier SWT.
• L'argument templateParams est un tableau de paires nom/valeur dans lequel les noms identifient les param&egrave;tres du
fichier SWT et les valeurs correspondent &agrave; la d&eacute;finition que vous voulez leur attribuer. Pour que Dreamweaver
puisse reconna&icirc;tre un fichier SWF comme objet Flash, le premier param&egrave;tre doit &ecirc;tre &quot;dwType&quot;. Sa valeur doit &ecirc;tre
une cha&icirc;ne repr&eacute;sentant le nom du type d'objet, telle que &quot;Flash Text&quot;.
• L'argument swfFileName, exprim&eacute; sous forme d'une URL de type file://, correspond au nom de fichier de sortie d'un
fichier SWF ou d'une cha&icirc;ne vide &agrave; ignorer.
• L'argument gifFileName, exprim&eacute; sous forme d'une URL de type file://, correspond au nom de fichier de sortie d'un
fichier GIF. Cet argument est facultatif.
Derni&egrave;re mise &agrave; jour le 22/6/2011
41
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Flash
• L'argument pngFileName, exprim&eacute; sous forme d'une URL de type file://, correspond au nom de fichier de sortie
d'un fichier PNG. Cet argument est facultatif.
• L'argument jpgFileName, exprim&eacute; sous forme d'une URL de type file://, correspond au nom de fichier de sortie d'un
fichier JPEG. Cet argument est facultatif.
• L'argument movFileName, exprim&eacute; sous forme d'une URL de type file://, correspond au nom de fichier de sortie
d'un fichier QuickTime. Cet argument est facultatif.
• L'argument generatorParams est un tableau de cha&icirc;nes repr&eacute;sentant les indicateurs facultatifs de la ligne de
commande de Generator. Cet argument est facultatif. Les &eacute;l&eacute;ments de donn&eacute;es de toutes les balises doivent le suivre
dans le tableau. Les indicateurs couramment utilis&eacute;s sont r&eacute;pertori&eacute;s dans le tableau suivant :
Indicateur d'option
Donn&eacute;es
Description
Exemple
-defaultsize
Largeur, hauteur
D&eacute;finit la taille de l'image de sortie en fonction des
largeur et hauteur indiqu&eacute;es.
&quot;-defaultsize&quot;,
&quot;640&quot;, &quot;480&quot;
-exactFit
Aucun
Etend le contenu de l'image de sortie pour qu'il
s'adapte exactement &agrave; la taille de sortie indiqu&eacute;e.
&quot;-exactFit&quot;
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient l'une des valeurs suivantes :
•
&quot;noError&quot; signifie que l'appel s'est d&eacute;roul&eacute; sans anomalie.
•
&quot;invalidTemplateFile&quot; signifie que le fichier de mod&egrave;le choisi &eacute;tait incorrect ou introuvable.
•
&quot;invalidOutputFile&quot; signifie qu'au moins un des noms de fichier de sortie sp&eacute;cifi&eacute;s &eacute;tait incorrect.
•
&quot;invalidData&quot; signifie qu'une ou plusieurs des paires nom/valeur de l'argument templateParams &eacute;taient
incorrectes.
•
&quot;initGeneratorFailed&quot; signifie que Generator n'a pas pu &ecirc;tre initialis&eacute;.
•
&quot;outOfMemory&quot; signifie que l'op&eacute;ration n'a pas pu se terminer correctement faute de m&eacute;moire.
•
&quot;unknownError&quot; signifie qu'une erreur inconnue s'est produite.
Exemple
Le code JavaScript suivant cr&eacute;e un fichier objet Flash de type &quot;myType&quot;, qui remplace toutes les occurrences de la
cha&icirc;ne &quot;text&quot; &agrave; l'int&eacute;rieur du fichier de mod&egrave;le par la cha&icirc;ne &quot;Hello World&quot;. Il cr&eacute;e un fichier GIF et un fichier SWF.
var params = new Array;
params[0] = &quot;dwType&quot;;
params[1] = &quot;myType&quot;;
params[2] = &quot;text&quot;;
params[3] = &quot;Hello World&quot;;
errorString = SWFFile.createFile( &quot;file:///MyMac/test.swt&quot;, &not;
params, &quot;file:///MyMac/test.swf&quot;, &quot;file:///MyMac/test.gif&quot;);
SWFFile.getNaturalSize()
Description
Cette fonction renvoie la taille naturelle de tout contenu Flash non compress&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
42
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Flash
Arguments
fileName
• L'argument fileName, exprim&eacute; sous la forme d'une URL de type file://, correspond au chemin d'acc&egrave;s au contenu
Flash.
Valeurs renvoy&eacute;es
Un tableau contenant deux &eacute;l&eacute;ments qui repr&eacute;sentent la largeur et la hauteur du contenu Flash non compress&eacute; ou une
valeur null si le fichier n'est pas un fichier Flash non compress&eacute;.
SWFFile.getObjectType()
Description
Cette fonction renvoie le type d'objet Flash, c'est-&agrave;-dire la valeur transmise dans le param&egrave;tre dwType lorsque le fichier
a &eacute;t&eacute; cr&eacute;&eacute; par la fonction SWFFile.createFile().
Arguments
fileName
• L'argument fileName, exprim&eacute; sous la forme d'une URL de type file://, correspond au chemin d'acc&egrave;s &agrave; un fichier
d'objet Flash. Il s'agit g&eacute;n&eacute;ralement d'un fichier SWF.
Valeurs renvoy&eacute;es
Une cha&icirc;ne repr&eacute;sentant le type d'objet ou contenant la valeur null si le fichier n'est pas un fichier d'objet Flash ou s'il
est introuvable.
Exemple
Le code suivant v&eacute;rifie si le fichier test.swf est un objet Flash de type myType :
if ( SWFFile.getObjectType(&quot;file:///MyMac/test.swf&quot;) == &quot;myType&quot; ){
alert (&quot;This is a myType object.&quot;);
}else{
alert (&quot;This is not a myType object.&quot;);
}
SWFFile.readFile()
Description
Cette fonction lit un fichier d'objet Flash.
Arguments
fileName
• L'argument fileName, exprim&eacute; sous la forme d'une URL de type file://, correspond au chemin d'acc&egrave;s &agrave; un fichier
d'objet Flash.
Derni&egrave;re mise &agrave; jour le 22/6/2011
43
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Flash
Valeurs renvoy&eacute;es
Un tableau de cha&icirc;nes dans lequel le premier &eacute;l&eacute;ment est le chemin d'acc&egrave;s complet du fichier mod&egrave;le SWT. Les
cha&icirc;nes suivantes repr&eacute;sentent les param&egrave;tres (paires nom/valeur) de l'objet. Dans le tableau, chaque nom est suivi de
sa valeur. La premi&egrave;re paire nom/valeur est &quot;dwType&quot;, suivie par sa valeur. La fonction renvoie une valeur null si le
fichier est introuvable ou s'il ne s'agit pas d'un fichier d'objet Flash.
Exemple
L'appel du code var params = SWFFile.readFile(&quot;file:///MyMac/test.swf&quot;) renvoie les valeurs suivantes
dans le tableau des param&egrave;tres :
&quot;file:///MyMac/test.swt&quot;
&quot;dwType&quot;
&quot;myType&quot;
&quot;text&quot;
&quot;Hello World&quot;
// template file used to create this .swf file
// first parameter
// first parameter value
// second parameter
// second parameter value
Fonctions des panneaux et des bo&icirc;tes de dialogue de
Flash
Les API suivantes permettent d'ajouter des fichiers SWF dans les panneaux et les bo&icirc;tes de dialogue.
dreamweaver.flash.newControl()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction permet de cr&eacute;er un contr&ocirc;le Flash. Elle est prise en r&eacute;f&eacute;rence plus tard par l'interm&eacute;diaire du param&egrave;tre
controlID. Le contr&ocirc;le affiche le fichier Flash (.swf) sp&eacute;cifi&eacute; par le chemin d'acc&egrave;s SWF. Le contr&ocirc;le poss&egrave;de une
position et une taille sp&eacute;cifi&eacute;es dans le param&egrave;tre defaultGeometry.
Remarque : Dreamweaver affiche les contr&ocirc;les Flash lorsque vous appelez flash.requestStateChange. Dreamweaver
affiche les contr&ocirc;les de bo&icirc;te de dialogue newControl ; il n'est pas n&eacute;cessaire d'appeler flash.requestStateChange.
Arguments
controlID, controlType, controlData
• L'argument controlID est une valeur de cha&icirc;ne.
• L'argument controlType sp&eacute;cifie si le panneau est une extension standard (&quot;standard&quot;), une extension standard
approuv&eacute;e (&quot;trusted&quot;) ou une extension plus (toute autre valeur). S'il s'agit d'une extension plus, la valeur est un
identificateur connu sp&eacute;cifiquement de l'application h&ocirc;te et qui indique le type d'int&eacute;gration personnalis&eacute;e requise.
Si l'application ne comprend pas le type d'int&eacute;gration personnalis&eacute;e, elle renvoie une erreur.
•
controlData est un objet. Voici quelques-unes des propri&eacute;t&eacute;s essentielles de cet argument :
Derni&egrave;re mise &agrave; jour le 22/6/2011
44
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Flash
Propri&eacute;t&eacute;
Description
Valeurs
controlData.swfUTF8Path
Emplacement du fichier SWF. Cette propri&eacute;t&eacute;,
obligatoire, est transmise sous la forme d'une
cha&icirc;ne de caract&egrave;res Unicode, car tous les
caract&egrave;res dans JavaScript sont en format
Unicode.
Valeurs admises pour
controlData.windowType
•
ce tableau &eacute;num&egrave;re les
sp&eacute;cifications pour cette valeur.
•
{controlData.scriptPath}
Chemin d'acc&egrave;s au fichier .js contenant les
fonctions &agrave; ex&eacute;cuter depuis .swf &agrave; l'aide d'un
appel d'interface externe. Cette propri&eacute;t&eacute; est
facultative. Si vous voulez effectuer un rappel
dans le code JavaScript de Dreamweaver &agrave; partir
du fichier .swf au moyen d'une interface externe,
vous pouvez fournir un fichier .js contenant des
fonctions que vous pourrez ensuite appeler
depuis le fichier .swf. Pour plus d'informations,
voir l'appel dw.flash.executeScript.
controlData.defaultGeometry
Les valeurs defaultGeometry sont
repr&eacute;sent&eacute;es sous la forme de coordonn&eacute;es
d'&eacute;cran &agrave; partir du coin sup&eacute;rieur gauche de
l'&eacute;cran. Cette propri&eacute;t&eacute; est obligatoire.
PanelWindow.Le tableau qui suit
ModalDialogWindow
Object /*!&lt; default creation
geometry, including positioning */
{ topleftx: Number, toplefty:
Number, width: Number, height:
Number }
Le tableau suivant &eacute;num&egrave;re les sp&eacute;cifications de PanelWindow :
Options
Type
Descriptions
name
Cha&icirc;ne
Le nom du panneau qui s'affiche dans l'onglet. Si vous ne le pr&eacute;cisez pas,
il est nomm&eacute; &laquo; UNDEFINED &raquo;. Tous les noms de panneaux sont en
majuscules. Vous ne pouvez pas les convertir en minuscules.
{controlData.minSize}
Objet
minSize ne s'applique qu'aux contr&ocirc;les de type PanelWindow. Cette
option d&eacute;termine la taille minimale &agrave; laquelle le panneau peut &ecirc;tre r&eacute;duit.
Cette option est facultative. Si la valeur minSize n'est pas pr&eacute;cis&eacute;e, elle
utilise par d&eacute;faut la largeur et la hauteur d&eacute;finies dans
defaultGeometry. Il est d&egrave;s lors impossible de redimensionner le
panneau.
{ width: Number, height: Number }
{controlData.maxSize}
Objet
maxSize ne s'applique qu'aux contr&ocirc;les de type
PanelWindow. Cette option est facultative. Cette option d&eacute;termine la
taille maximale &agrave; laquelle le panneau peut &ecirc;tre agrandi. Si la valeur
maxSize n'est pas pr&eacute;cis&eacute;e, elle utilise par d&eacute;faut la largeur et la hauteur
d&eacute;finies dans defaultGeometry. Il est d&egrave;s lors impossible de
redimensionner le panneau.
{ width: Number, height: Number }
Derni&egrave;re mise &agrave; jour le 22/6/2011
45
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Flash
Options
Type
Descriptions
{iconPathNormal}
Cha&icirc;ne
Chemin d'acc&egrave;s &agrave; l'ic&ocirc;ne qui doit &ecirc;tre employ&eacute;e dans le panneau flottant
lorsqu'il est r&eacute;duit en ic&ocirc;ne. Cette option est facultative.
{iconPathRollOver}
Cha&icirc;ne
Chemin d'acc&egrave;s &agrave; l'ic&ocirc;ne qui doit &ecirc;tre employ&eacute;e dans le panneau flottant
lorsqu'il est r&eacute;duit en ic&ocirc;ne et que l'utilisateur le survole. Cette option est
facultative.
{iconPathDisable}
Cha&icirc;ne
Chemin d'acc&egrave;s &agrave; l'ic&ocirc;ne qui doit &ecirc;tre employ&eacute;e dans le panneau flottant
lorsqu'il est r&eacute;duit en ic&ocirc;ne et d&eacute;sactiv&eacute;. Cette option est facultative.
Valeurs renvoy&eacute;es
L'un des codes de r&eacute;ussite ou d'erreur suivants :
• Le code PlugPlugErrorCode_success indique que la cr&eacute;ation du contr&ocirc;le a r&eacute;ussi.
• Le code PlugPlugErrorCode_extensionRegistrationFailed indique que vous n'avez pas r&eacute;ussi &agrave; enregistrer
le contr&ocirc;le.
dreamweaver.flash.requestStateChange()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction modifie l'&eacute;tat du panneau flottant identifi&eacute; par uniqueID pour l'extension poss&eacute;dant l'ID extensionID.
Arguments
controlID, stateChange, stateData
• L'argument controlID est une valeur de cha&icirc;ne.
• L'argument stateChange est une cha&icirc;ne qui peut avoir l'une des valeurs suivantes :
Valeur
Description
Move
Modification d'origine, mais pas de taille
Resize
Nouvelle taille et &eacute;ventuellement nouvelle origine
Show
Visibilit&eacute; uniquement, mais pas de modifications g&eacute;om&eacute;triques
Hide
Visibilit&eacute; uniquement, mais pas de modifications g&eacute;om&eacute;triques
Minimize
Similaire &agrave; hide, mais explique la raison du masquage.
Restore
Similaire &agrave; show, mais explique la raison de l'affichage.
Open
La fen&ecirc;tre est cr&eacute;&eacute;e et son extension est charg&eacute;e.
Close
L'extension contenue est d&eacute;charg&eacute;e.
• Les valeurs de l'argument stateData sont des cha&icirc;nes, comme le montre le tableau suivant :
Derni&egrave;re mise &agrave; jour le 22/6/2011
46
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Flash
Valeur de stateChange
Valeur de stateData
Move
eventData = { topleftx: Number, toplefty: Number }
Resize
eventData = { width: Number, height: Number }
Valeurs renvoy&eacute;es
Le tableau suivant contient les valeurs renvoy&eacute;es, qui sont des cha&icirc;nes :
Valeur
Description
RequestPosted
Un &eacute;v&eacute;nement ou une commande d'ex&eacute;cution de la demande a &eacute;t&eacute; plac&eacute; en file d'attente dans l'application
h&ocirc;te.
RequestComplete
L'application h&ocirc;te a termin&eacute; la demande.
RequestFailed
L'application h&ocirc;te a tent&eacute; de terminer la demande, mais a &eacute;chou&eacute;.
RequestDenied
L'application h&ocirc;te a refus&eacute; la demande, g&eacute;n&eacute;ralement parce qu'elle ne prend pas en charge l'action
demand&eacute;e.
Exemple
controlData = {};
controlData.defaultGeometry = {topleftx : 100, toplefty : 100, width : 200, height : 200 };
controlData.minSize = {width : 100; height : 100 };
controlData.maxSize = {width : 300; height : 300 };
var swfPath = dw.getConfigurationPath();
swfPath += '/flash/PhotoAlbum.swf';
controlData.swfUTF8Path = swfPath;
// open the window
flash.requestStateChange(&quot;com.adobe.extension.foo&quot;,&quot;Open&quot;,controlData.defaultGeometry);
dreamweaver.flash.controlEvent()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction permet de transmettre des &eacute;v&eacute;nements &agrave; un contr&ocirc;le Flash. Les appels d'&eacute;v&eacute;nements sont transmis sous
la forme d'une cha&icirc;ne XML qui capture la fonction et les param&egrave;tres appropri&eacute;s. La cha&icirc;ne XML capture la fonction &agrave;
d&eacute;marrer dans le fichier SWF.
Arguments
inControlID, inXMLString
• L'argument inControlID est une cha&icirc;ne.
• L'argument inXMLString est une cha&icirc;ne. Transmettez le inXMLString suivant pour appeler la fonction dans le
fichier Flash flashCallback et transmettez une cha&icirc;ne unique, 'Hello', en tant qu'argument.
&lt;invoke name=&quot;flashCallback&quot; returntype=&quot;xml&quot;&gt;
&lt;arguments&gt;
&lt;string&gt;Hello&lt;/string&gt;
&lt;/arguments&gt;
&lt;/invoke&gt;
Derni&egrave;re mise &agrave; jour le 22/6/2011
47
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Flash
Valeurs renvoy&eacute;es
Renvoie une cha&icirc;ne XML.
Exemple
L'exemple suivant appelle la fonction flashCallback depuis JavaScript. Dans cet exemple, vous transmettre le nom
de la fonction de rappel et ses arguments sous la forme d'une cha&icirc;ne XML.
var xmlString = '&lt;invoke name=&quot;flashCallback&quot; returntype=&quot;xml&quot;&gt;
&lt;arguments&gt;
&lt;string&gt;Hello&lt;/string&gt;
&lt;/arguments&gt;
&lt;/invoke&gt;';
Dans cet exemple, vous utilisez dw.flash.controlEvent pour effectuer un rappel dans le fichier Flash (.swf) :
dw.flash.controlEvent('Flickr', xmlString);
Les arguments suivants sont utilis&eacute;s dans cette fonction :
•
Flickr, qui est l'ID de l'extension transmis lorsque le contr&ocirc;le .swf a &eacute;t&eacute; cr&eacute;&eacute; avec dw.flash.newControl.
• La cha&icirc;ne XML contenant la fonction de rappel et les arguments.
L'exemple suivant est la mise en oeuvre de la fonction flashcallback impl&eacute;ment&eacute;e dans flashcallback.mxml. Dans
l'exemple suivant, ajoutez la fonction flashcallback. Cette fonction doit &ecirc;tre appel&eacute;e &agrave; partir d'applications externes.
public function initApp():void {
ExternalInterface.addCallback(&quot;flashCallback&quot;,flashCallback);
}
Cette fonction est rappel&eacute;e depuis l'ext&eacute;rieur du fichier Flash (.swf).
Remarque : Veillez &agrave; appeler ExternalInterface.addCallback (&quot;flashCallback&quot;,flashCallback) avant de
tenter d'appeler cette fonction.
public function flashCallback(inputStr:String):String
{
out.text += inputStr + &quot; got flashCallback!\n&quot;;
return &quot;it worked!&quot;;
}
dreamweaver.flash.setMenu()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction permet de fournir des commandes de survol pour les extensions de type &quot;PanelWindow&quot;.
Arguments
inControlID, inMenuPosition, inMenu
•
inControlID est un ID d'extension. L'appel de la fonction influe sur le menu de survol d'un panneau ouvert qui
h&eacute;berge l'extension. Si cet argument n'est pas d&eacute;fini, l'appel influe sur les menus principaux de l'application.
•
inMenuPosition est une cha&icirc;ne qui d&eacute;crit o&ugrave; les commandes donn&eacute;es doivent &ecirc;tre plac&eacute;es.
• Si cette cha&icirc;ne n'est pas d&eacute;finie, un menu entier est remplac&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
48
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Flash
• Si cette cha&icirc;ne concerne un panneau, toute la zone d&eacute;finissable par l'utilisateur du menu de survol est remplac&eacute;e.
L'application r&eacute;serve certains &eacute;l&eacute;ments de survol fixes.
• Si cette cha&icirc;ne concerne l'application, tout le sous-menu Contr&ocirc;les par d&eacute;faut du menu Fen&ecirc;tre est remplac&eacute;.
• Si cette cha&icirc;ne est une cha&icirc;ne XML dans un sch&eacute;ma restant &agrave; d&eacute;terminer pour la d&eacute;finition de sections de menus,
ce formulaire est fourni pour une compatibilit&eacute; future.
•
inMenu &eacute;quivaut &agrave; MenuItem. Cet argument indique une liste de commandes qui sont ajout&eacute;es &agrave; l'emplacement
indiqu&eacute; dans le menu. Il remplace tout &eacute;l&eacute;ment ant&eacute;rieur qui a &eacute;t&eacute; ajout&eacute; &agrave; cet endroit par un appel pr&eacute;c&eacute;dent.
Valeurs renvoy&eacute;es
L'un des codes de r&eacute;ussite ou d'erreur suivants :
• Le code PlugPlugErrorCode_success indique une r&eacute;ussite.
• Le code PlugPlugErrorCode_extensionMenuCreationFailed indique que la cr&eacute;ation du menu de l'extension a
&eacute;chou&eacute;.
• Le code PlugPlugErrorCode_unknown indique que la fonction a &eacute;chou&eacute; pour une raison inconnue.
Exemple
L'exemple suivant sert &agrave; configurer le menu :
function initializeMenuItem(menuID, menuName,extensionID, submenu)
{
var menuItem = {};
menuItem.menuId = menuID; //!&lt; unique menu ID, if NULL menu is disabled
menuItem.nameUtf8 = menuName; //!&lt; Item title, if &quot;---&quot; item is a separator
menuItem.extensionId = extensionID; //!&lt; optional extension ID, used for panels only
menuItem.submenu = submenu; //!&lt; if non-NULL, this is a submenu
return menuItem;
}
function setupMenu()
{
var menuItems = new Array();
menuItems.push(initializeMenuItem('id1','Call .swf
ActionScript',undefined,undefined));
menuItems.push(initializeMenuItem('id0','---',undefined,undefined));
menuItems.push(initializeMenuItem('id2','Call Dw JavaScript',undefined,undefined));
dw.flash.setMenu('Flickr',controlID,menuItems);
}
Remarque : Sp&eacute;cifiez une fonction nomm&eacute;e &quot;onSelectMenuItem&quot; dans le fichier JavaScript indiqu&eacute; dans le
scriptPath de l'objet transmis &agrave; newControl.
onSelectMenuItem est un gestionnaire d'&eacute;l&eacute;ment de menu. Il est appel&eacute; avec l'ID de menu correspondant lorsqu'une
commande est s&eacute;lectionn&eacute;e depuis le menu de survol de l'objet flottant.
L'exemple suivant sp&eacute;cifie la d&eacute;finition du gestionnaire de rappel dans &laquo; Configuration/flash/Flickr.js &raquo; :
Derni&egrave;re mise &agrave; jour le 22/6/2011
49
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Flash
function onSelectMenuItem(menuID)
{
if (menuID == 'id1') {
var flashCallbackString = '&lt;invoke name= &quot; flash Callback&quot;
returntype=&quot;xml&quot;&gt;
&lt;arguments&gt;&lt;string&gt;Hello&lt;/string&gt;&lt;/arguments&gt;&lt;/invoke&gt;';
dw.flash.control Event('Flickr', flashCallbackString);
return(&quot;PlugPlugRequestCompleted&quot;);
} else {
alert ( ' You selected: menuID = ' + menuID);
return ( &quot; PlugPlugRequestCompleted&quot;);
}
}
dreamweaver.flash.evalScript()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction sert &agrave; appeler une fonction JavaScript dans l'un des buts suivants :
• Ex&eacute;cution d'une fonction JavaScript d&eacute;finie dans le fichier de script associ&eacute; &agrave; l'extension (pour les extensions CSXS)
• Le fichier .js d&eacute;fini dans le param&egrave;tre scriptPath pour les extensions non bas&eacute;es sur CSXS.
Arguments
controlID, javascript function call
•
controlID est l'ID de l'extension qui doit ex&eacute;cuter le script. Cet ID doit correspondre &agrave; l'ID sp&eacute;cifi&eacute; comme
premier param&egrave;tre de dw.flash.newControl().
• L'argument d'appel de fonction JavaScript permet &agrave; l'utilisateur d'appeler une fonction avec n'importe quel nombre
de param&egrave;tres.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si l'ex&eacute;cution de la fonction a r&eacute;ussi et false dans le cas contraire. dans le cas contraire.
dreamweaver.flash.executeScript()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction sert &agrave; ex&eacute;cuter des fonctions dans un fichier .js. Le code ActionScript dans le fichier .swf d&eacute;marre la
fonction dreamweaver.flash.executeScript().
Arguments
javascript function call
Remarque : D&eacute;finissez un chemin d'acc&egrave;s au fichier .js contenant les fonctions que vous voulez appeler.
Derni&egrave;re mise &agrave; jour le 22/6/2011
50
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Flash
Valeurs renvoy&eacute;es
Cha&icirc;ne XML qui se s&eacute;rialise en un objet ActionScript.
Exemple
L'exemple suivant contient un fichier d'exemple, Sample.mxml, ainsi qu'une fonction JavaScript dans un fichier
JavaScript, Sample.js.
private function executeScript():void
{
if(ExternalInterface.available)
{
out.text += &quot;SwfCalledHost\n&quot;;
var scriptText:String = &quot;helloWorld('scott');\n&quot;;
var resultStr:Object =
ExternalInterface.call(&quot;dw.flash.executeScript&quot;,scriptText);
out.text += &quot;Result: &quot; + resultStr.strResult + '\n';
}
}
Le fichier JavaScript suivant contient une fonction JavaScript helloWorld() qui est appel&eacute;e depuis le fichier .swf.
Cette fonction emploie l'appel dw.getAppLanguage() pour renvoyer un code &agrave; cinq lettres de la langue dans laquelle
Dreamweaver s'ex&eacute;cute dans Sample.js.
function helloWorld(nameStr)
{
alert('hello ' + nameStr);
var appLanguage = dw.getAppLanguage();
var returnStr = '&lt;object&gt;&lt;property id=&quot;strResult&quot;&gt;&lt;string&gt;Language: ' + appLanguage
+ '&lt;/string&gt;&lt;/property&gt;&lt;/object&gt;'
alert(returnStr);
return (returnStr);
}
Voir aussi
&laquo; dreamweaver.flash.newControl() &raquo; &agrave; la page 43
dreamweaver.flash.controlExists
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction sert &agrave; v&eacute;rifier l'existence des contr&ocirc;les. Les contr&ocirc;les PanelWindow sont enregistr&eacute;s entre
les lancements de Dreamweaver.
Arguments
controlID
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le contr&ocirc;le a d&eacute;j&agrave; &eacute;t&eacute; cr&eacute;&eacute; et false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
51
Chapitre 7 : Int&eacute;gration de Photoshop
Adobe&reg; Dreamweaver CS5&reg; facilite une int&eacute;gration compacte avec Adobe&reg; Photoshop&reg;. L'utilisateur peut ins&eacute;rer des
images Photoshop sous la forme d'objets dynamiques dans Dreamweaver. La fonctionnalit&eacute; Objets dynamiques met
automatiquement &agrave; jour les images dans Dreamweaver si des modifications sont apport&eacute;es aux images d'origine &agrave;
l'aide de Photoshop.
Fonctionnement des objets dynamiques
Les images Photoshop sont ins&eacute;r&eacute;es dans Dreamweaver sous la forme d'objets dynamiques. Les objets dynamiques
restent li&eacute;s aux images Photoshop d'origine. Lorsqu'un utilisateur modifie l'image dans Photoshop, il peut voir une
image mise &agrave; jour dans Dreamweaver. Un objet dynamique poss&egrave;de un &eacute;tat sp&eacute;cifique, qui r&eacute;sulte principalement de
la connexion de l'image Web &agrave; son fichier d'actif initial. L'utilisateur peut d&eacute;terminer visuellement l'&eacute;tat d'un objet
dynamique. L'&eacute;tat de synchronisation d'un objet dynamique est indiqu&eacute; par le badge Sync.
L'API des objets dynamiques
Les fonctions des objets dynamiques traitent des op&eacute;rations relatives &agrave; l'int&eacute;gration de Dreamweaver et de Photoshop.
Ces fonctions permettent d'effectuer les op&eacute;rations suivantes :
• R&eacute;cup&eacute;ration de l'&eacute;tat d'une image
• R&eacute;cup&eacute;ration de la hauteur et de la largeur d'une image
dreamweaver.assetPalette.canUpdateSmartObjectFromOriginal()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Activateur : Cette fonction v&eacute;rifie si un objet dynamique, sur lequel on peut &eacute;mettre la commande Mettre &agrave; jour depuis
l'original, est s&eacute;lectionn&eacute; dans le panneau actif.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la commande Mettre &agrave; jour depuis l'original peut &ecirc;tre appliqu&eacute;e &agrave; la s&eacute;lection actuelle.
false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
52
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Photoshop
dreamweaver.assetPalette.updateSmartObjectFromOriginal()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction recr&eacute;e l'image Web s&eacute;lectionn&eacute;e sur la base du contenu actuel du fichier source d'origine connect&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.getSmartObjectState()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction renvoie l'&eacute;tat d'une image Web en termes de fonctionnalit&eacute;s d'objets dynamiques.
Arguments
URL locale absolue d'une image Web.
Valeurs renvoy&eacute;es
L'&eacute;tat de l'objet dynamique sous la forme d'une valeur num&eacute;rique, comme :
Valeur num&eacute;rique
Description
-10
Erreur inconnue
0
Pas d'objet dynamique.
1
Synchronis&eacute; avec le contenu du fichier d'actif d'origine.
100
Image Web modifi&eacute;e apr&egrave;s la derni&egrave;re synchronisation.
200
Actif d'origine modifi&eacute; apr&egrave;s la derni&egrave;re synchronisation.
+2
Les dimensions de l'actif d'origine diff&egrave;rent des attributs de largeur et de hauteur dans le code HTML.
+4
Les dimensions de l'image Web diff&egrave;rent des attributs de largeur et de hauteur dans le code HTML.
10
Impossible d'acc&eacute;der au fichier d'actif d'origine.
20
Impossible d'acc&eacute;der au fichier d'image Web.
dreamweaver.getSmartObjectOriginalWidth()
Disponibilit&eacute;
Dreamweaver CS4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
53
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Photoshop
Description
Cette fonction &eacute;value et renvoie la largeur en pixels du fichier d'actif d'origine d'un objet dynamique.
Arguments
URL locale absolue de l'image Web.
Valeurs renvoy&eacute;es
Largeur en pixels du fichier d'actif d'origine.
dreamweaver.getImageWidth()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction &eacute;value et renvoie la largeur en pixels d'une image.
Arguments
URL locale absolue d'une image Web.
Valeurs renvoy&eacute;es
Largeur en pixels de l'image.
dreamweaver.getImageHeight()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction &eacute;value et renvoie la hauteur en pixels d'une image.
Arguments
URL locale absolue d'une image Web.
Valeurs renvoy&eacute;es
Hauteur en pixels de l'image.
dreamweaver.resolveOriginalAssetFileURLToAbsoluteLocalFilePath()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction r&eacute;sout un chemin d'acc&egrave;s de fichier &agrave; un fichier d'acc&egrave;s d'origine (tel que stock&eacute; dans les Design Notes).
Le chemin peut &ecirc;tre vide, relatif au site ou absolu.
Derni&egrave;re mise &agrave; jour le 22/6/2011
54
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Int&eacute;gration de Photoshop
Arguments
URL locale absolue ou relative au site de l'image Web. Cette URL est requise pour la r&eacute;solution du site.
Valeurs renvoy&eacute;es
Chemin d'acc&egrave;s absolu au fichier local.
dreamweaver.canUpdateSmartObjectFromOriginal()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction sp&eacute;cifie si un objet dynamique peut &ecirc;tre mis &agrave; jour &agrave; partir de son fichier d'actif d'origine.
Arguments
Etat num&eacute;rique de l'objet dynamique ImageManipulatorSettings : GetSmartObjectStatus() renvoie cet &eacute;tat.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'&eacute;tat autorise une mise &agrave; jour &agrave; partir de l'image d'origine, false
dans le cas contraire.
dreamweaver.updateSmartObjectFromOriginal()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction met &agrave; jour une image Web sur la base du contenu actuel d'un fichier source d'origine.
Arguments
URL locale absolue d'une image Web.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
55
Chapitre 8 : API de base de donn&eacute;es
Les fonctions de l'API de base de donn&eacute;es permettent de g&eacute;rer les connexions aux bases de donn&eacute;es et d'acc&eacute;der aux
informations stock&eacute;es dans ces derni&egrave;res. L'API de base de donn&eacute;es est divis&eacute;e en deux fonctions distinctes : gestion
des connexions aux bases de donn&eacute;es et acc&egrave;s aux connexions de bases de donn&eacute;es.
Les fonctions de l'API de base de donn&eacute;es sont utilis&eacute;es au moment de la conception, lorsque les utilisateurs
d&eacute;veloppent leurs applications Web, et non au moment de l'ex&eacute;cution, c'est-&agrave;-dire lorsque l'application Web est
d&eacute;ploy&eacute;e.
Il est possible d'utiliser ces fonctions dans n'importe quelle extension. En fait, les API de comportement de serveur, de
format des donn&eacute;es et de source de donn&eacute;es d'Adobe&reg; Dreamweaver&reg; CS5 utilisent toutes ces fonctions de base de
donn&eacute;es.
Fonctionnement de l'API de base de donn&eacute;es
L'exemple suivant illustre la fa&ccedil;on dont la fonction de comportement de serveur, getDynamicBindings(), est d&eacute;finie
pour Recordset.js. Cet exemple utilise la fonction MMDB.getColumnAndTypeList() :
function getDynamicBindings(ss)
{
var serverModel = dw.getDocumentDOM().serverModel.getServerName();
var bindingsAndTypeArray = new Array();
var connName=ss.connectionName;
var statement = ss.source;
var rsName= ss.rsName;
// remove SQL comments
statement = statement.replace(/\/\*[\S\s]*?\*\//g, &quot; &quot;);
var bIsSimple = ParseSimpleSQL(statement);
statement = stripCFIFSimple(statement);
if (bIsSimple) {
statement = RemoveWhereClause(statement,false);
} else {
var pa = new Array();
if (ss.ParamArray != null) {
for (var i = 0; i &lt; ss.ParamArray.length; i++) {
pa[i] = new Array();
pa[i][0] = ss.ParamArray[i].name;
pa[i][1] = ss.ParamArray[i].value;
}
}
var statement = replaceParamsWithVals(statement, pa, serverModel);
}
bindingsAndTypeArray = MMDB.getColumnAndTypeList(connName, statement);
return bindingsAndTypeArray;
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
56
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Fonctions de connexion &agrave; une base de donn&eacute;es
Les fonctions de connexion &agrave; une base de donn&eacute;es vous permettent d'&eacute;tablir et de g&eacute;rer toutes les connexions, y
compris les connexions ADO de Dreamweaver, ColdFusion et JDBC.
Ces fonctions interagissent avec le Gestionnaire de connexions uniquement ; elles n'acc&egrave;dent pas aux bases de
donn&eacute;es. Pour les fonctions qui acc&egrave;dent aux bases de donn&eacute;es, voir &laquo; Fonctions d'acc&egrave;s &agrave; la base de donn&eacute;es &raquo; &agrave; la
page 68.
Dans le cadre de la gestion des connexions de bases de donn&eacute;es, vous pouvez obtenir le nom d'utilisateur et le mot de
passe afin d'accomplir des activit&eacute;s telles que :
• Etablissement d'une connexion &agrave; une base de donn&eacute;es
• Ouverture d'une bo&icirc;te de dialogue de connexion &agrave; une base de donn&eacute;es
MMDB.deleteConnection()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction permet de supprimer la connexion &agrave; la base de donn&eacute;es nomm&eacute;e.
Arguments
connName
• L'argument connName est le nom de la connexion &agrave; la base de donn&eacute;es tel qu'il est sp&eacute;cifi&eacute; dans le Gestionnaire de
connexions. Cet argument identifie la connexion &agrave; la base de donn&eacute;es &agrave; supprimer en fonction de son nom.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant supprime une connexion &agrave; une base de donn&eacute;es :
function clickedDelete()
{
var selectedObj = dw.serverComponents.getSelectedNode();
if (selectedObj &amp;&amp; selectedObj.objectType==&quot;Connection&quot;)
{
var connRec = MMDB.getConnection(selectedObj.name);
if (connRec)
{
MMDB.deleteConnection(selectedObj.name);
dw.serverComponents.refresh();
}
}
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
57
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
MMDB.getColdFusionDsnList()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Cette fonction extrait les noms des sources de donn&eacute;es (DSN) ColdFusion du serveur du site, en utilisant les fonctions
getRDSUserName() et getRDSPassword().
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau contenant les DSN ColdFusion d&eacute;finis sur le serveur pour le site en cours.
MMDB.getConnection()
Disponibilit&eacute;
Dreamweaver UltraDev 4, am&eacute;lior&eacute; dans Dreamweaver MX.
Description
Extrait un objet de connexion nomm&eacute;.
Arguments
name
• L'argument name est une variable de cha&icirc;ne qui sp&eacute;cifie le nom de la connexion &agrave; laquelle vous souhaitez faire
r&eacute;f&eacute;rence.
Valeurs renvoy&eacute;es
R&eacute;f&eacute;rence &agrave; un objet de connexion nomm&eacute;. Les objets de connexion ont les propri&eacute;t&eacute;s suivantes :
Propri&eacute;t&eacute;
Description
name
Nom de connexion
type
Indique, si useHTTP a pour valeur false, quel fichier DLL utiliser pour se connecter &agrave; une base de
donn&eacute;es en ex&eacute;cution.
string
Cha&icirc;ne de connexion ADO d'ex&eacute;cution ou URL JDBC
dsn
DSN ColdFusion
driver
Pilote JDBC d'ex&eacute;cution
username
Nom d'utilisateur d'ex&eacute;cution
password
Mot de passe d'ex&eacute;cution
useHTTP
Cha&icirc;ne qui contient la valeur true ou false, indiquant si vous devez utiliser un pilote distant
(connexion HTTP) au moment de la conception ou un pilote local (DLL).
Derni&egrave;re mise &agrave; jour le 22/6/2011
58
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Propri&eacute;t&eacute;
Description
includePattern
Expression r&eacute;guli&egrave;re utilis&eacute;e pour trouver l'instruction d'inclusion de fichier sur la page pendant Live
Data et Aper&ccedil;u dans le navigateur
variables
Tableau de noms de variables de pages et leurs valeurs correspondantes, utilis&eacute; pendant Live Data
et Aper&ccedil;u dans le navigateur
catalog
Utilis&eacute; pour restreindre les m&eacute;tadonn&eacute;es qui apparaissent (pour plus d'informations, voir
&laquo; MMDB.getProcedures() &raquo; &agrave; la page 71)
schema
Utilis&eacute; pour restreindre les m&eacute;tadonn&eacute;es qui apparaissent (pour plus d'informations, voir
&laquo; MMDB.getProcedures() &raquo; &agrave; la page 71)
filename
Nom de fichier de bo&icirc;te de dialogue qui &eacute;tait utilis&eacute; pour cr&eacute;er la connexion
Remarque : Il s'agit des propri&eacute;t&eacute;s standard impl&eacute;ment&eacute;es par Dreamweaver. Les d&eacute;veloppeurs peuvent d&eacute;finir leurs
propres types de connexion et ajouter de nouvelles propri&eacute;t&eacute;s &agrave; cet ensemble standard, ou bien fournir un ensemble
diff&eacute;rent de propri&eacute;t&eacute;s.
MMDB.getConnectionList()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Cette fonction extrait une liste de toutes les cha&icirc;nes de connexion d&eacute;finies dans le Gestionnaire de connexions.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes, chaque cha&icirc;ne correspondant au nom d'une connexion tel qu'il appara&icirc;t dans le Gestionnaire de
connexions.
Exemple
La fonction MMDB.getConnectionList() peut renvoyer les cha&icirc;nes [&quot;EmpDB&quot;, &quot;Test&quot;, &quot;TestEmp&quot;].
MMDB.getConnectionName()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Extrait un nom de connexion correspondant &agrave; la cha&icirc;ne de connexion sp&eacute;cifi&eacute;e. Cette fonction est utile lorsque vous
devez res&eacute;lectionner un nom de connexion dans l'interface utilisateur (UI) &agrave; partir des donn&eacute;es de la page.
Si vous avez une cha&icirc;ne de connexion faisant r&eacute;f&eacute;rence &agrave; deux pilotes diff&eacute;rents, vous pouvez sp&eacute;cifier &agrave; la fois la cha&icirc;ne
de connexion et le pilote correspondant au nom de connexion que vous souhaitez obtenir. Par exemple, vous pourriez
avoir deux connexions :
• Connexion 1 poss&egrave;de les propri&eacute;t&eacute;s suivantes :
Derni&egrave;re mise &agrave; jour le 22/6/2011
59
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
ConnectionString=&quot;jdbc:inetdae:velcro-qa-5:1433?database=pubs&quot;
DriverName=&quot;com.inet.tds.TdsDriver&quot;
• Connexion 2 poss&egrave;de les propri&eacute;t&eacute;s suivantes :
ConnectionString=&quot;jdbc:inetdae:velcro-qa-5:1433?database=pubs&quot;
DriverName=&quot;com.inet.tds.TdsDriver2&quot;
Les cha&icirc;nes de connexion de Connexion 1 et Connexion 2 sont identiques. Connexion 2 &eacute;tablit une connexion avec
une version plus r&eacute;cente de TdsDriver. Vous devez transmettre le nom du pilote &agrave; cette fonction pour d&eacute;finir
compl&egrave;tement le nom de connexion que vous souhaitez obtenir.
Arguments
connString, {driverName}
• connString est la cha&icirc;ne de connexion qui extrait le nom de la connexion.
• L'argument facultatif driverName d&eacute;finit l'argument connString de mani&egrave;re plus pr&eacute;cise.
Valeurs renvoy&eacute;es
Cha&icirc;ne de nom de connexion correspondant &agrave; la cha&icirc;ne de connexion.
Exemple
Le code suivant renvoie la cha&icirc;ne &quot;EmpDB&quot; :
var connectionName = MMDB.getConnectionName &not;
(&quot;dsn=EmpDB;uid=;pwd=&quot;);
MMDB.getConnectionString()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Extrait la cha&icirc;ne de connexion associ&eacute;e &agrave; la connexion nomm&eacute;e.
Arguments
connName
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
Valeurs renvoy&eacute;es
Cha&icirc;ne de connexion qui correspond &agrave; la connexion nomm&eacute;e.
Exemple
Le code var connectionString = MMDB.getConnectionString (&quot;EmpDB&quot;) renvoie diff&eacute;rentes cha&icirc;nes pour une
connexion ADO ou JDBC.
• Pour une connexion ADO, la cha&icirc;ne suivante peut renvoyer :
&quot;dsn=EmpDB;uid=;pwd=&quot;;
• Pour une connexion JDBC, la cha&icirc;ne suivante peut renvoyer :
Derni&egrave;re mise &agrave; jour le 22/6/2011
60
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
&quot;jdbc:inetdae:192.168.64.49:1433?database=pubs&amp;user=JoeUser&amp;&not;
password=joesSecret&quot;
MMDB.getDriverName()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Extrait le nom du pilote associ&eacute; &agrave; la connexion sp&eacute;cifi&eacute;e. Seules les connexions JDBC ont des noms de pilote.
Arguments
connName
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le nom du pilote.
Exemple
L'instruction MMDB.getDriverName (&quot;EmpDB&quot;); peut renvoyer la cha&icirc;ne suivante :
&quot;jdbc/oracle/driver/JdbcOracle&quot;
MMDB.getLocalDsnList()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Extrait les DSN ODBC d&eacute;finis dans le syst&egrave;me de l'utilisateur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau contenant les DSN ODBC d&eacute;finis sur le syst&egrave;me de l'utilisateur.
MMDB.getPassword()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Extrait le mot de passe utilis&eacute; pour la connexion sp&eacute;cifi&eacute;e.
Derni&egrave;re mise &agrave; jour le 22/6/2011
61
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Arguments
connName
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
Valeurs renvoy&eacute;es
Une cha&icirc;ne de mot de passe associ&eacute;e au nom de connexion.
Exemple
L'instruction MMDB.getPassword (&quot;EmpDB&quot;); peut renvoyer &quot;joessecret&quot;.
MMDB.getRDSPassword()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Extrait le mot de passe Remote Development Services (RDS) (&agrave; utiliser avec les connexions ColdFusion).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le mot de passe RDS.
MMDB.getRDSUserName()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Extrait le nom d'utilisateur RDS (&agrave; utiliser avec les connexions ColdFusion).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant le nom d'utilisateur RDS.
MMDB.getRemoteDsnList()
Disponibilit&eacute;
Dreamweaver UltraDev 4, am&eacute;lior&eacute; dans Dreamweaver MX.
Derni&egrave;re mise &agrave; jour le 22/6/2011
62
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Description
Extrait les DSN ODBC du serveur de site. Les fonctions getRDSUserName() et getRDSPassword() sont utilis&eacute;es
lorsque le mod&egrave;le de serveur du site en cours est ColdFusion. Cette fonction offre aux d&eacute;veloppeurs la possibilit&eacute; de
sp&eacute;cifier une cha&icirc;ne de param&egrave;tre URL &agrave; annexer &agrave; l'URL Remote Connectivity g&eacute;n&eacute;r&eacute;e par
MMDB.getRemoteDsnList(). Si le d&eacute;veloppeur fournit une cha&icirc;ne de param&egrave;tre, cette fonction la transmet aux scripts
de connectivit&eacute; HTTP.
Arguments
{urlParams}
• L'argument facultatif urlParams est une cha&icirc;ne contenant une liste d'expressions nom=valeur, s&eacute;par&eacute;es par des
esperluettes (&amp;). Les valeurs ne doivent pas &ecirc;tre entour&eacute;es de guillemets. Certains caract&egrave;res, tels que l'espace dans
la valeur Hello World, doivent &ecirc;tre cod&eacute;s. Voici un exemple d'argument valide que vous pouvez transmettre dans
MMDB.getRemoteDsnList(): a=1&amp;b=Hello%20World
Valeurs renvoy&eacute;es
Renvoie un tableau contenant les DSN ODBC d&eacute;finis sur le serveur pour le site en cours.
MMDB.getRuntimeConnectionType()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Renvoie le type de connexion d'ex&eacute;cution du nom de connexion sp&eacute;cifi&eacute;.
Arguments
connName
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
Valeurs renvoy&eacute;es
Cha&icirc;ne correspondant au type de connexion. Cette fonction peut renvoyer l'une des valeurs suivantes : &quot;ADO&quot;,
&quot;ADODSN&quot;, &quot;JDBC&quot; ou &quot;CFDSN&quot;.
Exemple
Le code suivant renvoie la cha&icirc;ne &quot;ADO&quot; pour une connexion ADO :
var connectionType = MMDB.getRuntimeConnectionType (&quot;EmpDB&quot;)
MMDB.getUserName()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Renvoie un nom d'utilisateur pour la connexion sp&eacute;cifi&eacute;e.
Derni&egrave;re mise &agrave; jour le 22/6/2011
63
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Arguments
connName
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
Valeurs renvoy&eacute;es
Cha&icirc;ne de nom d'utilisateur associ&eacute;e au nom de connexion.
Exemple
L'instruction MMDB.getUserName (&quot;EmpDB&quot;); peut renvoyer &quot;amit&quot;.
MMDB.hasConnectionWithName()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
D&eacute;termine l'existence de la connexion d'un nom donn&eacute;.
Arguments
name
• name est le nom de la connexion.
Valeurs renvoy&eacute;es
Renvoie une valeur bool&eacute;enne : true indique l'existence d'une connexion ayant le nom sp&eacute;cifi&eacute; et false indique le
contraire.
MMDB.needToPromptForRdsInfo()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction d&eacute;termine si Dreamweaver doit ouvrir la bo&icirc;te de dialogue des informations de connexion RDS.
Arguments
bForce
• L'argument bForce est une valeur bool&eacute;enne ; true indique que l'utilisateur ayant pr&eacute;c&eacute;demment annul&eacute; la bo&icirc;te de
dialogue RDS doit toujours &ecirc;tre invit&eacute; &agrave; saisir les informations de connexion RDS.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true indique que l'utilisateur doit &ecirc;tre invit&eacute; &agrave; saisir les informations de connexion RDS ; false
indique le contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
64
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
MMDB.needToRefreshColdFusionDsnList()
Disponibilit&eacute;
Dreamweaver MX.
Description
Ordonne au Gestionnaire de connexions de vider la m&eacute;moire cache et d'extraire la liste des sources des donn&eacute;es
ColdFusion du serveur d'application la prochaine fois qu'un utilisateur demande la liste.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
MMDB.popupConnection()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction lance une bo&icirc;te de dialogue de connexion. Cette fonction a les trois signatures suivantes :
• Si la liste d'arguments ne comporte que dialogFileName (une cha&icirc;ne), popupConnection() provoque le lancement
de la bo&icirc;te de dialogue de connexion dans Dreamweaver, pour que vous puissiez y d&eacute;finir une nouvelle connexion.
• Si la liste d'arguments ne comporte que connRec (une r&eacute;f&eacute;rence de connexion), popupConnection() provoque le
lancement de la bo&icirc;te de dialogue de connexion en mode d'&eacute;dition dans Dreamweaver, pour que vous puissiez y
modifier la connexion nomm&eacute;e. Dans ce mode, la zone de texte du nom s'affiche en gris&eacute;.
• Si la liste d'arguments ne comporte que connRec et la valeur bool&eacute;enne bDuplicate, popupConnection() provoque
le lancement de la bo&icirc;te de dialogue en mode dupliqu&eacute; dans Dreamweaver. Dans ce mode, la zone de texte du nom
s'affiche en gris&eacute; et les propri&eacute;t&eacute;s restantes sont copi&eacute;es pour d&eacute;finir une connexion dupliqu&eacute;e.
Arguments
dialogFileName ou connRec ou connrec, bDuplicate
• dialogFileName est une cha&icirc;ne qui contient le nom d'un fichier HTML r&eacute;sidant dans le dossier
Configuration/Connections/server-model. Ce fichier HTML d&eacute;finit la bo&icirc;te de dialogue qui cr&eacute;e une connexion. Ce
fichier doit d&eacute;ployer trois fonctions d'API JavaScript : findConnection(), inspectConnection() et
applyConnection(). En g&eacute;n&eacute;ral, vous cr&eacute;ez un fichier JavaScript qui impl&eacute;mente ces fonctions, puis vous int&eacute;grez
ce fichier au fichier HTML. Pour plus d'informations sur la cr&eacute;ation d'une connexion, voir &laquo; API de connectivit&eacute; &agrave;
une base de donn&eacute;es &raquo; &agrave; la page 80.
• connRec est une r&eacute;f&eacute;rence &agrave; un objet de connexion existant.
• bDuplicate est une valeur bool&eacute;enne.
Valeurs renvoy&eacute;es
Aucune. La bo&icirc;te de dialogue de connexion d&eacute;finie s'ouvre.
Derni&egrave;re mise &agrave; jour le 22/6/2011
65
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
MMDB.setRDSPassword()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
D&eacute;finit le mot de passe RDS.
Arguments
password
• password est une cha&icirc;ne contenant le mot de passe RDS.
Valeurs renvoy&eacute;es
Aucune.
MMDB.setRDSUserName()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
D&eacute;finit le nom d'utilisateur RDS.
Arguments
username
• L'argument username est le nom d'un utilisateur RDS valide.
Valeurs renvoy&eacute;es
Aucune.
MMDB.showColdFusionAdmin()
Disponibilit&eacute;
Dreamweaver MX.
Description
Affiche la bo&icirc;te de dialogue ColdFusion Administrator.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune. La bo&icirc;te de dialogue ColdFusion Administrator s'affiche.
Derni&egrave;re mise &agrave; jour le 22/6/2011
66
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
MMDB.showConnectionMgrDialog()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Affiche la bo&icirc;te de dialogue Gestionnaire de connexions.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune. La bo&icirc;te de dialogue Gestionnaire de connexions s'affiche.
MMDB.showOdbcDialog()
Disponibilit&eacute;
Dreamweaver UltraDev 4 (Windows uniquement).
Description
Affiche la bo&icirc;te de dialogue d'administration ODBC syst&egrave;me ou Administrateur de source de donn&eacute;es ODBC.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune. La bo&icirc;te de dialogue d'administration ODBC syst&egrave;me ou Administrateur de source de donn&eacute;es ODBC
appara&icirc;t.
MMDB.showRdsUserDialog()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Affiche la bo&icirc;te de dialogue demandant le nom d'utilisateur et du mot de passe RDS.
Arguments
username, password
• username est le nom d'utilisateur initial.
• password est le mot de passe initial.
Valeurs renvoy&eacute;es
Objet contenant les nouvelles valeurs dans les propri&eacute;t&eacute;s username et password. Si l'une des propri&eacute;t&eacute;s n'est pas
d&eacute;finie, ceci indique que l'utilisateur a annul&eacute; la bo&icirc;te de dialogue.
Derni&egrave;re mise &agrave; jour le 22/6/2011
67
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
MMDB.showRestrictDialog()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Affiche la bo&icirc;te de dialogue Restreindre.
Arguments
catalog, schema
• catalog est la valeur de catalogue initiale.
• L'argument schema est la valeur de sch&eacute;ma initiale.
Valeurs renvoy&eacute;es
Objet contenant les nouvelles valeurs dans les propri&eacute;t&eacute;s catalog et schema. Si l'une des propri&eacute;t&eacute;s n'est pas d&eacute;finie,
ceci indique que l'utilisateur a annul&eacute; la bo&icirc;te de dialogue.
MMDB.testConnection()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Teste les param&egrave;tres de connexion. Affiche une bo&icirc;te de dialogue modale qui d&eacute;crit les r&eacute;sultats.
Arguments
serverPropertiesArray
Cette fonction attend un seul argument, un objet de tableau contenant les valeurs de la liste suivante adapt&eacute;es au
mod&egrave;le de serveur en cours. Pour les propri&eacute;t&eacute;s qui ne s'appliquent pas &agrave; la connexion test&eacute;e, laissez-les vides (&quot;&quot;).
• type indique, lorsque useHTTP est une valeur false, quelle DLL utiliser pour se connecter &agrave; une base de donn&eacute;es
au moment de la conception, pour tester les param&egrave;tres de connexion.
• string est la cha&icirc;ne de connexion ADO ou l'URL JDBC.
• dsn est le nom de la source de donn&eacute;es.
• driver est le pilote JDBC.
• username est le nom d'utilisateur.
• L'argument password est le mot de passe.
• L'argument useHTTP est une valeur bool&eacute;enne. Une valeur true sp&eacute;cifie que Dreamweaver doit utiliser une
connexion HTTP au moment de la conception ; dans le cas contraire, Dreamweaver utilise une DLL.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le test de connexion est r&eacute;ussi, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
68
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Fonctions d'acc&egrave;s &agrave; la base de donn&eacute;es
Les fonctions d'acc&egrave;s &agrave; la base de donn&eacute;es vous permettent de faire une recherche dans la base de donn&eacute;es.
L'acc&egrave;s aux informations de base de donn&eacute;es permet par exemple d'extraire les m&eacute;tadonn&eacute;es qui d&eacute;crivent le sch&eacute;ma
ou la structure d'une base de donn&eacute;es. Ces m&eacute;tadonn&eacute;es incluent des informations telles que les noms des tables, des
colonnes, des proc&eacute;dures stock&eacute;es et des affichages. Vous pouvez &eacute;galement afficher les r&eacute;sultats de l'ex&eacute;cution d'une
requ&ecirc;te de base de donn&eacute;es ou d'une proc&eacute;dure stock&eacute;e. Lorsque vous acc&eacute;dez &agrave; une base de donn&eacute;es par le biais de
cette API, vous utilisez des instructions SQL (Structured Query Language).
Pour l'ensemble des fonctions qui g&egrave;rent une connexion &agrave; une base de donn&eacute;es, voir &laquo; Fonctions de connexion &agrave; une
base de donn&eacute;es &raquo; &agrave; la page 56.
La liste suivante d&eacute;crit certains des arguments communs &agrave; toutes les fonctions disponibles :
• La plupart des fonctions d'acc&egrave;s &agrave; une base de donn&eacute;es utilisent un nom de connexion comme argument. Pour
obtenir une liste des noms de connexion valides, utilisez le Gestionnaire de connexions ou la fonction
MMDB.getConnectionList(). Cette derni&egrave;re vous permet d'obtenir par programmation une liste de tous les noms
de connexion.
• Les proc&eacute;dures stock&eacute;es exigent souvent des param&egrave;tres. Vous pouvez sp&eacute;cifier des valeurs de param&egrave;tre pour les
fonctions d'acc&egrave;s &agrave; la base de donn&eacute;es de deux fa&ccedil;ons. En premier lieu, vous pouvez fournir un tableau de valeurs
de param&egrave;tre (paramValuesArray). Si vous ne sp&eacute;cifiez que des valeurs de param&egrave;tre, celles-ci doivent &ecirc;tre dans
l'ordre dans lequel la proc&eacute;dure stock&eacute;e les demande. Sp&eacute;cifiez ensuite les valeurs de param&egrave;tre pour fournir un
tableau des noms de param&egrave;tre (paramNameArray). Vous pouvez utiliser la fonction
MMDB.getSPParamsAsString() pour obtenir les param&egrave;tres de la proc&eacute;dure stock&eacute;e. Si vous fournissez des noms
de param&egrave;tres, les valeurs sp&eacute;cifi&eacute;es dans paramValuesArray doivent &ecirc;tre dans l'ordre dans lequel les noms ont &eacute;t&eacute;
sp&eacute;cifi&eacute;s dans paramNameArray.
MMDB.getColumnAndTypeList()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Cette fonction extrait une liste de colonnes et leurs types respectifs d'une d&eacute;claration SQL SELECT ex&eacute;cut&eacute;e.
Arguments
connName, d&eacute;claration
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
• L'argument statement est la d&eacute;claration SQL SELECT &agrave; ex&eacute;cuter.
Valeurs renvoy&eacute;es
Un tableau de cha&icirc;nes qui repr&eacute;sente une liste de colonnes (et leur type) qui correspondent &agrave; la d&eacute;claration SELECT,
ou bien une erreur si la d&eacute;claration SQL n'est pas valide ou si la connexion n'a pas pu s'&eacute;tablir.
Derni&egrave;re mise &agrave; jour le 22/6/2011
69
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Exemple
Le code var columnArray = MMDB.getColumnAndTypeList(&quot;EmpDB&quot;,&quot;Select * from Employees&quot;) renvoie le
tableau de cha&icirc;nes suivant :
columnArray[0]
columnArray[1]
columnArray[2]
columnArray[3]
columnArray[4]
columnArray[5]
=
=
=
=
=
=
&quot;EmpName&quot;
&quot;varchar&quot;
&quot;EmpFirstName&quot;
&quot;varchar&quot;
&quot;Age&quot;
&quot;integer&quot;
MMDB.getColumnList()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Cette fonction extrait la liste de colonnes d'une d&eacute;claration SQL SELECT ex&eacute;cut&eacute;e.
Arguments
connName, d&eacute;claration
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
• L'argument statement est la d&eacute;claration SQL SELECT &agrave; ex&eacute;cuter.
Valeurs renvoy&eacute;es
Un tableau de cha&icirc;nes qui repr&eacute;sente une liste de colonnes correspondant &agrave; la d&eacute;claration SELECT, ou une erreur si la
d&eacute;claration SQL n'est pas valide ou si la connexion n'a pas pu s'&eacute;tablir.
Exemple
Le code var columnArray = MMDB.getColumnList(&quot;EmpDB&quot;,&quot;Select * from Employees&quot;) renvoie le tableau
de cha&icirc;nes suivant :
columnArray[0] = &quot;EmpName&quot;
columnArray[1] = &quot;EmpFirstName&quot;
columnArray[2] = &quot;Age&quot;
MMDB.getColumns()
Disponibilit&eacute;
Dreamweaver MX, arguments mis &agrave; jour dans MX 2004.
Description
Renvoie un tableau d'objets qui d&eacute;crivent les colonnes de la table sp&eacute;cifi&eacute;e.
Derni&egrave;re mise &agrave; jour le 22/6/2011
70
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Arguments
connName, tableName
• L'argument connName est le nom de la connexion. Cette valeur identifie la connexion qui contient la cha&icirc;ne que
Dreamweaver doit utiliser pour &eacute;tablir une connexion de base de donn&eacute;es &agrave; une source de donn&eacute;es active.
• tableName est la table &agrave; interroger.
Valeurs renvoy&eacute;es
Un tableau d'objets, &agrave; raison d'un objet par colonne. Chaque objet d&eacute;finit les trois propri&eacute;t&eacute;s suivantes pour la colonne
&agrave; laquelle il est associ&eacute;.
Nom de propri&eacute;t&eacute;
Description
name
Nom de la colonne (par exemple, price)
datatype
Type de donn&eacute;es de la colonne (par exemple, small money)
definedsize
Taille d&eacute;finie de la colonne (par exemple, 8)
nullable
Indique si la colonne peut contenir des valeurs null
Exemple
L'exemple suivant utilise MMDB.getColumns() pour d&eacute;finir la valeur du texte de l'infobulle :
var columnNameObjs = MMDB.getColumns(connName,tableName);
var databaseType = MMDB.getDatabaseType(connName);
for (i = 0; i &lt; columnNameObjs.length; i++)
{
var columnObj = columnNameObjs[i];
var columnName = columnObj.name;
var typename = columnObj.datatype;
if (dwscripts.isNumber(typename))
{
// it already is a num
typename = dwscripts.getDBColumnTypeAsString(typename, databaseType);
}
var tooltiptext = typename;
}
MMDB.getColumnsOfTable()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Cette fonction extrait une liste de toutes les colonnes de la table sp&eacute;cifi&eacute;e.
Arguments
connName, tableName
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
• L'argument tableName est le nom d'une table de la base de donn&eacute;es d&eacute;sign&eacute;e par l'argument connName.
Derni&egrave;re mise &agrave; jour le 22/6/2011
71
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Valeurs renvoy&eacute;es
Un tableau de cha&icirc;nes dont chaque cha&icirc;ne est le nom d'une colonne de la table.
Exemple
L'instruction MMDB.getColumnsOfTable (&quot;EmpDB&quot;,&quot;Employees&quot;); renvoie les cha&icirc;nes suivantes :
[&quot;EmpID&quot;, &quot;FirstName&quot;, &quot;LastName&quot;]
MMDB.getPrimaryKeys()
Disponibilit&eacute;
Dreamweaver MX.
Description
Renvoie les noms de colonne qui s'associent pour former la cl&eacute; primaire de la table nomm&eacute;e. Une cl&eacute; primaire sert
d'identificateur unique pour une ligne de base de donn&eacute;es et se compose d'une colonne minimum.
Arguments
connName, tableName
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
• L'argument tableName est le nom de la table pour laquelle vous souhaitez restituer l'ensemble des colonnes
comprenant la cl&eacute; primaire de cette table.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes. Le tableau contient une cha&icirc;ne pour chaque colonne comprenant la cl&eacute; primaire.
Exemple
L'exemple suivant renvoie la cl&eacute; primaire de la table sp&eacute;cifi&eacute;e.
var connName
var tableName
var primaryKeys
= componentRec.parent.parent.parent.name;
= componentRec.name;
= MMDB.getPrimaryKeys(connName,tableName);
MMDB.getProcedures()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction renvoie un tableau d'objets de proc&eacute;dure associ&eacute;s &agrave; une connexion nomm&eacute;e.
Arguments
connName
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
Derni&egrave;re mise &agrave; jour le 22/6/2011
72
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Valeurs renvoy&eacute;es
Un tableau d'objets de proc&eacute;dure dans lequel chaque objet de proc&eacute;dure a les trois propri&eacute;t&eacute;s suivantes :
Nom de propri&eacute;t&eacute;
Description
schema
Nom du sch&eacute;ma associ&eacute; &agrave; l'objet.
Cette propri&eacute;t&eacute; identifie l'utilisateur associ&eacute; &agrave; la proc&eacute;dure stock&eacute;e dans la base de donn&eacute;es SQL et &agrave; laquelle
acc&egrave;de la fonction getProcedures(). La base de donn&eacute;es &agrave; laquelle acc&egrave;de cette fonction d&eacute;pend du type
de connexion.
catalog
•
Pour les connexions ODBC, la source de donn&eacute;es ODBC d&eacute;finit la base de donn&eacute;es. Le DSN est sp&eacute;cifi&eacute; par
la propri&eacute;t&eacute; dsn dans l'objet de connexion (connName) que vous transmettez &agrave; la fonction
getProcedures().
•
Pour les connexion &agrave; la BD OLE, la cha&icirc;ne de connexion donne un nom &agrave; la base de donn&eacute;es.
Nom du catalogue associ&eacute; &agrave; l'objet (qualificatif de propri&eacute;taire).
La valeur de la propri&eacute;t&eacute; catalog est d&eacute;finie par un attribut du pilote de la BD OLE. Cet attribut du pilote
d&eacute;finit une propri&eacute;t&eacute; user.database par d&eacute;faut &agrave; utiliser lorsque la cha&icirc;ne de connexion &agrave; la BD OLE
n'indique pas de base de donn&eacute;es.
procedure
Nom de la proc&eacute;dure.
Remarque : Dreamweaver se connecte &agrave; la base de donn&eacute;es et en extrait toutes les tables chaque fois que vous modifiez
un jeu d'enregistrements. Si la base de donn&eacute;es contient de nombreuses tables, la proc&eacute;dure de leur extraction par
Dreamweaver sur certains syst&egrave;mes peut prendre beaucoup de temps. Si votre base de donn&eacute;es contient un sch&eacute;ma ou un
catalogue, vous pouvez l'utiliser pour limiter le nombre d'&eacute;l&eacute;ments de base de donn&eacute;es que Dreamweaver r&eacute;cup&egrave;re au
moment de la conception. Pour commencer, cr&eacute;ez un sch&eacute;ma ou un catalogue dans votre application de base de donn&eacute;es
de fa&ccedil;on &agrave; pouvoir ensuite l'appliquer dans Dreamweaver. Consultez la documentation de votre syst&egrave;me de base de
donn&eacute;es ou consultez votre administrateur syst&egrave;me.
Exemple
Le code suivant extrait une liste de proc&eacute;dures :
var procObjects = MMDB.getProcedures(connectionName);
for (i = 0; i &lt; procObjects.length; i++)
{
var thisProcedure = procObjects[i]
thisSchema =Trim(thisProcedure.schema)
if (thisSchema.length == 0)
{
thisSchema = Trim(thisProcedure.catalog)
}
if (thisSchema.length &gt; 0)
{
thisSchema += &quot;.&quot;
}
var procName = String(thisSchema + thisProcedure.procedure);
}
MMDB.getSPColumnList()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Derni&egrave;re mise &agrave; jour le 22/6/2011
73
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Description
Cette fonction extrait une liste de colonnes de jeu de r&eacute;sultats g&eacute;n&eacute;r&eacute;es par un appel &agrave; la proc&eacute;dure stock&eacute;e sp&eacute;cifi&eacute;e.
Arguments
connName, statement, paramValuesArray
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
• L'argument statement est le nom de la proc&eacute;dure stock&eacute;e qui renvoie le jeu de r&eacute;sultats lorsqu'elle est ex&eacute;cut&eacute;e.
• L'argument paramValuesArray est un tableau contenant une liste de valeurs tests de param&egrave;tre au moment de la
conception. Sp&eacute;cifiez les valeurs de param&egrave;tre dans l'ordre attendu par la proc&eacute;dure stock&eacute;e. Vous pouvez utiliser
la fonction MMDB.getSPParamsAsString() pour obtenir les param&egrave;tres de la proc&eacute;dure stock&eacute;e.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes repr&eacute;sentant la liste des colonnes. Cette fonction renvoie une erreur lorsque l'instruction SQL ou
la cha&icirc;ne de connexion est incorrecte.
Exemple
Le code suivant peut renvoyer une liste de colonnes de jeux de r&eacute;sultats g&eacute;n&eacute;r&eacute;es &agrave; partir de la proc&eacute;dure stock&eacute;e
ex&eacute;cut&eacute;e, getNewEmployeesMakingAtLeast :
var paramValueArray = new Array(&quot;2/1/2000&quot;, &quot;50000&quot;)
var columnArray = MMDB.getSPColumnList(&quot;EmpDB&quot;, &not;
&quot;getNewEmployeesMakingAtLeast&quot;, paramValueArray)
The following values return:
columnArray[0] = &quot;EmpID&quot;, columnArray[1] = &quot;LastName&quot;, &not;
columnArray[2] =&quot;startDate&quot;, columnArray[3] = &quot;salary&quot;
MMDB.getSPColumnListNamedParams()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Cette fonction extrait une liste de colonnes de jeu de r&eacute;sultats g&eacute;n&eacute;r&eacute;es par un appel &agrave; la proc&eacute;dure stock&eacute;e sp&eacute;cifi&eacute;e.
Arguments
connName, statement, paramNameArray, paramValuesArray
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
• L'argument statement est le nom de la proc&eacute;dure stock&eacute;e qui renvoie le jeu de r&eacute;sultats lorsqu'elle est ex&eacute;cut&eacute;e.
• L'argument paramNameArray est un tableau contenant une liste de noms de param&egrave;tres. Vous pouvez utiliser la
fonction MMDB.getSPParamsAsString() pour obtenir les param&egrave;tres de la proc&eacute;dure stock&eacute;e.
Derni&egrave;re mise &agrave; jour le 22/6/2011
74
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
• L'argument paramValuesArray est un tableau contenant une liste de valeurs tests de param&egrave;tre au moment de la
conception. Vous pouvez sp&eacute;cifier si oui ou non la proc&eacute;dure requiert des param&egrave;tres pendant l'ex&eacute;cution. Si vous
avez fourni des noms de param&egrave;tre dans paramNameArray, sp&eacute;cifiez les valeurs de param&egrave;tre dans l'ordre dans
lequel leurs noms apparaissent dans paramNameArray. Si vous n'avez pas indiqu&eacute; paramNameArray, sp&eacute;cifiez les
valeurs dans l'ordre attendu par la proc&eacute;dure stock&eacute;e.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes repr&eacute;sentant la liste des colonnes. Cette fonction renvoie une erreur lorsque l'instruction SQL ou
la cha&icirc;ne de connexion est incorrecte.
Exemple
Le code suivant peut renvoyer une liste de colonnes de jeux de r&eacute;sultats g&eacute;n&eacute;r&eacute;es &agrave; partir de la proc&eacute;dure stock&eacute;e
ex&eacute;cut&eacute;e, getNewEmployeesMakingAtLeast :
var paramNameArray = new Array(&quot;startDate&quot;, &quot;salary&quot;)
var paramValueArray = new Array(&quot;2/1/2000&quot;, &quot;50000&quot;)
var columnArray = MMDB.getSPColumnListNamedParams(&quot;EmpDB&quot;, &not;
&quot;getNewEmployeesMakingAtLeast&quot;, paramNameArray, paramValueArray)
Les valeurs suivantes sont retourn&eacute;es :
columnArray[0] = &quot;EmpID&quot;, columnArray[1] = &quot;LastName&quot;,&not;
columnArray[2] =&quot;startDate&quot;, columnArray[3] = &quot;salary&quot;
MMDB.getSPParameters()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction renvoie un tableau d'objets de param&egrave;tre pour une proc&eacute;dure nomm&eacute;e.
Arguments
connName, procName
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
• L'argument procName est le nom de la proc&eacute;dure.
Valeurs renvoy&eacute;es
Tableau d'objets de param&egrave;tre, chacun d'entre eux sp&eacute;cifiant l'ensemble de propri&eacute;t&eacute;s suivant :
Derni&egrave;re mise &agrave; jour le 22/6/2011
75
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Nom de la propri&eacute;t&eacute;
Description
name
Nom du param&egrave;tre (par exemple, @@lolimit)
datatype
Type de donn&eacute;es du param&egrave;tre (par exemple, smallmoney)
direction
Direction du param&egrave;tre :
1 : Le param&egrave;tre est utilis&eacute; uniquement pour l'entr&eacute;e.
2 : Le param&egrave;tre est utilis&eacute; uniquement pour la sortie. Dans ce cas, vous transmettez le param&egrave;tre
par r&eacute;f&eacute;rence et la m&eacute;thode place une valeur dedans. Vous pouvez utiliser la valeur une fois la
m&eacute;thode renvoy&eacute;e.
3 : Le param&egrave;tre est utilis&eacute; pour l'entr&eacute;e et la sortie.
4 : Le param&egrave;tre contient une valeur de retour.
Exemple
L'exemple suivant extrait les objets de param&egrave;tre pour la proc&eacute;dure sp&eacute;cifi&eacute;e et cr&eacute;e une infobulle pour chaque objet
qui utilise ses propri&eacute;t&eacute;s.
var paramNameObjs = MMDB.getSPParameters(connName,procName);
for (i = 0; i &lt; paramNameObjs.length; i++)
{
var paramObj = paramNameObjs[i];
var tooltiptext = paramObj.datatype;
tooltiptext+=&quot; &quot;;
tooltiptext+=GetDirString(paramObj.directiontype);
}
MMDB.getSPParamsAsString()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Cette fonction extrait une cha&icirc;ne d&eacute;limit&eacute;e par des virgules et contenant la liste des param&egrave;tres pris par la proc&eacute;dure
stock&eacute;e.
Arguments
connName, procName
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
• L'argument procName est le nom de la proc&eacute;dure stock&eacute;e.
Valeurs renvoy&eacute;es
Cha&icirc;ne d&eacute;limit&eacute;e par virgules contenant la liste des param&egrave;tres requis par la proc&eacute;dure stock&eacute;e. Les noms, la direction
et le type de donn&eacute;es des param&egrave;tres sont inclus, s&eacute;par&eacute;s par des points-virgules (;).
Exemple
Le code MMDB.getSPParamsAsString (&quot;EmpDB&quot;,&quot;getNewEmployeesMakingAtLeast&quot;) peut renvoyer une cha&icirc;ne
de nom de formulaire startDate;direction:in;datatype:date, salary;direction:in;datatype:integer.
Derni&egrave;re mise &agrave; jour le 22/6/2011
76
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Dans cet exemple, la proc&eacute;dure stock&eacute;e getNewEmployeesMakingAtLeast a deux param&egrave;tres: startDate et Salary.
Pour startDate, la direction est in et le type de donn&eacute;es est date. Pour salary, la direction est in et le type de
donn&eacute;es est date.
MMDB.getTables()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Extrait une liste de toutes les tables d&eacute;finies pour la base de donn&eacute;es sp&eacute;cifi&eacute;e. Chaque objet de table poss&egrave;de trois
propri&eacute;t&eacute;s : table, schema et catalog.
Arguments
connName
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
Valeurs renvoy&eacute;es
Tableau d'objets poss&eacute;dant chacun trois propri&eacute;t&eacute;s : table, schema et catalog. Table est le nom de la table. Schema
est le nom du sch&eacute;ma qui contient la table. Catalog est le catalogue qui contient la table.
Exemple
L'instruction MMDB.getTables (&quot;EmpDB&quot;); pourrait produire un tableau de deux objets. Les propri&eacute;t&eacute;s du premier
objet peuvent ressembler &agrave; l'exemple suivant :
object1[table:&quot;Employees&quot;, schema:&quot;personnel&quot;, catalog:&quot;syscat&quot;]
Les propri&eacute;t&eacute;s du second objet peuvent ressembler &agrave; l'exemple suivant :
object2[table:&quot;Departments&quot;, schema:&quot;demo&quot;, catalog:&quot;syscat2&quot;]
MMDB.getViews()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Extrait une liste de tous les modes d'affichage d&eacute;finis pour la base de donn&eacute;es sp&eacute;cifi&eacute;e. Chaque objet mode d'affichage
a les propri&eacute;t&eacute;s catalog, schema et view.
Arguments
connName
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
Derni&egrave;re mise &agrave; jour le 22/6/2011
77
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Valeurs renvoy&eacute;es
Tableau d'objets de mode poss&eacute;dant chacun trois propri&eacute;t&eacute;s : catalog, schema et view. Catalog ou schema permet
de restreindre/filtrer le nombre de modes d'affichage rattach&eacute;s &agrave; un nom de sch&eacute;ma individuel ou &agrave; un nom de
catalogue d&eacute;fini comme faisant partie des informations de connexion.
Exemple
L'exemple suivant renvoie les modes pour une valeur de connexion donn&eacute;e, CONN_LIST.getValue() :
var viewObjects = MMDB.getViews(CONN_LIST.getValue())
for (i = 0; i &lt; viewObjects.length; i++)
{
thisView = viewObjects[i]
thisSchema = Trim(thisView.schema)
if (thisSchema.length == 0)
{
thisSchema = Trim(thisView.catalog)
}
if (thisSchema.length &gt; 0)
{
thisSchema += &quot;.&quot;
}
views.push(String(thisSchema + thisView.view))
}
MMDB.showResultset()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Affiche une bo&icirc;te de dialogue contenant les r&eacute;sultats de l'ex&eacute;cution de la d&eacute;claration SQL sp&eacute;cifi&eacute;e. La bo&icirc;te de dialogue
contient une grille dont l'en-t&ecirc;te refl&egrave;te les informations de colonnes qui d&eacute;crivent le jeu de r&eacute;sultats. Si la cha&icirc;ne de
connexion ou l'instruction SQL n'est pas valide, une erreur appara&icirc;t. Cette fonction valide l'instruction SQL.
Arguments
connName, SQLstatement
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
• L'argument SQLstatement d&eacute;signe l'instruction SQL SELECT.
Valeurs renvoy&eacute;es
Aucune. Cette fonction renvoie une erreur lorsque l'instruction SQL ou la cha&icirc;ne de connexion est incorrecte.
Exemple
Le code suivant affiche le r&eacute;sultat de l'instruction SQL ex&eacute;cut&eacute;e :
MMDB.showResultset(&quot;EmpDB&quot;,&quot;Select EmpName,EmpFirstName,Age &not;
from Employees&quot;)
Derni&egrave;re mise &agrave; jour le 22/6/2011
78
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
MMDB.showSPResultset()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Affiche une bo&icirc;te de dialogue contenant les r&eacute;sultats de l'ex&eacute;cution de la proc&eacute;dure stock&eacute;e sp&eacute;cifi&eacute;e. La bo&icirc;te de
dialogue contient une grille dont l'en-t&ecirc;te refl&egrave;te les informations de colonne qui d&eacute;crivent le jeu de r&eacute;sultats. Si la
cha&icirc;ne de connexion ou la proc&eacute;dure stock&eacute;e n'est pas valide, une erreur appara&icirc;t. Cette fonction valide la proc&eacute;dure
stock&eacute;e.
Arguments
connName, procName, paramValuesArray
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
• L'argument procName est le nom de la proc&eacute;dure stock&eacute;e &agrave; ex&eacute;cuter.
• L'argument paramValuesArray est un tableau contenant une liste de valeurs tests de param&egrave;tre au moment de la
conception. Sp&eacute;cifiez les valeurs de param&egrave;tre dans l'ordre attendu par la proc&eacute;dure stock&eacute;e. Vous pouvez utiliser
la fonction MMDB.getSPParamsAsString() pour obtenir les param&egrave;tres de la proc&eacute;dure stock&eacute;e.
Valeurs renvoy&eacute;es
Cette fonction renvoie une erreur lorsque l'instruction SQL ou la cha&icirc;ne de connexion est incorrecte, sinon, elle ne
renvoie rien.
Exemple
Le code suivant affiche le r&eacute;sultat de la proc&eacute;dure stock&eacute;e ex&eacute;cut&eacute;e :
var paramValueArray = new Array(&quot;2/1/2000&quot;, &quot;50000&quot;)
MMDB.showSPResultset(&quot;EmpDB&quot;, &quot;getNewEmployeesMakingAtLeast&quot;, &not;
paramValueArray)
MMDB.showSPResultsetNamedParams()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Affiche une bo&icirc;te de dialogue contenant le jeu de r&eacute;sultats de la proc&eacute;dure stock&eacute;e sp&eacute;cifi&eacute;e. La bo&icirc;te de dialogue
contient une grille dont l'en-t&ecirc;te refl&egrave;te les informations de colonne qui d&eacute;crivent le jeu de r&eacute;sultats. Si la cha&icirc;ne de
connexion ou la proc&eacute;dure stock&eacute;e n'est pas valide, une erreur appara&icirc;t. Cette fonction valide la proc&eacute;dure stock&eacute;e.
Cette fonction diff&egrave;re de MMDB.showSPResultset(), car vous pouvez sp&eacute;cifier les valeurs de param&egrave;tre par leur nom,
au lieu de l'ordre attendu par la proc&eacute;dure stock&eacute;e.
Derni&egrave;re mise &agrave; jour le 22/6/2011
79
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de base de donn&eacute;es
Arguments
connName, procName, paramNameArray, paramValuesArray
• connName est un nom de connexion sp&eacute;cifi&eacute; dans le Gestionnaire de connexions. Il identifie la cha&icirc;ne de connexion
que Dreamweaver doit utiliser pour connecter la base de donn&eacute;es &agrave; une source de donn&eacute;es active.
• L'argument procName est le nom de la proc&eacute;dure stock&eacute;e qui renvoie le jeu de r&eacute;sultats lorsqu'elle est ex&eacute;cut&eacute;e.
• L'argument paramNameArray est un tableau contenant une liste de noms de param&egrave;tres. Vous pouvez utiliser la
fonction MMDB.getSPParamsAsString() pour obtenir les param&egrave;tres de la proc&eacute;dure stock&eacute;e.
• L'argument paramValuesArray est un tableau contenant une liste de valeurs tests de param&egrave;tre au moment de la
conception.
Valeurs renvoy&eacute;es
Cette fonction renvoie une erreur lorsque l'instruction SQL ou la cha&icirc;ne de connexion est incorrecte, sinon, elle ne
renvoie rien.
Exemple
Le code suivant affiche le r&eacute;sultat de la proc&eacute;dure stock&eacute;e ex&eacute;cut&eacute;e :
var paramNameArray = new Array(&quot;startDate&quot;, &quot;salary&quot;)
var paramValueArray = new Array(&quot;2/1/2000&quot;, &quot;50000&quot;)
MMDB.showSPResultsetNamedParams(&quot;EmpDB&quot;,&quot;getNewEmployees&not;
MakingAtLeast&quot;, paramNameArray, paramValueArray)
Derni&egrave;re mise &agrave; jour le 22/6/2011
80
Chapitre 9 : API de connectivit&eacute; &agrave; une base
de donn&eacute;es
En tant que d&eacute;veloppeur, vous pouvez cr&eacute;er de nouveaux types de connexion et les bo&icirc;tes de dialogue correspondantes
pour les mod&egrave;les de serveur nouveaux et existants d'Adobe&reg; Dreamweaver&reg;. L'utilisateur peut ensuite cr&eacute;er un objet de
connexion lors de la configuration d'un site afin d'entamer la cr&eacute;ation de pages. Pour cr&eacute;er un objet de connexion,
l'utilisateur doit tout d'abord s&eacute;lectionner le type de connexion sp&eacute;cifique que vous avez cr&eacute;&eacute;.
S&eacute;lection d'un nouveau type de connexion
L'utilisateur peut s&eacute;lectionner votre nouveau type de connexion de plusieurs mani&egrave;res :
• Dans le panneau Application, l'utilisateur peut cliquer sur le bouton Plus (+) et s&eacute;lectionner Jeu d'enregistrements.
Dans la bo&icirc;te de dialogue Jeu d'enregistrements, il peut agrandir la fen&ecirc;tre de la liste Connexion.
• Il peut cliquer sur le bouton Plus (+) et s&eacute;lectionner Nom de la source de donn&eacute;es dans l'onglet Base de donn&eacute;es du
panneau Bases de donn&eacute;es.
Cr&eacute;ation d'un nouveau type de connexion
Les &eacute;tapes suivantes expliquent le processus de cr&eacute;ation d'un nouveau type de connexion :
1 D&eacute;finissez la mise en forme de la bo&icirc;te de dialogue de connexion.
Cr&eacute;ez un fichier HTML mettant en forme l'interface utilisateur de votre bo&icirc;te de dialogue de connexion. Donnez
un nom &agrave; ce fichier en utilisant le nom de la connexion (par exemple myConnection.htm). Pour plus
d'informations sur la cr&eacute;ation d'une bo&icirc;te de dialogue, voir Prise en main de Dreamweaver.
Assurez-vous que ce fichier HTML contient bien une r&eacute;f&eacute;rence au fichier de mise en œuvre JavaScript d&eacute;fini &agrave;
l'&eacute;tape 2, Cr&eacute;ez un fichier JavaScript mettant en œuvre au moins les &eacute;l&eacute;ments suivants, comme le montre l'exemple
suivant :
&lt;head&gt;
&lt;script SRC=&quot;../myConnectionImpl.js&quot;&gt;&lt;/script&gt;
&lt;/head&gt;
Stockez ce fichier HTML, qui d&eacute;finit votre bo&icirc;te de dialogue de connexion, dans le dossier
Configuration/Connections/mod&egrave;le_serveur/plate-forme (o&ugrave; la plate-forme est Windows ou Macintosh).
Par exemple, la bo&icirc;te de dialogue de connexion ADO par d&eacute;faut pour un document ASP JavaScript sur une plateforme Windows est stock&eacute;e dans le dossier ASP_Js/Win et est intitul&eacute;e Connection_ado_conn_string.htm.
Remarque : Pendant l'ex&eacute;cution, Dreamweaver &eacute;tablit de mani&egrave;re dynamique la liste des types de connexion
disponibles dans l'ensemble des bo&icirc;tes de dialogue pr&eacute;sentes dans le dossier ASP_Js/Win.
Le dossier Configuration/ServerModels contient des fichiers HTML qui d&eacute;finissent chaque mod&egrave;le de serveur.
Chaque fichier HTML contient la fonction getServerModelFolderName() qui renvoie le nom du dossier associ&eacute;
au mod&egrave;le de serveur. L'exemple suivant indique la fonction pour le type de document ASP JavaScript :
Derni&egrave;re mise &agrave; jour le 22/6/2011
81
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de connectivit&eacute; &agrave; une base de donn&eacute;es
function getServerModelFolderName()
{
return &quot;ASP_JS&quot;;
}
Vous pouvez &eacute;galement consulter le fichier MMDocumentTypes.xml, situ&eacute; dans le dossier
Configuration/DocumentTypes, pour d&eacute;terminer la correspondance entre les mod&egrave;les de serveur et les types de
documents.
2 Cr&eacute;ez un fichier JavaScript qui impl&eacute;mente au moins les &eacute;l&eacute;ments suivants :
El&eacute;ment
Description
Exemples
Un ensemble de variables
Chaque variable d&eacute;finit une propri&eacute;t&eacute; de
connexion sp&eacute;cifique.
Type de connexion, nom de la source de
donn&eacute;es, etc.
Un ensemble de boutons
Tous les boutons apparaissent dans la bo&icirc;te de
dialogue de connexion.
Tester, Aide, etc. (OK et Annuler sont
automatiquement inclus)
Fonctions de connectivit&eacute;
Ensemble, ces fonctions d&eacute;finissent l'API de
connectivit&eacute;.
•
findConnection()
•
applyConnection()
•
inspectConnection()
Vous pouvez choisir n'importe quel nom pour ce fichier de mise en œuvre, mais il doit comporter une extension
.js (par exemple, myConnectionImpl.js). Vous pouvez stocker ce fichier de mise en œuvre sur votre ordinateur local
ou distant. Si vous le souhaitez, vous pouvez &eacute;galement le stocker dans le sous-dossier appropri&eacute; du dossier
Configuration/Connections.
Remarque : Le fichier HTML d&eacute;fini &agrave; l'&eacute;tape 1, D&eacute;finissez la mise en forme de la bo&icirc;te de dialogue de connexion, doit
contenir ce fichier de mise en œuvre du type de connexion.
Ces deux &eacute;tapes constituent les conditions minimales pour cr&eacute;er une nouvelle bo&icirc;te de dialogue de connexion, sauf si
vous avez besoin de d&eacute;finir des param&egrave;tres de connexion autres que ceux fournis dans le fichier standard
connection_includefile.edml.
Remarque : Le titre de la bo&icirc;te de dialogue que voit l'utilisateur se trouve dans la balise title, sp&eacute;cifi&eacute;e dans le
document HTML.
Les fonctions r&eacute;pertori&eacute;es dans la section suivante permettent de cr&eacute;er une bo&icirc;te de dialogue de connexion. En plus
d'impl&eacute;menter les appels pour la g&eacute;n&eacute;ration des fichiers inclus r&eacute;serv&eacute;s &agrave; l'utilisateur, vous pouvez enregistrer votre
type de connectivit&eacute; dans la section du mod&egrave;le de serveur du fichier XML de connexion.
Pour plus d'informations sur l'API de connectivit&eacute; &agrave; une base de donn&eacute;es, associ&eacute;e &agrave; la cr&eacute;ation d'une nouvelle
connexion, voir &laquo; Fonctions de connexion &agrave; une base de donn&eacute;es &raquo; &agrave; la page 56.
L'API de connexion
Pour cr&eacute;er un nouveau type de connexion, y compris la bo&icirc;te de dialogue avec laquelle les utilisateurs interagissent,
vous devez impl&eacute;menter les trois fonctions suivantes : findConnection(), inspectConnection() et
applyConnection(). Vous devez r&eacute;diger ces trois fonctions et les inclure dans le fichier de mise en œuvre JavaScript
associ&eacute; &agrave; votre nouveau type de connexion (voir Etape 2, Cr&eacute;ez un fichier JavaScript qui impl&eacute;mente au moins les
&eacute;l&eacute;ments suivants).
Derni&egrave;re mise &agrave; jour le 22/6/2011
82
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de connectivit&eacute; &agrave; une base de donn&eacute;es
La fonction applyConnection() renvoie une source HTML dans un fichier inclus. Vous trouverez des exemples de
source HTML dans la section &laquo; Fichier inclus g&eacute;n&eacute;r&eacute; &raquo; &agrave; la page 84. La fonction findConnection() prend la source
HTML et en extrait les propri&eacute;t&eacute;s. Vous pouvez mettre en œuvre findConnection() pour utiliser les mod&egrave;les de
recherche dans les fichiers XML afin d'extraire les informations renvoy&eacute;es &agrave; partir de applyConnection(). Si vous
souhaitez voir un exemple de ce type de mise en œuvre, &eacute;tudiez les deux fichiers JavaScript suivants :
• Le fichier connection_ado_conn_string.js se trouve dans le dossier Configuration/Connections/ASP_Js.
• Le fichier connection_common.js se trouve dans le dossier Configuration/Connections/Shared.
Lorsque l'utilisateur ouvre un site, Dreamweaver parcourt tous les fichiers dans le dossier Connections, les ouvre et
transmet leur contenu &agrave; la fonction findConnection(). Si le contenu d'un fichier correspond aux crit&egrave;res d'une
connexion valide, findConnection() renvoie un objet de connexion. Dreamweaver r&eacute;pertorie ensuite tous les objets
de connexion dans le panneau Explorateur de base de donn&eacute;es.
Lorsque l'utilisateur ouvre une bo&icirc;te de dialogue de connexion et choisit de cr&eacute;er une nouvelle connexion ou de
dupliquer ou encore de modifier une connexion existante, Dreamweaver d&eacute;clenche la fonction
inspectConnection() et retransmet le m&ecirc;me objet de connexion cr&eacute;&eacute; par findConnection(). Ce processus permet
&agrave; Dreamweaver de renseigner la bo&icirc;te de dialogue en utilisant les informations de connexion.
Lorsque l'utilisateur clique sur OK dans une bo&icirc;te de dialogue de connexion, Dreamweaver d&eacute;clenche la fonction
applyConnection() pour construire la page HTML, plac&eacute;e dans le fichier inclus de connexion r&eacute;sidant dans le
dossier Configuration/Connections. La fonction applyConnection() renvoie une cha&icirc;ne vide qui indique une erreur
dans l'un des champs. La bo&icirc;te de dialogue ne doit pas &ecirc;tre ferm&eacute;e. Le fichier inclus a un type d'extension de fichier par
d&eacute;faut pour le mod&egrave;le de serveur en cours.
Lorsque l'utilisateur ajoute &agrave; une page un comportement de serveur qui utilise la connexion, tel qu'un jeu
d'enregistrements ou une proc&eacute;dure stock&eacute;e, Dreamweaver ajoute une instruction &agrave; la page qui comprend le fichier
inclus de connexion.
findConnection()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Dreamweaver appelle cette fonction pour d&eacute;tecter une connexion dans la source HTML sp&eacute;cifi&eacute;e et analyser les
param&egrave;tres de la connexion. Si le contenu de ce fichier source respecte les crit&egrave;res permettant une connexion valide,
findConnection() renvoie un objet de connexion ; dans le cas contraire, cette fonction renvoie une valeur null.
Argument
htmlSource
L'argument htmlSource est la source HTML d'une connexion.
Valeurs renvoy&eacute;es
Objet de connexion qui fournit les valeurs d'une combinaison particuli&egrave;re de propri&eacute;t&eacute;s r&eacute;pertori&eacute;es dans le tableau
suivant. Les propri&eacute;t&eacute;s pour lesquelles cette fonction renvoie une valeur d&eacute;pendent du type de document.
Derni&egrave;re mise &agrave; jour le 22/6/2011
83
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de connectivit&eacute; &agrave; une base de donn&eacute;es
Propri&eacute;t&eacute;
Description
name
Nom de la connexion.
type
Si useHTTP est false, indique quelle DLL doit &ecirc;tre utilis&eacute;e pour la connexion &agrave; des bases de
donn&eacute;es au moment de l'ex&eacute;cution.
string
Cha&icirc;ne de connexion d'ex&eacute;cution. Pour ADO, il s'agit d'une cha&icirc;ne de param&egrave;tres de connexion ;
pour JDBC, il s'agit d'une URL de connexion.
dsn
Nom de la source de donn&eacute;es utilis&eacute; pour les connexions de d'ex&eacute;cution ODBC ou Cold Fusion
driver
Nom d'un pilote JDBC utilis&eacute; pendant l'ex&eacute;cution
username
Nom d'utilisateur employ&eacute; pour la connexion d'ex&eacute;cution.
password
Mot de passe utilis&eacute; pour la connexion d'ex&eacute;cution.
designtimeString
Cha&icirc;ne de connexion au moment de la conception (voir string).
designtimeDsn
Nom de la source de donn&eacute;es au moment de la conception (voir dsn)
designtimeDriver
Nom d'un pilote JDBC utilis&eacute; au moment de la conception
designtimeUsername
Nom de l'utilisateur employ&eacute; pour la connexion au moment de la conception.
designtimePassword
Mot de passe utilis&eacute; pour la connexion au moment de la conception.
designtimeType
Type de connexion utilis&eacute;e au moment de la conception.
usesDesigntimeInfo
En cas de valeur false, Dreamweaver utilise les propri&eacute;t&eacute;s d'ex&eacute;cution au moment de la
conception ; dans le cas contraire, Dreamweaver utilise les propri&eacute;t&eacute;s au moment de la conception.
useHTTP
Cha&icirc;ne contenant true ou false ; true indique d'utiliser la connexion HTTP au moment de la
conception, et false d'utiliser une DLL.
includePattern
Expression r&eacute;guli&egrave;re utilis&eacute;e pour trouver l'instruction d'inclusion de fichier sur la page pendant Live
Data et Aper&ccedil;u dans le navigateur.
variables
Objet ayant une propri&eacute;t&eacute; pour chaque variable de page d&eacute;finie sur sa valeur correspondante. Cet
objet est utilis&eacute; pendant Live Data et Aper&ccedil;u dans le navigateur.
catalog
Cha&icirc;ne contenant un identificateur de base de donn&eacute;es qui restreint la quantit&eacute; de m&eacute;tadonn&eacute;es
qui apparaissent.
schema
Cha&icirc;ne contenant un identificateur de base de donn&eacute;es qui restreint la quantit&eacute; de m&eacute;tadonn&eacute;es
qui apparaissent.
filename
Nom de la bo&icirc;te de dialogue utilis&eacute;e pour cr&eacute;er la connexion.
Si une connexion n'est pas trouv&eacute;e dans htmlSource, une valeur null est renvoy&eacute;e.
Remarque : Les d&eacute;veloppeurs peuvent ajouter des propri&eacute;t&eacute;s personnalis&eacute;es (par exemple, m&eacute;tadonn&eacute;es) &agrave; la source
HTML, qui renvoie applyConnection() avec les propri&eacute;t&eacute;s standard.
inspectConnection()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
84
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de connectivit&eacute; &agrave; une base de donn&eacute;es
Description
Dreamweaver appelle cette fonction pour initialiser les donn&eacute;es de la bo&icirc;te de dialogue pour d&eacute;finir une connexion
lorsque l'utilisateur modifie une connexion existante. Ce processus permet &agrave; Dreamweaver de renseigner la bo&icirc;te de
dialogue en utilisant les informations de connexion appropri&eacute;es.
Argument
param&egrave;tres
L'argument parameters est le m&ecirc;me objet que celui qui est renvoy&eacute; par la fonction findConnection().
Valeurs renvoy&eacute;es
Aucune.
applyConnection()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Dreamweaver d&eacute;clenche cette fonction lorsque l'utilisateur clique sur OK dans la bo&icirc;te de dialogue de connexion. La
fonction applyConnection() g&eacute;n&egrave;re la source HTML pour une connexion. Dreamweaver &eacute;crit le HTML dans le
fichier inclus Configuration/Connections/nom-connexion.ext, o&ugrave; nom-connexion est le nom de votre connexion (voir
&laquo; Cr&eacute;ation d'un nouveau type de connexion &raquo; &agrave; la page 80) et .ext est l'extension par d&eacute;faut associ&eacute;e au mod&egrave;le de
serveur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Source HTML pour une connexion. Dreamweaver ferme &eacute;galement la bo&icirc;te de dialogue de connexion. Si une erreur
de validation d'un champ se produit, applyConnection() affiche un message d'erreur et renvoie une cha&icirc;ne vide pour
indiquer que la bo&icirc;te de dialogue doit rester ouverte.
Fichier inclus g&eacute;n&eacute;r&eacute;
Le fichier inclus que applyConnection() g&eacute;n&egrave;re d&eacute;clare toutes les propri&eacute;t&eacute;s d'une connexion. Le nom du fichier
inclus est le nom de la connexion. Il poss&egrave;de l'extension d&eacute;finie pour le mod&egrave;le de serveur associ&eacute; au site actuel.
Remarque : Les connexions &eacute;tant partag&eacute;es, d&eacute;finissez la valeur allowMultiple sur false. Elle garantit que le fichier
de connexion n'est inclus qu'une fois dans le document. En outre, elle garantit que le script de serveur reste sur la page si
d'autres comportements de serveur l'utilisent.
Vous trouverez quelques exemples de fichiers inclus que applyConnection() g&eacute;n&egrave;re pour divers mod&egrave;les de serveur
par d&eacute;faut illustr&eacute;s dans les sections suivantes.
Remarque : Pour cr&eacute;er un format de fichier inclus de connexion, d&eacute;finissez un nouveau fichier de mappage EDML,
similaire &agrave; connection_includefile.edml, comme l'explique la section &laquo; Fichier de d&eacute;finition pour votre type de
connexion &raquo; &agrave; la page 85.
Derni&egrave;re mise &agrave; jour le 22/6/2011
85
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de connectivit&eacute; &agrave; une base de donn&eacute;es
ASP JavaScript
Le fichier inclus ASP et JavaScript doit &ecirc;tre nomm&eacute; MyConnection1.asp, o&ugrave; MyConnection1 est le nom de la
connexion. L'exemple suivant est un fichier inclus pour une cha&icirc;ne de connexion ADO :
&lt;%
// Filename=&quot;Connection_ado_conn_string.htm&quot;
// Type=&quot;ADO&quot;
// HTTP=&quot;true&quot;
// Catalog=&quot;&quot;
// Schema=&quot;&quot;
var MM_MyConnection1_STRING = &quot;dsn=pubs&quot;;
%&gt;
Le fichier du comportement de serveur inclut cette connexion en utilisant l'instruction d'inclusion de fichier relative,
comme le montre l'exemple suivant :
&lt;!--#include file=&quot;../Connections/MyConnection1.asp&quot;--&gt;
ColdFusion
Lorsque vous utilisez UltraDev 4 ColdFusion, Dreamweaver s'appuie sur un fichier inclus ColdFusion pour extraire
une liste des sources de donn&eacute;es.
Remarque : Avec Dreamweaver ColdFusion standard, Dreamweaver ignore tous les fichiers inclus et utilise les RDS pour
r&eacute;cup&eacute;rer la liste des sources de donn&eacute;es &agrave; partir de ColdFusion.
Le fichier inclus UltraDev 4 ColdFusion doit &ecirc;tre nomm&eacute; MyConnection1.cfm, o&ugrave; MyConnection1 est le nom de votre
connexion. L'exemple suivant illustre le fichier inclus pour une connexion ColdFusion &agrave; un tableau de produits :
&lt;!-- FileName=&quot;Connection_cf_dsn.htm&quot; &quot;dsn=products&quot; --&gt;
&lt;!-- Type=&quot;ADO&quot; --&gt;
&lt;!-- Catalog=&quot;&quot; --&gt;
&lt;!-- Schema=&quot;&quot; --&gt;
&lt;!-- HTTP=&quot;false&quot; --&gt;
&lt;CFSET MM_MyConnection1_DSN
= &quot;products&quot;&gt;
&lt;CFSET MM_MyConnection1_USERNAME
= &quot;&quot;&gt;
&lt;CFSET MM_Product_USERNAME
= &quot;&quot;&gt;
&lt;CFSET MM_MyConnection1_PASSWORD
= &quot;&quot;&gt;
Le fichier du comportement de serveur inclut cette connexion en utilisant l'instruction cfinclude, comme le montre
l'exemple suivant :
&lt;cfinclude template=&quot;Connections/MyConnection1.cfm&quot;&gt;
Fichier de d&eacute;finition pour votre type de connexion
Pour tous les mod&egrave;les de serveur, il existe un fichier connection_includefile.edml qui d&eacute;finit le type de connexion et
associe les propri&eacute;t&eacute;s d&eacute;finies dans le fichier inclus aux &eacute;l&eacute;ments de l'interface Dreamweaver.
Par d&eacute;faut, Dreamweaver fournit des fichiers de d&eacute;finition, un pour chacun des mod&egrave;les de serveur pr&eacute;d&eacute;finis, comme
l'illustre le tableau suivant.
Derni&egrave;re mise &agrave; jour le 22/6/2011
86
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de connectivit&eacute; &agrave; une base de donn&eacute;es
Mod&egrave;le de serveur
Sous-dossier du dossier Configuration/Connections
ASP JavaScript
ASP_Js
ASP.NET CSharp
ASP.NET_Csharp
ASP.NET VBScrip
ASP.NET_VB
ASP VBScript
ASP_Vbs
ColdFusion
ColdFusion
JavaServer Page
JSP
PHP MySql
PHP_MySql
Dreamweaver utilise les param&egrave;tres quickSearch et searchPattern pour reconna&icirc;tre les blocs de connexion et le
param&egrave;tre insertText afin de cr&eacute;er des blocs de connexion. Pour plus d'informations sur les balises et les attributs
EDML et sur les mod&egrave;les de recherche d'expression r&eacute;guli&egrave;re, voir &laquo; Comportements de serveur &raquo; dans Extension de
Dreamweaver.
Remarque : Si vous changez le format de votre fichier inclus ou si vous d&eacute;finissez un fichier inclus pour un nouveau
mod&egrave;le de serveur, vous devez associer les param&egrave;tres de connexion avec l'interface utilisateur de Dreamweaver, Live
Data et Aper&ccedil;u dans le navigateur. L'exemple suivant de fichier EDML, associ&eacute; au mod&egrave;le de serveur ASP JS par d&eacute;faut,
met en correspondance toutes les variables de page de connexion avec leurs valeurs dynamiques respectives avant
d'envoyer la page au serveur. Pour plus d'informations sur EDML et les mod&egrave;les de recherche d'expression r&eacute;guli&egrave;re, voir
&laquo; Comportements de serveur &raquo; dans Extension de Dreamweaver.
Derni&egrave;re mise &agrave; jour le 22/6/2011
87
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API de connectivit&eacute; &agrave; une base de donn&eacute;es
&lt;participant name=&quot;connection_includefile&quot; version=&quot;5.0&quot;&gt;
&lt;quickSearch&gt;
&lt;![CDATA[// HTTP=]]&gt;&lt;/quickSearch&gt;
&lt;insertText location=&quot;&quot;&gt;
&lt;![CDATA[&lt;%
// FileName=&quot;@@filename@@&quot;
// Type=&quot;@@type@@&quot; @@designtimeString@@
// DesigntimeType=&quot;@@designtimeType@@&quot;
// HTTP=&quot;@@http@@&quot;
// Catalog=&quot;@@catalog@@&quot;
// Schema=&quot;@@schema@@&quot;
var MM_@@cname@@_STRING = @@string@@
%&gt;
]]&gt;
&lt;/insertText&gt;
&lt;searchPatterns whereToSearch=&quot;directive&quot;&gt;
&lt;searchPattern paramNames=&quot;filename&quot;&gt;
&lt;![CDATA[/\/\/\s*FileName=&quot;([^&quot;]*)&quot;/]]&gt;&lt;/searchPattern&gt;
&lt;searchPattern paramNames=&quot;type,designtimeString&quot;&gt;
&lt;![CDATA[/\/\/\s+Type=&quot;(\w*)&quot;([^\r\n]*)/]]&gt;&lt;/searchPattern&gt;
&lt;searchPattern paramNames=&quot;designtimeType&quot; isOptional=&quot;true&quot;&gt;
&lt;![CDATA[/\/\/\s*DesigntimeType=&quot;(\w*)&quot;/]]&gt;&lt;/searchPattern&gt;
&lt;searchPattern paramNames=&quot;http&quot;&gt;
&lt;![CDATA[/\/\/\s*HTTP=&quot;(\w+)&quot;/]]&gt;&lt;/searchPattern&gt;
&lt;searchPattern paramNames=&quot;catalog&quot;&gt;
&lt;![CDATA[/\/\/\s*Catalog=&quot;(\w*)&quot;/]]&gt;&lt;/searchPattern&gt;
&lt;searchPattern paramNames=&quot;schema&quot;&gt;
&lt;![CDATA[/\/\/\s*Schema=&quot;(\w*)&quot;/]]&gt;&lt;/searchPattern&gt;
&lt;searchPattern paramNames=&quot;cname,string&quot;&gt;
&lt;![CDATA[/var\s+MM_(\w*)_STRING\s*=\s*([^\r\n]+)/]]&gt;&lt;/searchPattern&gt;
&lt;/searchPatterns&gt;
&lt;/participant&gt;
Les expressions d'un fichier EDML, telles que @@filename@@ dans cet exemple, associent les valeurs du fichier inclus
avec les propri&eacute;t&eacute;s d'un objet de connexion. Les propri&eacute;t&eacute;s des objets de connexion sont d&eacute;finies dans le fichier de mise
en œuvre JavaScript.
Toutes les bo&icirc;tes de dialogue de connexion par d&eacute;faut de Dreamweaver utilisent le fichier de correspondance
connection_includefile.edml. Pour permettre &agrave; Dreamweaver de trouver ce fichier, son nom est d&eacute;fini dans le fichier
de mise en œuvre JavaScript, comme le montre l'exemple suivant :
var PARTICIPANT_FILE = &quot;connection_includefile&quot;;
Lors de la cr&eacute;ation d'un type de connexion personnalis&eacute;e, vous pouvez utiliser n'importe quel fichier de
correspondance dans vos bo&icirc;tes de dialogue personnalis&eacute;es. Si vous cr&eacute;ez un fichier de correspondance, vous pouvez
utiliser un nom diff&eacute;rent de connection_includefile pour votre fichier EDML. Si vous utilisez un autre nom, vous devez
l'utiliser dans votre fichier de mise en œuvre JavaScript lorsque vous indiquez la valeur assign&eacute;e &agrave; la variable
PARTICIPANT_FILE comme le montre l'exemple suivant :
var PARTICIPANT_FILE = &quot;myConnection_mappingfile&quot;;
Derni&egrave;re mise &agrave; jour le 22/6/2011
88
Chapitre 10 : API d'int&eacute;gration de
commande source
L'API d'int&eacute;gration de commande source permet de r&eacute;diger des biblioth&egrave;ques partag&eacute;es. Ces API vous permettent
d'&eacute;tendre la fonctionnalit&eacute; Archivage/Extraction d'Adobe&reg; Dreamweaver&reg; &agrave; l'aide de syst&egrave;mes de commande source
(tels que Sourcesafe ou CVS).
Vos biblioth&egrave;ques doivent prendre en charge un minimum de fonctions API pour que Dreamweaver puisse &ecirc;tre
int&eacute;gr&eacute; au syst&egrave;me de commande source. En outre, vos biblioth&egrave;ques doivent se trouver dans le dossier Program
Files/Adobe/Adobe Dreamweaver CS5/Configuration/SourceControl.
Lorsque vous d&eacute;marrez Dreamweaver, celui-ci charge toutes les biblioth&egrave;ques. Il d&eacute;termine les fonctionnalit&eacute;s prises
en charge par chaque biblioth&egrave;que en appelant la fonction GetProcAddress() pour chaque API. Si une adresse
n'existe pas, Dreamweaver suppose que la biblioth&egrave;que ne prend pas en charge l'API. Si l'adresse existe, Dreamweaver
utilise la version de la fonction qui se trouve dans la biblioth&egrave;que pour prendre en charge la fonctionnalit&eacute;. Lorsqu'un
utilisateur Dreamweaver d&eacute;finit ou modifie un site, puis choisit l'onglet SCS du serveur Web, les choix correspondant
aux DLL s'affichent dans l'onglet. Ces choix s'affichent en plus des &eacute;l&eacute;ments standard de l'onglet. Ces DLL sont
charg&eacute;es depuis le dossier Program Files/Adobe/Adobe Dreamweaver CS5/Configuration/SourceControl.
Pour cr&eacute;er un menu Site &gt; Commande source auquel vous pouvez ajouter des &eacute;l&eacute;ments personnalis&eacute;s, ajoutez le code
suivant. Ajoutez le code dans le menu Site, dans le fichier menus.xml :
&lt;menu name=&quot;Source Control&quot; id=&quot;DWMenu_MainSite_Site_Source&not;
Control&quot;&gt;&lt;menuitem dynamic name=&quot;None&quot;file=&quot;Menus/MM/&not;
File_SCSItems.htm&quot; id=&quot;DWMenu_MainSite_Site_NewFeatures_&not;
Default&quot; /&gt;
&lt;/menu&gt;
Fonctionnement de l'int&eacute;gration des commandes
source avec Dreamweaver
Lorsqu'un utilisateur Dreamweaver choisit des fonctions de connexion au serveur, de transfert de fichiers ou de Design
Notes, Dreamweaver appelle la version de la DLL de la fonction API correspondante (Connect(), Disconnect(),
Get(), Put(), Checkin(), Checkout(), Undocheckout() et Synchronize()). La DLL est responsable de la gestion
de la requ&ecirc;te, notamment de l'affichage des bo&icirc;tes de dialogue qui rassemblent les informations ou qui permettent &agrave;
l'utilisateur d'interagir avec la DLL. La DLL affiche &eacute;galement des informations ou des messages d'erreur.
Le syst&egrave;me de commande source peut &eacute;ventuellement prendre en charge les Design Notes et la fonction
d'archivage/extraction. Pour activer les Design Notes dans les syst&egrave;mes de commande source, l'utilisateur
Dreamweaver doit choisir l'onglet Design Notes dans la bo&icirc;te de dialogue Modifier les sites et cocher la case qui permet
d'activer cette fonctionnalit&eacute; (cette proc&eacute;dure s'applique &eacute;galement aux syst&egrave;mes FTP et de r&eacute;seau local). Si le syst&egrave;me
de commande source ne prend pas en charge les Design Notes et que l'utilisateur souhaite les utiliser, Dreamweaver
transporte les fichiers Design Note (.mno) pour g&eacute;rer les Design Notes (de la m&ecirc;me fa&ccedil;on qu'avec les syst&egrave;mes FTP et
de r&eacute;seau local).
Les fonctions d'archivage et d'extraction sont trait&eacute;es diff&eacute;remment ; si le syst&egrave;me de commande source les prend en
charge, l'utilisateur ne peut pas &eacute;viter leur utilisation dans la bo&icirc;te de dialogue Design Notes. Si l'utilisateur essaie de
court-circuiter le syst&egrave;me de commande source, un message d'erreur s'affiche.
Derni&egrave;re mise &agrave; jour le 22/6/2011
89
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
Ajout d'une fonctionnalit&eacute; de syst&egrave;me de commande
source
Pour ajouter une fonctionnalit&eacute; de syst&egrave;me de commande source &agrave; Dreamweaver, r&eacute;digez un gestionnaire
GetNewFeatures qui renvoie un jeu d'&eacute;l&eacute;ments de menu et les fonctions C correspondantes. Si, par exemple, vous
r&eacute;digez une biblioth&egrave;que Sourcesafe et que vous souhaitez permettre aux utilisateurs de Dreamweaver de consulter
l'historique d'un fichier, vous pouvez r&eacute;diger un gestionnaire GetNewFeatures qui renvoie l'&eacute;l&eacute;ment de menu
Historique et le nom de la fonction C history. Ainsi, sous Windows, si un utilisateur clique avec le bouton droit de
la souris sur un fichier, l'&eacute;l&eacute;ment Historique s'affiche dans le menu. Si l'utilisateur choisit alors l'&eacute;l&eacute;ment de menu
Historique, Dreamweaver appelle la fonction correspondante, qui se charge de transmettre les fichiers s&eacute;lectionn&eacute;s &agrave;
la DLL. La DLL affiche ensuite la bo&icirc;te de dialogue Historique, ce qui permet &agrave; l'utilisateur d'interagir avec elle de la
m&ecirc;me fa&ccedil;on que Sourcesafe.
Fonctions requises de l'API d'int&eacute;gration de commande
source
L'API d'int&eacute;gration de commande source comporte des fonctions obligatoires et facultatives. Les fonctions
r&eacute;pertori&eacute;es dans cette section sont obligatoires.
bool SCS_GetAgentInfo()
Description
Demande &agrave; la DLL de renvoyer son nom et sa description, qui sont affich&eacute;s dans la bo&icirc;te de dialogue Modifier les sites.
Le nom appara&icirc;t dans le menu d&eacute;roulant Acc&egrave;s (par exemple, Sourcesafe, WebDav, Perforce) et la description s'affiche
juste en dessous du menu.
Arguments
char name[32], char version[32], char description[256], const char *dwAppVersion
• name est le nom du syst&egrave;me de commande source. Ce nom s'affiche dans la zone de liste modifiable permettant de
s&eacute;lectionner un syst&egrave;me de commande source, dans l'onglet Commande source de la bo&icirc;te de dialogue Modifier les
sites. Le nom du ne doit pas compter plus de 32 caract&egrave;res.
• version est une cha&icirc;ne qui indique la version de la DLL. La version appara&icirc;t dans l'onglet Commande source de la
bo&icirc;te de dialogue Modifier les sites. La version ne doit pas compter plus de 32 caract&egrave;res.
• description est une cha&icirc;ne qui d&eacute;crit le syst&egrave;me de commande source. La description appara&icirc;t dans l'onglet
Commande source de la bo&icirc;te de dialogue Modifier les sites. La description ne doit pas compter plus de 256
caract&egrave;res.
• dwAppVersion est une cha&icirc;ne qui d&eacute;crit la version de Dreamweaver appelant la DLL. La DLL peut utiliser cette
cha&icirc;ne pour d&eacute;terminer la version et la langue de Dreamweaver.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
90
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
bool SCS_Connect()
Description
Connecte l'utilisateur &agrave; son syst&egrave;me de commande source. Si la DLL ne dispose pas d'informations de connexion, elle
doit afficher une bo&icirc;te de dialogue invitant l'utilisateur &agrave; entrer des informations, et elle doit stocker les donn&eacute;es pour
une utilisation ult&eacute;rieure.
Arguments
void **connectionData, const char siteName[64]
• connectionData est un descripteur des donn&eacute;es que l'agent souhaite recevoir de Dreamweaver lorsqu'il appelle
d'autres fonctions API.
• L'argument siteName est une cha&icirc;ne qui pointe vers le nom du site. Le nom du site ne doit pas compter plus de 64
caract&egrave;res.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_Disconnect()
Description
D&eacute;connecte l'utilisateur du syst&egrave;me de commande source.
Arguments
void *connectionData
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_IsConnected()
Description
D&eacute;termine l'&eacute;tat de la connexion.
Arguments
void *connectionData
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
91
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
int SCS_GetRootFolderLength()
Description
Renvoie la longueur du nom du dossier racine.
Arguments
void *connectionData
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
Valeur renvoy&eacute;e
Nombre entier qui indique la longueur du nom du dossier racine. Si la fonction renvoie &lt; 0, Dreamweaver consid&egrave;re
cette r&eacute;ponse comme une erreur et tente de r&eacute;cup&eacute;rer le message d'erreur de la DLL si elle est prise en charge.
bool SCS_GetRootFolder()
Description
Renvoie le nom du dossier racine.
Arguments
void *connectionData, char remotePath[], const int folderLen
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePath est une m&eacute;moire tampon dans laquelle est enregistr&eacute; le chemin distant complet du dossier racine.
• folderLen est un nombre entier qui indique la longueur de l'argument remotePath. Il s'agit de la valeur renvoy&eacute;e par
la fonction GetRootFolderLength.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
int SCS_GetFolderListLength()
Description
Renvoie le nombre d'&eacute;l&eacute;ments dans le dossier transmis.
Arguments
void *connectionData, const char *remotePath
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePath est le chemin d'acc&egrave;s et le nom complets du dossier distant dont la DLL v&eacute;rifie le nombre d'&eacute;l&eacute;ments.
Valeur renvoy&eacute;e
Nombre entier qui indique le nombre d'&eacute;l&eacute;ments dans le dossier en cours. Si la fonction renvoie &lt; 0, Dreamweaver
consid&egrave;re cette r&eacute;ponse comme une erreur et tente de r&eacute;cup&eacute;rer le message d'erreur de la DLL si elle est prise en charge.
Derni&egrave;re mise &agrave; jour le 22/6/2011
92
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
bool SCS_GetFolderList()
Description
Renvoie une liste de fichiers et de dossiers dans le dossier transmis, notamment des informations pertinentes telles que
la date de modification, la taille et si l'&eacute;l&eacute;ment est un dossier ou un fichier.
Arguments
void *connectionData, const char *remotePath, itemInfo itemList[ ], const int numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePath est le nom du chemin d'acc&egrave;s au dossier distant dont la DLL v&eacute;rifie le nombre d'&eacute;l&eacute;ments.
• L'argument itemList est une liste pr&eacute;-allou&eacute;e de structures itemInfo :
nom
char[256]
nom de fichier ou de dossier
isFolder
bool
true si c'est un dossier, false si c'est un fichier
month
int
Composant mois de la date de modification, de 1 &agrave; 12
day
int
Composant jour de la date de modification, de 1 &agrave; 31
year
int
Composant ann&eacute;e de la date de modification, 1900+
hour
int
Composant heure de la date de modification, de 0 &agrave; 23
minutes
int
Composant minute de la date de modification, de 0 &agrave; 59
seconds
int
Composant seconde de la date de modification, de 0 &agrave; 59
type
char[256]
Type de fichier (s'il n'est pas d&eacute;fini par la DLL, Dreamweaver utilise l'extension de
fichier pour d&eacute;terminer le type, comme il le fait &agrave; pr&eacute;sent)
size
int
En octets
• numItems est le nombre d'&eacute;l&eacute;ments allou&eacute;s &agrave; l'argument itemList (renvoy&eacute; par la fonction
GetFolderListLength).
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_Get()
Description
Extrait une liste de fichiers ou de dossiers et les stocke localement.
Arguments
void *connectionData, const char *remotePathList[], constchar*localPathList[], const int numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePathList est une liste des fichiers ou dossiers distants &agrave; extraire, exprim&eacute;e sous la forme de noms et de
chemins d'acc&egrave;s complets.
Derni&egrave;re mise &agrave; jour le 22/6/2011
93
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
• L'argument localPathList est une liste miroir des noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers locaux.
• L'argument numItems est le nombre d'&eacute;l&eacute;ments dans chaque liste.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_Put()
Description
Place une liste de fichiers ou de dossiers locaux dans le syst&egrave;me de commande source.
Arguments
void *connectionData, const char *remotePathList[], const char *localPathList[], const int numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• L'argument localPathList est la liste des noms de fichiers locaux ou des chemins de fichiers &agrave; placer dans le syst&egrave;me
de commande source.
• L'argument remotePathList est une liste miroir de noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers distants.
• L'argument numItems est le nombre d'&eacute;l&eacute;ments dans chaque liste.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_NewFolder()
Description
Cr&eacute;e un nouveau dossier.
Arguments
void *connectionData, const char *remotePath
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePath est le chemin d'acc&egrave;s complet du dossier distant que la DLL cr&eacute;e.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_Delete()
Description
Supprime une liste de fichiers ou de dossiers du syst&egrave;me de commande source.
Derni&egrave;re mise &agrave; jour le 22/6/2011
94
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
Arguments
void *connectionData, const char *remotePathList[], const int numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• L'argument remotePathList est une liste de noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers distants &agrave;
supprimer.
• numItems est le nombre d'&eacute;l&eacute;ments dans remotePathList.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_Rename()
Description
Renomme ou d&eacute;place un fichier ou un dossier selon les valeurs sp&eacute;cifi&eacute;es dans les arguments oldRemotePath et
newRemotePath. Ainsi, si les valeurs de oldRemotePath et newRemotePath sont respectivement &quot;$/folder1/file1&quot; et
&quot;$/folder1/renamefile1&quot;, le fichier file1 se voit attribuer le nouveau nom renamefile1 et reste dans le dossier
folder1.
Si les valeurs de oldRemotePath et de newRemotePath sont respectivement &quot;$/folder1/file1&quot; et
&quot;$/folder1/subfolder1/file1&quot;, le fichier file1 est alors d&eacute;plac&eacute; dans le sous-dossier subfolder1.
Pour savoir si l'invocation de cette fonction constitue un d&eacute;placement ou l'attribution d'un nouveau nom, v&eacute;rifiez les
chemins parents des deux valeurs d'entr&eacute;e ; s'ils sont identiques, il s'agit de l'op&eacute;ration &laquo; renommer &raquo;.
Arguments
void *connectionData, const char *oldRemotePath, const char *newRemotePath
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• oldRemotePath est le nom du chemin d'acc&egrave;s au fichier ou dossier distant &agrave; renommer.
• newRemotePath est le nom du chemin d'acc&egrave;s au nouveau fichier ou dossier distant.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_ItemExists()
Description
D&eacute;termine si un fichier ou un dossier existe sur le serveur.
Arguments
void *connectionData, const char *remotePath
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePath est le chemin d'acc&egrave;s d'un fichier ou d'un dossier distant.
Derni&egrave;re mise &agrave; jour le 22/6/2011
95
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
Fonctions facultatives de l'API d'int&eacute;gration de
commande source
L'API d'int&eacute;gration de commande source comporte des fonctions obligatoires et facultatives. Les fonctions
r&eacute;pertori&eacute;es dans cette section sont facultatives.
bool SCS_GetConnectionInfo()
Description
Affiche une bo&icirc;te de dialogue qui permet &agrave; l'utilisateur de modifier ou de d&eacute;finir les informations de connexion du site.
N'&eacute;tablit pas la connexion. Cette fonction est appel&eacute;e lorsque l'utilisateur clique sur le bouton Param&egrave;tres dans la
section Infos distantes de la bo&icirc;te de dialogue Modifier les sites.
Arguments
void **connectionData, const char siteName[64]
• L'argument connectionData est un descripteur des donn&eacute;es que l'agent veut recevoir de Dreamweaver lorsqu'il
appelle d'autres fonctions API.
• L'argument siteName est une cha&icirc;ne qui pointe vers le nom du site. Ce nom ne peut pas comporter plus de 64
caract&egrave;res.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_SiteDeleted()
Description
Informe la DLL que le site a &eacute;t&eacute; supprim&eacute; ou qu'il n'est plus li&eacute; &agrave; ce syst&egrave;me de commande source. Cette fonction
indique au syst&egrave;me de commande source qu'il peut supprimer les informations persistantes du site.
Arguments
const char siteName[64]
• L'argument siteName est une cha&icirc;ne qui pointe vers le nom du site. Ce nom ne peut pas comporter plus de 64
caract&egrave;res.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
96
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
bool SCS_SiteRenamed()
Description
Notifie &agrave; la DLL que l'utilisateur a renomm&eacute; le site, pour qu'il puisse mettre &agrave; jour les informations persistantes
relatives &agrave; ce site.
Arguments
const char oldSiteName[64], const char newSiteName[64]
• oldSiteName est une cha&icirc;ne qui pointe vers le nom initial du site, avant qu'il ne soit renomm&eacute;. Ce nom ne peut pas
comporter plus de 64 caract&egrave;res.
• newSiteName est une cha&icirc;ne qui pointe vers le nouveau nom du site, apr&egrave;s qu'il a &eacute;t&eacute; renomm&eacute;. Ce nom ne peut pas
comporter plus de 64 caract&egrave;res.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
int SCS_GetNumNewFeatures()
Description
Renvoie le nombre de nouvelles fonctions &agrave; ajouter &agrave; Dreamweaver (comme Historique de fichier, Diff&eacute;rences, etc.).
Arguments
Aucun.
Valeur renvoy&eacute;e
Nombre entier qui indique le nombre de nouvelles fonctionnalit&eacute;s &agrave; ajouter &agrave; Dreamweaver. Si la fonction renvoie &lt;
0, Dreamweaver consid&egrave;re cette r&eacute;ponse comme une erreur et tente de r&eacute;cup&eacute;rer le message d'erreur de la DLL si elle
est prise en charge.
bool SCS_GetNewFeatures()
Description
Renvoie une liste d'&eacute;l&eacute;ments &agrave; ajouter aux menus principaux et contextuels de Dreamweaver. Par exemple, la DLL
Sourcesafe peut ajouter Historique et Diff&eacute;rences de fichiers au menu principal.
Arguments
char menuItemList[][32], scFunction functionList[], scFunction enablerList[], const int numNewFeatures
• menuItemList est une liste de cha&icirc;nes compl&eacute;t&eacute;e par la DLL et indiquant les &eacute;l&eacute;ments &agrave; ajouter aux menus
principaux et contextuels. Chaque cha&icirc;ne peut contenir 32 caract&egrave;res maximum.
• L'argument functionList est renseign&eacute; par la DLL ; il indique les routines de la DLL &agrave; appeler lorsque l'utilisateur
choisit l'&eacute;l&eacute;ment de menu correspondant.
• L'argument enablerList est renseign&eacute; par la DLL ; il indique les routines de la DLL &agrave; appeler lorsque Dreamweaver
a besoin de d&eacute;terminer si l'&eacute;l&eacute;ment de menu correspondant est activ&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
97
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
• L'argument numNewFeatures est le nombre d'&eacute;l&eacute;ments ajout&eacute;s par la DLL ; cette valeur est r&eacute;cup&eacute;r&eacute;e en appelant
la fonction GetNumNewFeatures().
La signature de fonction suivante d&eacute;finit les fonctions et les activateurs transmis par appel de la fonction
SCS_GetNewFeatures() dans les arguments functionlist et enablerList.
bool (*scFunction)(void *connectionData, const char *remotePathList[],
const char *localPathList[], const int numItems)
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_GetCheckoutName()
Description
Renvoie le nom d'extraction de l'utilisateur en cours. Si le syst&egrave;me de commande source ne prend pas en charge cette
fonction et que l'utilisateur a activ&eacute; l'extraction, la fonction utilise la fonctionnalit&eacute; interne d'archivage et d'extraction
de Dreamweaver qui transporte les fichiers LCK depuis et vers le syst&egrave;me de commande source.
Arguments
void *connectionData, char checkOutName[64], char emailAddress[64]
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• checkOutName est le nom de l'utilisateur en cours.
• emailAddress est l'adresse &eacute;lectronique de l'utilisateur en cours.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_Checkin()
Description
Archive une liste de fichiers ou de dossiers locaux dans le syst&egrave;me de commande source. La DLL doit configurer le
fichier en lecture seule. Si le syst&egrave;me de commande source ne prend pas en charge cette fonction et que l'utilisateur a
activ&eacute; l'extraction, la fonction utilise la fonctionnalit&eacute; interne d'archivage et d'extraction de Dreamweaver qui
transporte les fichiers LCK depuis et vers le syst&egrave;me de commande source.
Arguments
void *connectionData, const char *localPathList[], const char *remotePathList[], bool successList[], const int numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• L'argument localPathList est une liste de noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers locaux &agrave; archiver.
• L'argument remotePathList est une liste miroir de noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers distants.
• successList est une liste de valeurs bool&eacute;ennes compl&eacute;t&eacute;e par la DLL pour permettre &agrave; Dreamweaver de conna&icirc;tre
les fichiers dont l'archivage a r&eacute;ussi.
Derni&egrave;re mise &agrave; jour le 22/6/2011
98
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
• L'argument numItems est le nombre d'&eacute;l&eacute;ments dans chaque liste.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_Checkout()
Description
Extrait une liste de fichiers ou de dossiers locaux du syst&egrave;me de commande source. La DLL se charge d'accorder les
droits d'acc&egrave;s en &eacute;criture au fichier. Si le syst&egrave;me de commande source ne prend pas en charge cette fonction et que
l'utilisateur a activ&eacute; l'extraction, la fonction utilise la fonctionnalit&eacute; interne d'archivage et d'extraction de Dreamweaver
qui transporte les fichiers LCK depuis et vers le syst&egrave;me de commande source.
Arguments
void *connectionData, const char *localPathList[], const char *remotePathList[], bool successList[], const int numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• L'argument remotePathList est une liste de noms de chemin d'acc&egrave;s aux fichiers et aux dossiers distant &agrave; extraire.
• L'argument localPathList est une liste miroir des noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers locaux.
• successList est une liste de valeurs bool&eacute;ennes compl&eacute;t&eacute;e par la DLL pour permettre &agrave; Dreamweaver de conna&icirc;tre
les fichiers dont l'extraction a r&eacute;ussi.
• L'argument numItems est le nombre d'&eacute;l&eacute;ments dans chaque liste.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_UndoCheckout()
Description
Annule l'&eacute;tat d'extraction d'une liste de fichiers ou de dossiers. La DLL doit configurer le fichier en lecture seule. Si le
syst&egrave;me de commande source ne prend pas en charge cette fonction et que l'utilisateur a activ&eacute; l'extraction, la fonction
utilise la fonctionnalit&eacute; interne d'archivage et d'extraction de Dreamweaver qui transporte les fichiers LCK depuis et
vers le syst&egrave;me de commande source.
Arguments
void *connectionData, const char *localPathList[], const char *remotePathList[], bool successList[], const int numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePathList est une liste de chemins aux fichiers ou dossiers distants dont l'extraction doit &ecirc;tre annul&eacute;e.
• L'argument localPathList est une liste miroir des noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers locaux.
• successList est une liste de valeurs bool&eacute;ennes compl&eacute;t&eacute;e par la DLL pour permettre &agrave; Dreamweaver de conna&icirc;tre
les fichiers dont l'extraction a &eacute;t&eacute; annul&eacute;e avec succ&egrave;s.
• L'argument numItems est le nombre d'&eacute;l&eacute;ments dans chaque liste.
Derni&egrave;re mise &agrave; jour le 22/6/2011
99
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
int SCS_GetNumCheckedOut()
Description
Renvoie le nombre d'utilisateurs dont un fichier a &eacute;t&eacute; extrait.
Arguments
void *connectionData, const char *remotePath
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePath est le nom du chemin d'acc&egrave;s au fichier ou dossier distant &agrave; v&eacute;rifier pour conna&icirc;tre le nombre
d'utilisateurs ayant proc&eacute;d&eacute; &agrave; son extraction.
Valeur renvoy&eacute;e
Nombre entier qui repr&eacute;sente le nombre de personnes disposant du fichier extrait. Si la fonction renvoie &lt; 0,
Dreamweaver consid&egrave;re cette r&eacute;ponse comme une erreur et tente de r&eacute;cup&eacute;rer le message d'erreur de la DLL si elle est
prise en charge.
bool SCS_GetFileCheckoutList()
Description
Renvoie une liste d'utilisateurs dont un fichier a &eacute;t&eacute; extrait. Si cette liste est vide, c'est que personne n'a de fichier extrait.
Arguments
void *connectionData, const char *remotePath, char checkOutList[][64], char emailAddressList[][64], const int
numCheckedOut
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePath est le nom du chemin d'acc&egrave;s au fichier ou dossier distant &agrave; v&eacute;rifier pour conna&icirc;tre le nombre
d'utilisateurs ayant proc&eacute;d&eacute; &agrave; son extraction.
• checkOutList est une liste de cha&icirc;nes qui correspond aux utilisateurs disposant du fichier extrait. Chaque cha&icirc;ne ne
doit pas avoir plus de 64 caract&egrave;res.
• emailAddressList est une liste de cha&icirc;nes correspondant aux adresses &eacute;lectroniques des utilisateurs. Chaque adresse
ne doit pas d&eacute;passer 64 caract&egrave;res.
• numCheckedOut est le nombre de personnes qui ont le fichier extrait. Il est renvoy&eacute; par GetNumCheckedOut().
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
100
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
int SCS_GetErrorMessageLength()
Description
Renvoie la longueur du message d'erreur interne en cours de la DLL. Permet d'allouer la m&eacute;moire tampon transmise
dans la fonction GetErrorMessage(). Cette fonction doit &ecirc;tre appel&eacute;e uniquement si une fonction d'API renvoie la
valeur false ou &lt;0, ce qui indique un &eacute;chec.
Arguments
void *connectionData
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
Valeur renvoy&eacute;e
Nombre entier repr&eacute;sentant la longueur du message d'erreur.
bool SCS_GetErrorMessage()
Description
Renvoie le dernier message d'erreur. Si vous impl&eacute;mentez getErrorMessage(), Dreamweaver l'appelle &agrave; chaque fois
qu'une de vos fonctions d'API renvoie false.
Si une routine renvoie -1 ou false, cela indique qu'un message d'erreur doit &ecirc;tre disponible.
Arguments
void *connectionData, char errorMsg[], const int *msgLength
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• errorMsg est une cha&icirc;ne pr&eacute;-allou&eacute;e de la DLL dans laquelle vient se placer le message d'erreur.
• msgLength est la longueur de la m&eacute;moire tampon repr&eacute;sent&eacute;e par l'argument errorMsg[].
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
int SCS_GetNoteCount()
Description
Renvoie le nombre de cl&eacute;s Design Note pour le chemin de dossier ou de fichier distant sp&eacute;cifi&eacute;. Si cela n'est pas pris en
charge par le syst&egrave;me de commande source, Dreamweaver obtient ces informations du fichier compagnon MNO.
Arguments
void *connectionData, const char *remotePath
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
Derni&egrave;re mise &agrave; jour le 22/6/2011
101
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
• remotePath est le nom du chemin d'acc&egrave;s au fichier ou dossier distant dont la DLL v&eacute;rifie le nombre de Design
Notes jointes.
Valeur renvoy&eacute;e
Nombre entier qui indique le nombre de Design Notes associ&eacute;es au fichier. Si la fonction renvoie &lt; 0, Dreamweaver
consid&egrave;re cette r&eacute;ponse comme une erreur et tente de r&eacute;cup&eacute;rer le message d'erreur de la DLL si elle est prise en charge.
int SCS_GetMaxNoteLength()
Description
Renvoie la longueur de la Design Note la plus longue pour le fichier ou le dossier sp&eacute;cifi&eacute;. Si cette fonction n'est pas
prise en charge par le syst&egrave;me de commande source, Dreamweaver obtient ces informations du fichier MNO.
Arguments
void *connectionData, const char *remotePath
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePath est le nom du chemin d'acc&egrave;s au fichier ou dossier distant dont la DLL v&eacute;rifie la Design Note la plus
longue.
Valeur renvoy&eacute;e
Nombre entier qui indique la taille de la Design Note la plus longue associ&eacute;e au fichier. Si la fonction renvoie &lt; 0,
Dreamweaver consid&egrave;re cette r&eacute;ponse comme une erreur et tente de r&eacute;cup&eacute;rer le message d'erreur de la DLL si elle est
prise en charge.
bool SCS_GetDesignNotes()
Description
R&eacute;cup&egrave;re des paires cl&eacute;-valeur des m&eacute;ta-informations pour le fichier ou le dossier sp&eacute;cifi&eacute;. Si cette fonction n'est pas
prise en charge par le syst&egrave;me de commande source, Dreamweaver r&eacute;cup&egrave;re ces informations depuis fichier MNO.
Arguments
void *connectionData, const char *remotePath, char keyList[][64], char *valueList[], bool showColumnList[], const int
noteCount, const int noteLength
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePath est le nom du chemin d'acc&egrave;s au fichier ou dossier distant dont la DLL v&eacute;rifie le nombre d'&eacute;l&eacute;ments.
• L'argument keyList est une liste de cl&eacute;s de Design Note, comme &quot;Status&quot;.
• valueList est une liste de valeurs de Design Note correspondant aux cl&eacute;s de Design Note, comme &quot;Awaiting
Signoff&quot;.
• L'argument showColumnList est une liste de valeurs bool&eacute;ennes correspondant aux cl&eacute;s de Design Note, qui
indiquent si Dreamweaver peut afficher une cl&eacute; sous forme de colonne dans le panneau Site.
• L'argument noteCount correspond au nombre de Design Notes jointes &agrave; un fichier ou dossier ; cette valeur est
renvoy&eacute;e par la fonction GetNoteCount().
Derni&egrave;re mise &agrave; jour le 22/6/2011
102
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
• L'argument noteLength est la longueur maximale d'une Design Note ; cette valeur est renvoy&eacute;e par la fonction
GetMaxNoteLength().
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_SetDesignNotes()
Description
Enregistre les paires cl&eacute;-valeur dans les m&eacute;ta-informations du fichier ou du dossier sp&eacute;cifi&eacute;. Cela remplace le jeu de
m&eacute;ta-informations du fichier. Si cette fonction n'est pas prise en charge par le syst&egrave;me de commande source,
Dreamweaver enregistre les Design Notes dans des fichiers MNO.
Arguments
void *connectionData, const char *remotePath, const char keyList[][64], const char *valueList[], bool showColumnList[],
const int noteCount, const int noteLength
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePath est le nom du chemin d'acc&egrave;s au fichier ou dossier distant dont la DLL v&eacute;rifie le nombre d'&eacute;l&eacute;ments.
• L'argument keyList est une liste de cl&eacute;s de Design Note, comme &quot;Status&quot;.
• valueList est une liste de valeurs de Design Note correspondant aux cl&eacute;s de Design Note, comme &quot;Awaiting
Signoff&quot;.
• L'argument showColumnList est une liste de valeurs bool&eacute;ennes correspondant aux cl&eacute;s de Design Note, qui
indiquent si Dreamweaver peut afficher une cl&eacute; sous forme de colonne dans le panneau Site.
• L'argument noteCount correspond au nombre de Design Notes jointes &agrave; un fichier ou dossier ; ce nombre permet
&agrave; la DLL de conna&icirc;tre la taille des listes sp&eacute;cifi&eacute;es. Si noteCount a pour valeur 0, toutes les Design Notes sont
supprim&eacute;es du fichier.
• L'argument noteLength est la longueur de la Design Note la plus longue pour le fichier ou le dossier sp&eacute;cifi&eacute;.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_IsRemoteNewer()
Description
V&eacute;rifie chaque chemin distant sp&eacute;cifi&eacute; pour voir si la copie distante est plus r&eacute;cente. Si cette fonction n'est pas prise en
charge par le syst&egrave;me de commande source, Dreamweaver utilise son algorithme interne isRemoteNewer.
Arguments
void *connectionData, const char *remotePathList[], constchar*localPathList[], int remoteIsNewerList[], const int
numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
Derni&egrave;re mise &agrave; jour le 22/6/2011
103
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
• remotePathList est une liste de noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers &agrave; comparer pour conna&icirc;tre ceux
dot&eacute;s des &eacute;tats les plus r&eacute;cents.
• L'argument localPathList est une liste miroir des noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers locaux.
• remoteIsNewerList est une liste de nombres entiers compl&eacute;t&eacute;e par la DLL pour permettre &agrave; Dreamweaver
d'identifier le fichier le plus r&eacute;cent du c&ocirc;t&eacute; distant. Les valeurs suivantes sont admises : 1 indique que la version
distante est la plus r&eacute;cente ; -1 indique que la version locale est la plus r&eacute;cente ; 0 indique que les deux versions sont
identiques.
• L'argument numItems est le nombre d'&eacute;l&eacute;ments dans chaque liste.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
Activateurs
Si les activateurs facultatifs ne sont pas pris en charge par le syst&egrave;me de commande source ou que l'application n'est
pas connect&eacute;e au serveur, Dreamweaver d&eacute;termine le moment o&ugrave; les &eacute;l&eacute;ments de menu sont activ&eacute;s, en fonction des
informations dont il dispose concernant les fichiers distants.
bool SCS_canConnect()
Description
Indique si l'&eacute;l&eacute;ment de menu Connecter doit &ecirc;tre activ&eacute;.
Arguments
Aucun.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_canGet()
Description
Indique si l'&eacute;l&eacute;ment de menu Acqu&eacute;rir doit &ecirc;tre activ&eacute;.
Arguments
void *connectionData, const char *remotePathList[], constchar*localPathList[], const int numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePathList est une liste de noms de chemin d'acc&egrave;s aux fichiers et aux dossier distant &agrave; obtenir.
• L'argument localPathList est une liste miroir des noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers locaux.
• L'argument numItems est le nombre d'&eacute;l&eacute;ments dans chaque liste.
Derni&egrave;re mise &agrave; jour le 22/6/2011
104
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_canCheckout()
Description
Indique si l'&eacute;l&eacute;ment de menu Extraire doit &ecirc;tre activ&eacute;.
Arguments
void *connectionData, const char *remotePathList[], constchar*localPathList[], const int numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• L'argument remotePathList est une liste de noms de chemin d'acc&egrave;s aux fichiers et aux dossiers distant &agrave; extraire.
• L'argument localPathList est une liste miroir des noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers locaux.
• L'argument numItems est le nombre d'&eacute;l&eacute;ments dans chaque liste.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_canPut()
Description
Indique si l'&eacute;l&eacute;ment de menu Placer doit &ecirc;tre activ&eacute;.
Arguments
void *connectionData, const char *remotePathList[], const char *localPathList[], const int numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• localPathList est une liste de noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers &agrave; placer dans le syst&egrave;me de
commande source.
• remotePathList est une liste miroir de noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers &agrave; placer dans le syst&egrave;me
de commande source.
• L'argument numItems est le nombre d'&eacute;l&eacute;ments dans chaque liste.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_canCheckin()
Description
Indique si l'&eacute;l&eacute;ment de menu Archiver doit &ecirc;tre activ&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
105
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
Arguments
void *connectionData, const char *remotePathList[], const char *localPathList[], const int numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• L'argument localPathList est une liste de noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers locaux &agrave; archiver.
• L'argument remotePathList est une liste miroir de noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers distants.
• L'argument numItems est le nombre d'&eacute;l&eacute;ments dans chaque liste.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_CanUndoCheckout()
Description
Indique si l'&eacute;l&eacute;ment de menu Annuler l'extraction doit &ecirc;tre activ&eacute;.
Arguments
void *connectionData, const char *remotePathList[], constchar*localPathList[], const int numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• L'argument remotePathList est une liste de noms de chemin d'acc&egrave;s aux fichiers et aux dossiers distant &agrave; extraire.
• localPathList est une liste de noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers locaux &agrave; placer dans le syst&egrave;me
de commande source.
• L'argument numItems est le nombre d'&eacute;l&eacute;ments dans chaque liste.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_canNewFolder()
Description
Indique si l'&eacute;l&eacute;ment de menu Nouveau dossier doit &ecirc;tre activ&eacute;.
Arguments
void *connectionData, const char *remotePath
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePath est une liste de noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers distants que l'utilisateur a
s&eacute;lectionn&eacute; pour indiquer l'emplacement de cr&eacute;ation du nouveau dossier.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
106
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
bool SCS_canDelete()
Description
Indique si l'&eacute;l&eacute;ment de menu Supprimer doit &ecirc;tre activ&eacute;.
Arguments
void *connectionData, const char *remotePathList[], const int numItems
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• L'argument remotePathList est une liste de noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers distants &agrave;
supprimer.
• L'argument numItems est le nombre d'&eacute;l&eacute;ments dans chaque liste.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_canRename()
Description
Indique si l'&eacute;l&eacute;ment de menu Renommer doit &ecirc;tre activ&eacute;.
Arguments
void *connectionData, const char *remotePath
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
• remotePathList est une liste des noms de chemin d'acc&egrave;s aux fichiers ou aux dossiers distants qui peuvent &ecirc;tre
renomm&eacute;s.
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
bool SCS_BeforeGet()
Description
Dreamweaver appelle cette fonction avant d'acqu&eacute;rir ou d'extraire un ou plusieurs fichiers. Cette fonction permet &agrave; la
DLL d'effectuer une op&eacute;ration sur un groupe de fichiers, telle que l'ajout d'un commentaire d'extraction.
Arguments
*connectionData
• L'argument *connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
107
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
Exemple
Pour acqu&eacute;rir un groupe de fichiers, Dreamweaver effectue des appels vers la DLL dans l'ordre suivant :
SCS_BeforeGet(connectionData);
SCS_Get(connectionData,remotePathList1,localPathList1,successList1);
SCS_Get(connectionData,remotePathList2,localPathList2,successList2);
SCS_Get(connectionData,remotePathList3,localPathList3,successList3);
SCS_AfterGet(connectionData);
bool SCS_BeforePut()
Description
Dreamweaver appelle cette fonction avant de placer ou d'archiver un ou plusieurs fichiers. Cette fonction permet &agrave; la
DLL d'effectuer une op&eacute;ration sur un groupe de fichiers, telle que l'ajout d'un commentaire d'archivage.
Arguments
*connectionData
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
Exemple
Pour acqu&eacute;rir un groupe de fichiers, Dreamweaver effectue des appels vers la DLL dans l'ordre suivant :
SCS_BeforePut(connectionData);
SCS_Put(connectionData,localPathList1,remotePathList1,successList1);
SCS_Put(connectionData,localPathList2,remotePathList2,successList2);
SCS_Put(connectionData,localPathList3,remotePathList3,successList3);
SCS_AfterPut(connectionData);
bool SCS_AfterGet()
Description
Dreamweaver appelle cette fonction apr&egrave;s avoir acquis ou extrait un ou plusieurs fichiers. Cette fonction permet &agrave; la
DLL d'effectuer n'importe quelle op&eacute;ration apr&egrave;s l'acquisition ou l'extraction d'un lot, telle que la cr&eacute;ation d'une bo&icirc;te
de dialogue de r&eacute;sum&eacute;.
Arguments
*connectionData
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
108
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
API d'int&eacute;gration de commande source
Exemple
Voir &laquo; bool SCS_BeforeGet() &raquo; &agrave; la page 106.
bool SCS_AfterPut()
Description
Dreamweaver appelle cette fonction apr&egrave;s avoir plac&eacute; ou archiv&eacute; un ou plusieurs fichiers. Cette fonction permet &agrave; la
DLL d'effectuer n'importe quelle op&eacute;ration apr&egrave;s le placement ou l'archivage d'un lot, telle que la cr&eacute;ation d'une bo&icirc;te
de dialogue de r&eacute;sum&eacute;.
Arguments
*connectionData
• L'argument connectionData est un pointeur vers les donn&eacute;es de l'agent transf&eacute;r&eacute;es &agrave; Dreamweaver pendant l'appel
de la fonction Connect().
Valeur renvoy&eacute;e
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
Exemple
Voir &laquo; bool SCS_BeforePut() &raquo; &agrave; la page 107.
Derni&egrave;re mise &agrave; jour le 22/6/2011
109
Chapitre 11 : Application
Les fonctions relatives aux applications effectuent des op&eacute;rations ayant trait &agrave; la fa&ccedil;on dont Adobe&reg; Dreamweaver&reg;
interagit avec d'autres applications ou des t&acirc;ches Dreamweaver ind&eacute;pendantes des documents individuels (d&eacute;finition
des pr&eacute;f&eacute;rences ou fermeture de Dreamweaver, par exemple).
Fonctions relatives aux applications externes
Ces fonctions permettent d'effectuer des op&eacute;rations relatives aux applications, telles que Adobe&reg; Flash&reg;, aux
navigateurs et aux &eacute;diteurs externes, d&eacute;finis respectivement dans les cat&eacute;gories Aper&ccedil;u dans le navigateur et Editeurs
externes des Pr&eacute;f&eacute;rences. Elles permettent d'obtenir des informations sur les applications externes et d'ouvrir des
fichiers dans ces applications.
dreamweaver.browseDocument()
Disponibilit&eacute;
Dreamweaver 2, am&eacute;lior&eacute;e dans les versions 3 et 4.
Description
Ouvre l'URL sp&eacute;cifi&eacute;e dans le navigateur sp&eacute;cifi&eacute;.
Arguments
fileName, {browser}
• L'argument fileName correspond au nom du fichier &agrave; ouvrir, exprim&eacute; sous la forme d'une absolue.
• L'argument browser d&eacute;finit un navigateur. Cet argument peut &ecirc;tre le nom d'un navigateur tel qu'il est d&eacute;fini dans
la cat&eacute;gorie Aper&ccedil;u dans le navigateur des Pr&eacute;f&eacute;rences ou &ecirc;tre primary ou secondary. Si l'argument est omis,
l'URL est ouverte dans le navigateur principal de l'utilisateur.
Remarque : Certains navigateurs ne sont pas en mesure de trouver un fichier dont l'URL contient une ancre (&laquo;
Configuration/ExtensionHelp/browseHelp.htm#helpyou &raquo;, par exemple).
Valeurs renvoy&eacute;es
Aucune.
Exemple
La fonction suivante utilise la fonction dreamweaver.browseDocument() pour ouvrir la page d'accueil Adobe dans
un navigateur :
function goToadobe(){
dreamweaver.browseDocument('http://www.adobe.com/');
}
Dans Dreamweaver 4, vous pouvez faire en sorte que cette op&eacute;ration ouvre le document dans Microsoft Internet
Explorer &agrave; l'aide du code suivant :
Derni&egrave;re mise &agrave; jour le 22/6/2011
110
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
function goToadobe(){
var prevBrowsers = dw.getBrowserList();
var theBrowser = &quot;&quot;;
for (var i=1; i &lt; prevBrowsers.length; i+2){
if (prevBrowsers[i].indexOf('Iexplore.exe') != -1){
theBrowser = prevBrowsers[i];
break;
}
}
dw.browseDocument('http://www.adobe.com/',theBrowser);
}
Pour plus d'informations sur la fonction dreamweaver.getBrowserList(), consultez la section
&laquo; dreamweaver.getBrowserList() &raquo; &agrave; la page 110.
dreamweaver.getBrowserList()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient la liste des navigateurs d&eacute;finis dans le sous-menu Fichier &gt; Aper&ccedil;u dans le navigateur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau contenant autant de paires de cha&icirc;nes que de navigateurs d&eacute;finis. La premi&egrave;re cha&icirc;ne de la paire repr&eacute;sente le
nom du navigateur et la seconde son emplacement sur l'ordinateur de l'utilisateur, exprim&eacute; sous la forme d'une URL
de type file://. Si aucun navigateur n'est d&eacute;fini, la fonction ne renvoie rien.
dreamweaver.getExtensionEditorList()
Disponibilit&eacute;
Dreamweaver 3
Description
Obtient la liste des &eacute;diteurs d&eacute;finis dans la cat&eacute;gorie Editeurs externes des pr&eacute;f&eacute;rences pour le fichier sp&eacute;cifi&eacute;.
Arguments
fileURL
• L'argument fileURL peut &ecirc;tre une URL compl&egrave;te de type file://, un nom de fichier ou une extension de fichier (point
compris).
Valeurs renvoy&eacute;es
Tableau contenant autant de paires de cha&icirc;nes que d'&eacute;diteurs d&eacute;finis. La premi&egrave;re cha&icirc;ne de la paire repr&eacute;sente le nom
de l'&eacute;diteur et la seconde son emplacement sur l'ordinateur de l'utilisateur, exprim&eacute; sous la forme d'une URL de type
file://. Si aucun &eacute;diteur n'est d&eacute;fini dans les pr&eacute;f&eacute;rences, la fonction renvoie un tableau contenant une cha&icirc;ne vide.
Derni&egrave;re mise &agrave; jour le 22/6/2011
111
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
Exemple
Un appel &agrave; la fonction dreamweaver.getExtensionEditorList(&quot;.gif&quot;) pourrait renvoyer un tableau contenant
les cha&icirc;nes suivantes :
•
&quot;Fireworks 3&quot;
•
&quot;file:///C|/Program Files/Adobe/Fireworks 3/Fireworks 3.exe&quot;
dreamweaver.getExternalTextEditor()
Disponibilit&eacute;
Dreamweaver 4.
Description
Obtient le nom de l'&eacute;diteur de texte externe actuellement configur&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant le nom de l'&eacute;diteur de texte appropri&eacute; pour l'interface utilisateur et non le chemin entier.
dreamweaver.getFlashPath()
Disponibilit&eacute;
Dreamweaver MX.
Description
Obtient le chemin d'acc&egrave;s complet de l'application FlashMX sous la forme d'une URL de fichier.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau contenant deux &eacute;l&eacute;ments. El&eacute;ment [0] est une cha&icirc;ne contenant le nom de l'&eacute;diteur FlashMX. El&eacute;ment [1] est
une cha&icirc;ne contenant le chemin de l'application Flash sur l'ordinateur local, exprim&eacute; sous la forme d'une URL de type
file://. Si Flash n'est pas install&eacute;, la fonction ne renvoie rien.
Exemple
L'exemple suivant appelle la fonction dw.getFlashPath() pour obtenir le chemin d'acc&egrave;s &agrave; l'application Flash et
transmettre ce dernier sous la forme d'une URL de type file:// &agrave; la fonction dw.openWithApp() afin d'ouvrir le
document avec Flash :
var myDoc = dreamweaver.getDocumentDOM();
if (dreamweaver.validateFlash()) {
var flashArray = dreamweaver.getFlashPath();
dreamweaver.openWithApp(myDoc.myForm.swfFilePath, flashArray[1]);
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
112
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
dreamweaver.getPrimaryBrowser()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient le chemin du navigateur principal.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant le chemin d'acc&egrave;s au navigateur principal sur l'ordinateur de l'utilisateur, exprim&eacute; sous la forme
d'une URL de type file://, ou rien, si aucun navigateur principal n'est d&eacute;fini.
dreamweaver.getPrimaryExtensionEditor()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient l'&eacute;diteur principal associ&eacute; au fichier sp&eacute;cifi&eacute;.
Arguments
fileURL
• L'argument fileURL correspond au chemin d'acc&egrave;s au fichier &agrave; ouvrir, exprim&eacute; sous la forme d'une URL de type
file://.
Valeurs renvoy&eacute;es
Tableau contenant une paire de cha&icirc;nes. La premi&egrave;re cha&icirc;ne de la paire repr&eacute;sente le nom de l'&eacute;diteur et la seconde son
emplacement sur l'ordinateur de l'utilisateur, exprim&eacute; sous la forme d'une URL de type file://. Si aucun &eacute;diteur
principal n'est d&eacute;fini, la fonction renvoie un tableau contenant une cha&icirc;ne vide.
dreamweaver.getSecondaryBrowser()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient le chemin du navigateur secondaire.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
113
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant le chemin d'acc&egrave;s au navigateur secondaire sur l'ordinateur de l'utilisateur, exprim&eacute; sous la
forme d'une URL de type file://, ou rien, si aucun navigateur secondaire n'est d&eacute;fini.
dreamweaver.openHelpURL()
Disponibilit&eacute;
Dreamweaver MX.
Description
Ouvre le fichier d'aide sp&eacute;cifi&eacute; dans le visualisateur d'aide du syst&egrave;me d'exploitation.
Dreamweaver affiche le contenu de l'aide dans le visualisateur d'aide standard du syst&egrave;me d'exploitation plut&ocirc;t que
dans un navigateur. L'aide est au format HTML, mais elle peut &ecirc;tre lue par HTML Help sous Windows ou Help Viewer
sur MacOs X.
L'aide compl&egrave;te est contenue dans les quatre types de fichiers suivants. Pour plus d'informations sur les fichiers d'aide,
consultez la documentation de votre syst&egrave;me d'exploitation.
• Manuel d'aide
Le manuel d'aide se compose de fichiers d'aide HTML, d'images et d'index. Sous Windows, le manuel d'aide est un
fichier portant l'extension .chm. Sur Macintosh, le manuel d'aide est undossier.
Les fichiers du manuel d'aide se trouvent dans le dossier d'aide de Dreamweaver.
• Fichier help.xml
Le fichier help.xml &eacute;tablit des correspondances entre les ID et le nom des manuels d'aide. Par exemple, le code XML
ci-dessous &eacute;tablit une correspondance entre l'ID du manuel d'aide de Dreamweaver et le nom des fichiers contenant
cette aide, sous Windows comme sur Macintosh :
&lt;?xml version = &quot;1.0&quot; ?&gt; &lt;help-books&gt;&lt;book-id id=&quot;DW_Using&quot; winmapping=&quot;UsingDreamweaver.chm&quot; mac-mapping=&quot;Dreamweaver Help&quot;/&gt; &lt;/help-books&gt;
Chaque entr&eacute;e book-id comporte les attributs suivants :
• L'attribut id correspond &agrave; l'ID de manuel utilis&eacute; dans les fichiers help.map et HelpDoc.js.
• L'attribut win-mapping correspond au nom du manuel Windows, &quot;UsingDreamweaver.chm&quot; dans cet
exemple.
• L'attribut mac-mapping correspond au nom du manuel Macintosh, soit &quot;Dreamweaver
Help&quot; dans cet
exemple.
• Fichier help.map
Le fichier help.map &eacute;tablit une correspondance entre un ID de contenu de l'aide et un manuel d'aide sp&eacute;cifique.
Dreamweaver utilise le fichier help.map pour rechercher un contenu d'aide sp&eacute;cifique lorsqu'il appelle l'aide
directement.
• Fichier helpDoc.js
Le fichier helpDoc.js vous permet d'&eacute;tablir une correspondance entre des noms de variables que vous pouvez
utiliser &agrave; la place de l'ID du manuel et de la cha&icirc;ne de page. Le fichier helpDoc.js &eacute;tablit une correspondance entre
un ID de contenu et une page HTML dans un manuel d'aide sp&eacute;cifique. Dreamweaver utilise le fichier helpDoc.js
lorsqu'il appelle l'aide &agrave; partir de JavaScript.
Derni&egrave;re mise &agrave; jour le 22/6/2011
114
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
Arguments
bookID.
• L'argument obligatoire bookID se pr&eacute;sente au format suivant : ID:page
L'attribut ID correspond &agrave; l'ID de manuel bookID de l'entr&eacute;e figurant dans le fichier help.xml qui indique le fichier
renfermant l'aide &agrave; afficher. L'attribut page de l'entr&eacute;e identifie la page &agrave; afficher. Les pages sont r&eacute;f&eacute;renc&eacute;es dans
le fichier help.map.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true en cas de r&eacute;ussite et false si Dreamweaver ne peut pas ouvrir le fichier sp&eacute;cifi&eacute; dans le
visualisateur d'aide.
Exemple
openHelpURL(&quot;DW_Using:index.htm&quot;);
dreamweaver.openWithApp()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre le fichier sp&eacute;cifi&eacute; dans l'application sp&eacute;cifi&eacute;e.
Arguments
fileURL, appURL
• L'argument fileURL correspond au chemin d'acc&egrave;s au fichier &agrave; ouvrir, exprim&eacute; sous la forme d'une URL de type
file://.
• L'argument appURL correspond au chemin d'acc&egrave;s &agrave; l'application dans laquelle ouvrir le fichier, exprim&eacute; sous
forme d'une URL de type file://.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.openWithBrowseDialog()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue S&eacute;lectionner un &eacute;diteur externe pour permettre &agrave; l'utilisateur de s&eacute;lectionner l'application
dans laquelle ouvrir le fichier sp&eacute;cifi&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
115
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
Arguments
fileURL
• L'argument fileURL correspond au chemin d'acc&egrave;s au fichier &agrave; ouvrir, exprim&eacute; sous la forme d'une URL de type
file://.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.openWithExternalTextEditor()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre le document actif dans l'&eacute;diteur de texte externe d&eacute;fini dans la section Editeurs externes de la bo&icirc;te de dialogue
Pr&eacute;f&eacute;rences.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.openWithImageEditor()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre le fichier nomm&eacute; dans l'&eacute;diteur d'image sp&eacute;cifi&eacute;.
Remarque : Cette fonction lance un m&eacute;canisme sp&eacute;cial d'int&eacute;gration Adobe Fireworks qui renvoie les informations au
document actif lorsque Fireworks est sp&eacute;cifi&eacute; comme &eacute;diteur d'image. Pour &eacute;viter les erreurs lorsqu'aucun document n'est
actif, n'appelez jamais cette fonction &agrave; partir du panneau Site.
Arguments
fileURL, appURL
• L'argument fileURL correspond au chemin d'acc&egrave;s au fichier &agrave; ouvrir, exprim&eacute; sous la forme d'une URL de type
file://.
• L'argument appURL correspond au chemin d'acc&egrave;s &agrave; l'application dans laquelle ouvrir le fichier, exprim&eacute; sous
forme d'une URL de type file://.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
116
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
dreamweaver.validateFlash()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;termine si FlashMX (ou une version ult&eacute;rieure) est install&eacute; sur l'ordinateur local.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si Flash MX (ou une version ult&eacute;rieure) est install&eacute; sur l'ordinateur et false s'il ne l'est pas.
dom.insertFiles()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Ins&egrave;re un ou plusieurs fichiers dans le document actuel au point d'insertion en cours ou &agrave; la place de la s&eacute;lection
actuelle, et invite l'utilisateur &agrave; d&eacute;finir des param&egrave;tres si n&eacute;cessaire.
Arguments:
strFiles
• L'argument strFiles est une cha&icirc;ne qui sp&eacute;cifie les chemins et les noms des fichiers &agrave; ins&eacute;rer. Plusieurs noms de
fichiers peuvent &ecirc;tre transmis &agrave; cette fonction.
Valeurs renvoy&eacute;es
Aucune
dreamweaver.activateApp()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Fait passer l'application sp&eacute;cifi&eacute;e au premier plan.
Arguments:
applicationID
• applicationID est une cha&icirc;ne qui indique quelle application activer, par exemple, dreamweaver.
Valeurs renvoy&eacute;es
Aucune
Derni&egrave;re mise &agrave; jour le 22/6/2011
117
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
dreamweaver.printDocument()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Ex&eacute;cute l'&eacute;quivalent de la commande Fichier &gt; Imprimer le code de Dreamweaver sur le fichier requis.
Arguments:
fileName
• L'argument fileName est une cha&icirc;ne qui contient le nom du fichier &agrave; imprimer, exprim&eacute; sous la forme d'une URL.
Valeurs renvoy&eacute;es
Aucune
dreamweaver.revealDocument()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Rend Dreamweaver actif pour le syst&egrave;me d'exploitation et, si le fichier sp&eacute;cifi&eacute; est ouvert dans Dreamweaver, affiche
Dreamweaver au premier plan.
Arguments:
fileName
• fileName est une cha&icirc;ne qui contient le nom du fichier &agrave; afficher, exprim&eacute; sous la forme d'une URL.
Valeurs renvoy&eacute;es
Aucune
dreamweaver.launchApp()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Lance l'application s&eacute;lectionn&eacute;e, &eacute;ventuellement avec des arguments de ligne de commande.
Arguments:
fileURL
• fileURL est le chemin d'acc&egrave;s &agrave; l'application, indiqu&eacute; sous la forme d'une URL
Derni&egrave;re mise &agrave; jour le 22/6/2011
file://.
118
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
optionalArgs
• optionalArgs est une cha&icirc;ne qui permet de transmettre des arguments de ligne de commande &agrave; l'application
indiqu&eacute;e.
Valeurs renvoy&eacute;es
Aucune
Exemple
// Launches the notepad application to edit filefoo.txt file.
dreamweaver.launchApp(&quot;file:///c:/windows/system32/notepad.exe&quot;, &quot;c:\temp\foo.txt&quot;);
// Launches myapp with some command line arguments.
dreamweaver.launchApp(&quot;file:///c:/bin/myapp.exe&quot;, &quot;-chrome false –print c:\temp\foo.txt&quot;);
Fonctions globales relatives aux applications
Ces fonctions agissent sur l'ensemble d'une application. Elles permettent d'effectuer des t&acirc;ches comme quitter une
application ou acc&eacute;der aux pr&eacute;f&eacute;rences.
dreamweaver.beep()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cr&eacute;e un bip syst&egrave;me.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant appelle la fonction dw.beep() pour attirer l'attention de l'utilisateur sur un message affich&eacute; par la
fonction alert() :
beep(){
if(confirm(&quot;Is your order complete?&quot;)
{
dreamweaver.beep();
alert(&quot;Click OK to submit your order&quot;);
}
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
119
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
dreamweaver.getShowDialogsOnInsert()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si l'option Afficher la bo&icirc;te de dialogue lors de l'insertion d'objets est activ&eacute;e dans la cat&eacute;gorie G&eacute;n&eacute;ral des
pr&eacute;f&eacute;rences.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne qui indique si cette option est activ&eacute;e.
dreamweaver.quitApplication()
Disponibilit&eacute;
Dreamweaver 3.
Description
Quitte Dreamweaver lorsque l'ex&eacute;cution du script appelant cette fonction prend fin.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.showAboutBox()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue A propos de.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
120
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
dreamweaver.showDynamicDataDialog()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Affiche la bo&icirc;te de dialogue Donn&eacute;es dynamiques ou Texte dynamique, puis attend que l'utilisateur ferme la bo&icirc;te de
dialogue. Si l'utilisateur clique sur OK, la fonction showDynamicDataDialog() renvoie une cha&icirc;ne &agrave; ins&eacute;rer dans le
document de l'utilisateur. Cette cha&icirc;ne est renvoy&eacute;e par la fonction API de la source des donn&eacute;es, c'est-&agrave;-dire
generateDynamicDataRef(), et est transmise &agrave; la fonction API du format de donn&eacute;es, formatDynamicDataRef().
La valeur renvoy&eacute;e par formatDynamicDataRef() est la m&ecirc;me que celle renvoy&eacute;e par la fonction
showDynamicDataDialog().
Arguments
source, {title}.
• L'argument source est une cha&icirc;ne contenant le code source qui repr&eacute;sente l'objet de donn&eacute;es dynamique. Il s'agit de
la m&ecirc;me cha&icirc;ne que celle renvoy&eacute;e apr&egrave;s un appel pr&eacute;c&eacute;dent de la m&ecirc;me fonction. Cette fonction utilise le contenu
de l'argument source pour initialiser toutes les commandes de la bo&icirc;te de dialogue afin qu'elles apparaissent
exactement telles qu'elles &eacute;taient au moment o&ugrave; l'utilisateur a cliqu&eacute; sur OK pour cr&eacute;er cette cha&icirc;ne.
Dreamweaver transmet cette cha&icirc;ne &agrave; la fonction inspectDynamicDataRef() pour d&eacute;terminer si la cha&icirc;ne
correspond &agrave; l'un des nœuds de l'arborescence. Si la cha&icirc;ne correspond &agrave; un nœud, celui-ci est s&eacute;lectionn&eacute; lorsque
la bo&icirc;te de dialogue r&eacute;appara&icirc;t. Vous pouvez &eacute;galement transmettre une cha&icirc;ne vide qui n'initialise pas la bo&icirc;te de
dialogue. Par exemple, aucune bo&icirc;te de dialogue n'est initialis&eacute;e lorsqu'elle est utilis&eacute;e pour cr&eacute;er un nouvel&eacute;l&eacute;ment.
• L'argument title, qui est facultatif, est une cha&icirc;ne qui contient le texte &agrave; afficher dans la barre de titre de la bo&icirc;te de
dialogue. S'il n'est pas d&eacute;fini, Dreamweaver affiche Donn&eacute;es dynamiques dans la barre de titre.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui repr&eacute;sente l'objet de donn&eacute;es dynamique, si l'utilisateur clique sur OK.
dreamweaver.showPasteSpecialDialog()
Disponibilit&eacute;
Dreamweaver 8.
Description
Affiche la bo&icirc;te de dialogue Collage sp&eacute;cial. Si l'utilisateur clique sur OK, la fonction showPasteSpecialDialog()
effectue le collage.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
dw.showPasteSpecialDialog();
Derni&egrave;re mise &agrave; jour le 22/6/2011
121
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
dreamweaver.showPreferencesDialog()
Disponibilit&eacute;
Dreamweaver 3. Ajout de l'argument strCategory dans Dreamweaver 8. Mis &agrave; jour dans CS4.
Description
La fonction ouvre la bo&icirc;te de dialogue Pr&eacute;f&eacute;rences.
Arguments
{strCategory}
• L'argument facultatif strCategory doit &ecirc;tre l'une des cha&icirc;nes suivantes pour ouvrir la cat&eacute;gorie correspondante de
la bo&icirc;te de dialogue Pr&eacute;f&eacute;rences : general, accessibility, &quot;html colors&quot; (pour la cat&eacute;gorie Coloration du
code), &quot;html format&quot; (pour la cat&eacute;gorie Format du code), &quot;code hints&quot;, &quot;html rewriting&quot; (pour la cat&eacute;gorie
Correction du code), copyPaste , &quot;css styles&quot;, &quot;file compare&quot;, &quot;external editors&quot; (pour la cat&eacute;gorie
Types de fichiers/Editeurs), fonts, highlighting, &quot;invisible elements&quot;, layers,&quot;new document&quot;,
floaters (pour la cat&eacute;gorie Panneaux), browsers, (pour la cat&eacute;gorie Aper&ccedil;u dans le navigateur), &quot;site ftp&quot;
(pour la cat&eacute;gorie Site), &quot;status bar&quot; et validator. Si Dreamweaver ne reconna&icirc;t pas dans l'argument un nom
de volet valide, la bo&icirc;te de dialogue ouvre le dernier volet actif. Il en va de m&ecirc;me si aucun argument n'est d&eacute;fini.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant ouvre la bo&icirc;te de dialogue Pr&eacute;f&eacute;rences et s&eacute;lectionne la cat&eacute;gorie Coloration du code :
dw.showPreferencesDialog(&quot;html colors&quot;);
dreamweaver.showTagChooser()
Disponibilit&eacute;
Dreamweaver MX.
Description
Active ou d&eacute;sactive l'affichage de la bo&icirc;te de dialogue S&eacute;lecteur de balise afin que les utilisateurs ins&egrave;rent des balises en
mode Code. La fonction affiche la bo&icirc;te de dialogue S&eacute;lecteur de balise au-dessus de toutes les autres fen&ecirc;tres
Dreamweaver. Si la bo&icirc;te de dialogue n'est pas visible, la fonction l'ouvre, l'affiche au premier plan et en fait l'&eacute;l&eacute;ment
actif. Si le s&eacute;lecteur de balise est visible, la fonction masque la bo&icirc;te de dialogue.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
122
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
dw.registerIdleHandler()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Cette fonction enregistre une fonction JavaScript &agrave; appeler de fa&ccedil;on p&eacute;riodique au cours du temps de traitement
inactif.
Arguments
id, idleFunction, interval
• L'argument id est une cha&icirc;ne unique permettant d'identifier la t&acirc;che d'inactivit&eacute; &agrave; enregistrer. Pour assurer que cet
argument soit unique, ajoutez &agrave; cet ID un pr&eacute;fixe correspondant &agrave; un identificateur unique. Par exemple, vous
voudrez peut-&ecirc;tre qu'un bip sonore soit &eacute;mis toutes les 5 secondes, mais pas appeler la t&acirc;che &quot;beep&quot;, parce qu'il est
possible que quelqu'un d'autre ait cr&eacute;&eacute; une t&acirc;che portant le m&ecirc;me nom. Un nom plus appropri&eacute; serait par exemple
&quot;acme_beep_task&quot;, un nom unique fournissant &eacute;galement un contexte.
• L'argument idleFunction est la fonction JavaScript &agrave; appeler au cours du temps de traitement inactif.
• L'argument interval est le nombre de secondes entre les appels de la fonction idleFunction, soumis &agrave; la
disponibilit&eacute; du temps d'inactivit&eacute;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si la t&acirc;che d'inactivit&eacute; a &eacute;t&eacute; enregistr&eacute;e correctement.
Exemple
L'exemple suivant entra&icirc;ne l'&eacute;mission par le syst&egrave;me d'un bip sonore toutes les 5 secondes :
dw.registerIdleHandler(&quot;acme_beep_task&quot;, function() { dw.beep();}, 5);
dw.revokeIdleHandler()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Cette fonction supprime une t&acirc;che d'inactivit&eacute; pr&eacute;c&eacute;demment g&eacute;n&eacute;r&eacute;e par la fonction registerIdleHandler.
L'objectif est de fournir un moyen de supprimer une t&acirc;che d'inactivit&eacute; enregistr&eacute;e pr&eacute;c&eacute;demment. Si une t&acirc;che
d'inactivit&eacute; est cens&eacute;e rester active jusqu'&agrave; ce que l'application soit ferm&eacute;e, il n'est pas n&eacute;cessaire d'appeler cette
fonction. Si c'est le cas, la t&acirc;che d'inactivit&eacute; est supprim&eacute;e automatiquement avant la fermeture de l'application.
Arguments
id
• L'id est une cha&icirc;ne unique permettant d'identifier la t&acirc;che d'inactivit&eacute; enregistr&eacute;e &agrave; supprimer. Il s'agit du m&ecirc;me ID
qui a &eacute;t&eacute; utilis&eacute; initialement pour enregistrer la t&acirc;che.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si la t&acirc;che d'inactivit&eacute; a &eacute;t&eacute; supprim&eacute;e correctement.
Derni&egrave;re mise &agrave; jour le 22/6/2011
123
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
Exemple
L'exemple suivant supprime la t&acirc;che d'inactivit&eacute; nomm&eacute;e &quot;dw_beep_task&quot; de la file d'attente des t&acirc;ches d'inactivit&eacute; :
dw.revokeIdleHandler(&quot;acme_beep_task&quot;);
Fonctions de communication avec Bridge
Les fonctions de communication avec Bridge permettent la communication entre Dreamweaver et l'application
Bridge. Cette communication permet notamment &agrave; l'utilisateur de rechercher facilement des fichiers dans Bridge &agrave;
partir de Dreamweaver.
BridgeTalk.bringToFront()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Fait de l'application sp&eacute;cifi&eacute;e le processus de premier plan en appelant la fonction BridgeTalk::bringToFront().
Arguments
applicationID
• L'argument applicationID est une cha&icirc;ne, par exemple, bridge ou dreamweaver, qui indique quelle application
activer.
Valeurs renvoy&eacute;es
Aucune
Exemple
Cet exemple illustre la fa&ccedil;on dont Dreamweaver impl&eacute;mente la fonction browseInBridge(). Vous cr&eacute;ez d'abord une
instance BridgeTalk, puis vous d&eacute;finissez les deux propri&eacute;t&eacute;s les plus importantes : target et body. &lt;target&gt; est
l'application cible. Dans le cas pr&eacute;sent, il suffit de l'application Bridge. Son identificateur est bridge. &lt;body&gt; est le
message &agrave; envoyer. En r&egrave;gle g&eacute;n&eacute;rale, &lt;body&gt; est un script que l'application cible peut comprendre et ex&eacute;cuter apr&egrave;s
l'avoir re&ccedil;u. La fonction send() est appel&eacute;e pour envoyer la propri&eacute;t&eacute; &lt;body&gt; &agrave; la propri&eacute;t&eacute; &lt;target&gt;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
124
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
if (!JSBridge.isRunning('bridge'))
{
var bt = new BridgeTalk;
var scriptSavePath = browsePath.replace(/['&quot;\\]/g, &quot;\$&amp;&quot;);
var script = &quot;app.document.thumbnail = new Thumbnail(decodeURI('&quot; + scriptSavePath + &quot;'));&quot;;
// Send the script to bridge and give it 10 sec to launch before assuming an error.
bt.target = &quot;bridge&quot;;
bt.body = script;
result = bt.send(10);
}
if (result)
BridgeTalk.bringToFront('bridge');
Bridgetalk.send()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Etablit la communication avec l'application Bridge.
Arguments:
timeout
• L'argument timeout est un attribut qui d&eacute;finit l'intervalle de d&eacute;lai d'attente, en secondes.
Valeurs renvoy&eacute;es
Une valeur bool&eacute;enne indiquant si la communication avec l'application Bridge a r&eacute;ussi (True = r&eacute;ussi, False =
&eacute;chou&eacute;).
Exemple
result = bridgeTalk.send(10);
BridgeTalk.suppressStartupScreen()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Recherche -nostartupscreen dans les options de lancement afin de d&eacute;terminer si la fen&ecirc;tre modale doit &ecirc;tre
supprim&eacute;e apr&egrave;s le d&eacute;marrage.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si les &eacute;crans de d&eacute;marrage doivent &ecirc;tre supprim&eacute;s.
Derni&egrave;re mise &agrave; jour le 22/6/2011
125
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Application
dw.browseInBridge()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Vous permet de parcourir des fichiers dans Bridge &agrave; partir de Dreamweaver. La fonction dw.browseInBridge()
d&eacute;marre l'application Bridge. Si Bridge est d&eacute;j&agrave; en cours d'ex&eacute;cution, dw.browseInBridge bascule vers l'application
Bridge.
Arguments:
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si le script de navigation a &eacute;t&eacute; envoy&eacute; &agrave; l'application Bridge correctement (true = r&eacute;ussi,
false = &eacute;chou&eacute;).
Derni&egrave;re mise &agrave; jour le 22/6/2011
126
Chapitre 12 : Espace de travail
Les fonctions de l'API de l'espace de travail cr&eacute;ent des &eacute;l&eacute;ments dans l'espace de travail Adobe&reg; Dreamweaver&reg; ou
effectuent des actions dessus. Elles permettent d'effectuer les t&acirc;ches suivantes :
• r&eacute;p&eacute;tition d'&eacute;tapes figurant dans le panneau Historique ;
• placement d'un objet dans la barre Insertion ;
• navigation &agrave; l'aide de fonctions de clavier ;
• rechargement de menus ;
• manipulation de fen&ecirc;tres de r&eacute;sultats autonomes ou int&eacute;gr&eacute;es ;
• D&eacute;finition d'options
• positionnement d'une barre d'outils ;
• obtention ou d&eacute;finition du focus.
Fonctions d'historique
Ces fonctions permettent d'annuler, de refaire, d'enregistrer et de lire toutes les &eacute;tapes qui s'affichent dans le panneau
Historique. Par &eacute;tape, on entend une modification apport&eacute;e &agrave; un document (ou &agrave; une s&eacute;lection dans le document)
pouvant &ecirc;tre reproduite. Les m&eacute;thodes de l'objet dreamweaver.historyPalette permettent de contr&ocirc;ler ou d'agir
sur la s&eacute;lection dans le panneau Historique et non dans le document actif.
dom.redo()
Disponibilit&eacute;
Dreamweaver 3.
Description
R&eacute;p&egrave;te l'&eacute;tape qui vient juste d'&ecirc;tre annul&eacute;e dans le document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canRedo() &raquo; &agrave; la page 508.
Derni&egrave;re mise &agrave; jour le 22/6/2011
127
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.undo()
Disponibilit&eacute;
Dreamweaver 3.
Description
Annule l'&eacute;tape qui vient d'&ecirc;tre ex&eacute;cut&eacute;e dans le document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canUndo() &raquo; &agrave; la page 511.
dreamweaver.getRedoText()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient le texte associ&eacute; &agrave; l'op&eacute;ration de modification &agrave; r&eacute;p&eacute;ter si l'utilisateur choisit Edition &gt; R&eacute;p&eacute;ter ou s'il appuie
sur Ctrl+Y (Windows) ou sur Commande+Y (Macintosh).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le texte associ&eacute; &agrave; l'op&eacute;ration de modification &agrave; r&eacute;p&eacute;ter.
Exemple
Si la derni&egrave;re action de l'utilisateur a consist&eacute; &agrave; mettre le texte s&eacute;lectionn&eacute; en gras, un appel &agrave; la fonction
dreamweaver.getRedoText() renvoie &quot;Repeat Apply Bold&quot;.
dreamweaver.getUndoText()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient le texte associ&eacute; &agrave; l'op&eacute;ration de modification &agrave; annuler si l'utilisateur choisit Edition &gt; Annuler ou s'il appuie
sur Ctrl+Z (Windows) ou sur Commande+Z (Macintosh).
Derni&egrave;re mise &agrave; jour le 22/6/2011
128
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le texte associ&eacute; &agrave; l'op&eacute;ration de modification &agrave; annuler.
Exemple
Si la derni&egrave;re action de l'utilisateur a consist&eacute; &agrave; appliquer un style CSS (cascading style sheet) &agrave; un texte s&eacute;lectionn&eacute;,
un appel &agrave; la fonction dreamweaver.getUndoText() renvoie &quot;Undo Apply &lt;span&gt;&quot;.
dreamweaver.playRecordedCommand()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ex&eacute;cute la commande m&eacute;moris&eacute;e dans le document actif.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canPlayRecordedCommand() &raquo; &agrave; la page 515.
dreamweaver.redo()
Disponibilit&eacute;
Dreamweaver 3.
Description
R&eacute;p&egrave;te l'&eacute;tape qui vient juste d'&ecirc;tre annul&eacute;e dans la fen&ecirc;tre de document, la bo&icirc;te de dialogue, le panneau flottant ou le
panneau Site en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canRedo() &raquo; &agrave; la page 516.
Derni&egrave;re mise &agrave; jour le 22/6/2011
129
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dreamweaver.startRecording()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;marre la m&eacute;morisation des &eacute;tapes dans le document actif ; la commande pr&eacute;c&eacute;demment m&eacute;moris&eacute;e est
imm&eacute;diatement &eacute;limin&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.isRecording() &raquo; &agrave; la page 523 (doit retourner une valeur false).
dreamweaver.stopRecording()
Disponibilit&eacute;
Dreamweaver 3.
Description
Arr&ecirc;te la m&eacute;morisation sans intervention de l'utilisateur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.isRecording() &raquo; &agrave; la page 523 (doit retourner une valeur true).
dreamweaver.undo()
Disponibilit&eacute;
Dreamweaver 3.
Description
Annule l'&eacute;tape pr&eacute;c&eacute;dente dans la fen&ecirc;tre de document, la bo&icirc;te de dialogue, le panneau flottant ou le panneau Site
actif.
Derni&egrave;re mise &agrave; jour le 22/6/2011
130
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canUndo() &raquo; &agrave; la page 511.
dreamweaver.historyPalette.clearSteps()
Disponibilit&eacute;
Dreamweaver 3.
Description
Efface toutes les &eacute;tapes du panneau Historique et d&eacute;sactive les &eacute;l&eacute;ments de menu Annuler et R&eacute;tablir.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.historyPalette.copySteps()
Disponibilit&eacute;
Dreamweaver 3.
Description
Copie les &eacute;tapes sp&eacute;cifi&eacute;es de l'historique dans le Presse-papiers. Dreamweaver pr&eacute;vient l'utilisateur de la possibilit&eacute; de
cons&eacute;quences inattendues au cas o&ugrave; les &eacute;tapes sp&eacute;cifi&eacute;es contiendraient une action impossible &agrave; reproduire.
Arguments
arrayOfIndices
• L'argument arrayOfIndices est un tableau d'index de position dans le panneau Historique.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient le code JavaScript correspondant aux &eacute;tapes sp&eacute;cifi&eacute;es de l'historique.
Exemple
L'exemple suivant copie les quatre premi&egrave;res &eacute;tapes dans le panneau Historique :
dreamweaver.historyPalette.copySteps([0,1,2,3]);
Derni&egrave;re mise &agrave; jour le 22/6/2011
131
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dreamweaver.historyPalette.getSelectedSteps()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine quelle section du panneau Historique est s&eacute;lectionn&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau qui contient les index de position de toutes les &eacute;tapes s&eacute;lectionn&eacute;es. La premi&egrave;re position est la position0
(z&eacute;ro).
Exemple
Si la deuxi&egrave;me, la troisi&egrave;me et la quatri&egrave;me &eacute;tapes sont s&eacute;lectionn&eacute;es dans le panneau Historique, comme le montre la
figure ci-apr&egrave;s, un appel &agrave; la fonction dreamweaver.historyPalette.getSelectedSteps() renvoie [1,2,3] :
dreamweaver.historyPalette.getStepCount()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient le nombre d'&eacute;tapes figurant dans le panneau Historique.
Derni&egrave;re mise &agrave; jour le 22/6/2011
132
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
Aucun.
Valeurs renvoy&eacute;es
Nombre entier qui repr&eacute;sente le nombre d'&eacute;tapes r&eacute;pertori&eacute;es actuellement dans le panneau Historique.
dreamweaver.historyPalette.getStepsAsJavaScript()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient l'&eacute;quivalent JavaScript des &eacute;tapes s&eacute;lectionn&eacute;es.
Arguments
arrayOfIndices
• L'argument arrayOfIndices est un tableau d'index de position dans le panneau Historique.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient le code JavaScript correspondant aux &eacute;tapes sp&eacute;cifi&eacute;es de l'historique.
Exemple
Si les trois &eacute;tapes indiqu&eacute;es dans l'illustration ci-apr&egrave;s sont s&eacute;lectionn&eacute;es dans le panneau Historique, un appel &agrave; la
fonction dreamweaver.historyPalette.getStepsAsJavaScript(dw.historyPalette.getSelectedSteps())
renvoie &quot;dw.getDocumentDOM().insertText('Hey diddle diddle, a cat and a fiddle, the cow jumped
over the moon.');\ndw.getDocumentDOM().newBlock();\n dw.getDocumentDOM().insertHTML('img
src=\ &quot;../wdw99/50browsers/images/sun.gif\&quot;', true);\n&quot; :
Derni&egrave;re mise &agrave; jour le 22/6/2011
133
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dreamweaver.historyPalette.getUndoState()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient l'&eacute;tat d'annulation en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
La position du marqueur d'annulation dans le panneau Historique.
dreamweaver.historyPalette.replaySteps()
Disponibilit&eacute;
Dreamweaver 3.
Description
R&eacute;ex&eacute;cute les &eacute;tapes sp&eacute;cifi&eacute;es de l'historique dans le document actif. Dreamweaver pr&eacute;vient l'utilisateur de la
possibilit&eacute; de cons&eacute;quences inattendues dans le cas o&ugrave; les &eacute;tapes sp&eacute;cifi&eacute;es contiendraient une action qui ne peut pas
&ecirc;tre reproduite.
Arguments
arrayOfIndices
• L'argument arrayOfIndices est un tableau d'index de position dans le panneau Historique.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient le code JavaScript correspondant aux &eacute;tapes sp&eacute;cifi&eacute;es de l'historique.
Exemple
Un appel &agrave; la fonction dreamweaver.historyPalette.replaySteps([0,2,3]) r&eacute;ex&eacute;cute la premi&egrave;re, la troisi&egrave;me
et la quatri&egrave;me &eacute;tapes dans le panneau Historique.
dreamweaver.historyPalette.saveAsCommand()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Enregistrer comme commande et permet &agrave; l'utilisateur d'enregistrer les &eacute;tapes sp&eacute;cifi&eacute;es
sous forme de commande. Dreamweaver pr&eacute;vient l'utilisateur de la possibilit&eacute; de cons&eacute;quences inattendues dans le cas
o&ugrave; les &eacute;tapes sp&eacute;cifi&eacute;es contiendraient une action qui ne peut pas &ecirc;tre reproduite.
Derni&egrave;re mise &agrave; jour le 22/6/2011
134
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
arrayOfIndices
• L'argument arrayOfIndices est un tableau d'index de position dans le panneau Historique.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient le code JavaScript correspondant aux &eacute;tapes sp&eacute;cifi&eacute;es de l'historique.
Exemple
L'exemple suivant enregistre la quatri&egrave;me, la sixi&egrave;me et la huiti&egrave;me &eacute;tapes du panneau Historique comme une
commande :
dreamweaver.historyPalette.saveAsCommand([3,5,7]);
dreamweaver.historyPalette.setSelectedSteps()
Disponibilit&eacute;
Dreamweaver 3.
Description
S&eacute;lectionne les &eacute;tapes sp&eacute;cifi&eacute;es dans le panneau Historique.
Arguments
arrayOfIndices
• La fonction arrayOfIndices est un tableau d'index de position dans le panneau Historique. Si aucun argument n'est
d&eacute;fini, aucune &eacute;tape n'est s&eacute;lectionn&eacute;e.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant s&eacute;lectionne la premi&egrave;re, la deuxi&egrave;me et la troisi&egrave;me &eacute;tapes dans le panneau Historique :
dreamweaver.historyPalette.setSelectedSteps([0,1,2]);
dreamweaver.historyPalette.setUndoState()
Disponibilit&eacute;
Dreamweaver 3.
Description
Effectue le nombre d'annulations et de r&eacute;p&eacute;titions n&eacute;cessaires pour arriver &agrave; l'&eacute;tat d'annulation sp&eacute;cifi&eacute;.
Arguments
undoState
• L'argument undoState correspond &agrave; l'objet renvoy&eacute; par la fonction
dreamweaver.historyPalette.getUndoState().
Derni&egrave;re mise &agrave; jour le 22/6/2011
135
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Aucune.
Fonctions d'insertion d'objets
Les fonctions d'insertion d'objets permettent d'effectuer des t&acirc;ches ayant trait aux objets de la barre Insertion ou du
menu Insertion.
dreamweaver.objectPalette.getMenuDefault()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Extrait la cha&icirc;ne d'ID de l'&eacute;l&eacute;ment par d&eacute;faut pour le menu associ&eacute;.
Arguments
menuId
• L'argument menuId correspond &agrave; la cha&icirc;ne d&eacute;finissant le menu dans le fichier insertbar.xml.
Valeurs renvoy&eacute;es
Valeur de la cha&icirc;ne d&eacute;finissant l'ID de l'&eacute;l&eacute;ment par d&eacute;faut.
Exemple
L'exemple suivant attribue l'objet par d&eacute;faut actif du menu Support &agrave; la variable defID :
var defId = dw.objectPalette.getMenuDefault(&quot;DW_Media&quot;);
dreamweaver.objectPalette.setMenuDefault()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
D&eacute;finit l'objet par d&eacute;faut d'un menu d&eacute;roulant. L'ic&ocirc;ne de l'objet par d&eacute;faut repr&eacute;sente le menu d&eacute;roulant sp&eacute;cifi&eacute; dans
la barre Insertion. L'utilisateur peut cliquer sur l'objet par d&eacute;faut pour l'ins&eacute;rer ou cliquer sur la fl&egrave;che figurant en
regard pour ouvrir le menu d&eacute;roulant correspondant afin d'afficher les autres objets de ce menu. Dreamweaver
prendra en compte la nouvelle valeur par d&eacute;faut la prochaine fois que l'utilisateur ouvrira Dreamweaver ou utilisera la
commande Recharger extensions.
Arguments
menuId, defaultId.
• L'argument menuId correspond &agrave; la cha&icirc;ne d&eacute;finissant le menu dans le fichier insertbar.xml.
• L'argument defaultId correspond &agrave; la cha&icirc;ne d&eacute;finissant le nouvel objet par d&eacute;faut dans le champ insertbar.xml.
Derni&egrave;re mise &agrave; jour le 22/6/2011
136
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la configuration de la nouvelle valeur par d&eacute;faut r&eacute;ussit et false dans le cas contraire.
Exemple
L'exemple suivant d&eacute;finit l'objet Flash en qualit&eacute; d'objet par d&eacute;faut pour le menu Support :
dw.objectPalette.setMenuDefault(&quot;DW_Media&quot;, &quot;DW_Flash&quot;);
dreamweaver.reloadObjects()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Recharge tous les objets de la barre Insertion. Cette fonction revient &agrave; maintenir la touche Ctrl (Windows) ou Alt
(Macintosh) enfonc&eacute;e tout en cliquant dans le menu des cat&eacute;gories de la barre Insertion et &agrave; s&eacute;lectionner l'option de
menu Recharger extensions.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le chargement des objets a r&eacute;ussi et false dans le cas contraire.
dom.convertActiveContent()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Convertit tout le contenu actif du document donn&eacute;.
Arguments
forceUpdate
• L'argument forceUpdate est une valeur bool&eacute;enne qui indique si les param&egrave;tres de pr&eacute;f&eacute;rence de l'utilisateur
doivent &ecirc;tre remplac&eacute;s (true, = remplacer). Cet argument est facultatif.
Valeurs renvoy&eacute;es
Une valeur bool&eacute;enne true si l'ensemble du contenu actif a &eacute;t&eacute; converti correctement. Renvoie false si une partie du
contenu actif qui devait &ecirc;tre converti ne l'a pas &eacute;t&eacute;, par exemple, des balises d'objet se trouvant dans une r&eacute;gion
verrouill&eacute;e d'une instance de mod&egrave;le.
Exemple
if( !dom.convertActiveContent(true) ) {
alert(dw.loadString(&quot;ActiveContent/notAllConverted&quot;));
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
137
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.convertNextActiveContent()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Indique qu'un script sera cr&eacute;&eacute; pour la prochaine balise d'objet qui sera ins&eacute;r&eacute;e (pour le reste de l'action de modification
en cours, action qui n'est pas annulable). Cette fonction vous permet d'utiliser une extension de tiers pour g&eacute;n&eacute;rer le
script appropri&eacute; pour le contenu actif sp&eacute;cifique.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
dom.convertNextActiveContent();
dom.insertHTML(&quot;&lt;object classid=\&quot;clsid:D27CDB6E-AE6D-11cf-96B8-444553540000\&quot; codebase=\
&quot;http://download.Macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=7,0,19,0\&quot;
width=\&quot;100\&quot; height=\&quot;22\&quot;&gt;&lt;param name=\&quot;movie\&quot; value=\&quot;button1.swf\&quot; /&gt;&lt;param name=\
&quot;quality\&quot; value=\&quot;high\&quot; /&gt;&lt;embed src=\&quot;button1.swf\&quot; quality=\&quot;high\&quot; pluginspage=\
&quot;http://www.Macromedia.com/go/getflashplayer\&quot; type=\&quot;application/
x-shockwave-flash\&quot;width=\&quot;100\&quot; height=\&quot;22\&quot;&gt;&lt;/embed&gt;&lt;/object&gt;\&quot;);
Fonctions relatives au clavier
Les fonctions relatives au clavier &eacute;mulent les op&eacute;rations de d&eacute;placement au sein d'un document effectu&eacute;es &agrave; l'aide des
touches de direction RET.ARR, SUPPR., PG.PREC et PG.SUIV. Parall&egrave;lement aux fonctions g&eacute;n&eacute;rales, telles que
arrowLeft() (&eacute;quivalent &agrave; la touche de direction GAUCHE) et backspaceKey() (&eacute;quivalent &agrave; la touche RET.ARR),
Dreamweaver propose &eacute;galement des m&eacute;thodes permettant d'acc&eacute;der soit au mot ou paragraphe suivant ou pr&eacute;c&eacute;dent,
soit au d&eacute;but ou &agrave; la fin d'une ligne ou d'un document.
dom.arrowDown()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le point d'insertion vers le bas du nombre de lignes sp&eacute;cifi&eacute;.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument nTimes correspond au nombre de fois o&ugrave; le point d'insertion doit se d&eacute;placer vers le bas. Si cet
argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur 1.
Derni&egrave;re mise &agrave; jour le 22/6/2011
138
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
• L'argument bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si cet argument n'est
pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
dom.arrowLeft()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le point d'insertion vers la gauche du nombre de colonnes sp&eacute;cifi&eacute;.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes correspond au nombre de fois o&ugrave; le point d'insertion doit se d&eacute;placer vers la gauche.
Si cet argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si cet
argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
dom.arrowRight()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le point d'insertion vers la droite du nombre de colonnes sp&eacute;cifi&eacute;.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes correspond au nombre de fois o&ugrave; le point d'insertion doit se d&eacute;placer vers la droite.
Si cet argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si cet
argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
139
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.arrowUp()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le point d'insertion vers le haut du nombre de lignes sp&eacute;cifi&eacute;.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes correspond au nombre de fois o&ugrave; le point d'insertion doit se d&eacute;placer vers le haut. Si
cet argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si cet
argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
dom.backspaceKey()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction revient &agrave; appuyer sur la touche RET.ARR un nombre de fois donn&eacute;. Le r&eacute;sultat obtenu diff&egrave;re selon qu'il
y ait une s&eacute;lection en cours ou simplement un point d'insertion.
Arguments
{nTimes}
• L'argument facultatif nTimes correspond au nombre de fois qu'une op&eacute;ration de retour arri&egrave;re doit avoir lieu. Si
l'argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur 1.
Valeurs renvoy&eacute;es
Aucune.
dom.deleteKey()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction revient &agrave; appuyer sur la touche SUPPR. un nombre de fois donn&eacute;. Le r&eacute;sultat obtenu diff&egrave;re selon qu'il
y ait une s&eacute;lection en cours ou simplement un point d'insertion.
Derni&egrave;re mise &agrave; jour le 22/6/2011
140
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
{nTimes}
• L'argument facultatif nTimes correspond au nombre de fois qu'une op&eacute;ration de suppression doit avoir lieu. Si
l'argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur 1.
Valeurs renvoy&eacute;es
Aucune.
dom.endOfDocument()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le point d'insertion &agrave; la fin du document, dans la fen&ecirc;tre active (selon le cas, apr&egrave;s le dernier contenu visible
dans la fen&ecirc;tre de document ou apr&egrave;s la balise HTML de fermeture dans l'inspecteur de code).
Arguments
{bShiftIsDown}
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si l'argument
n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
dom.endOfLine()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le point d'insertion &agrave; la fin de la ligne.
Arguments
{bShiftIsDown}
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si l'argument
n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
141
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.nextParagraph()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le point d'insertion au d&eacute;but du paragraphe suivant ou saute plusieurs paragraphes si l'argument nTimes est
sup&eacute;rieur &agrave; 1.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes correspond au nombre de paragraphes suivants que le point d'insertion doit sauter.
Si cet argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur 1.
• L'argument bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si cet argument n'est
pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
dom.nextWord()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le point d'insertion au d&eacute;but du mot suivant ou saute plusieurs mots si l'argument nTimes est sup&eacute;rieur &agrave; 1.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes correspond au nombre de mots suivants que le point d'insertion doit sauter. Si cet
argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si cet
argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
dom.pageDown()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le point d'insertion d'une page vers le bas (&eacute;quivalent &agrave; la touche PG.SUIV).
Derni&egrave;re mise &agrave; jour le 22/6/2011
142
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes correspond au nombre de pages suivantes que le point d'insertion doit sauter. Si cet
argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si cet
argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
dom.pageUp()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le point d'insertion d'une page vers le haut (&eacute;quivalent &agrave; la touche PG.PREC).
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes correspond au nombre de pages pr&eacute;c&eacute;dentes que le point d'insertion doit sauter. Si
cet argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si cet
argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
dom.previousParagraph()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le point d'insertion au d&eacute;but du paragraphe pr&eacute;c&eacute;dent ou saute plusieurs paragraphes si l'argument nTimes
est sup&eacute;rieur &agrave; 1.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes correspond au nombre de paragraphes pr&eacute;c&eacute;dents que le point d'insertion doit sauter.
Si cet argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si cet
argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Derni&egrave;re mise &agrave; jour le 22/6/2011
143
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Aucune.
dom.previousWord()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le point d'insertion au d&eacute;but du mot pr&eacute;c&eacute;dent ou saute plusieurs mots si l'argument nTimes est sup&eacute;rieur &agrave; 1.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes correspond au nombre de mots pr&eacute;c&eacute;dents que le point d'insertion doit sauter. Si cet
argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur 1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si cet
argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
dom.startOfDocument()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le point d'insertion au d&eacute;but du document (selon le cas, avant le premier contenu visible dans la fen&ecirc;tre de
document ou avant la balise HTML d'ouverture dans l'inspecteur de code).
Arguments
{bShiftIsDown}
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si l'argument
n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
dom.startOfLine()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
144
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Description
D&eacute;place le point d'insertion au d&eacute;but de la ligne.
Arguments
{bShiftIsDown}
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique s'il faut &eacute;tendre la s&eacute;lection. Si l'argument
n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.mapKeyCodeToChar()
Disponibilit&eacute;
Dreamweaver 4.
Description
Convertit un code de touche tel qu'il est indiqu&eacute; dans le champ keyCode de l'objet &eacute;v&eacute;nement en caract&egrave;re. Vous devez
v&eacute;rifier si le code de touche est une touche sp&eacute;ciale, telle que les touches ORIG, PG. SUIV, etc. S'il ne s'agit pas d'une
touche sp&eacute;ciale, cette m&eacute;thode peut &ecirc;tre utilis&eacute;e pour traduire le code en code de caract&egrave;re affichable &agrave; l'utilisateur.
Arguments
keyCode.
• L'argument keyCode est le code de touche &agrave; traduire en caract&egrave;re.
Valeurs renvoy&eacute;es
Renvoie le code de caract&egrave;re si la correspondance a r&eacute;ussi. Renvoie 0 dans le cas contraire.
Fonctions relatives aux menus
Ces fonctions permettent d'optimiser et de recharger les menus dans Dreamweaver. Les fonctions
dreamweaver.getMenuNeedsUpdating() et dreamweaver.notifyMenuUpdated() sont sp&eacute;cialement con&ccedil;ues pour
emp&ecirc;cher l'ex&eacute;cution de routines de mise &agrave; jour superflues sur les menus dynamiques int&eacute;gr&eacute;s &agrave; Dreamweaver. Pour
plus d'informations, voir &laquo; dreamweaver.getMenuNeedsUpdating() &raquo; &agrave; la page 144 et
&laquo; dreamweaver.notifyMenuUpdated() &raquo; &agrave; la page 145.
dreamweaver.getMenuNeedsUpdating()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si le menu sp&eacute;cifi&eacute; doit &ecirc;tre mis &agrave; jour.
Derni&egrave;re mise &agrave; jour le 22/6/2011
145
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
menuId
• L'argument menuId est une cha&icirc;ne contenant la valeur de l'attribut id de l'&eacute;l&eacute;ment de menu, tel qu'il est d&eacute;fini dans
le fichier menus.xml.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne qui indique si le menu doit &ecirc;tre mis &agrave; jour. Cette fonction renvoie la valeur false uniquement si la
fonction dreamweaver.notifyMenuUpdated() a &eacute;t&eacute; appel&eacute;e avec cet argument menuId et si la valeur renvoy&eacute;e par
menuListFunction n'a pas chang&eacute;. Pour plus d’informations, voir &laquo; dreamweaver.notifyMenuUpdated() &raquo; &agrave; la
page 145.
dreamweaver.notifyMenuUpdated()
Disponibilit&eacute;
Dreamweaver 3.
Description
Pr&eacute;vient Dreamweaver lorsque le menu sp&eacute;cifi&eacute; doit &ecirc;tre mis &agrave; jour.
Arguments
menuId, menuListFunction.
• L'argument menuId est une cha&icirc;ne contenant la valeur de l'attribut id de l'&eacute;l&eacute;ment de menu, tel qu'il est d&eacute;fini dans
le fichier menus.xml.
• L'argument menuListFunction doit &ecirc;tre l'une des cha&icirc;nes suivantes : &quot;dw.cssStylePalette.getStyles()&quot;,
&quot;dw.getDocumentDOM().getFrameNames()&quot;, &quot;dw.getDocumentDOM().getEditableRegionList&quot;,
&quot;dw.getBrowserList()&quot;, &quot;dw.getRecentFileList()&quot;, &quot;dw.getTranslatorList()&quot;, &quot;dw.getFontList()&quot;,
&quot;dw.getDocumentList()&quot;, &quot;dw.htmlStylePalette.getStyles()&quot; ou &quot;site.getSites()&quot;.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.reloadMenus()
Disponibilit&eacute;
Dreamweaver 3.
Description
Recharge la structure de menus &agrave; partir du fichier menus.xml du dossier Configuration.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
146
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Fonctions de la fen&ecirc;tre de r&eacute;sultats
Les fonctions de la fen&ecirc;tre de r&eacute;sultats vous permettent de dialoguer avec les panneaux int&eacute;gr&eacute;s du groupe de panneaux
R&eacute;sultats ou de cr&eacute;er une fen&ecirc;tre ind&eacute;pendante contenant des colonnes de donn&eacute;es format&eacute;es.
Groupe de panneaux R&eacute;sultats int&eacute;gr&eacute;
Ces fonctions produisent l'affichage dans le groupe de panneaux R&eacute;sultats. Le groupe de panneaux R&eacute;sultats pr&eacute;sente
des panneaux &agrave; onglets sur les recherches, la validation de la source, les rapports au niveau du site, la v&eacute;rification de
compatibilit&eacute; avec les navigateurs, le d&eacute;bogage de serveur, les connexions FTP et les v&eacute;rifications de liens.
Panneaux enfants sp&eacute;cifiques
Les panneaux enfants suivants sont des fen&ecirc;tres de r&eacute;sultats int&eacute;gr&eacute;es qui existent toujours dans l'interface
Dreamweaver et auxquelles il est possible d'acc&eacute;der directement.
•
dreamweaver.resultsPalette.siteReports
•
dreamweaver.resultsPalette.validator
•
dreamweaver.resultsPalette.bcc
Ces panneaux &eacute;tant des fen&ecirc;tres de r&eacute;sultats, vous pouvez utiliser les m&eacute;thodes suivantes, d&eacute;finies pour les fen&ecirc;tres de
r&eacute;sultats ind&eacute;pendantes :
•
getItem()
•
getItemCount()
•
getSelectedItem()
•
setSelectedItem()
Pour plus d'informations sur l'utilisation des m&eacute;thodes resWin, voir &laquo; Fen&ecirc;tre de r&eacute;sultats ind&eacute;pendante &raquo; &agrave; la
page 151.
Panneau enfant actif
Les fonctions API g&eacute;n&eacute;rales suivantes s'appliquent au panneau enfant actif. Certains panneaux enfants peuvent ignorer
certaines de ces fonctions. Si le panneau enfant actif ne prend pas la fonction en charge, l'appel n'a aucun effet.
dreamweaver.showResults()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Ouvre le panneau flottant de r&eacute;sultats sp&eacute;cifi&eacute; et s&eacute;lectionne l'&eacute;l&eacute;ment.
Remarque : Cette fonction est uniquement prise en charge dans les fen&ecirc;tres Validation, V&eacute;rification de compatibilit&eacute; avec
les navigateurs et les panneaux Rapports du site du groupe de panneaux de r&eacute;sultats.
Derni&egrave;re mise &agrave; jour le 22/6/2011
147
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
floaterName, floaterIndex
• L'argument floaterName est une cha&icirc;ne indiquant le panneau flottant de r&eacute;sultats &agrave; ouvrir. Les valeurs autoris&eacute;es
sont 'validation' ou 'reports'.
• L'argument floaterIndex est un nombre ou une cha&icirc;ne. Utilisez un nombre pour sp&eacute;cifier l'index d'un &eacute;l&eacute;ment &agrave;
s&eacute;lectionner dans le panneau de r&eacute;sultats. Utilisez une cha&icirc;ne pour sp&eacute;cifier l'URL d'un document. Dans le cas d'une
URL, la fonction s&eacute;lectionne le premier &eacute;l&eacute;ment visible de ce document.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant v&eacute;rifie la pr&eacute;sence d'erreurs au d&eacute;but de la s&eacute;lection en cours dans le document. Si des erreurs sont
d&eacute;tect&eacute;es, elles sont affich&eacute;es dans la fen&ecirc;tre sp&eacute;cifi&eacute;e (floaterName) du panneau de r&eacute;sultats. Dans le cas contraire,
il ouvre la fen&ecirc;tre V&eacute;rification de compatibilit&eacute; avec les navigateurs du panneau de r&eacute;sultats et affiche le premier
&eacute;l&eacute;ment visible du document.
var offset = dw.getDocumentDOM().source.getSelection()[0];
var errors = dw.getDocumentDOM().source.getValidationErrorsForOffset(offset);
if ( errors &amp;&amp; errors.length &gt; 0 )
dw.showResults( errors[0].floaterName, errors[0].floaterIndex );
else
dw.showResults('bcc', dw.getDocumentDOM().URL);
dreamweaver.resultsPalette.siteReports.addResultItem()
Disponibilit&eacute;
Dreamweaver 4.
Description
Ajoute une nouvelle entr&eacute;e dans le panneau Rapports du site, en fonction des informations figurant dans le fichier
trait&eacute; par la fonction processfile().
Cette fonction est uniquement disponible dans le rappel processFile() d'un rapport de site. Pour plus
d'informations sur les rapports de site, consultez la rubrique &laquo; Rapports &raquo; dans Extension de Dreamweaver.
Arguments
strFilePath, strIcon, strDisplay, strDesc, {iLineNo}, {iStartSel}, {iEndSel}
• L'argument strFilePath est le chemin d'acc&egrave;s complet &agrave; l'URL du fichier &agrave; traiter.
• L'argument strIcon est le chemin d'acc&egrave;s &agrave; l'ic&ocirc;ne &agrave; utiliser. Pour afficher une ic&ocirc;ne int&eacute;gr&eacute;e, utilisez une valeur
comprise entre 1 et 10 plut&ocirc;t que le chemin d'acc&egrave;s complet &agrave; l'ic&ocirc;ne (utilisez la valeur 0 pour n'afficher aucune
ic&ocirc;ne). L'illustration ci-dessous indique les ic&ocirc;nes correspondant aux chiffres allant de 1 &agrave; 10 :
• L'argument strDisplay est la cha&icirc;ne &agrave; afficher &agrave; l'utilisateur dans la premi&egrave;re colonne de la fen&ecirc;tre de r&eacute;sultats
(g&eacute;n&eacute;ralement le nom de fichier).
Derni&egrave;re mise &agrave; jour le 22/6/2011
148
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
• L'argument strDesc est la description qui accompagne l'entr&eacute;e.
• L'argument iLineNo est le nombre de lignes figurant dans le fichier (facultatif).
• L'argument iStartSel indique le d&eacute;but du d&eacute;calage dans le fichier (facultatif, mais s'il est pr&eacute;sent, il faut &eacute;galement
utiliser l'argument iEndSel).
• L'argument iEndSel indique la fin du d&eacute;calage dans le fichier (obligatoire si l'argument iStartSel est utilis&eacute;).
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.resultsPalette.clear()
Disponibilit&eacute;
Dreamweaver MX.
Description
Efface le contenu du panneau actif.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.resultsPalette.canClear() &raquo; &agrave; la page 524.
dreamweaver.resultsPalette.Copy()
Disponibilit&eacute;
Dreamweaver MX.
Description
Envoie un message copi&eacute; &agrave; la fen&ecirc;tre active (souvent utilis&eacute; pour la fen&ecirc;tre de connexion FTP).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.resultsPalette.canCopy() &raquo; &agrave; la page 524.
Derni&egrave;re mise &agrave; jour le 22/6/2011
149
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dreamweaver.resultsPalette.cut()
Disponibilit&eacute;
Dreamweaver MX.
Description
Envoie un message coup&eacute; &agrave; la fen&ecirc;tre active (souvent utilis&eacute; pour la fen&ecirc;tre de connexion FTP).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.resultsPalette.canCut() &raquo; &agrave; la page 524.
dreamweaver.resultsPalette.Paste()
Disponibilit&eacute;
Dreamweaver MX.
Description
Envoie un message coll&eacute; &agrave; la fen&ecirc;tre active (souvent utilis&eacute; pour la fen&ecirc;tre de connexion FTP).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.resultsPalette.canPaste() &raquo; &agrave; la page 525.
dreamweaver.resultsPalette.openInBrowser
Disponibilit&eacute;
Dreamweaver MX.
Description
Envoie un rapport (Rapports de site, V&eacute;rification du navigateur cible, Validation et V&eacute;rificateur de lien) vers le
navigateur par d&eacute;faut.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
150
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.resultsPalette.canOpenInBrowser() &raquo; &agrave; la page 525.
dreamweaver.resultsPalette.openInEditor()
Disponibilit&eacute;
Dreamweaver MX.
Description
Saute &agrave; la ligne s&eacute;lectionn&eacute;e pour les rapports sp&eacute;cifiques (Rapports du site, V&eacute;rification du navigateur cible,
Validation et V&eacute;rificateur de lien) et ouvre le document dans l'&eacute;diteur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.resultsPalette.canOpenInEditor() &raquo; &agrave; la page 525.
dreamweaver.resultsPalette.save()
Disponibilit&eacute;
Dreamweaver MX.
Description
Ouvre la bo&icirc;te de dialogue Enregistrer pour une fen&ecirc;tre qui prend en charge la fonction Enregistrer (Rapports du site,
V&eacute;rification du navigateur cible, Validation et V&eacute;rificateur de lien).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.resultsPalette.canSave() &raquo; &agrave; la page 526.
Derni&egrave;re mise &agrave; jour le 22/6/2011
151
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dreamweaver.resultsPalette.selectAll()
Disponibilit&eacute;
Dreamweaver MX.
Description
Envoie une commande S&eacute;lectionner tout vers la fen&ecirc;tre active.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.resultsPalette.canSelectAll() &raquo; &agrave; la page 526.
Fen&ecirc;tre de r&eacute;sultats ind&eacute;pendante
La fonction dreamweaver.createResultsWindow() cr&eacute;e une fen&ecirc;tre de r&eacute;sultats.
dreamweaver.createResultsWindow()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cr&eacute;e une nouvelle fen&ecirc;tre de r&eacute;sultats et renvoie une r&eacute;f&eacute;rence d'objet JavaScript &agrave; la fen&ecirc;tre.
Arguments
strName, arrColumns
• L'argument strName est la cha&icirc;ne &agrave; utiliser pour le titre de la fen&ecirc;tre.
• L'argument arrColumns est un tableau de noms de colonnes &agrave; utiliser dans le contr&ocirc;le de liste.
Valeurs renvoy&eacute;es
R&eacute;f&eacute;rence d'objet &agrave; la fen&ecirc;tre cr&eacute;&eacute;e.
resWin.addItem()
Disponibilit&eacute;
Dreamweaver 4.
Description
Ajoute un nouvel &eacute;l&eacute;ment &agrave; la fen&ecirc;tre de r&eacute;sultats.
Derni&egrave;re mise &agrave; jour le 22/6/2011
152
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Remarque : Utilisez uniquement les fen&ecirc;tres de r&eacute;sultats ind&eacute;pendantes cr&eacute;&eacute;es &agrave; l'aide de
&laquo; dreamweaver.createResultsWindow() &raquo; &agrave; la page 151. La fonction resWin.addItem() ne peut pas &ecirc;tre utilis&eacute;e avec les
fen&ecirc;tres de r&eacute;sultats int&eacute;gr&eacute;es, notamment avec les fen&ecirc;tres Validation, V&eacute;rifier la compatibilit&eacute; avec les navigateurs ou
Rapports du site.
Arguments
resultWindowObj, strIcon, strDesc, itemData, iStartSel, iEndSel, colNdata
• L'argument resultWindowObj correspond &agrave; l'objet renvoy&eacute; par la fonction createResultsWindow().
• L'argument strIcon est une cha&icirc;ne indiquant le chemin d'acc&egrave;s &agrave; l'ic&ocirc;ne &agrave; utiliser. Pour afficher une ic&ocirc;ne int&eacute;gr&eacute;e,
utilisez une valeur comprise entre 1 et 10 plut&ocirc;t que le chemin d'acc&egrave;s complet &agrave; l'ic&ocirc;ne. Utilisez la valeur 0 pour
n'afficher aucune ic&ocirc;ne. L'illustration ci-dessous indique les ic&ocirc;nes correspondant aux chiffres allant de 1 &agrave; 10 :
• L'argument strDesc correspond &agrave; la description d&eacute;taill&eacute;e de l'&eacute;l&eacute;ment. Indiquez &quot;0&quot; s'il n'y a pas dedescription.
• L'argument itemData est une cha&icirc;ne qui peut vous servir &agrave; stocker des donn&eacute;es particuli&egrave;res relatives &agrave; l'&eacute;l&eacute;ment &agrave;
ajouter (num&eacute;ro de ligne du document, par exemple).
• L'argument iStartSel indique le d&eacute;but du d&eacute;calage de la s&eacute;lection dans le fichier. Entrez la valeur null s'il n'y a pas
de d&eacute;calage.
• L'argument iEndSel indique la fin du d&eacute;calage de la s&eacute;lection dans le fichier. Entrez la valeur null s'il n'y a pas de
d&eacute;calage.
• L'argument colNdata est un tableau de cha&icirc;nes qui contient les donn&eacute;es de chaque colonne (par exemple, tableau
de 3 cha&icirc;nes s'il existe 3 colonnes).
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'&eacute;l&eacute;ment a &eacute;t&eacute; ajout&eacute;, false dans le cas contraire.
Exemple
L'exemple suivant cr&eacute;e une fen&ecirc;tre de r&eacute;sultats du nom de resWin dont les colonnes s'intitulent Frodo, Sam et Gollum.
L'appel de la fonction resWin.addItem() ajoute une ic&ocirc;ne de dossier ainsi que les trois cha&icirc;nes (msg1, msg2 et msg3)
dans les trois colonnes d&eacute;finies pour la fen&ecirc;tre.
var resWin = dw.createResultsWindow(&quot;Test Window&quot;, [&quot;Frodo&quot;, &quot;Sam&quot;, &quot;Gollum&quot;]);
resWin.addItem(resWin, &quot;3&quot;, &quot;Description&quot;, null, null, null, [&quot;msg1&quot;, &quot;msg2&quot;, &quot;msg3&quot;]);
resWin.getItem()
Disponibilit&eacute;
Dreamweaver 4.
Description
Extrait un tableau d'&eacute;l&eacute;ments qui incluent le nom de la commande qui a ajout&eacute; l'&eacute;l&eacute;ment et les m&ecirc;mes cha&icirc;nes que
celles transmises &agrave; la fonction addItem().
Derni&egrave;re mise &agrave; jour le 22/6/2011
153
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
itemIndex
• L'argument itemIndex correspond &agrave; l'index de l'&eacute;l&eacute;ment dont les donn&eacute;es doivent &ecirc;tre extraites.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes. Le premier &eacute;l&eacute;ment du tableau correspond au nom de la commande qui a ajout&eacute; l'&eacute;l&eacute;ment ; les
autres &eacute;l&eacute;ments correspondent aux m&ecirc;mes cha&icirc;nes que celles transmises &agrave; la fonction addItem().
resWin.getItemCount()
Disponibilit&eacute;
Dreamweaver 4.
Description
Extrait le nombre d'&eacute;l&eacute;ments contenus dans la liste.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Le nombre d'&eacute;l&eacute;ments contenus dans la liste.
resWin.getSelectedItem()
Disponibilit&eacute;
Dreamweaver 4.
Description
Extrait l'index de l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
L'index de l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;.
resWin.setButtons()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;finit les boutons sp&eacute;cifi&eacute;s par l'argument arrButtons.
Derni&egrave;re mise &agrave; jour le 22/6/2011
154
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
cmdDoc, arrButtons
• L'argument cmdDoc est un objet document repr&eacute;sentant la commande utilis&eacute;e pour appeler la fonction. Les
commandes doivent utiliser le mot cl&eacute; this.
• L'argument arrButtons est un tableau de cha&icirc;nes correspondant au texte du bouton et au code JavaScript &agrave; ex&eacute;cuter
lorsque l'utilisateur clique sur le bouton en question. Cet argument fonctionne de la m&ecirc;me mani&egrave;re que la fonction
commandButtons() pour les commandes. Vous ne pouvez d&eacute;finir que deux boutons dans la fen&ecirc;tre.
Valeurs renvoy&eacute;es
Aucune.
resWin.setCallbackCommands()
Disponibilit&eacute;
Dreamweaver 4.
Description
Indique &agrave; la fen&ecirc;tre de r&eacute;sultats sur quelles commandes la m&eacute;thode processFile() doit &ecirc;tre appel&eacute;e. Si cette fonction
n'est pas appel&eacute;e, la commande qui a cr&eacute;&eacute; la fen&ecirc;tre de r&eacute;sultats est appel&eacute;e.
Arguments
arrCmdNames.
• L'argument arrCmdNames est un tableau de noms de commandes sur lesquelles appeler la fonction
processFile().
Valeurs renvoy&eacute;es
Aucune.
resWin.setColumnWidths()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;finit la largeur de chaque colonne.
Arguments
arrWidth.
• L'argument arrWidth est un tableau de nombres entiers repr&eacute;sentant les largeurs &agrave; utiliser pour chaque colonne de
la commande.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
155
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
resWin.setFileList()
Disponibilit&eacute;
Dreamweaver 4.
Description
Indique &agrave; la fen&ecirc;tre de r&eacute;sultats une liste de fichiers, de dossiers ou des deux sur lesquels appeler un ensemble de
commandes &agrave; traiter.
Arguments
arrFilePaths, bRecursive.
• L'argument arrFilePaths est un tableau de chemins de fichier ou de dossier &agrave; r&eacute;p&eacute;ter.
• L'argument bRecursive est une valeur bool&eacute;enne indiquant si la r&eacute;p&eacute;tition doit &ecirc;tre r&eacute;currente (true) ou non
(false).
Valeurs renvoy&eacute;es
Aucune.
resWin.setSelectedItem()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;finit l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; sur l'&eacute;l&eacute;ment sp&eacute;cifi&eacute; par itemIndex.
Arguments
itemIndex
• L'index de l'&eacute;l&eacute;ment &agrave; s&eacute;lectionner contenu dans la liste.
Valeurs renvoy&eacute;es
L'index de l'ancien &eacute;l&eacute;ment s&eacute;lectionn&eacute;
resWin.setTitle()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;finit le titre de la fen&ecirc;tre.
Arguments
strTitle.
• L'argument strTitle est le nouveau titre du panneau flottant.
Derni&egrave;re mise &agrave; jour le 22/6/2011
156
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Aucune.
resWin.startProcessing()
Disponibilit&eacute;
Dreamweaver 4.
Description
Lance le traitement du fichier.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
resWin.stopProcessing()
Disponibilit&eacute;
Dreamweaver 4.
Description
Arr&ecirc;te le traitement du fichier.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
D&eacute;bogage de serveur
Dreamweaver peut solliciter des fichiers &agrave; partir d'Adobe ColdFusion et afficher la r&eacute;ponse dans son navigateur
incorpor&eacute;. Lorsque le serveur renvoie la r&eacute;ponse, Dreamweaver recherche un paquet de XML ayant une signature
connue, dans la r&eacute;ponse. Si Dreamweaver trouve XML avec cette signature, il traite XML et affiche les informations
contenues dans une commande d'arborescence. Cette arborescence affiche des informations sur les &eacute;l&eacute;ments suivants :
• Ensemble des mod&egrave;les, balises personnalis&eacute;es et fichiers inclus utilis&eacute;s pour cr&eacute;er la page CFM rendue
• Exceptions
• Requ&ecirc;tes SQL
• Requ&ecirc;tes d'objets
• Variables
• Plage de trac&eacute;
Derni&egrave;re mise &agrave; jour le 22/6/2011
157
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
En outre, le panneau D&eacute;bogage du serveur peut afficher des donn&eacute;es de d&eacute;bogage provenant d'autres mod&egrave;les de
serveur. Pour configurer Dreamweaver afin que le programme d&eacute;bogue les autres mod&egrave;les de serveur, utilisez la
fonction dreamweaver.resultsPalette.debugWindow.addDebugContextData().
dreamweaver.resultsPalette.debugWindow.addDebugContextData()
Disponibilit&eacute;
Dreamweaver MX.
Description
Interpr&egrave;te un fichier XML personnalis&eacute; renvoy&eacute; du serveur sp&eacute;cifi&eacute; dans la bo&icirc;te de dialogue D&eacute;finition du site. Le
contenu du fichier XML affiche les donn&eacute;es de l'arborescence dans le panneau D&eacute;bogage du serveur, pour que vous
puissiez utiliser le panneau D&eacute;bogage du serveur en vue d'&eacute;valuer le contenu g&eacute;n&eacute;r&eacute; par le serveur &agrave; partir des
diff&eacute;rents mod&egrave;les de serveur.
Arguments
treedata.
• L'argument treedata est la cha&icirc;ne XML renvoy&eacute;e par le serveur. La cha&icirc;ne XML doit utiliser la mise en forme
suivante :
server debug node
Noeud racine pour les donn&eacute;es XML de d&eacute;bogage
debugnode
Correspond &agrave; tous les nœuds
context
Nom de l'&eacute;l&eacute;ment qui appara&icirc;t dans la liste de contexte
icon
Ic&ocirc;ne &agrave; utiliser pour le nœud d'arborescence
name
Nom &agrave; afficher
value
Valeur &agrave; afficher
timestamp
Uniquement applicable au nœud de contexte
Les cha&icirc;nes suivantes sont facultatives :
jumptoline
Etablit un lien vers un num&eacute;ro de ligne sp&eacute;cifique
template
Nom de la partie du fichier de mod&egrave;le de l'URL
path
Chemin du fichier &agrave; partir du serveur
line number
Num&eacute;ro de ligne dans le fichier
start position
D&eacute;but du d&eacute;calage de caract&egrave;res dans la ligne
end position
Fin du d&eacute;calage de caract&egrave;res dans la ligne
Par exemple :
Derni&egrave;re mise &agrave; jour le 22/6/2011
158
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
&lt;serverdebuginfo&gt;
&lt;context&gt;
&lt;template&gt;&lt;![CDATA[/ooo/master.cfm]]&gt;&lt;/template&gt;
&lt;path&gt;&lt;![CDATA[C:\server\wwwroot\ooo\master.cfm]]&gt;&lt;/path&gt;
&lt;timestamp&gt;&lt;![CDATA[0:0:0.0]]&gt;&lt;/timestamp&gt;
&lt;/context&gt;
&lt;debugnode&gt;
&lt;name&gt;&lt;![CDATA[CGI]]&gt;&lt;/name&gt;
&lt;icon&gt;&lt;![CDATA[ServerDebugOutput/ColdFusion/CGIVariables.gif]]&gt;&lt;/icon&gt;
&lt;debugnode&gt;
&lt;name&gt;&lt;![CDATA[Pubs.name.sourceURL]]&gt;&lt;/name&gt;
&lt;icon&gt;&lt;![CDATA[ServerDebugOutput/ColdFusion/Variable.gif]]&gt;&lt;/icon&gt;
&lt;value&gt;&lt;![CDATA[jdbc:Macromedia:sqlserver:
//name.Macromedia.com:1111;databaseName=Pubs]]&gt;&lt;/value&gt;
&lt;/debugnode&gt;
&lt;/debugnode&gt;
&lt;debugnode&gt;
&lt;name&gt;&lt;![CDATA[Element Snippet is undefined in class
coldfusion.compiler.TagInfoNotFoundException]]&gt;&lt;/name&gt;
&lt;icon&gt;&lt;![CDATA[ServerDebugOutput/ColdFusion/Exception.gif]]&gt;&lt;/icon&gt;
&lt;jumptoline linenumber=&quot;3&quot; startposition=&quot;2&quot; endposition=&quot;20&quot;&gt;
&lt;template&gt;&lt;![CDATA[/ooo/master.cfm]]&gt;&lt;/template&gt;
&lt;path&gt;&lt;![CDATA[C:\Neo\wwwroot\ooo\master.cfm]]&gt;&lt;/path&gt;
&lt;/jumptoline&gt;
&lt;/debugnode&gt;
&lt;/serverdebuginfo&gt;
Valeurs renvoy&eacute;es
Aucune.
Fonctions de bascule
Ces fonctions permettent d'obtenir et de d&eacute;finir un certain nombre d'options qui peuvent &ecirc;tre activ&eacute;es ou d&eacute;sactiv&eacute;es.
dom.getEditNoFramesContent()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Modifier &gt; Jeu de cadres &gt; Modifier le contenu sans cadres.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le contenu de NOFRAMES est l'affichage actif et false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
159
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.getHideAllVisualAids()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine si les assistances visuelles sont d&eacute;finies comme &eacute;tant masqu&eacute;es.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true pour d&eacute;finir les assistances visuelles comme &eacute;tant masqu&eacute;es et false dans le cas contraire.
dom.getPreventLayerOverlaps()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Emp&ecirc;cher le chevauchement des calques.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true pour activer l'option Emp&ecirc;cher le chevauchement des calques et false dans le cas contraire.
dom.getShowAutoIndent()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine si l'option de retrait automatique est activ&eacute;e dans la fen&ecirc;tre de document en mode Code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la mise en retrait automatique est activ&eacute;e, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
160
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.getShowFrameBorders()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Affichage &gt; Bordures de cadre.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les bordures de cadre sont visibles, false dans le cas contraire.
dom.getShowGrid()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Affichage &gt; Grille &gt; Afficher.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la grille est visible, false dans le cas contraire.
dom.getShowHeadView()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Affichage &gt; Contenu de l'en-t&ecirc;te.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le contenu de l'en-t&ecirc;te est visible, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
161
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.getShowInvalidHTML()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine si le code HTML incorrect est actuellement en surbrillance dans la fen&ecirc;tre de document en
mode Code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le code HTML incorrect est en surbrillance et false dans le cas contraire.
dom.getShowImageMaps()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Affichage &gt; Cartes graphiques.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les cartes graphiques sont visibles, false dans le cas contraire.
dom.getShowInvisibleElements()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Affichage &gt; El&eacute;ments invisibles.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les marqueurs d'&eacute;l&eacute;ments invisibles sont visibles, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
162
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.getShowLayerBorders()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Affichage &gt; Bordures de calque.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les bordures de calque sont visibles, false dans le cas contraire.
dom.getShowLineNumbers()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine si les num&eacute;ros de ligne sont affich&eacute;s en mode Code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les num&eacute;ros de ligne sont visibles, false dans le cas contraire.
dom.getShowRulers()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Affichage &gt; R&egrave;gles &gt; Afficher.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les r&egrave;gles sont visibles, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
163
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.getShowSyntaxColoring()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine si l'option de coloration de la syntaxe est activ&eacute;e dans la fen&ecirc;tre dedocument en mode Code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la coloration de la syntaxe est activ&eacute;e, false dans le cas contraire.
dom.getShowTableBorders()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Affichage &gt; Bordures de tableau.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les bordures de tableau sont visibles, false dans le cas contraire.
dom.getShowToolbar()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine si la barre d'outils est visible.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la barre d'outils est visible, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
164
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.getShowTracingImage()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Affichage &gt; Trac&eacute; de l'image &gt; Afficher.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'option est activ&eacute;e, false dans le cas contraire.
dom.getShowWordWrap()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine si l'option de retour automatique &agrave; la ligne est activ&eacute;e dans la fen&ecirc;tre de document en mode
Code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le renvoi des mots &agrave; la ligne est activ&eacute;, false dans le cas contraire.
dom.getSnapToGrid()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Affichage &gt; Grille &gt; Aligner sur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'option d'alignement sur la grille est activ&eacute;e, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
165
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.setEditNoFramesContent()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active ou d&eacute;sactive l'option Modifier &gt; Jeu de cadres &gt; Modifier le contenu sans cadres.
Arguments
bEditNoFrames.
• L'argument bEditNoFrames est une valeur bool&eacute;enne : true active l'option Modifier le contenu sans cadres, tandis
que false la d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canEditNoFramesContent() &raquo; &agrave; la page 505.
dom.getHideAllVisualAids()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;sactive l'affichage de l'ensemble des bordures, cartes graphiques et &eacute;l&eacute;ments invisibles, quel que soit
leur param&egrave;tre individuel dans le menu Affichage.
Arguments
bSet.
• L'argument bSet est une valeur bool&eacute;enne : true pour masquer les assistances visuelles et false dans le cas
contraire.
Valeurs renvoy&eacute;es
Aucune.
dom.getPreventLayerOverlaps()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active ou d&eacute;sactive l'option Emp&ecirc;cher le chevauchement des calques.
Derni&egrave;re mise &agrave; jour le 22/6/2011
166
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
bPreventLayerOverlaps.
• L'argument bPreventLayerOverlaps est une valeur bool&eacute;enne: true
active l'option Emp&ecirc;cher le
chevauchement des calques, tandis que false la d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
dom.getShowFrameBorders()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active ou d&eacute;sactive l'option Affichage &gt; Bordures de cadre.
Arguments
bShowFrameBorders.
• L'argument bShowFrameBorders est une valeur bool&eacute;enne : true active l'option Bordures de cadre et false la
d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
dom.getShowGrid()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active ou d&eacute;sactive l'option Affichage &gt; Grille &gt; Afficher.
Arguments
bShowGrid.
• L'argument bShowGrid est une valeur bool&eacute;enne: true
active l'option Affichage &gt; Grille &gt; Afficher,
tandis que false la d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
dom.getShowHeadView()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
167
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Description
Cette fonction active ou d&eacute;sactive l'option Affichage &gt; Contenu de l'en-t&ecirc;te.
Arguments
bShowHead.
• L'argument bShowHead est une valeur bool&eacute;enne : true active l'option Contenu de l'en-t&ecirc;te, tandis que false la
d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
dom.getShowInvalidHTML()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction active ou d&eacute;sactive la mise en surbrillance du code HTML incorrect dans la fen&ecirc;tre de document en
mode Code.
Cette fonction d&eacute;termine si le code HTML incorrect est actuellement en surbrillance.
Arguments
bShow.
• L'argument bShow est une valeur bool&eacute;enne : true indique que la mise en surbrillance du code HTML incorrect est
visible, et false qu'elle ne l'est pas.
Valeurs renvoy&eacute;es
Aucune.
dom.getShowImageMaps()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active ou d&eacute;sactive l'option Affichage &gt; Cartes graphiques.
Arguments
bShowImageMaps.
• L'argument bShowImageMaps est une valeur bool&eacute;enne : true active l'option Cartes graphiques, tandis que false
la d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
168
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.getShowInvisibleElements()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active ou d&eacute;sactive l'option Affichage &gt; El&eacute;ments invisibles.
Arguments
bViewInvisibleElements.
• L'argument bViewInvisibleElements est une valeur bool&eacute;enne : true active l'option El&eacute;ments invisibles, tandis que
false la d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
dom.getShowLayerBorders()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active ou d&eacute;sactive l'option Affichage &gt; Bordures de calque.
Arguments
bShowLayerBorders.
• L'argument bShowLayerBorders est une valeur bool&eacute;enne : true active l'option Bordures de calque, tandis que
false la d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
dom.setShowLineNumbers()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction affiche ou masque les num&eacute;ros de ligne dans la fen&ecirc;tre de document en mode Code.
Arguments
bShow.
• L'argument bShow est une valeur bool&eacute;enne : true signifie que les num&eacute;ros de ligne sont visibles et false qu'ils ne
le sont pas.
Derni&egrave;re mise &agrave; jour le 22/6/2011
169
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Aucune.
dom.setShowRulers()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active ou d&eacute;sactive l'option Affichage &gt; R&egrave;gles &gt; Afficher.
Arguments
bShowRulers.
• L'argument bShowRulers est une valeur bool&eacute;enne : true active l'option Afficher, tandis que false la d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
dom.setShowSyntaxColoring()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction active ou d&eacute;sactive la coloration de la syntaxe dans la fen&ecirc;tre de document en mode Code.
Arguments
bShow.
• L'argument bShow est une valeur bool&eacute;enne : true signifie que la coloration de la syntaxe est visible et false qu'elle
ne l'est pas.
Valeurs renvoy&eacute;es
Aucune.
dom.setShowTableBorders()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active ou d&eacute;sactive l'option Affichage &gt; Bordures de tableau.
Derni&egrave;re mise &agrave; jour le 22/6/2011
170
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
bShowTableBorders.
• L'argument bShowTableBorders est une valeur bool&eacute;enne : true active l'option Bordures de tableau, tandis que
false la d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
dom.setShowToolbar()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction affiche ou masque la barre d'outils.
Arguments
bShow.
• L'argument bShow est une valeur bool&eacute;enne : true signifie que la barre d'outils est visible et false qu'elle ne l'est pas.
Valeurs renvoy&eacute;es
Aucune.
dom.setShowTracingImage()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active ou d&eacute;sactive l'option Affichage &gt; Trac&eacute; de l'image &gt; Afficher.
Arguments
bShowTracingImage.
• L'argument bShowTracingImage est une valeur bool&eacute;enne : true active l'option Afficher, tandis que false la
d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
dom.setShowWordWrap()
Disponibilit&eacute;
Dreamweaver 4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
171
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Description
Cette fonction active ou d&eacute;sactive l'option Retour &agrave; la ligne dans la fen&ecirc;tre de document en mode Code.
Arguments
bShow.
• L'argument bShow est une valeur bool&eacute;enne : true signifie que le renvoi des mots &agrave; la ligne est activ&eacute; et false qu'il
ne l'est pas.
Valeurs renvoy&eacute;es
Aucune.
dom.setSnapToGrid()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active ou d&eacute;sactive l'option Affichage &gt; Grille &gt; Aligner sur.
Arguments
bSnapToGrid.
• L'argument bSnapToGrid est une valeur bool&eacute;enne : true active l'option Aligner sur, tandis que false la d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.getHideAllFloaters()
Disponibilit&eacute;
Dreamweaver 3, mise &agrave; jour dans CS4.
Description
D&eacute;termine si tous les panneaux, ancr&eacute;s ou flottants, sont masqu&eacute;s. Le r&eacute;sultat n'influe pas sur la visibilit&eacute; de la barre
Insertion. Les composants suivants ne sont pas consid&eacute;r&eacute;s comme masqu&eacute;s :
• Panneaux ferm&eacute;s
• Groupes d'onglets r&eacute;duits
• Panneaux r&eacute;duits
Remarque : Le r&eacute;sultat n'influe pas sur la barre Insertion, mais bien sur le panneau Insertion.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si tous les panneaux sont masqu&eacute;s, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
172
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dreamweaver.getShowStatusBar()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Affichage &gt; Barre d'&eacute;tat.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la barre d'&eacute;tat est visible, false dans le cas contraire.
dreamweaver.htmlInspector.getShowAutoIndent()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine si l'option de retrait automatique est activ&eacute;e dans l'inspecteur de code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la mise en retrait automatique est activ&eacute;e, false dans le cas contraire.
dreamweaver.htmlInspector.getShowInvalidHTML()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine si le code HTML incorrect est actuellement en surbrillance dans l'inspecteurde code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le code HTML incorrect est en surbrillance et false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
173
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dreamweaver.htmlInspector.getShowLineNumbers()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine si les num&eacute;ros de ligne sont affich&eacute;s dans l'inspecteur de code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les num&eacute;ros de ligne sont visibles, false dans le cas contraire.
dreamweaver.htmlInspector.getShowSyntaxColoring()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine si l'option de coloration de la syntaxe est activ&eacute;e dans l'inspecteur de code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la coloration de la syntaxe est activ&eacute;e, false dans le cas contraire.
dreamweaver.htmlInspector.getShowWordWrap()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine si l'option de retour &agrave; la ligne est activ&eacute;e dans l'inspecteur de code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le renvoi des mots &agrave; la ligne est activ&eacute;, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
174
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dreamweaver.htmlInspector.setShowAutoIndent()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction active ou d&eacute;sactive l'option de retrait automatique dans l'inspecteur de code.
Arguments
bShow.
• L'argument bShow est une valeur bool&eacute;enne : true active la mise en retrait automatique, tandis que false la
d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.htmlInspector.setShowInvalidHTML()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction active ou d&eacute;sactive la mise en surbrillance du code HTML incorrect dans l'inspecteur de code.
Arguments
bShow.
• L'argument bShow est une valeur bool&eacute;enne : true indique que la mise en surbrillance du code HTML incorrect est
visible, et false qu'elle ne l'est pas.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.htmlInspector.setShowLineNumbers()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction affiche ou masque les num&eacute;ros de ligne dans l'inspecteur de code en mode Code.
Arguments
bShow.
• L'argument bShow est une valeur bool&eacute;enne : true signifie que les num&eacute;ros de ligne sont visibles et false qu'ils ne
le sont pas.
Derni&egrave;re mise &agrave; jour le 22/6/2011
175
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.htmlInspector.setShowSyntaxColoring()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction active ou d&eacute;sactive la coloration de la syntaxe dans l'inspecteur de code en mode Code.
Arguments
bShow.
• L'argument bShow est une valeur bool&eacute;enne : true signifie que la coloration de la syntaxe est visible et false qu'elle
ne l'est pas.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.htmlInspector.setShowWordWrap()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction active ou d&eacute;sactive l'option Retour &agrave; la ligne dans l'inspecteur de code.
Arguments
bShow.
• L'argument bShow est une valeur bool&eacute;enne : true active le retour &agrave; la ligne automatique, tandis que false le
d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.setHideAllFloaters()
Disponibilit&eacute;
Dreamweaver 3, mise &agrave; jour dans CS4.
Description
Cette fonction affiche ou masque tous les panneaux. Elle n'influe pas sur la barre Insertion.
Derni&egrave;re mise &agrave; jour le 22/6/2011
176
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
bShowFloatingPalettes
• L'argument bShowFloatingPalettes est une valeur bool&eacute;enne : true masque tous les panneaux et false les
affiche. Lorsqu'un panneau est visible, l'envoi de false entra&icirc;ne l'affichage de tous les panneaux restants. Lorsque
vous les panneaux sont visibles, l'envoi de false est sans effet.
Remarque : Cette commande ne masque aucun panneau, sauf s'ils sont tous visibles. D&egrave;s lors, l'envoi de true lorsqu'un
panneau est visible est sans effet.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.setShowStatusBar()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active ou d&eacute;sactive l'option Affichage &gt; Barre d'&eacute;tat.
Arguments
bShowStatusBar.
• L'argument bShowStatusBar est une valeur bool&eacute;enne : true active l'option Barre d'&eacute;tat, tandis que false la
d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
site.getShowToolTips()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient l'&eacute;tat en cours de l'option Infobulles.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true lorsque les infobulles sont visibles dans le panneau Site et false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
177
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
site.setShowToolTips()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active ou d&eacute;sactive l'option Infobulles.
Arguments
bShowToolTips.
• L'argument bShowToolTips est une valeur bool&eacute;enne : true active l'option Infobulles, tandis que false la d&eacute;sactive.
Valeurs renvoy&eacute;es
Aucune.
Fonctions relatives aux barres d'outils
Les fonctions JavaScript suivantes vous permettent d'obtenir et de d&eacute;finir l'affichage des barres d'outils et de leurs
&eacute;tiquettes, de vous procurer les &eacute;tiquettes des &eacute;l&eacute;ments de barre d'outils dans la fen&ecirc;tre en cours, de positionner les
barres d'outils et d'obtenir leur ID. Pour plus d'informations sur la cr&eacute;ation ou la modification des barres d'outils,
consultez la rubrique &laquo; Barres d'outils &raquo; dans l'aide Extension de Dreamweaver.
dom.getShowToolbarIconLabels()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction d&eacute;termine si les &eacute;tiquettes des boutons sont visibles dans la fen&ecirc;tre de document actuelle. Dreamweaver
affiche toujours les &eacute;tiquetts des commandes qui ne sont pas des boutons, si elles sont d&eacute;finies.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les &eacute;tiquettes des boutons sont visibles dans la fen&ecirc;tre de document active et false dans le
cas contraire.
Exemple
L'exemple suivant permet d'afficher les &eacute;tiquettes des boutons :
var dom = dw.getDocumentDom();
if (dom.getShowToolbarIconLabels() == false)
{
dom.setShowToolbarIconLabels(true);
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
178
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.getToolbarIdArray()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction renvoie un tableau contenant les ID de toutes les barres d'outils de l'application. Utilisez la fonction
dom.getToolbarIdArray() pour d&eacute;sactiver toutes les barres d'outils et pouvoir ainsi les repositionner en ne rendant
visibles que certaines d'entre elles.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de tous les ID de barre d'outils.
Exemple
L'exemple suivant stocke le tableau des ID de barre d'outils dans la variable tb_ids :
var tb_ids = new Array();
tb_ids = dom.getToolbarIdArray();
dom.getToolbarItemValue()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Obtient la valeur de l'&eacute;l&eacute;ment de barre d'outils sp&eacute;cifi&eacute;.
Arguments
toolbarID, itemID.
• L'argument toolbarID est une cha&icirc;ne indiquant l'ID de la barre d'outils contenant l'&eacute;l&eacute;ment pour lequel vous
souhaitez obtenir une valeur.
• L'argument itemID est une cha&icirc;ne qui indique l'ID de l'&eacute;l&eacute;ment pour lequel vous souhaitez obtenir une valeur.
Valeurs renvoy&eacute;es
Une cha&icirc;ne repr&eacute;sentant la valeur de l'&eacute;l&eacute;ment de barre d'outils.
Exemple
L'exemple de fonction receiveArguments() suivant figure dans une commande de barre d'outils qui r&eacute;git le
comportement d'un champ de texte Size ; il obtient la valeur du champ Size sous la forme d'un argument, puis lit la
valeur du champ Units afin de g&eacute;n&eacute;rer une valeur valide pour la fonction de propri&eacute;t&eacute; CSS font-size :
Derni&egrave;re mise &agrave; jour le 22/6/2011
179
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
receiveArguments(newSize){
var dom = dw.getDocumentDOM();
if (newSize != &quot;&quot;){
dom.applyFontMarkupAsStyle('font-size', newSize +
dom.getToolbarItemValue(&quot;DW_Toolbar_Text&quot;,&quot;DW_Text_Units&quot;));
}
else{
dom.removeFontMarkupAsStyle('font-size');
}
}
dom.getToolbarLabel()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction obtient l'&eacute;tiquette de la barre d'outils sp&eacute;cifi&eacute;e. Utilisez la fonction dom.getToolbarLabel() pour les
menus qui affichent ou masquent des barres d'outils.
Arguments
toolbar_id
• L'argument toolbar_id est l'ID de la barre d'outils, qui correspond &agrave; la valeur de l'attribut ID de la balise toolbar
d&eacute;finie dans le fichier toolbars.xml.
Valeurs renvoy&eacute;es
La cha&icirc;ne de nom label qui est affect&eacute;e &agrave; la balise toolbar comme attribut.
Exemple
L'exemple suivant stocke l'&eacute;tiquette de myEditbar dans la variable label :
var label = dom.getToolbarLabel(&quot;myEditbar&quot;);
dom.getToolbarVisibility()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction renvoie une valeur bool&eacute;enne qui indique si la barre d'outils sp&eacute;cifi&eacute;e dans l'argument toolbar_id est
visible.
Arguments
toolbar_id
• L'argument toolbar_id est la cha&icirc;ne d'ID affect&eacute;e &agrave; la barre d'outils.
Derni&egrave;re mise &agrave; jour le 22/6/2011
180
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la barre d'outils est visible et false si la barre d'outils n'est pas visible ou n'existe pas.
Exemple
L'exemple suivant v&eacute;rifie si la barre d'outils myEditbar est visible dans la fen&ecirc;tre de document, puis stocke cette valeur
dans la variable retval :
var retval = dom.getToolbarVisibility(&quot;myEditbar&quot;);
return retval;
dom.setToolbarItemAttribute()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Modifie une valeur parmi les trois attributs image ou l'attribut tooltip d'un &eacute;l&eacute;ment de la barre d'outils.
Arguments
toolbarID, toolbarItemId, attrName, attrValue
• L'argument toolbarID est une cha&icirc;ne qui indique l'ID de la barre d'outils.
• L'argument toolbarItemId est une cha&icirc;ne qui indique l'ID de l'&eacute;l&eacute;ment de la barre d'outils.
• L'argument attrName est une cha&icirc;ne qui indique le nom de l'attribut &agrave; d&eacute;finir. Les valeurs autoris&eacute;es sont 'image',
'overImage', 'disabledImage' et 'tooltip'.
• L'argument attrValue est une cha&icirc;ne qui indique la valeur &agrave; d&eacute;finir.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant appelle dom.setToolbarItemAttribute() trois fois pour d&eacute;finir les attributs image, imageOver
et tooltip de l'&eacute;l&eacute;ment MyButton sur la barre d'outils portant l'ID DW_Toolbar_Main :
var dom = dw.getDocumentDOM();
dom.setToolbarItemAttribute('DW_Toolbar_Main', 'MyButton', 'image',
'Toolbars/imgs/newimage.gif');
dom.setToolbarItemAttribute('DW_Toolbar_Main', 'MyButton', 'imageOver',
'Toolbars/imgs/newimageOver.gif');
dom.setToolbarItemAttribute('DW_Toolbar_Main', 'MyButton', 'tooltip', 'One fine button');
dom.setShowToolbarIconLabels()
Disponibilit&eacute;
Dreamweaver MX.
Derni&egrave;re mise &agrave; jour le 22/6/2011
181
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Description
Cette fonction ordonne &agrave; Dreamweaver s'afficher les &eacute;tiquettes des boutons qui en poss&egrave;dent. Dreamweaver affiche
toujours les &eacute;tiquettes des commandes qui ne sont pas des boutons, si elles sont d&eacute;finies.
Arguments
bShow.
• L'argument bShow est une valeur bool&eacute;enne : true affiche les &eacute;tiquettes des boutons et false les masque.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant indique &agrave; Dreamweaver d'afficher les &eacute;tiquettes des boutons sur les barres d'outils :
dom.setShowToolbarIconLabels(true);
dom.setToolbarPosition()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction d&eacute;place la barre d'outils sp&eacute;cifi&eacute;e &agrave; la position indiqu&eacute;e.
Remarque : Il est impossible de d&eacute;terminer la position actuelle d'une barre d'outils.
Arguments
toobar_id, position, relative_to
• L'argument toolbar_id est l'ID de la barre d'outils, qui correspond &agrave; la valeur de l'attribut ID de la balise toolbar
d&eacute;finie dans le fichier toolbars.xml.
• L'argument position indique l'endroit o&ugrave; Dreamweaver place la barre d'outils par rapport aux autres barres d'outils.
Les valeurs possibles de l'argument position sont d&eacute;crites dans la liste suivante :
•
top correspond &agrave; la position par d&eacute;faut. La barre d'outils appara&icirc;t en haut de la fen&ecirc;tre de document.
•
below force la barre d'outils &agrave; s'afficher au d&eacute;but de la ligne, juste sous la barre d'outils sp&eacute;cifi&eacute;e par l'attribut
relative_to. Dreamweaver signale une erreur si la barre d'outils ne trouve pas la barre sp&eacute;cifi&eacute;e par relative_to.
•
floating affiche la barre d'outils au-dessus du document, en mode flottant. Dreamweaver place
automatiquement la barre d'outils de sorte qu'elle soit d&eacute;cal&eacute;e par rapport aux autres barres d'outils flottantes.
Sur Macintosh, floating est trait&eacute; de la m&ecirc;me fa&ccedil;on que top.
• relative_to=&quot;toolbar_id&quot; est requis si position sp&eacute;cifie below. Dans les autres cas, cet argument est ignor&eacute;.
Indique l'ID de la barre d'outils en dessous de laquelle cette barre d'outils doit &ecirc;tre plac&eacute;e.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant place myEditbar en dessous de la barre d'outils myPicturebar :
Derni&egrave;re mise &agrave; jour le 22/6/2011
182
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.setToolbarPosition(&quot;myEditbar&quot;, &quot;below&quot;, &quot;myPicturebar&quot;);
dom.setToolbarVisibility()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction affiche ou masque la barre d'outils sp&eacute;cifi&eacute;e.
Arguments
toolbar_id, bShow
• L'argument toolbar_id est l'ID de la barre d'outils, qui correspond &agrave; la valeur de l'attribut ID de la balise toolbar
d&eacute;finie dans le fichier toolbars.xml.
• L'argument bShow est une valeur bool&eacute;enne qui indique si la barre d'outils doit &ecirc;tre affich&eacute;e ou masqu&eacute;e. Si bShow
a pour valeur true, la fonction dom.setToolbarVisibility() rend la barre d'outils visible. Si bShow a pour
valeur false, la fonction dom.setToolbarVisibility() rend la barre d'outils invisible.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant v&eacute;rifie si la barre d'outils myEditbar est visible dans la fen&ecirc;tre de document. Si ce n'est pas le cas, il
l'affiche :
var dom = dw.getDocumentDOM();
if(dom != null &amp;&amp; dom.getToolbarVisibility(&quot;myEditbar&quot;) == false)
{
dom.setToolbarVisibility(&quot;myEditbar&quot;, true);
{
dreamweaver.reloadToolbars()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction recharge toutes les barres d'outils JavaScript dans le dossier Configuration/Toolbars.
Arguments
{resetToDefault}
• L'argument resetToDefault est une valeur bool&eacute;enne qui indique s'il faut lire la visibilit&eacute; et la position par d&eacute;faut
pour chaque barre d'outils &agrave; partir du fichier toolbars.xml. Si sa valeur est false ou si elle n'est pas fournie, les
positions et visibilit&eacute;s des barres d'outils sont pr&eacute;serv&eacute;es lors du rechargement. Cet argument est facultatif.
Derni&egrave;re mise &agrave; jour le 22/6/2011
183
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Aucune.
Fonctions relatives aux fen&ecirc;tres
Ces fonctions permettent d'agir sur la fen&ecirc;tre de document et sur les panneaux flottants. Elles permettent d'afficher et
de masquer les panneaux flottants, de d&eacute;terminer la partie active de la fen&ecirc;tre de document et de d&eacute;finir le document
actif. Pour les op&eacute;rations relatives au panneau Site, consultez la section &laquo; Fonctions relatives aux sites &raquo; &agrave; la page 223.
Remarque : Certaines fonctions de cette section fonctionnent uniquement sous Windows. Leur description indique si tel
est le cas.
dom.getFocus()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction d&eacute;termine quelle partie du document est actuellement active.
Arguments
Aucun.
Valeurs renvoy&eacute;es
L'une des cha&icirc;nes suivantes :
• la cha&icirc;ne &quot;head&quot; si la zone HEAD est active ;
• la cha&icirc;ne &quot;body&quot; si la zone BODY ou NOFRAMES est active ;
• la cha&icirc;ne &quot;frameset&quot; si un jeu de cadres ou l'un des cadres qui le composent est s&eacute;lectionn&eacute; ;
• la cha&icirc;ne &quot;none&quot; si la zone active ne figure pas dans le document (si elle se trouve dans l'inspecteur Propri&eacute;t&eacute;s ou
dans un autre panneau flottant, par exemple).
dom.getView()
Disponibilit&eacute;
Dreamweaver 4, mise &agrave; jour dans CS4.
Description
Cette fonction d&eacute;termine quel mode est visible.
Arguments
Aucun.
Valeurs renvoy&eacute;es
design, code, split ou &quot;split code&quot;, selon le mode d'affichage visible.
Derni&egrave;re mise &agrave; jour le 22/6/2011
184
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.getWindowTitle()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient le titre de la fen&ecirc;tre contenant le document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le texte qui appara&icirc;t entre les balises TITLE du document, ou rien si le document ne figure pas dans
une fen&ecirc;tre ouverte.
dom.setView()
Disponibilit&eacute;
Dreamweaver 4, mise &agrave; jour dans CS4.
Description
Cette fonction affiche ou masque le mode Cr&eacute;ation ou Code pour produire un affichage contenant uniquement le
mode Cr&eacute;ation ou Code ou les deux.
Arguments
viewString
• L'argument viewString est le mode d'affichage &agrave; produire. Il doit s'agir d'une des valeurs suivantes : design, code,
split ou &quot;split code&quot;.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.bringAttentionToFloater()
Disponibilit&eacute;
Dreamweaver MX.
Description
Place au premier plan le panneau ou l'inspecteur sp&eacute;cifi&eacute; et attire l'attention sur cet &eacute;l&eacute;ment en le faisant clignoter
(fonctionnalit&eacute; l&eacute;g&egrave;rement diff&eacute;rente de dw.toggleFloater()).
Arguments
floaterName.
• L'argument floaterName correspond au nom de la fen&ecirc;tre, du panneau ou de l'inspecteur.
Derni&egrave;re mise &agrave; jour le 22/6/2011
185
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant ouvre le panneau Actifs et le fait clignoter :
dw.bringAttentionToFloater(&quot;library&quot;);
dreamweaver.cascade()
Disponibilit&eacute;
Dreamweaver MX (Windows uniquement), Dreamweaver8 (prise en charge suppl&eacute;mentaire pour Macintosh).
Description
Affiche en cascade les fen&ecirc;tres de document en commen&ccedil;ant dans l'angle sup&eacute;rieur gauche et en d&eacute;calant l&eacute;g&egrave;rement
chaque fen&ecirc;tre par rapport &agrave; la pr&eacute;c&eacute;dente.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant affiche les documents ouverts en cascade :
dw.cascade()
dreamweaver.getActiveWindow()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient le document figurant dans la fen&ecirc;tre active.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Objet document correspondant au document qui figure dans la fen&ecirc;tre active ou, si le document figure dans un cadre,
objet document correspondant au jeu de cadres.
dreamweaver.getDocumentList()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
186
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Description
Cette fonction renvoie la liste de tous les documents ouverts.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau d'objets document, chacun correspondant &agrave; une fen&ecirc;tre de document ouverte. Si une fen&ecirc;tre de document
contient un jeu de cadres, l'objet document d&eacute;signe le jeu de cadres et non le contenu des cadres.
dreamweaver.getFloatersVisible()
Disponibilit&eacute;
Description
D&eacute;termine si un panneau, ancr&eacute; ou flottant, est visible. Le r&eacute;sultat n'influe pas sur les &eacute;l&eacute;ments suivants :
• Visibilit&eacute; de la barre Insertion
• Panneaux ferm&eacute;s
Remarque : Le r&eacute;sultat n'influe pas sur la barre Insertion, mais bien sur le panneau Insertion.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si un panneau est visible et false dans le cas contraire.
dreamweaver.getFloaterVisibility()
Disponibilit&eacute;
Dreamweaver 3, mise &agrave; jour dans CS4.
Description
Cette fonction v&eacute;rifie si le panneau ou l'inspecteur sp&eacute;cifi&eacute; est visible.
Arguments
floaterName
• L'argument floaterName est le nom du panneau flottant. Si floaterName ne correspond &agrave; aucun nom de panneau
int&eacute;gr&eacute;, Dreamweaver recherche dans le dossier Configuration/Floaters un fichier appel&eacute; floaterName.htm, o&ugrave;
floaterName correspond au nom d'un panneau flottant.
Les valeurs de floaterName pour les panneaux int&eacute;gr&eacute;s sont les cha&icirc;nes se trouvant &agrave; droite des noms de panneaux
dans la liste suivante :
Derni&egrave;re mise &agrave; jour le 22/6/2011
187
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Actifs = &quot;assets&quot;
Comportements = &quot;behaviors&quot;
Liaisons = &quot;data bindings&quot;
Inspecteur de code = &quot;html&quot;
Composants = &quot;server components&quot;
Styles CSS = &quot;css styles&quot;
Bases de donn&eacute;es = &quot;databases&quot;
Cadres = &quot;frames&quot;
Historique = &quot;history&quot;
Barre Insertion = &quot;objects&quot;
Calques = &quot;layers&quot;
Biblioth&egrave;que = &quot;library&quot;
V&eacute;rificateur de liens (R&eacute;sultats) = &quot;linkchecker&quot;
Propri&eacute;t&eacute;s = &quot;properties&quot;
R&eacute;f&eacute;rence = &quot;reference&quot;
Rapports (R&eacute;sultats) = &quot;reports&quot;
Recherche (R&eacute;sultats) = &quot;search&quot;
Inspecteur de s&eacute;lections = &quot;selection inspector&quot;
Comportements de serveur = &quot;server behaviors&quot;
Site = &quot;site&quot;
Fichiers du site = &quot;site files&quot;
Fragments de code = &quot;snippets&quot;
V&eacute;rification de la compatibilit&eacute; avec les navigateurs = &quot;bcc&quot;
Validation (R&eacute;sultats) = &quot;validation&quot;
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le panneau flottant est visible et se trouve au premier plan, false si ce n'est pas le cas ou
que Dreamweaver ne trouve pas de panneau flottant nomm&eacute; floaterName.
dreamweaver.getFocus()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine la partie de l'application actuellement active.
Derni&egrave;re mise &agrave; jour le 22/6/2011
188
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
bAllowFloaters.
• L'argument bAllowFloaters est une valeur bool&eacute;enne : true si la fonction doit renvoyer le nom du panneau
flottant (si un panneau flottant est actif) et false dans le cas contraire.
Valeurs renvoy&eacute;es
L'une des cha&icirc;nes suivantes :
• La cha&icirc;ne &quot;document&quot; si la fen&ecirc;tre de document est active.
• La cha&icirc;ne &quot;site&quot; si le panneau Site est actif.
• La cha&icirc;ne &quot;textView&quot; si le mode Texte est actif.
• La cha&icirc;ne &quot;html&quot; si l'inspecteur de code est actif.
• La cha&icirc;ne floaterName, si bAllowFloaters a pour valeur true et si un panneau flottant est actif, floaterName
correspondant &agrave; &quot;objects&quot;, &quot;properties&quot;, &quot;launcher&quot;, &quot;library&quot;, &quot;css styles&quot;, &quot;html styles&quot;,
&quot;behaviors&quot;, &quot;timelines&quot;, &quot;layers&quot;, &quot;frames&quot;, &quot;templates&quot; ou &quot;history&quot;.
• La cha&icirc;ne &quot;none&quot; (Macintosh) si aucune fen&ecirc;tre de document ni le panneau Site ne sont ouverts.
dreamweaver.getPrimaryView()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;termine le mode d'affichage d&eacute;fini comme mode principal (au premier plan).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Les cha&icirc;nes &quot;design&quot; ou &quot;code&quot;, selon le mode visible ou le volet situ&eacute; au premier plan dans un affichage &agrave; deux
volets.
dreamweaver.getSnapDistance()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction renvoie la distance d'alignement en pixels.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
189
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Nombre entier repr&eacute;sentant la distance d'alignement en pixels. La distance par d&eacute;faut est 10 pixels ; 0 indique que la
fonction d'alignement est d&eacute;sactiv&eacute;e.
dreamweaver.minimizeRestoreAll()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction r&eacute;duit en ic&ocirc;ne ou restaure toutes les fen&ecirc;tres dans Dreamweaver.
Arguments
bMinimize
• L'argument bMinimize est une valeur bool&eacute;enne : true si les fen&ecirc;tres doivent &ecirc;tre r&eacute;duites et false si les fen&ecirc;tres
r&eacute;duites doivent &ecirc;tre agrandies.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.getActiveWindow()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction active la fen&ecirc;tre contenant le document sp&eacute;cifi&eacute;.
Arguments
documentObject, {bActivateFrame}
• L'argument documentObject correspond &agrave; l'objet situ&eacute; &agrave; la racine de l'arborescence DOM d'un document (c'est-&agrave;dire la valeur renvoy&eacute;e par la fonction dreamweaver.getDocumentDOM()).
• L'argument facultatif bActivateFrame n'est applicable que lorsque documentObject se trouve &agrave; l'int&eacute;rieur d'un jeu
de cadres. L'argument bActivateFrame est une valeur bool&eacute;enne : true active le cadre qui contient le document
ainsi que la fen&ecirc;tre qui contient le jeu de cadres ; false dans le cas contraire.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.setFloaterVisibility()
Disponibilit&eacute;
Dreamweaver 3, mise &agrave; jour dans CS4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
190
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Description
Cette fonction indique s'il faut rendre visible un panneau flottant ou un inspecteur sp&eacute;cifique.
Arguments
floaterName, bIsVisible
• L'argument floaterName est le nom du panneau flottant. Si l'argument floaterName ne correspond pas &agrave; l'un des
noms de panneau flottant r&eacute;serv&eacute;s, Dreamweaver recherche dans le dossier Configuration/Floaters un fichier
nomm&eacute; floaterName.htm. Si Dreamweaver ne trouve aucun panneau flottant portant le nom floaterName, cette
fonction n'a aucun effet.
Les valeurs de floaterName pour les panneaux int&eacute;gr&eacute;s sont les cha&icirc;nes se trouvant &agrave; droite des noms de panneaux
dans la liste suivante :
Actifs = &quot;assets&quot;
Comportements = &quot;behaviors&quot;
Liaisons = &quot;data sources&quot;
Inspecteur de code = &quot;html&quot;
Composants = &quot;server components&quot;
Styles CSS = &quot;css styles&quot;
Bases de donn&eacute;es = &quot;databases&quot;
Cadres = &quot;frames&quot;
Historique = &quot;history&quot;
Styles HTML = &quot;html styles&quot;
Barre Insertion = &quot;objects&quot;
Calques = &quot;layers&quot;
Biblioth&egrave;que = &quot;library&quot;
V&eacute;rificateur de liens (R&eacute;sultats) = &quot;linkchecker&quot;
Propri&eacute;t&eacute;s = &quot;properties&quot;
R&eacute;f&eacute;rence = &quot;reference&quot;
Rapports (R&eacute;sultats) = &quot;reports&quot;
Recherche (R&eacute;sultats) = &quot;search&quot;
Comportements de serveur = &quot;server behaviors&quot;
Site = &quot;site&quot;
Fichiers du site = &quot;site files&quot;
Fragments de code = &quot;snippets&quot;
Inspecteur de balises = &quot;tag inspector&quot;
V&eacute;rification de la compatibilit&eacute; avec les navigateurs = &quot;bcc&quot;
Mod&egrave;les = &quot;templates&quot;
Validation (R&eacute;sultats) = &quot;validation&quot;
Derni&egrave;re mise &agrave; jour le 22/6/2011
191
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
• L'argument bIsVisible est une valeur bool&eacute;enne indiquant si le panneau flottant doit &ecirc;tre visible.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.setPrimaryView()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction affiche le mode sp&eacute;cifi&eacute; en haut de la fen&ecirc;tre de document.
Arguments
viewString.
• L'argument viewString correspond au mode &agrave; afficher en haut de la fen&ecirc;tre de document ; il peut avoir l'une des
valeurs suivantes : &quot;design&quot; ou &quot;code&quot;.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.setSnapDistance()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction d&eacute;finit la distance d'alignement en pixels.
Arguments
snapDistance.
• L'argument snapDistance est un nombre entier repr&eacute;sentant la distance d'alignement en pixels. La valeur par d&eacute;faut
est 10 pixels. Saisissez 0 pour d&eacute;sactiver la fonction d'alignement.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.showProperties()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction rend l'inspecteur Propri&eacute;t&eacute;s visible et l'active.
Derni&egrave;re mise &agrave; jour le 22/6/2011
192
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.tileHorizontally()
Disponibilit&eacute;
Dreamweaver MX (Windows uniquement), Dreamweaver8 (prise en charge suppl&eacute;mentaire pour Macintosh).
Description
Organise les fen&ecirc;tres de document en mosa&iuml;que horizontale en les pla&ccedil;ant les unes &agrave; c&ocirc;t&eacute; des autres sans qu'elles ne se
chevauchent. Ce processus revient au partage vertical de l'espace de travail.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant affiche les documents ouverts en mosa&iuml;que horizontale :
dw.tileHorizontally()
dreamweaver.tileVertically()
Disponibilit&eacute;
Dreamweaver MX (Windows uniquement), Dreamweaver8 (prise en charge suppl&eacute;mentaire pour Macintosh).
Description
Organise les fen&ecirc;tres de documents en mosa&iuml;que verticale en les pla&ccedil;ant les unes derri&egrave;re les autres sans qu'elles ne se
chevauchent. Ce processus revient au partage horizontal de l'espace de travail.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant affiche les documents ouverts en mosa&iuml;que verticale :
dw.tileVertically()
Derni&egrave;re mise &agrave; jour le 22/6/2011
193
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dreamweaver.toggleFloater()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction affiche, masque ou place au premier plan le panneau ou l'inspecteur sp&eacute;cifi&eacute;.
Remarque : Cette fonction n'a de sens que dans le fichier menus.xml. Pour afficher, placer au premier plan ou masquer
un panneau flottant, utilisez la fonction dw.setFloaterVisibility().
Arguments
floaterName.
• L'argument floaterName correspond au nom de la fen&ecirc;tre. Si le nom de la fen&ecirc;tre flottante est reference, l'&eacute;tat de
visibilit&eacute; du panneau R&eacute;f&eacute;rence peut &ecirc;tre mis &agrave; jour par l'utilisateur dans le mode Code. Tous les autres panneaux
effectuent un suivi continu de la s&eacute;lection, mais le panneau R&eacute;f&eacute;rence n'analyse la s&eacute;lection dans le mode Code que
lorsque l'utilisateur lance un suivi.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.updateReference()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction met &agrave; jour le panneau flottant R&eacute;f&eacute;rence. Si le panneau flottant R&eacute;f&eacute;rence n'est pas visible,
dw.updateReference() l'affiche et le met &agrave; jour.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Fonctions de la barre d'information
La barre d'information sert &agrave; afficher des messages d'erreur sans interrompre les activit&eacute;s. Les fonctions suivantes de
la barre d'information servent &agrave; masquer ou &agrave; afficher la barre d'information contenant des messages d'erreur.
dom.showInfoBar()
Disponibilit&eacute;
Dreamweaver CS4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
194
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Description
Cette fonction affiche la barre d'information contenant le message transmis. Si la barre d'information est d&eacute;j&agrave; affich&eacute;e,
son contenu est mis &agrave; jour en fonction du nouveau message transmis. Si aucun message n'est transmis, une erreur JS
se produit.
Arguments
Message.
Valeurs renvoy&eacute;es
Aucune.
dom.hideInfoBar()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction masque la barre d'information.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Fonctions des fichiers apparent&eacute;s
Les fonctions des fichiers apparent&eacute;s facilitent le travail des codeurs en leur offrant un acc&egrave;s ais&eacute; aux fichiers auxiliaires
et apparent&eacute;s qu'ils utilisent fr&eacute;quemment.
dreamweaver.getRelatedFiles()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction renvoie la liste de tous les fichiers apparent&eacute;s. Les fichiers apparent&eacute;s peuvent &ecirc;tre des documents
enfants, des fichiers HTML source et des fichiers source g&eacute;n&eacute;r&eacute;s.
Arguments
Valeur bool&eacute;enne qui sp&eacute;cifie les noms d'affichage du document parent et des fichiers source g&eacute;n&eacute;r&eacute;s.
• La valeur true permet d'afficher HTML source et Source g&eacute;n&eacute;r&eacute;e dans le menu.
• La valeur false permet d'afficher le nom r&eacute;el des fichiers apparent&eacute;s dans le menu.
Derni&egrave;re mise &agrave; jour le 22/6/2011
195
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes qui contient tous les fichiers apparent&eacute;s analys&eacute;s sous la forme d'URL locales absolues.
dreamweaver.openRelatedFile()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Affiche le fichier apparent&eacute; s&eacute;lectionn&eacute; dans le mode Code du document actuel.
Arguments
Cha&icirc;ne qui est l'URL locale absolue du fichier.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.getActiveRelatedFilePath()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction obtient le chemin d'acc&egrave;s complet du fichier apparent&eacute; ouvert.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui est l'URL locale absolue du fichier apparent&eacute;.
dreamweaver.getRelatedFilesFilter()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet d'obtenir le filtre de nom de fichier appliqu&eacute; aux fichiers associ&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Objet DWFilenameFilter repr&eacute;sentant le filtre actuellement appliqu&eacute; aux fichiers associ&eacute;s. Un objet de filtre vide
indique que tous les fichiers seront affich&eacute;s dans la barre Fichiers associ&eacute;s.
Derni&egrave;re mise &agrave; jour le 22/6/2011
196
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Les objets DWFilenameFilter sont une nouveaut&eacute; de Dreamweaver CS5. Ils permettent de restreindre les fichiers
affich&eacute;s dans la barre Fichiers associ&eacute;s.
dreamweaver.setRelatedFilesFilter()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;finir le filtre appliqu&eacute; &agrave; la barre Fichiers associ&eacute;s.
Arguments
Cha&icirc;ne ou DWFilenameFilter. Exemples : &laquo; .js &raquo;, &laquo; .php &raquo;, &laquo; *.js &raquo;, &laquo; *.php.js &raquo;, &laquo; *.css &raquo;, &laquo; &raquo;, &laquo; b*.js &raquo;,
&laquo; b*.* &raquo;, &laquo; *.js;.css &raquo;. Une cha&icirc;ne vide affichera tous les fichiers dans la barre Fichiers associ&eacute;s.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.getQuickRelatedFilesFilterStrings()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet d'obtenir la plage d'objets Cha&icirc;ne repr&eacute;sentant les extensions des fichiers affich&eacute;s dans la barre
Fichiers associ&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Plage d'objets Cha&icirc;ne repr&eacute;sentant les extensions des fichiers affich&eacute;s dans la barre Fichiers associ&eacute;s. Exemple :
{&laquo; .js &raquo;, &laquo; .php &raquo;, &laquo; .css &raquo;}.
dreamweaver.invokeRelatedFilesCustomFilterDialog()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de charger la bo&icirc;te de dialogue des fichiers associ&eacute;s personnalis&eacute;s. L'utilisateur peut appliquer
un filtre &agrave; partir de cette bo&icirc;te de dialogue. Pour d&eacute;terminer le nouveau filtre, l'utilisateur doit appeler la
fonctiongetRelatedFilesFilter .
Derni&egrave;re mise &agrave; jour le 22/6/2011
197
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.getDynamicRelatedFilesDiscoverySetting()
Disponibilit&eacute;
Dreamweaver CS5.
Description
La fonction Fichiers &agrave; association dynamique accro&icirc;t les possibilit&eacute;s de la fonction Fichiers associ&eacute;s, en vous
permettant de voir les fichiers associ&eacute;s aux pages dynamiques dans la barre Fichiers associ&eacute;s.
Cette fonction permet d'obtenir l'option de d&eacute;couverte pour les fichiers &agrave; association dynamique.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Objet Cha&icirc;ne d&eacute;finissant le m&eacute;canisme de d&eacute;couverte, qui est l'une des valeurs suivantes :
Valeur
Description
automatic
Permet la d&eacute;couverte automatique des fichiers associ&eacute;s.
manual
Permet la d&eacute;couverte manuelle des fichiers associ&eacute;s. Dans ce cas, l'utilisateur doit r&eacute;soudre manuellement les
r&eacute;f&eacute;rences aux fichiers associ&eacute;s.
disabled
D&eacute;sactive la d&eacute;couverte automatique des fichiers associ&eacute;s.
dreamweaver.setDynamicRelatedFilesDiscoverySetting()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;finir l'option de d&eacute;couverte pour les fichiers &agrave; association dynamique.
Arguments
Objet Cha&icirc;ne d&eacute;finissant le m&eacute;canisme de d&eacute;couverte, qui est l'une des valeurs suivantes :
Valeur
Description
automatic
Permet la d&eacute;couverte automatique des fichiers associ&eacute;s.
manual
Permet la d&eacute;couverte manuelle des fichiers associ&eacute;s. Dans ce cas, l'utilisateur doit r&eacute;soudre manuellement les
r&eacute;f&eacute;rences aux fichiers associ&eacute;s.
disabled
D&eacute;sactive la d&eacute;couverte automatique des fichiers associ&eacute;s.
Derni&egrave;re mise &agrave; jour le 22/6/2011
198
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.refreshRelatedFiles()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet d'actualiser les fichiers associ&eacute;s affich&eacute;s dans la barre Fichiers associ&eacute;s pour le document actif.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.saveAllRelatedFiles()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet d'enregistrer tous les fichiers associ&eacute;s modifi&eacute;s pour le document actif. L'appel de la fonction
permet d'enregistrer le document actif et tous les fichiers associ&eacute;s modifi&eacute;s pour le document actif. Si le document est
un nouveau document, une bo&icirc;te de dialogue Enregistrer sous s'affiche.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.canSaveAllRelatedFiles()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;terminer si des fichiers associ&eacute;s au document actif ont &eacute;t&eacute; modifi&eacute;s et peuvent &ecirc;tre
enregistr&eacute;s.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
199
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si des fichiers associ&eacute;s ont &eacute;t&eacute; modifi&eacute;s et peuvent &ecirc;tre enregistr&eacute;s.
document.isRelatedFileViewOpen()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;terminer si la fen&ecirc;tre Affichage du code affiche actuellement le code source du document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la fen&ecirc;tre Affichage du code affiche le code source du document.. La valeur false est
renvoy&eacute;e si un code en direct d'un fichier associ&eacute; est ouvert dans la fen&ecirc;tre Affichage du code.
document.getRelatedFiles()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de r&eacute;cup&eacute;rer la liste des fichiers associ&eacute;s au document.
Arguments
filtered
Valeur bool&eacute;enne : true pour appliquer au r&eacute;sultat le filtre s&eacute;lectionn&eacute; dans la barre Fichiers associ&eacute;s. Utilisez false
pour obtenir tous les fichiers associ&eacute;s du document. Cet argument est facultatif. La valeur par d&eacute;faut est false.
type
Cha&icirc;ne facultative qui repr&eacute;sente le type des fichiers associ&eacute;s. Il peut s'agir d'une cha&icirc;ne vide ou d'une cha&icirc;ne contenant
l'une des valeurs suivantes :
•
SOURCE_HTML : r&eacute;cup&egrave;re le document HTML source, qui est le document de niveau sup&eacute;rieur.
•
GENERATED_HTML : r&eacute;cup&egrave;re le document HTML g&eacute;n&eacute;r&eacute; en direct. Cette option n'est d'application que si la
fonctionnalit&eacute; Code en direct est activ&eacute;e.
•
CHILD_DOC : r&eacute;cup&egrave;re la liste des documents associ&eacute;s au chemin statique.
•
PROCESSED_CHILD_DOC : r&eacute;cup&egrave;re la liste des documents associ&eacute;s trait&eacute;s par le serveur. Cette option n'est
d'application que si les fichiers &agrave; association dynamique ont &eacute;t&eacute; d&eacute;couverts et que le r&eacute;sultat g&eacute;n&eacute;r&eacute; par le serveur
fait r&eacute;f&eacute;rence aux documents enfants qui n'avaient pas d&eacute;j&agrave; &eacute;t&eacute; trouv&eacute;s en tant que documents associ&eacute;s au chemin
statique lors de l'ouverture du document.
Derni&egrave;re mise &agrave; jour le 22/6/2011
200
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
•
LIVE_VIEW_CHILD : r&eacute;cup&egrave;re la liste des documents enfants associ&eacute;s du mode En direct. Cette option n'est
d'application que si le document est ouvert en mode En direct et que la source g&eacute;n&eacute;r&eacute;e par le serveur fait r&eacute;f&eacute;rence
aux documents enfants qui n'avaient pas d&eacute;j&agrave; &eacute;t&eacute; trouv&eacute;s en tant que documents associ&eacute;s au chemin statique lors
de l'ouverture du document.
•
LIVE_VIEW_XHR_CHILD : r&eacute;cup&egrave;re la liste des documents de ressource r&eacute;f&eacute;renc&eacute;s dans le mode En direct. Cette
option n'est d'application que lorsque le document est ouvert en mode En direct.
•
DYNAMIC_PATH_CHILD_DOC : r&eacute;cup&egrave;re la liste des fichiers associ&eacute;s du chemin dynamique. Cette option n'est
d'application que si les fichiers &agrave; association dynamique ont &eacute;t&eacute; d&eacute;couverts et que les documents enfants &agrave; relation
dynamique ont &eacute;t&eacute; trouv&eacute;s dans le processus de d&eacute;couverte.
•
USER_DEFINED_CHILD_DOC : r&eacute;cup&egrave;re la liste des fichiers associ&eacute;s au chemin dynamique et d&eacute;finis par l'utilisateur.
Cette option n'est d'application que si une extension a ajout&eacute; des fichiers associ&eacute;s d&eacute;finis par l'utilisateur apr&egrave;s
l'appel de la fonction addRelatedFile(). Pour plus d'informations sur la fonction addRelatedFile(), voir
&laquo; document.addRelatedFile() &raquo; &agrave; la page 200.
•
ALL_TYPES : r&eacute;cup&egrave;re tous les fichiers associ&eacute;s. Il s'agit de la valeur par d&eacute;faut.
Valeurs renvoy&eacute;es
Plage d'objets de fichiers associ&eacute;s. Chaque objet poss&egrave;de les propri&eacute;t&eacute;s suivantes :
•
uri : objet DWUri repr&eacute;sentant l'URI du document associ&eacute;.
•
type : cha&icirc;ne d'un des types indiqu&eacute;s dans la section Arguments, ou UNKNOWN_TYPE si le type est inconnu.
•
document : objet document du document associ&eacute;. S'il n'existe pas de document associ&eacute;, cette propri&eacute;t&eacute; a la valeur NULL.
•
isChildDocType : valeur bool&eacute;enne. &laquo; true &raquo; si le document associ&eacute; est un document enfant (pas la source ni le
document source g&eacute;n&eacute;r&eacute;).
•
isSelectedDoc : valeur bool&eacute;enne. &laquo; true &raquo; si le document est s&eacute;lectionn&eacute;.
document.addRelatedFile()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet d'ajouter un fichier associ&eacute; d&eacute;fini par une extension.
Si vous &ecirc;tes d&eacute;veloppeur d'extensions, veillez &agrave; appeler la fonction refreshRelatedFiles() apr&egrave;s avoir appel&eacute; la
fonction addRelatedFile(). Pour plus d'informations sur la fonction refreshRelatedFiles(), voir
&laquo; dreamweaver.refreshRelatedFiles() &raquo; &agrave; la page 198.
Arguments
• uri : objet DWUri qui repr&eacute;sente l'objet de fichier associ&eacute;. Cet argument est requis.
•
persistent : valeur bool&eacute;enne. &laquo; true &raquo; si l'objet de fichier associ&eacute; doit persister lorsque le document de niveau
sup&eacute;rieur est &agrave; nouveau analys&eacute;. Cet argument est facultatif.
• type : cha&icirc;ne facultative sp&eacute;cifi&eacute;e dans la fonction document.getRelatedFiles(). Les appelants qui omettent ce
param&egrave;tre ins&eacute;reront un fichier associ&eacute; de type USER_DEFINED_CHILD_DOC.
Derni&egrave;re mise &agrave; jour le 22/6/2011
201
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Aucune.
document.removeRelatedFile()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de supprimer un fichier associ&eacute; d&eacute;fini par une extension.
Seuls les objets de document associ&eacute; du type CHILD_DOC peuvent &ecirc;tre supprim&eacute;s &agrave; l'aide de cette fonction. Elle ne peut
pas supprimer les objets de type SOURCE_HTML ou GENERATED_HTML.
Arguments
uri : objet DWUri qui repr&eacute;sente l'objet de fichier associ&eacute;. Cet argument est requis.
Valeurs renvoy&eacute;es
Aucune.
document.getDependentFiles()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de r&eacute;cup&eacute;rer les fichiers d&eacute;pendants de l'objet de document.
La liste des fichiers d&eacute;pendants est la liste des fichiers qui sont envoy&eacute;s au serveur s'ils sont modifi&eacute;s pour aper&ccedil;u dans
le navigateur, affichage en direct, ou lors de l'obtention du document depuis le serveur ou le contr&ocirc;le de version.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Plage d'objets DWUri repr&eacute;sentant la liste des fichiers d&eacute;pendants.
R&eacute;f&eacute;rence de DWFilenameFilter
Les objets de type DWFilenameFilter sont des nouveaut&eacute;s de Dreamweaver CS5. Ils permettent de restreindre la liste
des fichiers affich&eacute;s dans la barre Fichiers associ&eacute;s. Pour manipuler le filtre de la barre Fichiers associ&eacute;s, un
d&eacute;veloppeur d'extension peut cr&eacute;er un nouvel objet DWFilenameFilter et modifier le comportement du filtre &agrave; l'aide
des fonctions d&eacute;crites dans les sections suivantes.
Par exemple,
var filter = new DWFilenameFilter;
filter.setExpression('*.js');
Derni&egrave;re mise &agrave; jour le 22/6/2011
202
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dw.setRelatedFilesFilter(filter);
Le d&eacute;veloppeur d'extension peut aussi manipuler le filtre actuellement appliqu&eacute; &agrave; la barre Fichiers associ&eacute;s en appelant
la fonction dreamweaver.getRelatedFilesFilter() (voir &laquo; dreamweaver.getRelatedFilesFilter() &raquo; &agrave; la page 195)
puis en modifiant le comportement du filtre au moyen d'autres fonctions.
Par exemple :
var filter = dw.getRelatedFilesFilter();
filter.addExtensionToExclusionExpression('.js');
dw.setRelatedFilesFilter(filter);
DWFilenameFilter.isValidFilterExpression()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;terminer si une expression est une expression de filtre valide.
Arguments
expression : cha&icirc;ne repr&eacute;sentant une expression de filtre.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'expression est valide.
DWFilenameFilter.isEmpty()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;terminer si un objet de filtre est vide.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'objet de filtre est vide.
DWFilenameFilter.doesExcludeExtension()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;terminer si une extension est exclue par l'objet de filtre.
Derni&egrave;re mise &agrave; jour le 22/6/2011
203
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Les filtres emploient un test exclusif afin de d&eacute;terminer si une extension de fichier est exclue &agrave; l'aide de l'expression
d'exclusion. Utilisez cette fonction pour d&eacute;terminer si une extension de fichier a &eacute;t&eacute; pr&eacute;c&eacute;demment ajout&eacute;e &agrave; la liste
d'exclusion &agrave; l'aide de la fonction DWFilenameFilter.addExtensionToExclusionExpression(). Pour plus
d'informations, voir &laquo; DWFilenameFilter.addExtensionToExclusionExpression() &raquo; &agrave; la page 205.
Arguments
extension : cha&icirc;ne qui repr&eacute;sente une extension.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'extension est exclue par le filtre.
DWFilenameFilter.isAdvancedFilter()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;terminer si l'objet de filtre est un filtre avanc&eacute;.
Le filtre avanc&eacute; est activ&eacute; lorsque l'utilisateur choisit &laquo; Avanc&eacute;... &raquo; dans le menu Filtre.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le filtre est un filtre avanc&eacute;.
DWFilenameFilter.willMatchAnyFile()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;terminer si l'objet de filtre correspondra &agrave; n'importe quel fichier. Si un filtre correspond &agrave;
n'importe quel fichier, tous les fichiers seront affich&eacute;s dans la barre Fichiers associ&eacute;s.
Pour correspondre &agrave; n'importe quel fichier, l'objet de filtre doit &ecirc;tre vide ou comporter un filtre avanc&eacute; dont
l'expression est &laquo; *.* &raquo;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le filtre correspond &agrave; n'importe quel fichier.
Derni&egrave;re mise &agrave; jour le 22/6/2011
204
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
DWFilenameFilter.getExpression()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de r&eacute;cup&eacute;rer l'expression de filtre.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui repr&eacute;sente l'expression de filtre.
Une cha&icirc;ne vide est renvoy&eacute;e si le filtre correspondant &agrave; n'importe quel fichier est vide.
DWFilenameFilter.setExpression()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;finir l'expression de filtre.
Arguments
expression : cha&icirc;ne repr&eacute;sentant une expression de filtre.
Cet argument est un ou plusieurs filtres &agrave; caract&egrave;res g&eacute;n&eacute;riques, s&eacute;par&eacute;s par des points virgules. Exemple : &laquo; ;Help*. &raquo;.
La fixation d'une cha&icirc;ne vide pour l'objet de filtre fera en sorte que le filtre corresponde &agrave; n'importe quel fichier.
Valeurs renvoy&eacute;es
Aucune.
DWFilenameFilter.getExcludedExtensions()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction sert &agrave; r&eacute;cup&eacute;rer la liste de toutes les extensions de fichier exclues.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
205
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Plage d'objets de cha&icirc;ne repr&eacute;sentant les extensions que le filtre doit exclure. Voir aussi la fonction
&laquo; DWFilenameFilter.addExtensionToExclusionExpression() &raquo; &agrave; la page 205.
Exemple : {&laquo; .php &raquo;, &laquo; .css &raquo;, &laquo; .engine &raquo;}
DWFilenameFilter.getExclusionExpression()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de r&eacute;cup&eacute;rer l'expression d'exclusion.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant des valeurs s&eacute;par&eacute;es par des points virgules, qui repr&eacute;sente la liste des extensions qui sont exclues.
Exemple : {&laquo; .php;.css;.engine &raquo;}
DWFilenameFilter.getAdvancedExpression()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de r&eacute;cup&eacute;rer l'expression avanc&eacute;e.
Le filtre peut &ecirc;tre un filtre avanc&eacute; contenant d'autres filtres d'exclusion &agrave; caract&egrave;res g&eacute;n&eacute;riques, ou un filtre simple
contenant une liste d'extensions de fichier &agrave; exclure.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant des valeurs s&eacute;par&eacute;es par des points virgules, qui repr&eacute;sentent la liste des filtres dans l'expression
avanc&eacute;e.
Exemple : &laquo; *.css;help*.js &raquo;
DWFilenameFilter.addExtensionToExclusionExpression()
Disponibilit&eacute;
Dreamweaver CS5.
Derni&egrave;re mise &agrave; jour le 22/6/2011
206
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Description
Cette fonction permet d'ajouter une extension &agrave; la liste d'exclusion de l'objet de filtre.
Arguments
extension : cha&icirc;ne ou objet DWUri.
Cet argument repr&eacute;sente le nom de fichier ou l'extension &agrave; ajouter au filtre.
L'argument peut &ecirc;tre une extension, un nom de fichier local complet ou une URL distant sous la forme d'une cha&icirc;ne
ou d'un objet DWUri valide.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant des valeurs s&eacute;par&eacute;es par des points virgules, qui repr&eacute;sentent la liste des filtres dans l'expression
avanc&eacute;e.
Exemple : &laquo; *.css;help*.js &raquo;
DWFilenameFilter.removeExtensionFromExclusionExpression()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de supprimer une extension de la liste d'exclusion de l'objet de filtre.
Arguments
extension : cha&icirc;ne ou objet DWUri.
Cet argument repr&eacute;sente le nom de fichier ou l'extension &agrave; supprimer du filtre.
L'argument peut &ecirc;tre une extension, un nom de fichier local complet ou une URL distant sous la forme d'une cha&icirc;ne
ou d'un objet DWUri valide.
Valeurs renvoy&eacute;es
Aucune.
DWFilenameFilter.empty()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet d'effacer le filtre.
Un filtre vide correspondra &agrave; tous les fichiers.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
207
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Aucune.
Fonctions du mode Fractionnement vertical
Les fonctions du mode Fractionnement vertical permettent l'affichage c&ocirc;te &agrave; c&ocirc;te des modes Code et Cr&eacute;ation ou Code
et Mise en forme du code. Ces fonctions permettent aussi &agrave; l'utilisateur de choisir une orientation horizontale ou
verticale des modes Fractionn&eacute; et Code fractionn&eacute;, et de basculer entre celles-ci.
dreamweaver.getSplitViewOrientation()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction affiche l'orientation actuelle du mode Fractionn&eacute;. L'orientation peut &ecirc;tre obtenue m&ecirc;me si l'affichage
n'est pas fractionn&eacute;. Dans ce cas, la valeur renvoy&eacute;e indique l'orientation si l'affichage Fractionn&eacute; ou Code fractionn&eacute;
est activ&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur de cha&icirc;ne qui d&eacute;finit l'orientation. Renvoie la valeur vertical ou horizontal en fonction de l'orientation
actuelle.
dreamweaver.setSplitViewOrientation()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction modifie l'orientation actuelle du mode Fractionn&eacute;. L'orientation peut &ecirc;tre modifi&eacute;e m&ecirc;me si l'affichage
n'est pas fractionn&eacute;. Dans ce cas, l'argument indique l'orientation la prochaine fois que l'affichage Fractionn&eacute; ou Code
fractionn&eacute; sera activ&eacute;.
Arguments
Valeur de cha&icirc;ne qui indique l'orientation. Utilisez vertical ou horizontal pour indiquer l'orientation. Cet
argument est requis.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false si une erreur se produit.
Derni&egrave;re mise &agrave; jour le 22/6/2011
208
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dreamweaver.getPrimaryView()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction obtient le nom du mode d'affichage principal. En mode Fractionn&eacute; ou Code fractionn&eacute;, le mode
principal est la fen&ecirc;tre sup&eacute;rieure ou de gauche, en fonction de l'orientation du mode Fractionn&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le nom du mode d'affichage principal, qui peut &ecirc;tre l'une des valeurs suivantes :
Valeur
Description
code
L'affichage principal est la fen&ecirc;tre Code.
design
L'affichage principal est la fen&ecirc;tre Cr&eacute;ation.
related file
L'affichage principal est la fen&ecirc;tre des fichiers apparent&eacute;s. Cette valeur est renvoy&eacute;e lorsque l'affichage utilis&eacute; pour
le document est Code fractionn&eacute; et qu'un fichier apparent&eacute; a &eacute;t&eacute; ouvert.
dreamweaver.setPrimaryView()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction modifie le mode d'affichage principal. En mode Fractionn&eacute; ou Code fractionn&eacute;, le mode principal est
la fen&ecirc;tre sup&eacute;rieure ou de gauche, en fonction de l'orientation du mode Fractionn&eacute;.
Arguments
Cha&icirc;ne contenant le nom du mode d'affichage principal, qui peut &ecirc;tre l'une des valeurs suivantes :
Valeur
Description
code
L'affichage principal est la fen&ecirc;tre Code.
design
L'affichage principal est la fen&ecirc;tre Cr&eacute;ation.
related file
L'affichage principal est la fen&ecirc;tre des fichiers apparent&eacute;s. Cette valeur est utilis&eacute;e lorsque l'affichage utilis&eacute;
pour le document est Code fractionn&eacute; et qu'un fichier apparent&eacute; a &eacute;t&eacute; ouvert.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
209
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dom.isRelatedFileViewOpen()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction d&eacute;termine si l'affichage contient une fen&ecirc;tre de fichiers apparent&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si une fen&ecirc;tre de fichiers apparent&eacute;s est ouverte, false dans le cas contraire.
Fonctions relatives au fractionnement des codes
Ces fonctions vous permettent de fractionner et d'&eacute;tendre visuellement des codes. Vous pouvez fractionner ou &eacute;tendre
des s&eacute;lections arbitraires de codes, ou des fragments situ&eacute;s entre les balises d'ouverture et de fermeture. Bien que les
fonctions de fractionnement de code existent dans le dom comme dans htmlInspector, les plages r&eacute;duites sont
identiques dans le mode Code et dans Cold Inspector.
dom.collapseFullTag()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;termine si l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; se trouve dans une seule paire de balises d'ouverture et de fermeture
ou s'il contient une seule paire de balises d'ouverture et de fermeture en mode Code. Le cas &eacute;ch&eacute;ant, la fonction
fractionne le fragment de code qui commence imm&eacute;diatement avant la balise d'ouverture et se termine apr&egrave;s la balise
de fermeture ; dans le cas contraire, elle ne fait rien.
Arguments
allowCodeFragmentAdjustment
• L'argument obligatoire allowCodeFragmentAdjustment est une valeur bool&eacute;enne. Si d&eacute;fini sur true, cet argument
n'a aucun effet actuellement ou bien le m&ecirc;me effet que la valeur false. Si d&eacute;fini sur false, Dreamweaver
fractionne le code qui commence imm&eacute;diatement avant la balise d'ouverture et se termine imm&eacute;diatement apr&egrave;s la
balise de fermeture, sans le modifier.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant fractionne le fragment de code qui commence juste avant la balise d'ouverture et se termine juste
apr&egrave;s la balise de fermeture dans la s&eacute;lection en cours du mode Code :
Derni&egrave;re mise &agrave; jour le 22/6/2011
210
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
var currentDOM = dw.getDocumentDOM();
currentDOM.collapseFullTag(false);
dom.collapseFullTagInverse()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;termine si l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; se trouve dans une seule paire de balises d'ouverture et de fermeture
ou s'il contient une seule paire de balises d'ouverture et de fermeture en mode Code. Le cas &eacute;ch&eacute;ant, elle fractionne le
code qui pr&eacute;c&egrave;de la balise d'ouverture et le code qui suit la balise de fermeture ; dans le cas contraire, elle ne fait rien.
Arguments
allowAdjustmentOfCodeFragments
• L'argument obligatoire allowAdjustmentOfCodeFragments est une valeur bool&eacute;enne. Si d&eacute;fini sur true,
Dreamweaver ajuste les limites du code situ&eacute; avant la balise de d'ouverture et du code situ&eacute; apr&egrave;s la balise de
fermeture pour effectuer un fractionnement intelligent qui conserve la mise en retrait et l'espacement en cours. Si
d&eacute;fini sur false, Dreamweaver fractionne les fragments de code qui se trouvent avant la balise d'ouverture et apr&egrave;s
la balise de fermeture, exactement comme indiqu&eacute; par la s&eacute;lection.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant ajuste les limites du code avant la balise d'ouverture et apr&egrave;s la balise de fermeture pour effectuer un
fractionnement intelligent qui conserve la mise en retrait et l'espacement :
var currentDOM = dw.getDocumentDOM();
currentDOM.collapseFullTagInverse(true);
dom.collapseSelectedCodeFragment()
Disponibilit&eacute;
Dreamweaver 8.
Description
Fractionne le code s&eacute;lectionn&eacute; en mode Code. Si la s&eacute;lection est d&eacute;j&agrave; r&eacute;duite, cette fonction ne fait rien.
Arguments
allowCodeFragmentAdjustment
• allowCodeFragmentAdjustment est une valeur bool&eacute;enne obligatoire. Si d&eacute;fini sur true, Dreamweaver modifie les
limites de la s&eacute;lection en cours pour effectuer un fractionnement intelligent et conserver la mise en retrait et
l'espacement en cours. Si d&eacute;fini sur false, Dreamweaver fractionne le fragment de code actuellement s&eacute;lectionn&eacute;,
exactement comme indiqu&eacute; par la s&eacute;lection.
Derni&egrave;re mise &agrave; jour le 22/6/2011
211
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant fractionne le fragment de code s&eacute;lectionn&eacute; en mode Code sans le modifier :
var currentDOM = dw.getDocumentDOM();
currentDOM.collapseSelectedCodeFragment(false);
dom.collapseSelectedCodeFragmentInverse()
Disponibilit&eacute;
Dreamweaver 8.
Description
Fractionne toutes les portions de code avant et apr&egrave;s le code s&eacute;lectionn&eacute; en mode Code.
Arguments
allowAdjustmentOfCodeFragments
• L'argument obligatoire allowAdjustmentOfCodeFragments est une valeur bool&eacute;enne. Si d&eacute;fini sur true,
Dreamweaver ajuste les limites du code situ&eacute; avant et apr&egrave;s la s&eacute;lection en cours pour effectuer un fractionnement
intelligent qui conserve la mise en retrait et l'espacement en cours. Si d&eacute;fini sur false, Dreamweaver fractionne le
fragment de code exactement comme indiqu&eacute; par la s&eacute;lection.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant modifie puis fractionne toutes les portions de code situ&eacute;es avant et apr&egrave;s le code s&eacute;lectionn&eacute; en
mode Code :
var currentDOM = dw.getDocumentDOM();
currentDOM.collapseSelectedCodeFragmentInverse(true);
dom.expandAllCodeFragments()
Disponibilit&eacute;
Dreamweaver 8.
Description
Etend tous les fragments de code r&eacute;duits en mode Code, y compris les fragments de code r&eacute;duits imbriqu&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
212
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Exemple
L'exemple suivant &eacute;tend toutes les portions de code r&eacute;duit en mode Code :
var currentDOM = dw.getDocumentDOM();
currentDOM.expandAllCodeFragments();
dom.expandSelectedCodeFragments()
Disponibilit&eacute;
Dreamweaver 8.
Description
Etend tous les fragments de code r&eacute;duits dans la s&eacute;lection en cours en mode Code. Si la s&eacute;lection est d&eacute;j&agrave; &eacute;tendue, cette
fonction ne fait rien.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant &eacute;tend toutes les portions de code r&eacute;duit dans la s&eacute;lection en cours en mode Code :
var currentDOM = dw.getDocumentDOM();
currentDOM.expandSelectedCodeFragments();
dreamweaver.htmlInspector.collapseFullTag()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;termine si l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; se trouve dans une seule paire de balises d'ouverture et de fermeture
ou s'il contient une seule paire de balises d'ouverture et de fermeture dans l'inspecteur de code. Le cas &eacute;ch&eacute;ant, la
fonction fractionne le fragment de code qui commence imm&eacute;diatement avant la balise d'ouverture et se termine apr&egrave;s
la balise de fermeture ; dans le cas contraire, elle ne fait rien.
Arguments
allowACodeFragmentAdjustment
• L'argument obligatoire allowCodeFragmentAdjustment est une valeur bool&eacute;enne. Si d&eacute;fini sur true, cet argument
n'a aucun effet actuellement ou bien le m&ecirc;me effet que la valeur false. Si d&eacute;fini sur false, Dreamweaver
fractionne le code qui commence imm&eacute;diatement avant la balise d'ouverture et se termine imm&eacute;diatement apr&egrave;s la
balise de fermeture, sans le modifier.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
213
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Exemple
L'exemple suivant fractionne le fragment de code qui commence juste avant la balise d'ouverture et se termine juste
apr&egrave;s la balise de fermeture dans la s&eacute;lection en cours de l'inspecteur de code :
dreamweaver.htmlInspector.collapseFullTag(false);
dreamweaver.htmlInspector.collapseFullTagInverse()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;termine si l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; se trouve dans une seule paire de balises d'ouverture et de fermeture
ou s'il contient une seule paire de balises d'ouverture et de fermeture dans l'inspecteur de code. Le cas &eacute;ch&eacute;ant, elle
fractionne le code situ&eacute; avant la balise d'ouverture et le code situ&eacute; apr&egrave;s la balise de fermeture ; dans le cas contraire,
elle ne fait rien.
Arguments
allowAdjustmentOfCodeFragments
• L'argument obligatoire allowAdjustmentOfCodeFragments est une valeur bool&eacute;enne. Si d&eacute;fini sur true,
Dreamweaver ajuste les limites du code situ&eacute; avant la balise de d'ouverture et du code situ&eacute; apr&egrave;s la balise de
fermeture pour effectuer un fractionnement intelligent qui conserve la mise en retrait et l'espacement existants. Si
d&eacute;fini sur false, Dreamweaver fractionne le code situ&eacute; avant la balise d'ouverture et le code situ&eacute; apr&egrave;s la balise de
fermeture, sans le modifier.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant effectue un fractionnement intelligent sur les sections de code qui apparaissent avant la balise
d'ouverture et apr&egrave;s la balise de fermeture de la s&eacute;lection en cours :
dreamweaver.htmlInspector.collapseFullTagInverse(true);
dreamweaver.htmlInspector.collapseSelectedCodeFragment()
Disponibilit&eacute;
Dreamweaver 8.
Description
Fractionne le code s&eacute;lectionn&eacute; dans l'inspecteur de code. Si la s&eacute;lection est d&eacute;j&agrave; r&eacute;duite, cette fonction ne fait rien.
Derni&egrave;re mise &agrave; jour le 22/6/2011
214
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
allowCodeFragmentAdjustment
• allowCodeFragmentAdjustment est une valeur bool&eacute;enne obligatoire. Si d&eacute;fini sur true, Dreamweaver modifie la
s&eacute;lection en cours pour effectuer un fractionnement intelligent et conserver la mise en retrait et l'espacement
existants. Si d&eacute;fini sur false, Dreamweaver fractionne le fragment de code actuellement s&eacute;lectionn&eacute;, exactement
comme indiqu&eacute; par la s&eacute;lection.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant modifie puis fractionne le code s&eacute;lectionn&eacute; dans l'inspecteur de code :
dreamweaver.htmlInspector.collapseSelectedCodeFragment(true);
dreamweaver.htmlInspector.collapseSelectedCodeFragmentInverse()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction fractionne toutes les portions de code avant et apr&egrave;s le code s&eacute;lectionn&eacute; dans l'inspecteur de code. Si la
s&eacute;lection est d&eacute;j&agrave; r&eacute;duite, cette fonction ne fait rien.
Arguments
allowAdjustmentOfCodeFragments
• L'argument obligatoire allowAdjustmentOfCodeFragments est une valeur bool&eacute;enne. Si d&eacute;fini sur true,
Dreamweaver ajuste les limites des sections de code situ&eacute; avant et apr&egrave;s la s&eacute;lection en cours pour effectuer un
fractionnement intelligent qui conserve la mise en retrait et l'espacement en cours. Si d&eacute;fini sur false,
Dreamweaver fractionne les sections de code exactement comme indiqu&eacute; par la s&eacute;lection.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant fractionne toutes les portions de code avant et apr&egrave;s le code s&eacute;lectionn&eacute; dans l'inspecteur de code,
exactement comme indiqu&eacute; par la s&eacute;lection :
dreamweaver.htmlInspector.collapseSelectedCodeFragmentInverse(false);
dreamweaver.htmlInspector.expandAllCodeFragments()
Disponibilit&eacute;
Dreamweaver 8.
Description
Etend tous les fragments de code r&eacute;duits dans l'inspecteur de code, y compris les fragments de code r&eacute;duits imbriqu&eacute;s.
Derni&egrave;re mise &agrave; jour le 22/6/2011
215
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant &eacute;tend toutes les portions de code r&eacute;duit dans l'inspecteur de code :
dreamweaver.htmlInspector.expandAllCodeFragments();
dreamweaver.htmlInspector.expandSelectedCodeFragments()
Disponibilit&eacute;
Dreamweaver 8.
Description
Etend tous les fragments de code r&eacute;duits dans la s&eacute;lection en cours de l'inspecteur de code. Si la s&eacute;lection est d&eacute;j&agrave;
&eacute;tendue, cette fonction ne fait rien.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant &eacute;tend toutes les portions de code r&eacute;duit dans la s&eacute;lection en cours de l'inspecteur de code :
dreamweaver.htmlInspector.expandSelectedCodeFragments();
Fonctions relatives aux barres d'outils du mode Code
Ces fonctions permettent d'ins&eacute;rer du texte, de supprimer des commentaires, d'afficher ou de masquer les caract&egrave;res
sp&eacute;ciaux utilis&eacute;s pour les espaces blancs en mode Code et d'obtenir le chemin d'acc&egrave;s du document actif.
Remarque : Il existe deux barres d'outils de codage, l'une pour le mode Code et l'autre pour l'inspecteur ed code. Les deux
sont personnalis&eacute;es dans le ficher Configuration/Toolbars/toolbars.xml.
dom.getOpenPathName()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction obtient le chemin de fichier absolu du document ouvert.
Derni&egrave;re mise &agrave; jour le 22/6/2011
216
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui correspond au chemin de fichier absolu du document ouvert.
Exemple
L'exemple suivant assigne la cha&icirc;ne contenant le chemin d'acc&egrave;s du document actuellement ouvert &agrave; la variable
fileName :
var fileName = dom.getOpenPathName();
dom.getShowHiddenCharacters()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;termine si les caract&egrave;res sp&eacute;ciaux utilis&eacute;s pour les espaces blancs sont affich&eacute;s dans la fen&ecirc;tre de
document en mode Code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les caract&egrave;res masqu&eacute;s sont affich&eacute;s, false dans le cas contraire.
Exemple
L'exemple suivant d&eacute;sactive l'affichage des caract&egrave;res sp&eacute;ciaux utilis&eacute;s pour les espaces blancs lorsque l'affichage de ces
caract&egrave;res est activ&eacute; :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowHiddenCharacters()){
currentDOM.setShowHiddenCharacters(false);
}
dom.setShowHiddenCharacters()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction affiche ou masque les caract&egrave;res sp&eacute;ciaux utilis&eacute;s pour les espaces blancs dans l'inspecteur de code en
mode Code.
Voir &laquo; dom.getShowHiddenCharacters() &raquo; &agrave; la page 216 pour un exemple.
Derni&egrave;re mise &agrave; jour le 22/6/2011
217
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
show
• L'argument obligatoire show est une valeur bool&eacute;enne qui indique s'il faut afficher les caract&egrave;res masqu&eacute;s.
Valeurs renvoy&eacute;es
Aucune.
dom.source.applyComment()
Disponibilit&eacute;
Dreamweaver 8.
Description
Ins&egrave;re le texte sp&eacute;cifi&eacute; dans l'argument beforeText avant la s&eacute;lection en cours et le texte sp&eacute;cifi&eacute; dans l'argument
afterText apr&egrave;s la s&eacute;lection en cours. La fonction &eacute;tend ensuite la s&eacute;lection en cours de mani&egrave;re &agrave; inclure le texte ajout&eacute;.
Cependant, s'il n'y a pas de s&eacute;lection, la fonction ne s&eacute;lectionne aucun &eacute;l&eacute;ment. Si la valeur du texte sp&eacute;cifi&eacute; dans
l'argument afterText est null, la fonction ins&egrave;re le texte sp&eacute;cifi&eacute; dans l'argument beforeText au d&eacute;but de chaque ligne
dans la s&eacute;lection en cours.
Arguments
beforeText, afterText
• L'argument beforeText est obligatoire. Il indique le texte &agrave; ins&eacute;rer au d&eacute;but de la s&eacute;lection, ou, si la valeur de
l'argument afterText est null, il indique le texte &agrave; ins&eacute;rer au d&eacute;but de chaque ligne dans la s&eacute;lection.
• L'argument facultatif afterText indique le texte &agrave; ins&eacute;rer &agrave; la fin de la s&eacute;lection.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant transforme la s&eacute;lection en cours en un commentaire HTML :
dw.getDocumentDOM().source.applyComment('&lt;!--', '--&gt;')
dom.source.refreshVariableCodeHints()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Analyse &agrave; nouveau la page &agrave; la recherche de variables et d'associations de classe correspondantes. Cette fonction recr&eacute;e
le moteur d'&eacute;tat des couleurs et la liste de variables.
Derni&egrave;re mise &agrave; jour le 22/6/2011
218
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Arguments
bSyncDoc
• Il s'agit d'une valeur bool&eacute;enne. La valeur par d&eacute;faut est false. Si la valeur est d&eacute;finie sur true, le mode Cr&eacute;ation
est synchronis&eacute; avec le mode Code.
Valeurs renvoy&eacute;es
Aucune.
Exemple
dom.source.refreshVariableCodeHints();
dom.source.removeComment()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction supprime des commentaires. Si vous n'indiquez aucun argument, elle supprime tous les types de
commentaires de la s&eacute;lection en cours, &agrave; l'exception des inclusions c&ocirc;t&eacute; serveur et des commentaires sp&eacute;cifiques
Dreamweaver. En cas de commentaires imbriqu&eacute;s, elle supprime uniquement le commentaire externe. S'il n'y a pas de
s&eacute;lection en cours, elle supprime uniquement le premier commentaire de la ligne sur laquelle se trouve le curseur. Si
vous indiquez des arguments, la fonction supprime uniquement les commentaires correspondant aux valeurs
sp&eacute;cifi&eacute;es dans les arguments beforeText et afterText, m&ecirc;me si les commentaires correspondants sont imbriqu&eacute;s dans
d'autres types de commentaires.
Arguments
beforeText, afterText
• L'argument beforeText est facultatif. Il indique le texte permettant d'identifier le d&eacute;but du commentaire &agrave; supprimer
dans la s&eacute;lection, ou, si la valeur de l'argument afterText est null, il indique le type de commentaire de ligne &agrave;
supprimer de la s&eacute;lection en cours.
• L'argument facultatif afterText indique le texte permettant d'identifier la fin du commentaire &agrave; supprimer dans la
s&eacute;lection.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant supprime un commentaire HTML :
dw.getDocumentDOM().source.removeComment('&lt;!--', '--&gt;')
dreamweaver.htmlInspector.getShowHiddenCharacters()
Disponibilit&eacute;
Dreamweaver 8.
Derni&egrave;re mise &agrave; jour le 22/6/2011
219
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Description
Cette fonction d&eacute;termine si les caract&egrave;res sp&eacute;ciaux utilis&eacute;s pour les espaces blancs sont affich&eacute;s dans l'inspecteur de
code en mode Code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les caract&egrave;res masqu&eacute;s sont affich&eacute;s, false dans le cas contraire.
Exemple
L'exemple suivant d&eacute;sactive l'affichage des caract&egrave;res sp&eacute;ciaux utilis&eacute;s pour les espaces blancs dans l'inspecteur de code
lorsque l'affichage de ces caract&egrave;res est activ&eacute; :
if (dreamweaver.htmlinspector.getShowHiddenCharacters()){
dreamweaver.htmlinspector.setShowHiddenCharacters(false);
}
dreamweaver.htmlInspector.setShowHiddenCharacters()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction affiche ou masque les caract&egrave;res sp&eacute;ciaux utilis&eacute;s pour les espaces blancs dans l'inspecteur de code en
mode Code.
Arguments
show
• L'argument obligatoire show est une valeur bool&eacute;enne qui indique s'il faut afficher les caract&egrave;res masqu&eacute;s utilis&eacute;s
pour les espaces blancs.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les caract&egrave;res masqu&eacute;s sont affich&eacute;s, false dans le cas contraire.
Exemple
Voir &laquo; dreamweaver.htmlInspector.getShowHiddenCharacters() &raquo; &agrave; la page 218.
Fonctions des couleurs
Les fonctions des couleurs suivantes vous permettent de v&eacute;rifier que les extensions poss&egrave;dent le m&ecirc;me habillage que
l'interface utilisateur de l'application.
Derni&egrave;re mise &agrave; jour le 22/6/2011
220
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
dreamweaver.getPanelColor()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction obtient les couleurs des panneaux de l'interface utilisateur de l'application. Vous pouvez employer ces
couleurs pour les panneaux des extensions. Cette fonction vous permet de v&eacute;rifier que les couleurs des panneaux des
extensions sont assorties aux couleurs des panneaux de l'interface utilisateur de l'application.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes de taille 4 avec les valeurs suivantes :
• Rouge
• Vert
• Bleu
• Transparence Alpha
Exemple
var panelColorArray = dw.getPanelColor();
Les valeurs renvoy&eacute;es pour cet exemple sont :
•
panelColorArray[0] : Rouge
•
panelColorArray[1] : Vert
•
panelColorArray[2] : Bleu
•
panelColorArray[3] : Alpha
dreamweaver.getAppBarColor()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction obtient les couleurs de la barre d'application de l'interface utilisateur. Vous pouvez employer ces
couleurs pour les barres des extensions. Cette fonction vous permet de v&eacute;rifier que les couleurs des barres des
extensions sont assorties aux couleurs des barres de l'interface utilisateur de l'application.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
221
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Espace de travail
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes de taille 4 avec les valeurs suivantes :
• Rouge
• Vert
• Bleu
• Transparence Alpha
Exemple
var appBarColorArray = dw.getAppBarColor();
Les valeurs renvoy&eacute;es pour cet exemple sont :
•
appBarColorArray[0] : Rouge
•
appBarColorArray[1] : Vert
•
appBarColorArray[2] : Bleu
•
appBarColorArray[3] : Alpha
Derni&egrave;re mise &agrave; jour le 22/6/2011
222
Chapitre 13 : Site
Les fonctions relatives aux sites d'Adobe&reg; Dreamweaver&reg; CS5 effectuent des t&acirc;ches ayant trait &agrave; la gestion d'un site
Web. Il peut s'agir de personnaliser un rapport, de d&eacute;finir un nouveau site, d'archiver ou d'extraire des fichiers, de
valider un site, etc.
Fonctions relatives aux rapports
Ces fonctions permettent d'acc&eacute;der aux fonctionnalit&eacute;s de cr&eacute;ation de rapports et notamment de lancer, de contr&ocirc;ler
et de personnaliser le processus de cr&eacute;ation de rapports. Pour plus d'informations, consultez la rubrique &laquo; Rapports &raquo;
dans l'aide Extension de Dreamweaver.
dreamweaver.isReporting()
Disponibilit&eacute;
Dreamweaver 4.
Description
V&eacute;rifie si un processus de cr&eacute;ation de rapport est en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si un processus est en cours d'ex&eacute;cution, false dans le cas contraire.
dreamweaver.showReportsDialog()
Disponibilit&eacute;
Dreamweaver 4.
Description
Ouvre la bo&icirc;te de dialogue Rapports.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
223
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Fonctions relatives aux sites
Ces fonctions permettent d'effectuer des op&eacute;rations sur les fichiers de site. Elles permettent d'effectuer les t&acirc;ches
suivantes :
• cr&eacute;er des liens entre fichiers ;
• obtenir, placer, archiver et extraire des fichiers ;
• s&eacute;lectionner et d&eacute;s&eacute;lectionner des fichiers ;
• cr&eacute;er et supprimer des fichiers ;
• obtenir des informations sur les sites d&eacute;finis par l'utilisateur ;
• importer et exporter les informations du site.
dom.getSiteURLPrefixFromDoc()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction obtient le pr&eacute;fixe de l'URL du site qui est extrait de l'adresse HTTP d&eacute;finie dans la section Infos locales
de la bo&icirc;te de dialogue D&eacute;finition du site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne indiquant le pr&eacute;fixe de l'URL du site.
Exemple
L'exemple suivant obtient le pr&eacute;fixe de l'URL du site pour le document actif :
var currentDOM = dw.getDocumentDOM();
var sitePrefix = currentDOM.getSiteURLPrefixFromDoc();
dom.localPathToSiteRelative()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction convertit un chemin d'acc&egrave;s de fichier local en une r&eacute;f&eacute;rence d'URI relative au site.
Arguments
localFilePath
• L'argument obligatoire localFilePath est une cha&icirc;ne contenant le chemin d'acc&egrave;s &agrave; un fichier local sur votre
ordinateur local.
Derni&egrave;re mise &agrave; jour le 22/6/2011
224
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Valeurs renvoy&eacute;es
Cha&icirc;ne indiquant l'URI relative du site.
Exemple
L'exemple suivant renvoie &quot;/myWebApp/myFile.cfm&quot;, en fonction de vos mappages de site et de l'adresse HTTP
sp&eacute;cifi&eacute;e dans la section Infos locales de la bo&icirc;te de dialogue D&eacute;finition du site.
var dom = dw.getDocumentDOM();
var siteRelativeURI =
dom.localPathToSiteRelative(&quot;C:\Inetpub\wwwroot\siteA\myWebApp\myFile.cfm&quot;)
dom.siteRelativeToLocalPath()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction convertit une r&eacute;f&eacute;rence d'URI relative au site en un chemin d'acc&egrave;s de fichier local.
Arguments
siteRelativeURI
• L'argument obligatoire siteRelativeURI est une cha&icirc;ne contenant l'URI relative du site.
Valeurs renvoy&eacute;es
Cha&icirc;ne indiquant le chemin d'acc&egrave;s &agrave; un fichier local sur votre ordinateur local.
Exemple
L'exemple suivant
var filePath = siteRelativeToLocalPath(&quot;/myWebApp/myFile.xml&quot;);
renvoie &quot;C:\Inetpub\wwwroot\siteA\myFile.xml&quot;, en fonction de vos mappages de site et de l'adresse HTTP
sp&eacute;cifi&eacute;e dans la section Infos locales de la bo&icirc;te de dialogue D&eacute;finition du site.
dreamweaver.compareFiles()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction lance l'outil de comparaison de fichiers install&eacute; par l'utilisateur dans la section Diff de la bo&icirc;te de
dialogue Pr&eacute;f&eacute;rences.
Arguments
file1, file2
• L'argument obligatoire file1 est une cha&icirc;ne contenant le chemin d'acc&egrave;s complet au premier fichier &agrave; comparer.
• L'argument obligatoire file2 est une cha&icirc;ne contenant le chemin d'acc&egrave;s complet au second fichier &agrave; comparer.
Derni&egrave;re mise &agrave; jour le 22/6/2011
225
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant compare deux fichiers, red.htm et blue.htm :
dw.compareFiles(hc:\data\red.htm&quot;, &quot;e:\data\blue.htm&quot;);
dreamweaver.loadSitesFromPrefs()
Disponibilit&eacute;
Dreamweaver 4.
Description
Charge les informations du site pour tous les sites de la base de registres du syst&egrave;me (Windows) ou du fichier de
pr&eacute;f&eacute;rences Dreamweaver (Macintosh) dans Dreamweaver. Si un site est connect&eacute; &agrave; un serveur distant lorsque cette
fonction est appel&eacute;e, il est automatiquement d&eacute;connect&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.saveSitesToPrefs()
Disponibilit&eacute;
Dreamweaver 4.
Description
Enregistre toutes les informations pour chaque site que l'utilisateur a d&eacute;fini dans la base de registres du syst&egrave;me
(Windows) ou le fichier de pr&eacute;f&eacute;rences Dreamweaver (Macintosh).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.siteSyncDialog.compare()
Disponibilit&eacute;
Dreamweaver 8.
Derni&egrave;re mise &agrave; jour le 22/6/2011
226
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Description
Cette fonction ex&eacute;cute l'application de comparaison de fichiers sp&eacute;cifi&eacute;e dans la Cat&eacute;gorie de comparaison de fichiers
de la bo&icirc;te de dialogue Pr&eacute;f&eacute;rences pour comparer les fichiers s&eacute;lectionn&eacute;s sur les sites distants ou locaux.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.siteSyncDialog.canCompare() &raquo; &agrave; la page 526.
dreamweaver.siteSyncDialog.markDelete()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction bascule l'action des &eacute;l&eacute;ments s&eacute;lectionn&eacute;s sur Supprimer dans la bo&icirc;te de dialogue Synchronisation du site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.siteSyncDialog.canMarkDelete() &raquo; &agrave; la page 527.
dreamweaver.siteSyncDialog.markGet()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction bascule l'action des &eacute;l&eacute;ments s&eacute;lectionn&eacute;s sur Acqu&eacute;rir dans la bo&icirc;te de dialogue Synchronisation du site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.siteSyncDialog.canMarkGet() &raquo; &agrave; la page 527.
Derni&egrave;re mise &agrave; jour le 22/6/2011
227
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
dreamweaver.siteSyncDialog.markIgnore()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction bascule l'action des &eacute;l&eacute;ments s&eacute;lectionn&eacute;s sur Ignorer dans la bo&icirc;te de dialogue Synchronisation du site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.siteSyncDialog.canMarkIgnore() &raquo; &agrave; la page 527.
dreamweaver.siteSyncDialog.markPut()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction bascule l'action des &eacute;l&eacute;ments s&eacute;lectionn&eacute;s sur Placer dans la bo&icirc;te de dialogue Synchronisation du site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.siteSyncDialog.canMarkPut() &raquo; &agrave; la page 528.
dreamweaver.siteSyncDialog.markSynced()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction bascule l'action des &eacute;l&eacute;ments s&eacute;lectionn&eacute;s sur Synchroniser dans la bo&icirc;te de dialogue Synchronisation
du site.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
228
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.siteSyncDialog.canMarkSynced() &raquo; &agrave; la page 528.
dreamweaver.siteSyncDialog.toggleShowAllFiles()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction permet d'afficher les fichiers que Dreamweaver consid&egrave;re comme identiques sur les sites distants et
locaux dans la bo&icirc;te de dialogue d'aper&ccedil;u Synchroniser le site. Si la fonction est appel&eacute;e alors que la case &agrave; cocher
Afficher tous les fichiers est activ&eacute;e, elle la d&eacute;sactive ; inversement, si la case &agrave; cocher Afficher tous les fichiers est
d&eacute;sactiv&eacute;e, elle l'active.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
site.addLinkToExistingFile()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue S&eacute;lectionner fichier HTML pour permettre &agrave; l'utilisateur de s&eacute;lectionner un fichier, puis
cr&eacute;e un lien entre ce dernier et le document s&eacute;lectionn&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
site.changeLinkSitewide()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Modifier le lien au niveau du site.
Derni&egrave;re mise &agrave; jour le 22/6/2011
229
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
site.changeLink()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue S&eacute;lectionner fichier HTML pour permettre &agrave; l'utilisateur de s&eacute;lectionner le nouveau fichier
&agrave; associer au lien.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
site.checkIn()
Disponibilit&eacute;
Dreamweaver 3.
Description
Archive les fichiers s&eacute;lectionn&eacute;s et traite les fichiers d&eacute;pendants de l'une des fa&ccedil;ons suivantes :
• Si l'utilisateur a activ&eacute; l'option Invite lors de Placer/Archiver dans les pr&eacute;f&eacute;rences, cat&eacute;gorie FTP du site, la bo&icirc;te de
dialogue Fichiers d&eacute;pendants s'affiche.
• Si l'utilisateur a activ&eacute; l'option Ne plus afficher ce message dans la bo&icirc;te de dialogue Fichiers d&eacute;pendants, puis qu'il
a cliqu&eacute; sur Oui, les fichiers d&eacute;pendants sont t&eacute;l&eacute;charg&eacute;s et aucune bo&icirc;te de dialogue ne s'affiche.
• Si l'utilisateur a activ&eacute; l'option Ne plus afficher ce message dans la bo&icirc;te de dialogue Fichiers d&eacute;pendants, puis qu'il
a cliqu&eacute; sur Non, les fichiers d&eacute;pendants ne sont pas transmis et aucune bo&icirc;te de dialogue ne s'affiche.
Arguments
siteOrURL
• L'argument siteOrURL doit &ecirc;tre soit le mot cl&eacute; &quot;site&quot;, indiquant que la fonction doit agir sur l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;
dans le panneau Fichiers, soit l'URL d'un fichier.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
230
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Activateur
Voir &laquo; site.canCheckIn() &raquo; &agrave; la page 529.
site.checkLinks()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue V&eacute;rificateur de lien et v&eacute;rifie les liens dans les fichiers sp&eacute;cifi&eacute;s.
Arguments
scopeOfCheck.
• L'argument scopeOfCheck d&eacute;finit l'&eacute;tendue de la v&eacute;rification des liens. Il doit avoir pour valeur &quot;document&quot;,
&quot;selection&quot; ou &quot;site&quot;.
Valeurs renvoy&eacute;es
Aucune.
site.checkOut()
Disponibilit&eacute;
Dreamweaver 3.
Description
Extrait les fichiers s&eacute;lectionn&eacute;s et traite les fichiers d&eacute;pendants de l'une des fa&ccedil;ons suivantes :
• Si l'utilisateur a activ&eacute; l'option Invite lors de Acqu&eacute;rir/Extraire dans les pr&eacute;f&eacute;rences, cat&eacute;gorie FTP du site, la bo&icirc;te
de dialogue Fichiers d&eacute;pendants s'affiche.
• Si l'utilisateur a activ&eacute; l'option Ne plus afficher ce message dans la bo&icirc;te de dialogue Fichiers d&eacute;pendants, puis qu'il
a cliqu&eacute; sur Oui, les fichiers d&eacute;pendants sont t&eacute;l&eacute;charg&eacute;s et aucune bo&icirc;te de dialogue ne s'affiche.
• Si l'utilisateur a activ&eacute; l'option Ne plus afficher ce message dans la bo&icirc;te de dialogue Fichiers d&eacute;pendants, puis qu'il
a cliqu&eacute; sur Non, les fichiers d&eacute;pendants ne sont pas t&eacute;l&eacute;charg&eacute;s et aucune bo&icirc;te de dialogue ne s'affiche.
Arguments
siteOrURL
• L'argument siteOrURL doit &ecirc;tre soit le mot cl&eacute; &quot;site&quot;, indiquant que la fonction doit agir sur l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;
dans le panneau Fichiers, soit l'URL d'un fichier.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canCheckOut() &raquo; &agrave; la page 530.
Derni&egrave;re mise &agrave; jour le 22/6/2011
231
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
site.checkTargetBrowsers()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie le navigateur cible des documents s&eacute;lectionn&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
site.cloak()
Disponibilit&eacute;
Dreamweaver MX.
Description
Voile la s&eacute;lection en cours dans le panneau Fichiers ou le dossier sp&eacute;cifi&eacute;.
Arguments
siteOrURL
L'argument siteOrURL doit contenir l'une des deux valeurs suivantes :
• le mot-cl&eacute; &quot;site&quot;, qui indique si cloak() doit envelopper la s&eacute;lection dans le panneau Fichiers ;
• l'URL d'un dossier particulier, qui indique si cloak() doit envelopper le dossier sp&eacute;cifi&eacute; et tout son contenu.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canCloak() &raquo; &agrave; la page 530.
site.compareFiles()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction lance l'application d'int&eacute;gration d'outil Diff pour comparer deux fichiers.
Arguments
url
Derni&egrave;re mise &agrave; jour le 22/6/2011
232
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
L'argument obligatoire url doit contenir l'une des deux valeurs suivantes :
• le mot-cl&eacute; &quot;site&quot;, qui indique si compare() doit agir sur la s&eacute;lection dans le panneau Fichiers ;
• l'URL d'un fichier local &agrave; comparer avec sa version distante.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la comparaison a r&eacute;ussi, false dans le cas contraire.
Activateur
Voir &laquo; site.canCompareFiles() &raquo; &agrave; la page 531.
Exemple
L'exemple suivant compare les fichiers s&eacute;lectionn&eacute;s dans le panneau Fichiers avec leurs versions distantes :
site.compareFiles(&quot;site&quot;);
site.defineSites()
Disponibilit&eacute;
Dreamweaver 3.
Description
La fonction ouvre la bo&icirc;te de dialogue D&eacute;finition du site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
site.deleteSelection()
Disponibilit&eacute;
Dreamweaver 3.
Description
Supprime les fichiers s&eacute;lectionn&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
233
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
site.deployFilesToTestingServerBin()
Disponibilit&eacute;
Dreamweaver MX.
Description
Place le ou les fichiers sp&eacute;cifi&eacute;s dans le dossier bin du serveur d'&eacute;valuation. Si aucun param&egrave;tre relatif au d&eacute;ploiement
des fichiers de prise en charge n'est d&eacute;fini pour le site en cours, cette fonction lance la bo&icirc;te de dialogue D&eacute;ployer les
fichiers de prise en charge sur le serveur d'&eacute;valuation.
Arguments
filesToDeploy
• L'argument filesToDeploy correspond &agrave; un tableau de noms de fichiers que Dreamweaver d&eacute;ploiera.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le d&eacute;ploiement des fichiers a r&eacute;ussi et false dans le cas contraire.
Exemple
Cet exemple d&eacute;ploie les fichiers image1.jpg et script1.js dans le dossier bin du serveur d'&eacute;valuation :
site.deployFilesToTestingServerBin(&quot;image1.jpg&quot;, &quot;script1.js&quot;);
site.displaySyncInfoForFile()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Pr&eacute;sente une bo&icirc;te de dialogue contenant les heures d'&eacute;valuation, locales et distantes, du fichier correspondant au
param&egrave;tre transmis. Ces informations sont stock&eacute;es dans le fichier de synchronisation dwsync.xml.
La bo&icirc;te de dialogue affiche quatre heures diff&eacute;rentes :
• L'heure locale ordinateur distant, qui indique pour le fichier local, l'horodatage de la derni&egrave;re commande placer ou
acqu&eacute;rir sur le serveur distant.
• L'heure distante, qui indique pour le fichier situ&eacute; sur le serveur distant, l'horodatage de la derni&egrave;re commande
acqu&eacute;rir ou placer sur le serveur distant.
• L'heure locale ordinateur de test, qui indique pour le fichier local, l'horodatage de la derni&egrave;re commande placer ou
acqu&eacute;rir sur le serveur d'&eacute;valuation.
• L'heure de test, qui indique pour le fichier situ&eacute; sur le serveur d'&eacute;valuation, l'horodatage de la derni&egrave;re commande
acqu&eacute;rir ou placer sur le serveur d'&eacute;valuation.
Si le fichier dwsync.xml ne contient pas d'informations pour le fichier, un message s'affiche et indique qu'aucune
information n'est disponible. Si l'heure est d&eacute;finie dans le fichier XML, elle s'affiche au format date/heure
correspondant aux param&egrave;tres r&eacute;gionaux (par exemple, 24/6/05 14:43). Si l'heure n'est pas d&eacute;finie dans l'entr&eacute;e
correspondant au fichier, un tiret (-) est affich&eacute;.
Cette fonction agit sur le fichier s&eacute;lectionn&eacute; dans l'affichage local des fichiers, si 'site' est transmis, ou sur le fichier
correspondant &agrave; l'URL locale, si une URL est transmise.
Derni&egrave;re mise &agrave; jour le 22/6/2011
234
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Arguments
path, 'site'
• path est l'URL pointant vers un fichier local.
• 'site' indique que la fonction utilise le fichier s&eacute;lectionn&eacute; dans le panneau Fichiers.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canDisplaySyncInfoForFile() &raquo; &agrave; la page 531.
site.editColumns()
Description
Cette fonction affiche la bo&icirc;te de dialogue D&eacute;finition du site, qui contient la section Colonnes en mode Fichier.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
site.exportSite()
Disponibilit&eacute;
Dreamweaver MX, mis &agrave; jour dans Dreamweaver CS4.
Description
Exporte un site Dreamweaver dans un fichier XML, qui peut &ecirc;tre import&eacute; dans une autre instance de Dreamweaver
pour permettre la duplication du site.
Toutes les informations contenues dans la bo&icirc;te de dialogue D&eacute;finition du site sont enregistr&eacute;es dans un fichier XML
qui comprend la liste des dossiers voil&eacute;s et des informations sur le type de document par d&eacute;faut. La seule exception est
que l'utilisateur peut omettre le nom et le mot de passe de connexion lorsque l'acc&egrave;s FTP est d&eacute;fini.
Arguments
siteName, {askAboutLoginInfo}, {warnAboutSCS}, {savePath}
• L'argument siteName identifie le site &agrave; exporter. Si siteName est une cha&icirc;ne vide, Dreamweaver exporte le site en
cours.
• L'argument askAboutLoginInfo d&eacute;termine si une bo&icirc;te de dialogue demande &agrave; l'utilisateur s'il veut enregistrer ses
informations de connexion. Cet argument est facultatif.
• L'argument warnAboutSCS permet de d&eacute;terminer si l'utilisateur est ou non averti du non-enregistrement des
informations de connexion s'il acc&egrave;de &agrave; son site via le contr&ocirc;le de source. Cet argument est facultatif.
• L'argument savePath est le chemin local &agrave; un dossier (par exemple C:\sites\mySites\). Si vous fournissez une
valeur savePath, le fichier .ste est toujours enregistr&eacute; avec le nom du site. Cet argument est facultatif.
Derni&egrave;re mise &agrave; jour le 22/6/2011
235
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le site nomm&eacute; existe et si le fichier XML est correctement export&eacute;, et false dans le cas
contraire.
Exemple
L'exemple suivant pr&eacute;sente un fichier XML cr&eacute;&eacute; par Dreamweaver lors de l'exportation d'un site :
&lt;?xml version=&quot;1.0&quot; ?&gt;
&lt;site&gt;
&lt;localinfo
sitename=&quot;DW00&quot;
localroot=&quot;C:\Documents and Settings\jlondon\Desktop\DWServer\&quot;
imagefolder=&quot;C:\Documents and Settings\jlondon\Desktop\DWServer\Images\&quot;
spacerfilepath=&quot;&quot;
refreshlocal=&quot;TRUE&quot;
cache=&quot;FALSE&quot;
httpaddress=&quot;http://&quot; curserver=&quot;webserver&quot; /&gt;
&lt;remoteinfo
accesstype=&quot;ftp&quot;
host=&quot;dreamweaver&quot;
remoteroot=&quot;kojak/&quot;
user=&quot;dream&quot;
checkoutname=&quot;Jay&quot;
emailaddress=&quot;[email protected]&quot;
usefirewall=&quot;FALSE&quot;
usepasv=&quot;TRUE&quot;
enablecheckin=&quot;TRUE&quot;
checkoutwhenopen=&quot;TRUE&quot; /&gt;
&lt;designnotes
usedesignnotes=&quot;TRUE&quot;
sharedesignnotes=&quot;TRUE&quot; /&gt;
&lt;sitemap
homepage=&quot;C:\Documents and Settings\jlondon\Desktop\DWServer\Untitled-2.htm&quot;
pagesperrow=&quot;200&quot; columnwidth=&quot;125&quot; showdependentfiles=&quot;TRUE&quot;
showpagetitles=&quot;FALSE&quot; showhiddenfiles=&quot;TRUE&quot; /&gt;
&lt;fileviewcolumns sharecolumns=&quot;TRUE&quot;&gt;
&lt;column name=&quot;Local Folder&quot;
align=&quot;left&quot; show=&quot;TRUE&quot; share=&quot;FALSE&quot; builtin=&quot;TRUE&quot;
localwidth=&quot;180&quot; remotewidth=&quot;180&quot; /&gt;
&lt;column name=&quot;Notes&quot;
align=&quot;center&quot; show=&quot;TRUE&quot; share=&quot;FALSE&quot; builtin=&quot;TRUE&quot;
localwidth=&quot;36&quot; remotewidth=&quot;36&quot; /&gt;
&lt;column name=&quot;Size&quot;
align=&quot;right&quot; show=&quot;TRUE&quot; share=&quot;FALSE&quot; builtin=&quot;TRUE&quot;
localwidth=&quot;-2&quot; remotewidth=&quot;-2&quot; /&gt;
&lt;column name=&quot;Type&quot;
align=&quot;left&quot; show=&quot;TRUE&quot; share=&quot;FALSE&quot; builtin=&quot;TRUE&quot;
localwidth=&quot;60&quot; remotewidth=&quot;60&quot; /&gt;
&lt;column name=&quot;Modified&quot;
align=&quot;left&quot; show=&quot;TRUE&quot; share=&quot;FALSE&quot; builtin=&quot;TRUE&quot;
localwidth=&quot;102&quot; remotewidth=&quot;102&quot; /&gt;
&lt;column name=&quot;Checked Out By&quot;
align=&quot;left&quot; show=&quot;TRUE&quot; share=&quot;FALSE&quot; builtin=&quot;TRUE&quot;
localwidth=&quot;50&quot; remotewidth=&quot;50&quot; /&gt;
&lt;column name=&quot;Status&quot; note=&quot;status&quot;
align=&quot;left&quot; show=&quot;TRUE&quot; share=&quot;FALSE&quot; builtin=&quot;FALSE&quot;
Derni&egrave;re mise &agrave; jour le 22/6/2011
236
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
localwidth=&quot;50&quot; remotewidth=&quot;50&quot; /&gt;
&lt;/fileviewcolumns&gt;
&lt;appserverinfo
servermodel=&quot;ColdFusion&quot;
urlprefix=&quot;http://dreamweaver/kojak/&quot;
serverscripting=&quot;CFML&quot;
serverpageext=&quot;&quot;
connectionsmigrated=&quot;TRUE&quot;
useUD4andUD5pages=&quot;TRUE&quot;
defaultdoctype=&quot;&quot;
accesstype=&quot;ftp&quot;
host=&quot;dreamweaver&quot;
remoteroot=&quot;kojak/&quot;
user=&quot;dream&quot;
usefirewall=&quot;FALSE&quot;
usepasv=&quot;TRUE&quot; /&gt;
&lt;cloaking enabled=&quot;TRUE&quot; patterns=&quot;TRUE&quot;&gt;
&lt;cloakedfolder folder=&quot;databases/&quot; /&gt;
&lt;cloakedpattern pattern=&quot;.png&quot; /&gt;
&lt;cloakedpattern pattern=&quot;.jpg&quot; /&gt;
&lt;cloakedpattern pattern=&quot;.jpeg&quot; /&gt;
&lt;/cloaking&gt;
&lt;/site&gt;
site.get()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient les fichiers sp&eacute;cifi&eacute;s et traite les fichiers d&eacute;pendants comme suit :
• Si l'utilisateur a activ&eacute; l'option Invite lors de Acqu&eacute;rir/Extraire dans les pr&eacute;f&eacute;rences, cat&eacute;gorie FTP du site, la bo&icirc;te
de dialogue Fichiers d&eacute;pendants s'affiche.
• Si l'utilisateur a activ&eacute; l'option Ne plus afficher ce message dans la bo&icirc;te de dialogue Fichiers d&eacute;pendants, puis qu'il
a cliqu&eacute; sur Oui, les fichiers d&eacute;pendants sont t&eacute;l&eacute;charg&eacute;s et aucune bo&icirc;te de dialogue ne s'affiche.
• Si l'utilisateur a activ&eacute; l'option Ne plus afficher ce message dans la bo&icirc;te de dialogue Fichiers d&eacute;pendants, puis qu'il
a cliqu&eacute; sur Non, les fichiers d&eacute;pendants ne sont pas t&eacute;l&eacute;charg&eacute;s et aucune bo&icirc;te de dialogue ne s'affiche.
Arguments
siteOrURL
• L'argument siteOrURL doit &ecirc;tre soit le mot cl&eacute; &quot;site&quot;, indiquant que la fonction doit agir sur l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;
dans le panneau Fichiers, soit l'URL d'un fichier.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canGet() &raquo; &agrave; la page 532.
Derni&egrave;re mise &agrave; jour le 22/6/2011
237
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
site.getAppServerAccessType()
Disponibilit&eacute;
Dreamweaver MX.
Description
Renvoie la m&eacute;thode d'acc&egrave;s utilis&eacute;e pour tous les fichiers sur le serveur d'application du en cours. Le site en cours est
le site associ&eacute; au document actuellement activ&eacute;. Si aucun document n'est activ&eacute;, le site ouvert dans Dreamweaver est
utilis&eacute;.
Remarque : ColdFusion Component Explorer utilise cette fonction ; voir &laquo; site.getAppServerPathToFiles() &raquo; &agrave; la page 237
et &laquo; site.getLocalPathToFiles() &raquo; &agrave; la page 240.
Arguments
Aucun.
Valeurs renvoy&eacute;es
L'une des cha&icirc;nes suivantes :
•
&quot;none&quot;
•
&quot;local/network&quot;
•
&quot;ftp&quot;
•
&quot;source_control&quot;
site.getAppServerPathToFiles()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;termine le chemin d'acc&egrave;s aux fichiers distants sur le serveur d'application d&eacute;fini pour le site en cours. Le site en
cours est le site associ&eacute; au document actuellement activ&eacute;. Si aucun document n'est activ&eacute;, le site ouvert dans
Dreamweaver est utilis&eacute;.
Remarque : ColdFusion Component Explorer utilise cette fonction ; voir &laquo; site.getAppServerAccessType() &raquo; &agrave; la page 237
et &laquo; site.getLocalPathToFiles() &raquo; &agrave; la page 240.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Si le type d'acc&egrave;s au serveur d'application est local/network, cette fonction renvoie un chemin ; dans le cas contraire,
cette fonction renvoie une cha&icirc;ne vide.
Derni&egrave;re mise &agrave; jour le 22/6/2011
238
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
site.getAppURLPrefixForSite()
Disponibilit&eacute;
Dreamweaver MX.
Description
Renvoie la valeur du pr&eacute;fixe de l'URL qui est extraite de l'adresse HTTP d&eacute;finie dans la section Infos locales de la bo&icirc;te
de dialogue de d&eacute;finition du site. Il s'agit du chemin figurant apr&egrave;s http://nom_h&ocirc;te:num&eacute;ro_port/.
Arguments
{siteName}
L'argument siteName (facultatif) est le nom du site dont vous souhaitez obtenir le pr&eacute;fixe d'URL. Si vous n'indiquez
pas de site, la fonction obtient le pr&eacute;fixe d'URL du site en cours.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant le pr&eacute;fixe d'URL du site s&eacute;lectionn&eacute;.
Exemple
var sitePrefix = site.getAppURLPrefixForSite();
site.getCheckOutUser()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient les noms d'utilisateur et d'extraction associ&eacute;s au site en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant un nom d'utilisateur et un nom d'extraction, s'ils sont d&eacute;finis, ou une cha&icirc;ne vide si les fonctions
d'archivage et d'extraction sont d&eacute;sactiv&eacute;es.
Exemple
Un appel &agrave; la fonction site.getCheckOutUser() pourrait renvoyer &quot;denise (deniseLaptop)&quot;. Si aucun nom
d'extraction n'est sp&eacute;cifi&eacute;, seul le nom d'utilisateur est renvoy&eacute; (&quot;denise&quot;, par exemple).
site.getCheckOutUserForFile()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
239
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Description
Obtient le nom d'utilisateur et le nom d'extraction de l'utilisateur qui a extrait le fichier sp&eacute;cifi&eacute;.
Arguments
fileName
• L'argument fileName correspond au chemin d'acc&egrave;s au fichier interrog&eacute;, exprim&eacute; sous la forme d'une URL de type
file://.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le nom d'utilisateur et le nom d'extraction de l'utilisateur qui a extrait le fichier sp&eacute;cifi&eacute;, ou cha&icirc;ne
vide si le fichier n'a pas &eacute;t&eacute; extrait.
Exemple
Un appel &agrave; la fonction site.getCheckOutUserForFile(&quot;file://C:/sites/avocado8/index.html&quot;) pourrait
renvoyer &quot;denise (deniseLaptop)&quot;. Si aucun nom d'extraction n'est sp&eacute;cifi&eacute;, seul le nom d'utilisateur est renvoy&eacute;
(&quot;denise&quot;, par exemple).
site.getCloakingEnabled()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;termine si le voilage est activ&eacute; pour le site en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le voilage est activ&eacute; pour le site en cours et false dans le cas contraire.
site.getConnectionState()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient l'&eacute;tat de connexion en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si le site distant est connect&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
240
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Activateur
Voir &laquo; site.canConnect() &raquo; &agrave; la page 531.
site.getCurrentSite()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient le site en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient le nom du site en cours.
Exemple
Si plusieurs sites sont d&eacute;finis, un appel &agrave; la fonction site.getCurrentSite() renvoie celui qui est actuellement
affich&eacute; dans la liste des sites en cours du panneau Fichiers.
site.getFocus()
Disponibilit&eacute;
Dreamweaver 3, mise &agrave; jour dans CS4.
Description
D&eacute;termine quel volet du panneau Fichiers est activ&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
L'une des cha&icirc;nes suivantes, locales ou distantes.
site.getLocalPathToFiles()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;termine le chemin d'acc&egrave;s aux fichiers locaux d&eacute;finis pour le site en cours. Le site en cours est le site associ&eacute; au
document actuellement activ&eacute;. Si aucun document n'est activ&eacute;, le site ouvert dans Dreamweaver est utilis&eacute;.
Remarque : ColdFusion Component Explorer utilise cette fonction ; voir &laquo; site.getAppServerAccessType() &raquo; &agrave; la page 237
et &laquo; site.getAppServerPathToFiles() &raquo; &agrave; la page 237.
Derni&egrave;re mise &agrave; jour le 22/6/2011
241
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Arguments
Aucun.
Valeurs renvoy&eacute;es
Chemin d'acc&egrave;s aux fichiers qui r&eacute;sident sur l'ordinateur local pour le site en cours.
site.getLocalRootURL()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Obtient le dossier racine local du site.
Arguments
siteName
• L'argument siteName est une cha&icirc;ne qui sp&eacute;cifie le nom du site.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le dossier racine local du site nomm&eacute;, exprim&eacute; sous la forme d'une URL file://. La cha&icirc;ne est vide
lorsque le fichier sp&eacute;cifi&eacute; n'existe pas.
site.getSelection()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine quels sont les fichiers actuellement s&eacute;lectionn&eacute;s dans le panneau Fichiers.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes repr&eacute;sentant les chemins d'acc&egrave;s aux fichiers et dossiers s&eacute;lectionn&eacute;s, exprim&eacute; sous la forme d'une
URL de type file://, ou d'un tableau vide si aucun fichier ni dossier n'est s&eacute;lectionn&eacute;.
site.getSiteForURL()
Disponibilit&eacute;
Dreamweaver MX.
Description
Obtient le nom du site, s'il en a un, associ&eacute; &agrave; un fichier donn&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
242
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Arguments
fileURL
• L'argument fileURL est l'URL compl&egrave;te (y compris la cha&icirc;ne &quot;file://&quot;) d'un fichier nomm&eacute;.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient le nom du site, s'il en a un, dans lequel r&eacute;side le fichier sp&eacute;cifi&eacute;. La cha&icirc;ne est vide lorsque le fichier
sp&eacute;cifi&eacute; n'existe dans aucun site d&eacute;fini.
site.getSites()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient la liste des sites d&eacute;finis.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes repr&eacute;sentant les noms des sites d&eacute;finis, ou tableau vide si aucun site n'est d&eacute;fini.
site.getSiteRootForURL()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Obtient le dossier racine local du site associ&eacute; &agrave; une URL de fichier sp&eacute;cifique.
Arguments
fileURL
• L'argument fileURL est une cha&icirc;ne contenant l'URL compl&egrave;te (y compris la cha&icirc;ne file://) d'un fichier nomm&eacute;.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le dossier racine local du site, exprim&eacute; sous la forme d'une URL file://, o&ugrave; le fichier sp&eacute;cifi&eacute; existe.
La cha&icirc;ne est vide lorsque le fichier sp&eacute;cifi&eacute; n'existe dans aucun site d&eacute;fini.
Exemple
var dom = dw.getDocumentDOM();
var siteRoot = site.getSiteRootForURL(dom.URL);
Derni&egrave;re mise &agrave; jour le 22/6/2011
243
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
site.getSiteURLPrefix()
Disponibilit&eacute;
Dreamweaver 8.
Description
Obtient le pr&eacute;fixe de l'URL qui est extrait de l'adresse HTTP d&eacute;finie dans la section Infos locales.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le pr&eacute;fixe de l'URL du site.
Exemple
sitePrefix = getSiteURLPrefix();
site.importSite()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cr&eacute;e un site Dreamweaver &agrave; partir d'un fichier XML. Dreamweaver emploie l'attribut localroot de l'&eacute;l&eacute;ment
&lt;localinfo&gt; pour identifier le dossier racine local du site. Pendant l'importation, si ce dossier n'existe pas sur
l'ordinateur local, Dreamweaver demande un dossier racine local diff&eacute;rent. Dreamweaver se comporte de la m&ecirc;me
fa&ccedil;on lorsqu'il tente de trouver le dossier images par d&eacute;faut, sp&eacute;cifi&eacute; par l'attribut imagefolder de l'&eacute;l&eacute;ment
&lt;localinfo&gt;.
Arguments
pathToSteFile
• L'argument pathToSteFile est une cha&icirc;ne qui contient l'URL du fichier STE. Dreamweaver utilise ce fichier pour
cr&eacute;er un site. Si pathToSteFile est une cha&icirc;ne vide, Dreamweaver invite l'utilisateur &agrave; choisir un fichier STE &agrave;
importer.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le fichier STE nomm&eacute; existe et si la cr&eacute;ation du site r&eacute;ussit et false dans le cas contraire.
site.isCloaked()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;termine si la s&eacute;lection en cours dans le panneau Fichiers ou le dossier sp&eacute;cifi&eacute; est voil&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
244
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Arguments
siteOrURL
• L'argument siteOrURL doit contenir l'une des deux valeurs suivantes :
• le mot cl&eacute; &quot;site&quot;, qui indique que la fonction isCloaked() doit tester la s&eacute;lection dans le panneau Fichiers ;
• l'URL de fichier d'un dossier particulier, qui indique si isCloaked() doit tester le dossier sp&eacute;cifi&eacute;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si l'objet indiqu&eacute; est voil&eacute;, false dans le cas contraire.
site.locateInSite()
Disponibilit&eacute;
Dreamweaver 3.
Description
Recherche le ou les fichiers indiqu&eacute;s dans le volet sp&eacute;cifi&eacute; du panneau Fichiers et s&eacute;lectionne les fichiers.
Arguments
localOrRemote, siteOrURL.
• L'argument localOrRemote doit avoir la valeur &quot;local&quot; ou &quot;remote&quot;.
• L'argument siteOrURL doit &ecirc;tre soit le mot cl&eacute; &quot;site&quot;, indiquant que la fonction doit agir sur l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;
dans le panneau Fichiers, soit l'URL d'un fichier.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canLocateInSite() &raquo; &agrave; la page 532.
site.makeEditable()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;sactive le drapeau de lecture seule sur les fichiers s&eacute;lectionn&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
245
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Activateur
Voir &laquo; site.canMakeEditable() &raquo; &agrave; la page 533.
site.makeNewDreamweaverFile()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cr&eacute;e un nouveau fichier Dreamweaver dans le panneau Fichiers (dans le m&ecirc;me dossier que le premier fichier ou
dossier s&eacute;lectionn&eacute;).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canMakeNewFileOrFolder() &raquo; &agrave; la page 533.
site.makeNewFolder()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cr&eacute;e un nouveau dossier dans le panneau Fichiers (dans le m&ecirc;me dossier que le premier fichier ou dossier s&eacute;lectionn&eacute;).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canMakeNewFileOrFolder() &raquo; &agrave; la page 533.
site.newSite()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue D&eacute;finition du site pour d&eacute;finir un nouveau site.
Derni&egrave;re mise &agrave; jour le 22/6/2011
246
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
site.open()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre les fichiers actuellement s&eacute;lectionn&eacute;s dans le panneau Fichiers. Si des dossiers sont s&eacute;lectionn&eacute;s, ils sont
d&eacute;velopp&eacute;s dans l'affichage Fichiers du site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canOpen() &raquo; &agrave; la page 533.
site.put()
Disponibilit&eacute;
Dreamweaver 3.
Description
Place les fichiers sp&eacute;cifi&eacute;s et traite les fichiers d&eacute;pendants comme suit :
• Si l'utilisateur a activ&eacute; l'option Invite lors de Placer/Archiver dans les pr&eacute;f&eacute;rences, cat&eacute;gorie FTP du site, la bo&icirc;te de
dialogue Fichiers d&eacute;pendants s'affiche.
• Si l'utilisateur a activ&eacute; l'option Ne plus afficher ce message dans la bo&icirc;te de dialogue Fichiers d&eacute;pendants, puis qu'il
a cliqu&eacute; sur Oui, les fichiers d&eacute;pendants sont t&eacute;l&eacute;charg&eacute;s et aucune bo&icirc;te de dialogue ne s'affiche.
• Si l'utilisateur a activ&eacute; l'option Ne plus afficher ce message dans la bo&icirc;te de dialogue Fichiers d&eacute;pendants, puis qu'il
a cliqu&eacute; sur Non, les fichiers d&eacute;pendants ne sont pas transmis et aucune bo&icirc;te de dialogue ne s'affiche.
Arguments
siteOrURL
• L'argument siteOrURL doit &ecirc;tre soit le mot cl&eacute; &quot;site&quot;, indiquant que la fonction doit agir sur l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;
dans le panneau Fichiers, soit l'URL d'un fichier.
Derni&egrave;re mise &agrave; jour le 22/6/2011
247
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canPut() &raquo; &agrave; la page 534.
site.recreateCache()
Disponibilit&eacute;
Dreamweaver 3.
Description
Recr&eacute;e le cache du site en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canRecreateCache() &raquo; &agrave; la page 534.
site.refresh()
Disponibilit&eacute;
Dreamweaver 3, mise &agrave; jour dans CS4.
Description
Actualise la liste des fichiers sur le c&ocirc;t&eacute; sp&eacute;cifi&eacute; du panneau Fichiers.
Arguments
whichSide
• L'argument whichSide doit avoir pour valeur local ou remote.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canRefresh() &raquo; &agrave; la page 535.
site.remoteIsValid()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
248
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Description
D&eacute;termine si le site distant est valide.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne qui indique si un site distant a &eacute;t&eacute; d&eacute;fini et, dans le cas o&ugrave; le type de serveur est Local/R&eacute;seau, si le
lecteur est mont&eacute;.
site.renameSelection()
Disponibilit&eacute;
Dreamweaver 3.
Description
Transforme le nom du fichier s&eacute;lectionn&eacute; en champ de texte et permet &agrave; l'utilisateur de renommer le fichier. Si
plusieurs fichiers sont s&eacute;lectionn&eacute;s, cette fonction agit sur le dernier.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
site.selectAll()
Disponibilit&eacute;
Dreamweaver 3, mise &agrave; jour dans CS4.
Description
S&eacute;lectionne tous les fichiers dans la vue active.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
site.selectNewer()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
249
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Description
S&eacute;lectionne tous les fichiers les plus r&eacute;cents sur le c&ocirc;t&eacute; sp&eacute;cifi&eacute; du panneau Fichiers.
Arguments
whichSide.
• L'argument whichSide doit avoir pour valeur &quot;local&quot; ou &quot;remote&quot;.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canSelectNewer() &raquo; &agrave; la page 535.
site.serverActivity()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;termine si Dreamweaver est en train d'interagir avec un serveur. Dreamweaver ne peut effectuer
qu'une seule activit&eacute; de serveur &agrave; la fois, cette fonction vous permet donc de d&eacute;terminer s'il faut d&eacute;sactiver la
fonctionnalit&eacute; exigeant une interaction du serveur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si Dreamweaver est en train d'interagir avec un serveur.
Exemple
L'exemple suivant, extrait du fichier menus.xml, affiche un &eacute;l&eacute;ment de menu s'il n'y a pas d'activit&eacute; du serveur (et si un
site est actuellement sp&eacute;cifi&eacute; dans Dreamweaver) :
&lt;menuitem name=&quot;Remove Connection Scripts&quot; enabled=&quot;!site.serverActivity() &amp;&amp;
site.getCurrentSite() != ''&quot; command=&quot;alert(MMDB.removeConnectionScripts())&quot;
id=&quot;SiteOptionsSiteMenu_RemoveConnectionScripts&quot; /&gt;
site.setCloakingEnabled()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;termine s'il est n&eacute;cessaire d'activer le voilage pour le site en cours.
Derni&egrave;re mise &agrave; jour le 22/6/2011
250
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Arguments
enable
• L'argument enable est une valeur bool&eacute;enne qui indique s'il est n&eacute;cessaire d'activer le voilage. Une valeur true
active le voilage pour le site en cours ; une valeur false d&eacute;sactive le voilage pour le site en cours.
Valeurs renvoy&eacute;es
Aucun.
site.setConnectionState()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;finit l'&eacute;tat de connexion du site en cours.
Arguments
bConnected.
• L'argument bConnected est une valeur bool&eacute;enne qui indique s'il existe une connexion (true) ou non (false) au
site en cours.
Valeurs renvoy&eacute;es
Aucune.
site.setCurrentSite()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre le site sp&eacute;cifi&eacute; dans le volet local du panneau Fichiers.
Arguments
whichSite
• L'argument whichSite est le nom d'un site d&eacute;fini (tel qu'il appara&icirc;t dans la liste des sites en cours, dans le panneau
Fichiers ou dans la bo&icirc;te de dialogue D&eacute;finition du site).
Valeurs renvoy&eacute;es
Aucune.
Exemple
Si trois sites sont d&eacute;finis (avocado8, dreamcentral et testsite, par exemple), un appel &agrave; la fonction
site.setCurrentSite(&quot;dreamcentral&quot;) fait de dreamcentral le site en cours.
Derni&egrave;re mise &agrave; jour le 22/6/2011
251
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
site.setFocus()
Disponibilit&eacute;
Dreamweaver 3, mise &agrave; jour dans CS4.
Description
Active le volet sp&eacute;cifi&eacute; du panneau Fichiers. Si le volet sp&eacute;cifi&eacute; n'est pas affich&eacute;, la fonction l'affiche et l'active.
Arguments
whichPane, nextTextView
• L'argument whichPane doit correspondre &agrave; l'une des cha&icirc;nes suivantes : local ou remote.
• L'argument nextTextView alterne les modes actifs en mode d'affichage fractionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
site.setSelection()
Disponibilit&eacute;
Dreamweaver 3.
Description
S&eacute;lectionne les fichiers ou les dossiers visibles dans le volet actif du panneau Fichiers.
Arguments
arrayOfURLs
• L'argument arrayOfURLs est un tableau de cha&icirc;nes correspondant aux chemins d'acc&egrave;s aux fichiers et aux dossiers
du site s&eacute;lectionn&eacute;, exprim&eacute;s sous la forme d'une URL de type file://.
Remarque : Pour les chemins de dossier, ne tapez pas la barre oblique (/) &agrave; la fin du chemin.
Valeurs renvoy&eacute;es
Aucune.
site.siteRelativeToLocalPath()
Disponibilit&eacute;
Dreamweaver 8.
Description
Convertit une r&eacute;f&eacute;rence d'URI relative de site en un chemin d'acc&egrave;s de fichier local.
Arguments
siteRelativeURI
• L'argument obligatoire siteRelativeURI est une cha&icirc;ne contenant l'URI relative du site.
Derni&egrave;re mise &agrave; jour le 22/6/2011
252
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Valeurs renvoy&eacute;es
Cha&icirc;ne indiquant le chemin d'acc&egrave;s &agrave; un fichier local sur votre ordinateur local.
Exemple
L'exemple suivant
var filePath = site.siteRelativeToLocalPath(&quot;/myWebApp/myFile.xlml&quot;);
renvoie &quot;C:\Inetpub\wwwroot\siteA\myFile.xml&quot;, en fonction de vos mappages de site et de l'adresse HTTP sp&eacute;cifi&eacute;e
dans la section Infos locales de la bo&icirc;te de dialogue D&eacute;finition du site.
site.synchronize()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Synchroniser les fichiers.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canSynchronize() &raquo; &agrave; la page 536.
site.uncloak()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;voile la s&eacute;lection en cours dans le panneau Fichiers ou le dossier sp&eacute;cifi&eacute;.
Arguments
siteOrURL
• L'argument siteOrURL doit contenir l'une des valeurs suivantes :
• le mot cl&eacute; &quot;site&quot;, qui indique que la fonction unCloak() doit agir sur la s&eacute;lection dans le panneau Fichiers ;
• l'URL d'un dossier particulier, qui indique que la fonction unCloak() doit agir sur le dossier sp&eacute;cifi&eacute; et tout son
contenu.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
253
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Site
Activateur
Voir &laquo; site.canUncloak() &raquo; &agrave; la page 536.
site.uncloakAll()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;voile tous les dossiers dans le site s&eacute;lectionn&eacute; et d&eacute;sactive la case &agrave; cocher Voiler les fichiers se terminant avec : dans
les Param&egrave;tres de voilage.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canUncloak() &raquo; &agrave; la page 536.
site.undoCheckOut()
Disponibilit&eacute;
Dreamweaver 3.
Description
Retire des sites locaux et distants les fichiers verrouill&eacute;s associ&eacute;s aux fichiers s&eacute;lectionn&eacute;s et remplace leur copie locale
par la copie distante.
Arguments
siteOrURL
• L'argument siteOrURL doit &ecirc;tre soit le mot cl&eacute; &quot;site&quot;, indiquant que la fonction doit agir sur l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;
dans le panneau Fichiers, soit l'URL d'un fichier.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; site.canUndoCheckOut() &raquo; &agrave; la page 536.
Derni&egrave;re mise &agrave; jour le 22/6/2011
254
Chapitre 14 : Document
Les fonctions Document d'Adobe&reg; Dreamweaver&reg; permettent d'effectuer des op&eacute;rations dans le document modifi&eacute; par
l'utilisateur. Les fonctions de document permettent d'effectuer les op&eacute;rations suivantes :
• Conversion de tableaux en calques
• Ex&eacute;cution d'une commande dans le dossier Configuration/Commands
• Recherche d'une URL de fichier
• Conversion d'une URL relative en URL absolue
• Obtention du nœud s&eacute;lectionn&eacute;
• R&eacute;alisation d'un codage d'URL sur une cha&icirc;ne
• Ex&eacute;cution d'un traducteur sur le document
Fonctions relatives aux conversions
Ces fonctions permettent de convertir des tableaux en calques, des calques en tableaux et des feuilles de style en cascade
(CSS) en balises HTML. Chacune de ces fonctions se comporte exactement comme une commande de conversion du
menu Fichier ou Modifier.
dom.convertLayersToTable()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Convertir les calques en tableau.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canConvertLayersToTable() &raquo; &agrave; la page 503.
dom.convertTablesToLayers()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
255
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Description
Ouvre la bo&icirc;te de dialogue Convertir les tableaux en calques.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canConvertTablesToLayers() &raquo; &agrave; la page 503.
Fonctions relatives aux commandes
Ces fonctions permettent de tirer parti des fichiers figurant dans le dossier Configuration/Commands. Elles
permettent de g&eacute;rer le menu Commandes et d'appeler des commandes &agrave; partir d'autres types de fichiers d'extension.
dreamweaver.editCommandList()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Modifier la liste de commandes.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.runCommand()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ex&eacute;cute la commande sp&eacute;cifi&eacute;e ; cette fonction &eacute;quivaut &agrave; choisir la commande dans un menu. Si une bo&icirc;te de dialogue
est associ&eacute;e &agrave; la commande, elle appara&icirc;t et le script de la commande bloque les autres modifications jusqu'&agrave; ce que
l'utilisateur ferme la bo&icirc;te de dialogue. Cette fonction permet d'appeler une commande &agrave; partir d'un autre fichier
d'extension.
Remarque : Cette fonction peut &ecirc;tre appel&eacute;e &agrave; partir de la fonction objectTag(), d'un script de fichier de commande ou
du fichier d'inspecteur Propri&eacute;t&eacute;s.
Derni&egrave;re mise &agrave; jour le 22/6/2011
256
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Arguments
commandFile, {commandArg1}, {commandArg2},...{commandArgN}
• L'argument commandFile est un nom de fichier dans le dossier Configuration/Commands.
• Les autres arguments (commandArg1, commandArg2, etc.) sont facultatifs. Ils sont transmis &agrave; la fonction
receiveArguments() dans l'argument commandFile.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Vous pouvez cr&eacute;er un inspecteur Propri&eacute;t&eacute;s personnalis&eacute; pour les tableaux. Il permettra &agrave; l'utilisateur d'acc&eacute;der &agrave; la
commande Formater le tableau &agrave; l'aide d'un bouton de l'inspecteur. Pour ce faire, appelez la fonction suivante &agrave; partir
du gestionnaire d'&eacute;v&eacute;nements onClick de ce bouton :
function callFormatTable(){
dreamweaver.runCommand('Format Table.htm');
}
Fonctions relatives aux manipulations de fichiers
Ces fonctions permettent de cr&eacute;er, d'ouvrir et d'enregistrer des documents (y compris XML et XHTML), de convertir
des documents HTML existants en XHTML et d'exporter des styles CSS vers des fichiers externes. Elles permettent
&eacute;galement de rechercher des fichiers ou des dossiers, de cr&eacute;er des fichiers &agrave; partir de mod&egrave;les, de fermer des documents
et d'obtenir la liste des fichiers r&eacute;cemment ouverts.
dom.cleanupXHTML()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction est similaire &agrave; la fonction convertToXHTML(), &agrave; ceci pr&egrave;s que celle-ci nettoie un document XHTML
existant. Cette fonction peut &ecirc;tre ex&eacute;cut&eacute;e sur une s&eacute;lection &agrave; l'int&eacute;rieur du document. Vous pouvez utiliser la fonction
cleanupXHTML() pour nettoyer la syntaxe dans l'ensemble d'un document XHTML ou dans la s&eacute;lection en cours &agrave;
l'int&eacute;rieur du document.
Arguments
bWholeDoc
• L'argument bWholeDoc contient une valeur bool&eacute;enne. Si la valeur est true, la fonction cleanupXHTML() nettoie
l'ensemble du document ; dans le cas contraire, elle nettoie uniquement la s&eacute;lection.
Valeurs renvoy&eacute;es
Un tableau de six nombres entiers qui quantifient le nombre d'&eacute;l&eacute;ments suivants :
• erreurs XHTML r&eacute;par&eacute;es par Dreamweaver
• les &eacute;l&eacute;ments map ne disposant pas d'un attribut id et ne pouvant pas &ecirc;tre r&eacute;solus ;
Derni&egrave;re mise &agrave; jour le 22/6/2011
257
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
• les &eacute;l&eacute;ments script ne disposant pas d'un attribut type et ne pouvant pas &ecirc;tre r&eacute;solus ;
• les &eacute;l&eacute;ments style ne disposant pas d'un attribut type et ne pouvant pas &ecirc;tre r&eacute;solus ;
• les &eacute;l&eacute;ments img ne disposant pas d'un attribut alt et ne pouvant pas &ecirc;tre r&eacute;solus ;
• les &eacute;l&eacute;ments area ne disposant pas d'un attribut alt et ne pouvant pas &ecirc;tre r&eacute;solus.
dom.convertToXHTML()
Disponibilit&eacute;
Dreamweaver MX.
Description
Analyse le code HTML dans une arborescence DOM, ins&egrave;re les &eacute;l&eacute;ments manquants qui sont obligatoires pour
XHTML, nettoie l'arborescence puis &eacute;crit celle-ci au format XHTML. Les directives, d&eacute;clarations, &eacute;l&eacute;ments et attributs
manquants que la fonction convertToXHTML() ajoute &agrave; l'arborescence DOM si n&eacute;cessaire, incluent les &eacute;l&eacute;ments
suivants :
• Une directive XML
• Une d&eacute;claration doctype
• L'attribut xmlns dans l'&eacute;l&eacute;ment html
• Une section head
• Un &eacute;l&eacute;ment title
• Une section body
Pendant la conversion, la fonction dom.convertToXHTML() convertit les balises et les attributs HTML purs en
minuscules, &eacute;crit des balises et des attributs HTML &agrave; l'aide d'une syntaxe XHTML correcte et ajoute des attributs
HTML manquants o&ugrave; cela est possible. Cette fonction traite les balises et les attributs tiers en fonction des param&egrave;tres
de la bo&icirc;te de dialogue Pr&eacute;f&eacute;rences.
Si le document est un mod&egrave;le, la fonction dom.convertToXHTML() alerte l'utilisateur mais n'effectue pas la
conversion.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Un tableau de six nombres entiers qui quantifient le nombre d'&eacute;l&eacute;ments suivants :
• erreurs XHTML r&eacute;par&eacute;es par Dreamweaver
• les &eacute;l&eacute;ments map ne disposant pas d'un attribut id et ne pouvant pas &ecirc;tre r&eacute;solus ;
• les &eacute;l&eacute;ments script ne disposant pas d'un attribut type et ne pouvant pas &ecirc;tre r&eacute;solus ;
• les &eacute;l&eacute;ments style ne disposant pas d'un attribut type et ne pouvant pas &ecirc;tre r&eacute;solus ;
• les &eacute;l&eacute;ments img ne disposant pas d'un attribut alt et ne pouvant pas &ecirc;tre r&eacute;solus ;
• les &eacute;l&eacute;ments area ne disposant pas d'un attribut alt et ne pouvant pas &ecirc;tre r&eacute;solus.
Derni&egrave;re mise &agrave; jour le 22/6/2011
258
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Exemple
Dans le cadre d'une utilisation normale, une extension appelle d'abord la fonction dreamweaver.openDocument() ou
dreamweaver.getDocumentDOM() pour obtenir une r&eacute;f&eacute;rence au document. L'extension appelle ensuite la fonction
dom.getIsXHTMLDocument() pour d&eacute;terminer si le document est d&eacute;j&agrave; au format XHTML. Si ce n'est pas le cas, l'extension
appelle la fonction dom.convertToXHTML() pour convertir le document au format XHTML. Ensuite, l'extension appelle
la fonction dreamweaver.saveDocument() pour enregistrer le fichier converti sous un nouveau nom.
dom.getIsXHTMLDocument()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie un document (en particulier la d&eacute;claration &lt;!DOCTYPE&gt;) pour savoir si celui-ci est au format XHTML.
Arguments
Aucun.
Valeurs renvoy&eacute;es
true si le document est au format XHTML, false dans le cas contraire.
dreamweaver.browseForFileURL()
Disponibilit&eacute;
Dreamweaver 1, am&eacute;lior&eacute;e dans les versions 2, 3 et 4.
Description
Ouvre le type de bo&icirc;te de dialogue sp&eacute;cifi&eacute; ayant le libell&eacute; sp&eacute;cifi&eacute; dans la barre de titre.
Arguments
openSelectOrSave, {titleBarLabel}, {bShowPreviewPane}, {bSupressSiteRootWarnings},
{arrayOfExtensions}, {startFolder}, {allowDynamic}, {fileToLocate}
• L'argument openSelectOrSave indique le type de bo&icirc;te de dialogue : open, select ou save.
• L'argument titleBarLabel, ajout&eacute; &agrave; Dreamweaver 2, est le libell&eacute; qui doit figurer dans la barre de titre de la bo&icirc;te
de dialogue. Si cet argument n'est pas d&eacute;fini, Dreamweaver utilise par d&eacute;faut le libell&eacute; fourni par le syst&egrave;me
d'exploitation.
• L'argument bShowPreviewPane, ajout&eacute; &agrave; Dreamweaver 2, est une valeur bool&eacute;enne indiquant si le volet d'aper&ccedil;u
de l'image doit &ecirc;tre affich&eacute; dans la bo&icirc;te de dialogue. Si la valeur de cet argument est true, la bo&icirc;te de dialogue filtre
les fichiers d'image ; si elle est omise, l'argument prend par d&eacute;faut la valeur false.
• L'argument bSupressSiteRootWarnings, ajout&eacute; &agrave; Dreamweaver 3, est une valeur bool&eacute;enne indiquant s'il faut
supprimer les avertissements signalant que le fichier s&eacute;lectionn&eacute; se trouve hors du dossier racine du site. Si cet
argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Derni&egrave;re mise &agrave; jour le 22/6/2011
259
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
• L'argument arrayOfExtensions (ajout&eacute; dans Dreamweaver 4) est un tableau de cha&icirc;nes. Il d&eacute;finit le contenu par
d&eacute;faut de la liste Types de fichiers qui s'affiche dans le bas de la bo&icirc;te de dialogue. La syntaxe de cet argument est
menuEntryText|.xxx[;.yyy;.zzz]|CCCC|, o&ugrave; :
•
menuEntryText est le nom du type de fichier.
• Vous pouvez d&eacute;finir les extensions sous la forme .xxx[;.yyy;.zzz] ou CCCC :
•
.xxx sp&eacute;cifie l'extension de nom de fichier pour le type de fichier. .yyy et .zzz permettent de sp&eacute;cifier
plusieurs extensions de nom de fichier.
•
CCCC est la constante de type de fichiers &agrave; quatre caract&egrave;res pour Macintosh.
L'exemple suivant fournit deux filtres dans votre bo&icirc;te de dialogue de s&eacute;lection, l'un pour les fichiers MP3 et l'autre
pour tous les fichiers :
dw.browseForFileURL(&quot;select&quot;, &quot;Please select an mp3&quot;,false, true, new Array(&quot;mp3 Files
(*.MP3)|*.mp3||&quot;,&quot;All Files (*.*)|*.*||&quot;));
• L'argument startfolder est une valeur de cha&icirc;ne qui permet de sp&eacute;cifier l'URL de fichier du dossier dans lequel
la recherche d&eacute;bute. Si cet argument n'est pas sp&eacute;cifi&eacute;, la recherche d&eacute;bute &agrave; partir du dernier r&eacute;pertoire utilis&eacute;. Cet
argument est facultatif.
• L'argument allowdynamic est une valeur bool&eacute;enne qui indique si les URL et les param&egrave;tres dynamiques sont
autoris&eacute;s ou non. Si cet argument a la valeur true, les URL et les param&egrave;tres dynamiques sont autoris&eacute;s. Cet
argument est facultatif.
• L'argument fileToLocate est une valeur de cha&icirc;ne qui sert &agrave; sp&eacute;cifier l'URL du fichier que vous voulez trouver.
Cet argument est facultatif.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant le nom du fichier, exprim&eacute; sous la forme d'une URL de type file://.
dreamweaver.browseForFolderURL()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Choisir un dossier ayant le libell&eacute; sp&eacute;cifi&eacute; dans la barre de titre.
Arguments
{titleBarLabel}, {directoryToStartIn}
• L'argument titleBarLabel est le libell&eacute; qui doit s'afficher dans la barre de titre de la bo&icirc;te de dialogue. S'il n'est pas
sp&eacute;cifi&eacute;, l'argument titleBarLabel prend par d&eacute;faut la valeur Choose folder (Choisir un dossier).
• L'argument directoryToStartIn est le chemin indiquant o&ugrave; le dossier doit s'ouvrir, exprim&eacute; sous la forme d'une URL
de type file://.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant le nom du dossier, exprim&eacute; sous la forme d'une URL de type file://.
Exemple
Le code suivant renvoie l'URL d'un dossier :
Derni&egrave;re mise &agrave; jour le 22/6/2011
260
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
return dreamweaver.browseForFolderURL('Select a Folder', &not;
dreamweaver.getSiteRoot());
dreamweaver.closeDocument()
Disponibilit&eacute;
Dreamweaver 2.
Description
Ferme le document sp&eacute;cifi&eacute;.
Arguments
documentObject.
• L'argument documentObject correspond &agrave; l'objet situ&eacute; &agrave; la racine de l'arborescence DOM d'un document (c'est-&agrave;dire la valeur renvoy&eacute;e par la fonction dreamweaver.getDocumentDOM()). Si l'argument documentObject fait
r&eacute;f&eacute;rence au document actif, il se peut que la fen&ecirc;tre du document ne se ferme pas tant que l'ex&eacute;cution du script qui
appelle cette fonction n'est pas termin&eacute;e.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.createDocument()
Disponibilit&eacute;
Dreamweaver 2, am&eacute;lior&eacute;e dans Dreamweaver 4.
Description
En fonction de l'argument utilis&eacute;, cette fonction ouvre un nouveau document soit dans la m&ecirc;me fen&ecirc;tre, soit dans une
nouvelle fen&ecirc;tre. Le nouveau document devient le document actif.
Remarque : Cette fonction peut &ecirc;tre appel&eacute;e uniquement &agrave; partir du fichier menus.xml, d'un fichier de commande ou
depuis le fichier de l'inspecteur Propri&eacute;t&eacute;s. Si une action ou un objet tente d'appeler cette fonction, Dreamweaver affiche
un message d'erreur.
Arguments
{bOpenInSameWindow}, {type}
• L'argument bOpenInSameWindow est une valeur bool&eacute;enne indiquant si le nouveau document doit s'ouvrir dans
la fen&ecirc;tre en cours. Si l'argument bOpenInSameWindow a pour valeur false, qu'il n'est pas pr&eacute;cis&eacute; ou que la
fonction est appel&eacute;e sur Macintosh, le nouveau document s'ouvre dans une nouvelle fen&ecirc;tre.
• L'argument type indique le type de document &agrave; cr&eacute;er, conform&eacute;ment &agrave; ce qui a &eacute;t&eacute; d&eacute;clar&eacute; dans le fichier
Configuration/DocumentTypes/MMDocumentTypes.xml de Dreamweaver dans l'attribut id de la balise
documenttype. L'argument type peut par exemple avoir la valeur &quot;HTML&quot;, &quot;ASP-JS&quot;, &quot;ASP-VB&quot;,
&quot;ColdFusion&quot;, &quot;CFC&quot;, &quot;JSP&quot;, &quot;ASP.NET_VB&quot;, ou toute valeur similaire. Pour obtenir la liste compl&egrave;te des
types disponibles, consultez le fichier MMDocumentTypes.xml. Si vous ne d&eacute;finissez pas l'argument type, il adopte
la valeur &quot;HTML&quot;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
261
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Remarque : Vous pouvez &eacute;tendre le fichier MMDocumentTypes en ajoutant de nouveaux types de documents. Pour plus
d'informations sur l'extension des types de documents, voir Extension de Dreamweaver.
Valeurs renvoy&eacute;es
Objet document correspondant au nouveau document cr&eacute;&eacute;. Il s'agit de la valeur renvoy&eacute;e par la fonction
dreamweaver.getDocumentDOM().
dreamweaver.createXHTMLDocument()
Disponibilit&eacute;
Dreamweaver MX.
Description
En fonction de l'argument utilis&eacute;, cette fonction ouvre un nouveau document XHTML soit dans la m&ecirc;me fen&ecirc;tre, soit
dans une nouvelle fen&ecirc;tre. Le nouveau document devient le document actif. Cette fonction est similaire &agrave; la fonction
dreamweaver.createDocument().
Lorsque Dreamweaver cr&eacute;e un nouveau document XHTML, il lit un fichier nomm&eacute; default.xhtml, qui se trouve dans
le dossier Configuration/Templates, et, en utilisant le contenu de ce fichier, il cr&eacute;e un fichier de sortie contenant les
d&eacute;clarations suivantes :
&lt;?xml version=&quot;1.0&quot;&gt;
&lt;!DOCTYPE html PUBLIC &quot;-//W3C//DTD XHTML 1.0 Transitional//EN&quot;
&quot;http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd&quot;&gt;
&lt;html xmlns=&quot;http://www.w3.org/1999/xhtml&quot;&gt;
&lt;head&gt;
&lt;title&gt;Untitled Document&lt;/title&gt;
&lt;meta http-equiv=&quot;Content-Type&quot; content=&quot;text/html; charset=&quot; /&gt;
&lt;/head&gt;
&lt;body bgcolor=&quot;#FFFFFF&quot; text=&quot;#000000&quot;&gt;
&lt;/body&gt;
&lt;/html&gt;
La d&eacute;claration DTD par d&eacute;faut est XHTML 1.0 Transitional et non pas Strict. Si l'utilisateur ajoute un jeu de cadres
au document, Dreamweaver remplace la DTD par XHTML 1.0 Frameset. Content-Type est text/html, et charset
est intentionnellement omis du fichier default.xhtml mais est rempli avant que l'utilisateur visualise le nouveau
document. La directive ?xml n'est pas obligatoire si le document utilise le codage de caract&egrave;res UTF-8 ou UTF-16 ; si
elle est pr&eacute;sente, elle peut &ecirc;tre restitu&eacute;e par d'autres navigateurs de version ant&eacute;rieure. Cependant, &eacute;tant donn&eacute; que
cette directive doit se trouver dans un document XHTML, Dreamweaver l'utilise par d&eacute;faut (&agrave; la fois pour les
documents nouveaux et convertis). Les utilisateurs peuvent supprimer manuellement la directive. La directive ?xml
inclut l'attribut de codage qui correspond &agrave; charset dans l'attribut Content-Type.
Arguments
{bOpenInSameWindow}
• L'argument bOpenInSameWindow est une valeur bool&eacute;enne indiquant si le nouveau document doit s'ouvrir dans
la fen&ecirc;tre en cours. Si cet argument a pour valeur false, qu'il n'est pas pr&eacute;cis&eacute; ou que la fonction est appel&eacute;e sur
Macintosh, le nouveau document s'ouvre dans une nouvelle fen&ecirc;tre.
Derni&egrave;re mise &agrave; jour le 22/6/2011
262
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Valeurs renvoy&eacute;es
L'objet document correspondant au document nouvellement cr&eacute;&eacute; (m&ecirc;me valeur que celle renvoy&eacute;e par la fonction
dreamweaver.getDocumentDOM()).
dreamweaver.createXMLDocument()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cr&eacute;e et ouvre un nouveau fichier XML contenant uniquement la directive XML.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Le DOM du nouveau fichier XML.
Exemple
L'exemple suivant cr&eacute;e un nouveau document, contenant uniquement la directive XML :
var theDOM = dreamweaver.createXMLDocument(&quot;document&quot;);
dreamweaver.exportTemplateDataAsXML()
Disponibilit&eacute;
Dreamweaver MX.
Description
Exporte le document actif dans le fichier indiqu&eacute;, et ce au format XML. Cette fonction agit sur le document actif, qui
doit &ecirc;tre un mod&egrave;le. Si vous ne sp&eacute;cifiez pas un argument de nom de fichier, Dreamweaver MX ouvre une bo&icirc;te de
dialogue pour demander la cha&icirc;ne du fichier d'exportation.
Arguments
{filePath}
• L'argument filePath (facultatif) est une cha&icirc;ne sp&eacute;cifiant le nom du fichier vers lequel Dreamweaver exporte le
mod&egrave;le. Exprimez l'argument filePath sous forme d'une URL de type &quot;file:///c|/temp/mydata.txt&quot;.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canExportTemplateDataAsXML() &raquo; &agrave; la page 513.
Derni&egrave;re mise &agrave; jour le 22/6/2011
263
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Exemple
if(dreamweaver.canExportTemplateDataAsXML())
{
dreamweaver.exportTemplateDataAsXML(&quot;file:///c|/dw_temps/mytemplate.txt&quot;)
}
dreamweaver.getDocumentDOM()
Disponibilit&eacute;
Dreamweaver 2.
Description
Permet d'acc&eacute;der &agrave; l'arborescence des objets du document sp&eacute;cifi&eacute;. Une fois celle-ci renvoy&eacute;e &agrave; l'appelant, ce dernier
peut la modifier pour changer le contenu du document.
Arguments
{sourceDoc}
• L'argument sourceDoc doit &ecirc;tre &quot;document&quot;, &quot;parent&quot;, &quot;parent.frames[number]&quot;,
&quot;parent.frames['frameName']&quot;, ou une URL. L'argument sourceDoc prend par d&eacute;faut la valeur &quot;document&quot;
si vous ne fournissez pas de valeur. Ces valeurs sont expliqu&eacute;es ci-dessous :
• La valeur document d&eacute;signe le document actif contenant la s&eacute;lection en cours.
• La valeur parent d&eacute;signe le jeu de cadres parent (si le document s&eacute;lectionn&eacute; se trouve dans un cadre).
• Les valeurs parent.frames[number] et parent.frames['frameName'] d&eacute;signent un document figurant
dans un cadre sp&eacute;cifique du jeu de cadres contenant le document actif.
• Si l'argument est une URL relative, celle-ci est relative au fichier de l'extension.
Remarque : Si l'argument a pour valeur &quot;document&quot;, l'appelant doit &ecirc;tre la fonction applyBehavior(),
deleteBehavior(), objectTag() ou toute fonction d'un fichier de commande ou d'inspecteur Propri&eacute;t&eacute;s pouvant
modifier le document.
Valeurs renvoy&eacute;es
L'objet document JavaScript &agrave; la racine de l'arborescence.
Exemples
L'exemple suivant utilise la fonction dreamweaver.getDocumentDOM() pour acc&eacute;der au document actif :
var theDOM = dreamweaver.getDocumentDOM(&quot;document&quot;);
Dans l'exemple suivant, le document DOM actif identifie une s&eacute;lection et la colle &agrave; la fin d'un autre document :
var currentDOM = dreamweaver.getDocumentDOM('document');
currentDOM.setSelection(100,200);
currentDOM.clipCopy();
var otherDOM = dreamweaver.openDocument(dreamweaver.&not;
getSiteRoot() + &quot;html/foo.htm&quot;);
otherDOM.endOfDocument();
otherDOM.clipPaste();
Derni&egrave;re mise &agrave; jour le 22/6/2011
264
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Remarque : L'argument openDocument() est utilis&eacute; car les m&eacute;thodes de l'objet DOM agissent en principe uniquement sur
les documents ouverts. L'ex&eacute;cution d'une fonction sur un document qui n'est pas ouvert entra&icirc;ne une erreur de
Dreamweaver. Lorsqu'une m&eacute;thode de l'objet DOM ne peut &ecirc;tre appliqu&eacute;e qu'au document actif ou &agrave; des documents
ferm&eacute;s, cette caract&eacute;ristique est indiqu&eacute;e dans sa description.
dreamweaver.getNewDocumentDOM()
Disponibilit&eacute;
Dreamweaver MX ; argument documentType ajout&eacute; dans Dreamweaver 8.
Description
Permet d'acc&eacute;der &agrave; l'arborescence modifiable d'un nouveau document vide. Cette fonction est similaire &agrave; la fonction
getDocumentDOM(), &agrave; ceci pr&egrave;s qu'elle pointe vers un nouveau document plut&ocirc;t que vers un document existant et
qu'elle n'ouvre pas le document.
Arguments
{documentType}
• L'argument documentType est une cha&icirc;ne. Sa valeur doit &ecirc;tre un type de document sp&eacute;cifi&eacute; dans le fichier
DocumentTypes.xml.
Valeurs renvoy&eacute;es
Pointeur vers un nouveau document vide.
Exemple
Le code suivant renvoie le DOM d'un nouveau document vide :
var theDOM = dreamweaver.getNewDocumentDOM();
dreamweaver.getRecentFileList()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient la liste de tous les fichiers r&eacute;cemment ouverts et r&eacute;pertori&eacute;s au bas du menu Fichier.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Un tableau de cha&icirc;nes repr&eacute;sentant les chemins des derniers fichiers ouverts, exprim&eacute;s sous la forme d'une URL de
type file://. Si aucun fichier n'a &eacute;t&eacute; ouvert r&eacute;cemment, la fonction ne renvoie aucune valeur.
Derni&egrave;re mise &agrave; jour le 22/6/2011
265
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
dreamweaver.importXMLIntoTemplate()
Disponibilit&eacute;
Dreamweaver 3.
Description
Importe un fichier texte XML dans le mod&egrave;le de document actif. Cette fonction agit sur le document actif, qui doit &ecirc;tre
un mod&egrave;le. Si vous ne sp&eacute;cifiez pas un argument de nom de fichier, Dreamweaver ouvre une bo&icirc;te de dialogue pour
demander la cha&icirc;ne du fichier d'importation.
Arguments
{filePath}
• L'argument filePath (facultatif) est une cha&icirc;ne sp&eacute;cifiant le nom du fichier vers lequel Dreamweaver importe le
mod&egrave;le. Exprimez l'argument filePath sous forme d'une URL de type &quot;file:///c|/temp/mydata.txt&quot;.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.newDocument()
Disponibilit&eacute;
Dreamweaver MX.
Description
Ouvre un document dans le site en cours et affiche la bo&icirc;te de dialogue Nouveau document.
Arguments
{bopenWithCurSiteAndShowDialog}
• L'argument bopenWithCurSiteAndShowDialog (facultatif) peut avoir la valeur true ou false. Si vous souhaitez
ouvrir un document dans le site en cours et afficher la bo&icirc;te de dialogue Nouveau document, sp&eacute;cifiez true ; sinon,
sp&eacute;cifiez false.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.newFromTemplate()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cr&eacute;e un nouveau document &agrave; partir du mod&egrave;le sp&eacute;cifi&eacute;. Si vous ne sp&eacute;cifiez aucun argument, la bo&icirc;te de dialogue
S&eacute;lectionner le mod&egrave;le s'affiche.
Derni&egrave;re mise &agrave; jour le 22/6/2011
266
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Arguments
{templateURL}, bMaintain
• L'argument templateURL est le chemin d'un mod&egrave;le disponible sur le site en cours, exprim&eacute; sous la forme d'une
URL de type file://.
• L'argument bMaintain est une valeur bool&eacute;enne, pouvant &ecirc;tre true ou false, indiquant si le lien vers le mod&egrave;le
d'origine doit &ecirc;tre conserv&eacute; ou pas.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.openDocument()
Disponibilit&eacute;
Dreamweaver 2.
Description
Ouvre un document &agrave; modifier dans une nouvelle fen&ecirc;tre Dreamweaver et en fait le document actif. Pour l'utilisateur,
cela revient &agrave; choisir Fichier &gt; Ouvrir et &agrave; s&eacute;lectionner un fichier. Si le fichier sp&eacute;cifi&eacute; est d&eacute;j&agrave; ouvert, la fen&ecirc;tre
correspondante s'affiche au premier plan. La fen&ecirc;tre contenant le fichier sp&eacute;cifi&eacute; devient la fen&ecirc;tre active et le fichier
s&eacute;lectionn&eacute; devient le document actif. Dans Dreamweaver 2, si la fonction d'archivage/extraction est activ&eacute;e, le fichier
est extrait avant d'&ecirc;tre ouvert. Dans Dreamweaver 3 et ses versions ult&eacute;rieures, vous devez utiliser la fonction
&laquo; dreamweaver.openDocumentFromSite() &raquo; &agrave; la page 266 pour obtenir ce comportement.
Remarque : Cette fonction provoque une erreur si elle est appel&eacute;e &agrave; partir d'un fichier d'objet ou d'action de
comportement.
Arguments
fileName
• L'argument fileName est le nom du fichier &agrave; ouvrir, exprim&eacute; sous forme d'une URL absolue. S'il s'agit d'une URL
relative, elle est relative au fichier contenant le script ayant appel&eacute; cette fonction.
Valeurs renvoy&eacute;es
L'objet document correspondant au fichier sp&eacute;cifi&eacute;, soit la m&ecirc;me valeur renvoy&eacute;e par la fonction
dreamweaver.getDocumentDOM().
dreamweaver.openDocumentFromSite()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre un document &agrave; modifier dans une nouvelle fen&ecirc;tre Dreamweaver et en fait le document actif. Pour l'utilisateur,
cela revient &agrave; double-cliquer sur un fichier dans le panneau Site. Si le fichier sp&eacute;cifi&eacute; est d&eacute;j&agrave; ouvert, la fen&ecirc;tre
correspondante s'affiche au premier plan. La fen&ecirc;tre contenant le fichier sp&eacute;cifi&eacute; devient la fen&ecirc;tre active et le fichier
s&eacute;lectionn&eacute; devient le document actif.
Derni&egrave;re mise &agrave; jour le 22/6/2011
267
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Remarque : Cette fonction ne peut pas &ecirc;tre appel&eacute;e &agrave; partir d'un fichier d'objet ou d'action de comportement sous peine
de g&eacute;n&eacute;rer des erreurs.
Arguments
fileName
• L'argument fileName est le fichier &agrave; ouvrir, exprim&eacute; sous forme d'une URL absolue. S'il s'agit d'une URL relative,
elle est relative au fichier contenant le script ayant appel&eacute; cette fonction.
Valeurs renvoy&eacute;es
L'objet document correspondant au fichier sp&eacute;cifi&eacute;, soit la m&ecirc;me valeur renvoy&eacute;e par la fonction
dreamweaver.getDocumentDOM().
dreamweaver.openInFrame()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Ouvrir dans un cadre. Lorsque l'utilisateur s&eacute;lectionne un document, celui-ci s'ouvre dans
le cadre actif.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canOpenInFrame() &raquo; &agrave; la page 514.
dreamweaver.releaseDocument()
Disponibilit&eacute;
Dreamweaver 2.
Description
Lib&egrave;re explicitement de la m&eacute;moire un document pr&eacute;c&eacute;demment r&eacute;f&eacute;renc&eacute;.
Les documents r&eacute;f&eacute;renc&eacute;s par les fonctions dreamweaver.getObjectTags(), dreamweaver.getObjectRefs(),
dreamweaver.getDocumentPath() et dreamweaver.getDocumentDOM() sont automatiquement lib&eacute;r&eacute;s au terme de
l'ex&eacute;cution du script contenant l'appel. Si le script ouvre un nombre important de documents, vous devez utiliser cette
fonction pour en lib&eacute;rer certains explicitement avant la fin de l'ex&eacute;cution du script, ceci afin d'&eacute;viter de saturer la
m&eacute;moire.
Remarque : Cette fonction ne s'applique qu'aux documents r&eacute;f&eacute;renc&eacute;s par une URL, qui ne sont pas ouverts dans un
cadre ou dans une fen&ecirc;tre de document et qui ne correspondent pas &agrave; des fichiers d'extension (les fichiers d'extensions
externes sont charg&eacute;s en m&eacute;moire au d&eacute;marrage et n'en sont lib&eacute;r&eacute;s que lorsque vous quittez Dreamweaver).
Derni&egrave;re mise &agrave; jour le 22/6/2011
268
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Arguments
documentObject.
• L'argument documentObject correspond &agrave; l'objet situ&eacute; &agrave; la racine de l'arborescence DOM d'un document, c'est-&agrave;dire la valeur renvoy&eacute;e par la fonction dreamweaver.getDocumentDOM().
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.revertDocument()
Disponibilit&eacute;
Dreamweaver 3.
Description
R&eacute;tablit la version pr&eacute;c&eacute;demment enregistr&eacute;e du fichier sp&eacute;cifi&eacute;.
Arguments
documentObject, warn
• L'argument documentObject correspond &agrave; l'objet situ&eacute; &agrave; la racine de l'arborescence DOM d'un document, c'est-&agrave;dire la valeur renvoy&eacute;e par la fonction dreamweaver.getDocumentDOM().
• L'argument warn est une valeur bool&eacute;enne qui sp&eacute;cifie si l'utilisateur doit &ecirc;tre inform&eacute; que les modifications non
enregistr&eacute;es seront annul&eacute;es. En cas d'omission, la valeur par d&eacute;faut est true.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si Dreamweaver doit avertir l'utilisateur et false dans le cas contraire.
Activateur
Voir &laquo; dreamweaver.canRevertDocument() &raquo; &agrave; la page 516.
dreamweaver.saveAll()
Disponibilit&eacute;
Dreamweaver 3.
Description
Enregistre tous les documents ouverts et ouvre la bo&icirc;te de dialogue Enregistrer sous pour tous ceux qui n'ont pas
encore &eacute;t&eacute; enregistr&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
269
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Activateur
Voir &laquo; dreamweaver.canSaveAll() &raquo; &agrave; la page 516.
dreamweaver.saveDocument()
Disponibilit&eacute;
Dreamweaver 2.
Description
Enregistre le fichier sp&eacute;cifi&eacute; sur un ordinateur local.
Remarque : Dans Dreamweaver 2, si le fichier est en lecture seule, Dreamweaver tente de l'extraire. Si le document reste
en lecture seule apr&egrave;s cette tentative ou s'il ne peut pas &ecirc;tre cr&eacute;&eacute;, un message d'erreur s'affiche.
Arguments
documentObject, {fileURL}
• L'argument documentObject correspond &agrave; l'objet situ&eacute; &agrave; la racine de l'arborescence DOM d'un document, c'est-&agrave;dire la valeur renvoy&eacute;e par la fonction dreamweaver.getDocumentDOM().
• L'argument fileURL (facultatif) est une URL repr&eacute;sentant un emplacement sur un ordinateur local. S'il s'agit d'une
URL relative, elle est relative au fichier de l'extension. Dans Dreamweaver 2, cet argument est obligatoire. Dans
Dreamweaver 4, si l'argument fileURL est omis et si le fichier a &eacute;t&eacute; enregistr&eacute; pr&eacute;c&eacute;demment, ce dernier est
enregistr&eacute; au m&ecirc;me endroit ; sinon, la bo&icirc;te de dialogue Enregistrer sous s'affiche.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant le succ&egrave;s (true) ou l'&eacute;chec (false) de l'op&eacute;ration.
Activateur
Voir &laquo; dreamweaver.canSaveDocument() &raquo; &agrave; la page 517.
dreamweaver.saveDocumentAs()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Enregistrer sous.
Arguments
documentObject.
• L'argument documentObject correspond &agrave; l'objet situ&eacute; &agrave; la racine de l'arborescence DOM d'un document, c'est-&agrave;dire la valeur renvoy&eacute;e par la fonction dreamweaver.getDocumentDOM().
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
270
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
dreamweaver.saveDocumentAsTemplate()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Enregistrer comme mod&egrave;le.
Arguments
documentObject, {fileName}
• L'argument documentObject correspond &agrave; l'objet situ&eacute; &agrave; la racine de l'arborescence DOM d'un document, c'est-&agrave;dire la valeur renvoy&eacute;e par la fonction dreamweaver.getDocumentDOM().
• L'argument fileName (facultatif) est le nom du fichier &agrave; ouvrir, exprim&eacute; sous forme d'une URL absolue.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canSaveDocumentAsTemplate() &raquo; &agrave; la page 517.
dreamweaver.saveFrameset()
Disponibilit&eacute;
Dreamweaver 3.
Description
Enregistre le jeu de cadres sp&eacute;cifi&eacute; ou, si ce dernier n'a pas encore &eacute;t&eacute; enregistr&eacute;, ouvre la bo&icirc;te de dialogue Enregistrer sous.
Arguments
documentObject.
• L'argument documentObject correspond &agrave; l'objet situ&eacute; &agrave; la racine de l'arborescence DOM d'un document, c'est-&agrave;dire la valeur renvoy&eacute;e par la fonction dreamweaver.getDocumentDOM().
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canSaveFrameset() &raquo; &agrave; la page 517.
dreamweaver.saveFramesetAs()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
271
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Description
Ouvre la bo&icirc;te de dialogue Enregistrer sous correspondant au fichier de jeu de cadres comprenant le DOM sp&eacute;cifi&eacute;.
Arguments
documentObject.
• L'argument documentObject correspond &agrave; l'objet situ&eacute; &agrave; la racine de l'arborescence DOM d'un document, c'est-&agrave;dire la valeur renvoy&eacute;e par la fonction dreamweaver.getDocumentDOM().
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canSaveFramesetAs() &raquo; &agrave; la page 518.
Fonctions relatives &agrave; l'ensemble d'un document
Ces fonctions agissent sur l'ensemble d'un document. Elles permettent d'effectuer des v&eacute;rifications orthographiques,
de v&eacute;rifier les navigateurs cibles, de d&eacute;finir les propri&eacute;t&eacute;s des pages et de d&eacute;terminer les r&eacute;f&eacute;rences d'objet correctes des
&eacute;l&eacute;ments du document.
dom.checkSpelling()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie l'orthographe sur l'ensemble du document (en ouvrant la bo&icirc;te de dialogue V&eacute;rifier l'orthographe, si n&eacute;cessaire)
et pr&eacute;vient l'utilisateur lorsque la v&eacute;rification est termin&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.checkTargetBrowsers()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie le navigateur cible du document. Pour v&eacute;rifier le navigateur cible d'un dossier ou d'un groupe de fichiers,
consultez la fonction &laquo; site.checkTargetBrowsers() &raquo; &agrave; la page 231.
Derni&egrave;re mise &agrave; jour le 22/6/2011
272
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.getParseMode()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Permet d'obtenir le mode d'analyse du document. Ceci permet de contr&ocirc;ler la validation du document et de v&eacute;rifier
qu'il s'affiche au format HTML dans la fen&ecirc;tre de document principale.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui sp&eacute;cifie le mode d'analyse actuel : &quot;html&quot;, &quot;xml&quot;, &quot;css&quot; ou &quot;text&quot;.
dom.hideInfoMessagePopup()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Masque le message qui peut s'afficher sous forme d'infobulle dans la fen&ecirc;tre de document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Voir aussi
&laquo; dom.showInfoMessagePopup() &raquo; &agrave; la page 274.
dom.runValidation()
Disponibilit&eacute;
Dreamweaver MX, arguments facultatifs ajout&eacute;s &agrave; Dreamweaver MX 2004.
Derni&egrave;re mise &agrave; jour le 22/6/2011
273
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Description
Ex&eacute;cute le programme de validation sur un document unique sp&eacute;cifi&eacute;. Le validateur v&eacute;rifie que le langage du
document est conforme &agrave; celui qui a &eacute;t&eacute; sp&eacute;cifi&eacute; dans le doctype du document (par exemple HTML 4.0 ou HTML 3.2)
et &agrave; celui qui a &eacute;t&eacute; sp&eacute;cifi&eacute; par le mod&egrave;le de serveur (par exemple ColdFusion ou ASP). Si aucun doctype n'a &eacute;t&eacute; d&eacute;fini
pour le document, le validateur utilise le param&egrave;tre de langage sp&eacute;cifi&eacute; dans la section Validateur de la bo&icirc;te de
dialogue Pr&eacute;f&eacute;rences.
Arguments
{controlString}, {bOpenResultsWindow}, {bShowInfoMessage}
• L'argument controlString est une cha&icirc;ne facultative qui poss&egrave;de quatre valeurs possibles : une cha&icirc;ne vide, &quot;xml&quot;,
&quot;auto-explicit&quot; ou &quot;auto-implicit&quot;.
• Si la valeur de l'argument est une cha&icirc;ne vide, le validateur effectue une validation par d&eacute;faut. Si sa valeur est
&quot;xml&quot;, il valide le document en tant que XML.
• Si sa valeur est &quot;auto-explicit&quot; ou &quot;auto-implicit&quot;, Dreamweaver effectue une validation automatique
(ou validation en ligne). Plut&ocirc;t que d'&ecirc;tre affich&eacute;es dans la fen&ecirc;tre de r&eacute;sultats de la validation (voir
&laquo; dom.source.getValidationErrorsForOffset() &raquo; &agrave; la page 486 and &laquo; dom.getAutoValidationCount() &raquo; &agrave; la
page 479), les erreurs sont soulign&eacute;es dans le mode Code.
• Si la valeur de l'argument controlString est &quot;auto-explicit&quot;, l'utilisateur est invit&eacute; &agrave; enregistrer un document
non enregistr&eacute; avant la validation.
• Si la valeur de l'argument controlString est &quot;auto-implicit&quot;, la validation &eacute;choue sans pr&eacute;venir l'utilisateur
que le document en cours n'a pas &eacute;t&eacute; enregistr&eacute;.
Remarque : La validation automatique (d&eacute;finie par la valeur &quot;auto-explicit&quot; ou &quot;auto-implicit&quot; de l'argument
controlString) n'est disponible que pour la v&eacute;rification du navigateur cible.
• L'argument bOpenResultsWindow est une valeur bool&eacute;enne facultative : true ouvre la fen&ecirc;tre R&eacute;sultat de la
validation, et false ne l'ouvre pas. La valeur par d&eacute;faut est true.
• L'argument bShowInfoMessage n'est utilis&eacute; que si la valeur de l'argument controlString est &quot;auto-explicit&quot; ou
&quot;auto-implicit&quot;. L'argument bShowInfoMessage est une valeur bool&eacute;enne. true affiche un message
d'information sous l'&eacute;l&eacute;ment de barre d'outils, DW_ValidatorErrors, indiquant le nombre d'erreurs trouv&eacute;es.
false n'affiche rien. La valeur par d&eacute;faut est false.
Valeurs renvoy&eacute;es
Objet fen&ecirc;tre des r&eacute;sultats de la validation.
Exemple
Dans l'exemple suivant, une validation r&eacute;guli&egrave;re est effectu&eacute;e lorsque l'utilisateur s&eacute;lectionne Fichier &gt; V&eacute;rifier la page
&gt; Valider le marqueur (ou Valider le document actuel dans le panneau Validation) :
dw.getDocumentDOM().runValidation('');
Dans l'exemple suivant, l'utilisateur est invit&eacute; &agrave; enregistrer le document non enregistr&eacute;, puis une validation
automatique est effectu&eacute;e. La fen&ecirc;tre de r&eacute;sultats de la validation ne s'affiche pas et le nombre d'erreurs dans le
document s'affiche sur la barre d'outils du document pour DW_ValidatorErrors :
dw.getDocumentDOM().runValidation('auto-explicit', false, true);
Derni&egrave;re mise &agrave; jour le 22/6/2011
274
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Dans l'exemple suivant, l'utilisateur n'est pas invit&eacute; &agrave; enregistrer le document. Si le document n'a pas &eacute;t&eacute; enregistr&eacute;, la
validation ne peut pas d&eacute;marrer. Si le document a &eacute;t&eacute; enregistr&eacute;, Dreamweaver effectue une validation automatique.
La fen&ecirc;tre de r&eacute;sultats de la validation ne s'affiche pas et le nombre d'erreurs dans le document n'appara&icirc;t pas sur la
barre d'outils du document :
dw.getDocumentDOM().runValidation('auto-implicit', false);
dom.showInfoMessagePopup()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Affiche un message sous forme d'infobulle dans la fen&ecirc;tre de document ou sous un &eacute;l&eacute;ment de barre d'outils.
Arguments
location, message, timeout
• L'argument location est une cha&icirc;ne sp&eacute;cifiant un &eacute;l&eacute;ment de barre d'outils, une cha&icirc;ne vide ou l'un des mots cl&eacute;s
suivants : &quot;top&quot;, &quot;topright&quot;, &quot;right&quot;, &quot;bottomright&quot;, &quot;bottom&quot;, &quot;bottomleft&quot;, &quot;left&quot; ou &quot;topleft&quot;.
L'infobulle s'affiche pr&egrave;s du bord ou de l'angle sp&eacute;cifi&eacute; et est centr&eacute;e. Si la valeur de l'argument est une cha&icirc;ne vide,
l'infobulle est centr&eacute;e dans le document. Pour sp&eacute;cifier un &eacute;l&eacute;ment de barre d'outils, indiquez
&quot;toolbar:toolbarID:itemID&quot;. L'ID de barre d'outils et l'ID d'&eacute;l&eacute;ment de barre d'outils doivent correspondre aux
ID du fichier toolbars.xml.
• L'argument message est une cha&icirc;ne contenant le message.
• L'argument timeout est un nombre indiquant le temps d'affichage du message en millisecondes. Si sa valeur est 0
(valeur par d&eacute;faut), le message reste affich&eacute; pendant une dur&eacute;e illimit&eacute;e. Le message dispara&icirc;t automatiquement
lorsque l'utilisateur clique dessus, passe &agrave; un autre document ou lorsque la dur&eacute;e d'affichage sp&eacute;cifi&eacute;e arrive &agrave;
expiration.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Dans l'exemple ci-dessous, deux messages s'affichent sous forme d'infobulles. La premi&egrave;re ligne de code affiche le
message &quot;This message is in the center&quot; au centre du document. Le second appel de la fonction
showInfoMessagePopup() affiche le message &quot;Don't forget the title for the Window&quot; pour la zone de texte
Title (ID : DW_SetTitle) sur la barre d'outils dont l'ID est DW_Toolbar_Main.
dw.getDocumentDOM.showInfoMessagePopup('', 'This message is in the center', 5000);
dw.getDocumentDOM.showInfoMessagePopup('toolbar:DW_Toolbar_Main:DW_SetTitle', 'Don't
forget the title for the window', 5000);
Voir aussi
&laquo; dom.hideInfoMessagePopup() &raquo; &agrave; la page 272.
Derni&egrave;re mise &agrave; jour le 22/6/2011
275
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
dom.showPagePropertiesDialog()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Propri&eacute;t&eacute;s de la page.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.doURLDecoding()
Disponibilit&eacute;
Dreamweaver MX.
Description
Utilise le m&eacute;canisme de d&eacute;codage d'URL interne de Dreamweaver pour d&eacute;coder des caract&egrave;res sp&eacute;ciaux et des
symboles dans les cha&icirc;nes d'URL. Par exemple, cette fonction interpr&egrave;te %20 comme un caract&egrave;re d'espacement et le
nom &amp;quot comme des guillemets &quot;.
Arguments
inStr
• L'argument inStr est la cha&icirc;ne &agrave; d&eacute;coder.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant l'URL d&eacute;cod&eacute;e.
Exemple
L'exemple suivant appelle la fonction dw.doURLDecoding() afin de d&eacute;coder les caract&egrave;res sp&eacute;ciaux indiqu&eacute;s dans son
argument et enregistre la cha&icirc;ne obtenue dans outStr :
outStr = dreamweaver.doURLDecoding(&quot;http://maps.yahoo.com/py/ddResults.py?Pyt= &not;
Tmap&amp;tarname=&amp;tardesc=&amp;newname=&amp;newdesc=&amp;newHash=&amp;newTHash=&amp;newSts=&amp;newTSts=&amp;tlt=&amp;tln= &not;
&amp;slt=&amp;sln=&amp;newFL=Use+Address+Below&amp;newaddr=2000+Shamrock+Rd&amp;newcsz=Metroo+Park%2C+CA&amp; &not;
newcountry=us&amp;newTFL=Use+Address+Below&amp;newtaddr=500+El+Camino&amp;newtcsz=Santa+Clara%2C+CA&amp; &not;
newtcountry=us&amp;Submit=Get+Directions&quot;)
dreamweaver.getElementRef()
Disponibilit&eacute;
Dreamweaver 2.
Derni&egrave;re mise &agrave; jour le 22/6/2011
276
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Description
Obtient la r&eacute;f&eacute;rence d'objet Netscape Navigator ou Internet Explorer pour un objet balise sp&eacute;cifique de l'arborescence DOM.
Arguments
NSorIE, tagObject
• L'argument NSorIE doit &ecirc;tre &quot;NS
4.0&quot; ou &quot;IE 4.0&quot;. Le DOM et les r&egrave;gles relatives aux r&eacute;f&eacute;rences imbriqu&eacute;es
diff&egrave;rent dans Netscape Navigator 4.0 et Internet Explorer 4.0. Cet argument permet d'indiquer &agrave; quel navigateur
doit correspondre la r&eacute;f&eacute;rence renvoy&eacute;e.
• L'argument tagObject est un objet de balise dans l'arborescence DOM.
Valeurs renvoy&eacute;es
Cha&icirc;ne repr&eacute;sentant une r&eacute;f&eacute;rence JavaScript valide &agrave; l'objet, telle que document.layers['myLayer']. La cha&icirc;ne est
soumise aux conditions suivantes :
• Dreamweaver renvoie des r&eacute;f&eacute;rences Internet Explorer correctes pour les balises suivantes : A, AREA, APPLET,
EMBED, DIV, SPAN, INPUT, SELECT, OPTION, TEXTAREA, OBJECT et IMG.
• Dreamweaver renvoie des r&eacute;f&eacute;rences Netscape Navigator correctes pour les balises suivantes : A, AREA, APPLET,
EMBED, LAYER, ILAYER, SELECT, OPTION, TEXTAREA, OBJECT, and IMG, ainsi que pour les balises DIV et SPAN &agrave;
positionnement absolu. Pour les balises DIV et SPAN dont le positionnement n'est pas absolu, Dreamweaver renvoie
&quot;cannot reference &lt;tag&gt;&quot;.
• Dreamweaver ne renvoie pas de r&eacute;f&eacute;rences pour les objets sans nom. Si un objet ne contient pas d'attribut NAME ou
ID, Dreamweaver renvoie &quot;unnamed &lt;tag&gt;&quot;. Si le navigateur ne prend pas en charge une r&eacute;f&eacute;rence par nom,
Dreamweaver fait r&eacute;f&eacute;rence &agrave; l'objet &agrave; l'aide de son index (par exemple document.myform.applets[3]).
• Dreamweaver renvoie les r&eacute;f&eacute;rences des objets nomm&eacute;s figurant dans des formulaires ou des calques sans nom (par
exemple document.forms[2].myCheckbox).
dreamweaver.getPreferenceInt()
Disponibilit&eacute;
Dreamweaver MX.
Description
Vous permet d'extraire une pr&eacute;f&eacute;rence de nombre entier pour une extension donn&eacute;e.
Arguments
section, key, default_value
• L'argument section est une cha&icirc;ne qui sp&eacute;cifie la section des pr&eacute;f&eacute;rences contenant l'entr&eacute;e.
• L'argument key est une cha&icirc;ne qui sp&eacute;cifie l'entr&eacute;e de la valeur &agrave; extraire.
• L'argument default_value est la valeur par d&eacute;faut renvoy&eacute;e par Dreamweaver si l'entr&eacute;e est introuvable. Il doit s'agir
d'un entier non sign&eacute; compris entre 0 et 65535 ou d'un entier sign&eacute; compris entre -32768 et 32767.
Valeurs renvoy&eacute;es
Valeur enti&egrave;re de l'entr&eacute;e sp&eacute;cifi&eacute;e dans la section ou valeur par d&eacute;faut si la fonction ne trouve pas l'entr&eacute;e. Renvoie 0
si la valeur de l'entr&eacute;e sp&eacute;cifi&eacute;e n'est pas un entier.
Derni&egrave;re mise &agrave; jour le 22/6/2011
277
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Exemple
L'exemple suivant renvoie la valeur du param&egrave;tre Distance d'accrochage de la section Mon extension des Pr&eacute;f&eacute;rences.
Si la section Mon extension n'existe pas ou si le param&egrave;tre Distance d'accrochage n'est pas d&eacute;fini, la fonction renvoie
la valeur par d&eacute;faut sp&eacute;cifi&eacute;e (0).
var snapDist; //default value if entry not found
snapDist = dreamweaver.getPreferenceInt(&quot;My Extension&quot;, &quot;Snap Distance&quot;, 0);
dreamweaver.getPreferenceString()
Disponibilit&eacute;
Dreamweaver MX.
Remarque : Pour acc&eacute;der aux pr&eacute;f&eacute;rences des sites, vous devez poss&eacute;der la version 7.0.1. V&eacute;rifiez dw.appVersion pour
conna&icirc;tre la version correcte avant d'acc&eacute;der aux informations relatives au site.
Description
Permet d'extraire une pr&eacute;f&eacute;rence de cha&icirc;ne que vous avez stock&eacute;e pour une extension.
Arguments
section, key, default_value
• L'argument section est une cha&icirc;ne qui sp&eacute;cifie la section des pr&eacute;f&eacute;rences contenant l'entr&eacute;e.
• L'argument key est une cha&icirc;ne qui sp&eacute;cifie la valeur &agrave; extraire.
• L'argument default_value est la valeur de cha&icirc;ne par d&eacute;faut renvoy&eacute;e par Dreamweaver si l'entr&eacute;e est introuvable.
Valeurs renvoy&eacute;es
Cha&icirc;ne de la pr&eacute;f&eacute;rence demand&eacute;e ou valeur par d&eacute;faut si la cha&icirc;ne est introuvable.
Exemple
L'exemple suivant renvoie la valeur du param&egrave;tre Editeur de texte de la section Mon extension des Pr&eacute;f&eacute;rences. Si la
section Mon extension n'existe pas ou si le param&egrave;tre Editeur de texte n'est pas d&eacute;fini, la fonction renvoie la valeur par
d&eacute;faut sp&eacute;cifi&eacute;e par la variable txtEditor.
var txtEditor = getExternalTextEditor(); //set default text Editor value
txtEditor = dreamweaver.getPreferenceString(&quot;My Extension&quot;, &quot;Text Editor&quot;, txtEditor);
dreamweaver.setPreferenceInt()
Disponibilit&eacute;
Dreamweaver MX.
Description
Vous permet de d&eacute;finir une pr&eacute;f&eacute;rence de nombre entier pour une extension donn&eacute;e. Ce param&egrave;tre est enregistr&eacute; avec
les pr&eacute;f&eacute;rences de Dreamweaver lorsque Dreamweaver n'est pas actif.
Derni&egrave;re mise &agrave; jour le 22/6/2011
278
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Arguments
section, key, new_value
• L'argument section est une cha&icirc;ne qui sp&eacute;cifie la cat&eacute;gorie de pr&eacute;f&eacute;rences d&eacute;finissant l'option. Si la cat&eacute;gorie n'existe
pas, Dreamweaver la cr&eacute;e.
• L'argument key est une cha&icirc;ne qui sp&eacute;cifie l'option de cat&eacute;gorie d&eacute;finie par la fonction. Si l'option n'existe pas,
Dreamweaver la cr&eacute;e.
• L'argument new_value est un entier qui sp&eacute;cifie la valeur de l'option de cat&eacute;gorie.
Valeurs renvoy&eacute;es
Valeur true en cas de succ&egrave;s et false dans le cas contraire.
Exemple
L'exemple suivant d&eacute;finit l'entr&eacute;e Distance d'accrochage en fonction de la valeur de la variable snapDist de la cat&eacute;gorie
Mon extension dans les Pr&eacute;f&eacute;rences :
var snapDist = getSnapDistance();
if(snapDist &gt; 0)
{
dreamweaver.setPreferenceInt(&quot;My Extension&quot;, &quot;Snap Distance&quot;, snapDist);
}
dreamweaver.setPreferenceString()
Disponibilit&eacute;
Dreamweaver MX.
Remarque : Pour acc&eacute;der aux pr&eacute;f&eacute;rences des sites, vous devez poss&eacute;der la version 7.0.1. V&eacute;rifiez dw.appVersion pour
conna&icirc;tre la version correcte avant d'acc&eacute;der aux informations relatives au site.
Description
Permet d'&eacute;crire une pr&eacute;f&eacute;rence de cha&icirc;ne pour une extension. Ce param&egrave;tre est enregistr&eacute; avec les pr&eacute;f&eacute;rences de
Dreamweaver lorsque Dreamweaver n'est pas actif.
Arguments
section, key, new_value
• L'argument section est une cha&icirc;ne qui sp&eacute;cifie la cat&eacute;gorie de Pr&eacute;f&eacute;rences d&eacute;finissant l'option. Si la cat&eacute;gorie n'existe
pas, Dreamweaver la cr&eacute;e.
• L'argument key est une cha&icirc;ne qui sp&eacute;cifie l'option de cat&eacute;gorie d&eacute;finie par les fonctions. Si l'option de cat&eacute;gorie
n'existe pas, Dreamweaver la cr&eacute;e.
• L'argument new_value est une cha&icirc;ne qui sp&eacute;cifie la valeur de l'option de cat&eacute;gorie.
Valeurs renvoy&eacute;es
Valeur true en cas de succ&egrave;s et false dans le cas contraire.
Exemple
var txtEditor = getExternalTextEditor();
dreamweaver.setPreferenceString(&quot;My Extension&quot;, &quot;Text Editor&quot;, txtEditor);
Derni&egrave;re mise &agrave; jour le 22/6/2011
279
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
dreamweaver.showTargetBrowsersDialog()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Ouvre la bo&icirc;te de dialogue Navigateurs cibles. Cette bo&icirc;te de dialogue permet &agrave; l'utilisateur de sp&eacute;cifier les versions des
navigateurs utilis&eacute;es par la fonction V&eacute;rification du navigateur cible pour contr&ocirc;ler les probl&egrave;mes de compatibilit&eacute; du
navigateur sur la page actuelle.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Fonctions relatives aux chemins
Ces fonctions permettent d'obtenir et de manipuler les chemins d'acc&egrave;s aux diff&eacute;rents fichiers et dossiers enregistr&eacute;s
sur le disque dur d'un utilisateur. Elles permettent, entre autres, de d&eacute;terminer le chemin d'acc&egrave;s &agrave; la racine du site dans
lequel r&eacute;side le document actif et de convertir des chemins relatifs en URL absolues.
dreamweaver.absoluteURLToDocRelative()
Disponibilit&eacute;
Dreamweaver 2.
Description
Lorsqu'elle re&ccedil;oit une URL absolue et le chemin d'un document, cette fonction convertir l'URL absolue en un chemin
d'acc&egrave;s relatif au document.
Arguments
docPathURL, siteRootURL, absoluteURL
• L'argument docPathURL est le chemin d'acc&egrave;s &agrave; un document sur l'ordinateur de l'utilisateur (par exemple, le
document actuel), exprim&eacute; sous la forme d'une URL file://.
• L'argument siteRootURL est le chemin d'acc&egrave;s &agrave; la racine du site, exprim&eacute; sous la forme d'une URL file://.
• L'argument absoluteURL est l'URL file:// &agrave; convertir en chemin d'acc&egrave;s relatif au document.
Valeurs renvoy&eacute;es
Cha&icirc;ne repr&eacute;sentant le chemin d'acc&egrave;s au document &agrave; absoluteURL, exprim&eacute; de fa&ccedil;on relative au document &agrave;
docPathURL.
Derni&egrave;re mise &agrave; jour le 22/6/2011
280
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Exemple
Dans l'exemple suivant, si les valeurs de docPathURL et siteRootURL sont respectivement
file://C:/sites/cherrystreet/archives/october.shtml et file://C:/sites/cherrystreet/, la valeur
renvoy&eacute;e est &quot;../includes/header.html&quot;. Cette valeur permet de faire r&eacute;f&eacute;rence &agrave; /includes/header.html &agrave;
partir de /archives/october.shtml.
var
var
var
var
docPathURL = dw.getDocumentDOM().URL;
siteRootURL = dw.getSiteRoot();
absoluteURL= dw.relativeToAbsoluteURL(docPathURL, siteRootURL, &quot;/includes/header.html&quot;);
docRelPath = dw.absoluteURLToDocRelative(docPathURL, siteRootURL, absoluteURL);
dreamweaver.getConfigurationPath()
Disponibilit&eacute;
Dreamweaver 2.
Description
Obtient le chemin d'acc&egrave;s au dossier Configuration de Dreamweaver, exprim&eacute; sous la forme d'une URL de type file://.
Pour savoir comment acc&egrave;de aux dossiers Configuration sur une plate-forme multiutilisateur, voir &laquo; Extensions C &raquo;
dans l'aide Extension de Dreamweaver.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Chemin d'acc&egrave;s aux configurations de l'application.
Exemple
La fonction ci-dessous permet de faire r&eacute;f&eacute;rence &agrave; d'autres fichiers d'extension stock&eacute;s dans le sous-dossier
Configuration du dossier de l'application Dreamweaver :
var sortCmd = dreamweaver.getConfigurationPath() + &not;
&quot;/Commands/Sort Table.htm&quot;
var sortDOM = dreamweaver.getDocumentDOM(sortCmd);
dreamweaver.getDocumentPath()
Disponibilit&eacute;
Dreamweaver 1.2.
Description
Obtient le chemin d'acc&egrave;s du document d&eacute;fini, exprim&eacute; sous la forme d'une URL de type file://. Cette fonction revient
&agrave; appeler la fonction dreamweaver.getDocumentDOM() et &agrave; lire la propri&eacute;t&eacute; URL de la valeur renvoy&eacute;e.
Derni&egrave;re mise &agrave; jour le 22/6/2011
281
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Arguments
sourceDoc
• La valeur de l'argument sourceDoc doit &ecirc;tre &quot;document&quot;, &quot;parent&quot;, &quot;parent.frames[number]&quot; ou
&quot;parent.frames['frameName']&quot;. &quot;document&quot; d&eacute;signe le document actif contenant la s&eacute;lection en cours.
&quot;parent&quot; d&eacute;signe le jeu de cadres parent (si le document s&eacute;lectionn&eacute; se trouve dans un cadre);
&quot;parent.frames[number]&quot; et &quot;parent.frames['frameName']&quot; d&eacute;signent un document figurant dans un cadre
sp&eacute;cifique du jeu de cadres contenant le document actif.
Valeurs renvoy&eacute;es
Soit une cha&icirc;ne contenant l'URL du document d&eacute;fini si le fichier a &eacute;t&eacute; enregistr&eacute;, soit une cha&icirc;ne vide si le fichier n'a
pas &eacute;t&eacute; enregistr&eacute;.
dreamweaver.getSiteRoot()
Disponibilit&eacute;
Dreamweaver 1.2.
Description
Obtient le dossier racine local (tel que d&eacute;fini dans la bo&icirc;te de dialogue D&eacute;finition du site) du site associ&eacute; au document
s&eacute;lectionn&eacute;, exprim&eacute; sous la forme d'une URL de type file://.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Soit une cha&icirc;ne contenant l'URL du dossier racine local du site o&ugrave; le fichier a &eacute;t&eacute; enregistr&eacute;, soit une cha&icirc;ne vide si le
fichier n'est associ&eacute; &agrave; aucun site.
dreamweaver.getTempFolderPath()
Disponibilit&eacute;
Dreamweaver MX.
Description
Permet d'obtenir le chemin d'acc&egrave;s complet &agrave; un dossier temporaire dans lequel vous pouvez enregistrer les fichiers
temporaires ou transitoires. Cette fonction recherche un dossier Temp dans le dossier Configuration de Dreamweaver.
Si le syst&egrave;me est multiutilisateur, la recherche se fait dans le dossier Configuration de l'utilisateur. Si aucun dossier
Temp n'a &eacute;t&eacute; trouv&eacute;, la fonction en cr&eacute;e un. Les fichiers partag&eacute;s qui ne sont pas transitoires doivent &ecirc;tre enregistr&eacute;s
dans le dossier Configuration/Shared.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Chemin d'acc&egrave;s au dossier, exprim&eacute; sous la forme d'une URL de type file://.
Derni&egrave;re mise &agrave; jour le 22/6/2011
282
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Exemple
La ligne de code ci-dessous renvoie le chemin d'acc&egrave;s complet au fichier sp&eacute;cifi&eacute;. Contrairement aux autres fonctions
Dreamweaver (telles que dreamweaver.getSiteRoot()), la fonction dw.getTempFolderPath() ne renvoie pas de
barre oblique (/) &agrave; la fin du chemin :
var myTempfile = dw.getTempFolderPath() + &quot;/myTempFile.txt&quot;;
dreamweaver.relativeToAbsoluteURL()
Disponibilit&eacute;
Dreamweaver 2.
Description
Si on lui fournit une URL relative et un point de r&eacute;f&eacute;rence donn&eacute;s (chemin d'acc&egrave;s au document actif ou racine du site),
cette fonction convertit l'URL relative en URL absolue (file://).
Arguments
docPath, siteRoot, relURL
• L'argument docPath correspond au chemin d'acc&egrave;s &agrave; un document sur l'ordinateur de l'utilisateur (le document
actif, par exemple), exprim&eacute; sous la forme d'une URL de type file://, ou &agrave; une cha&icirc;ne vide si relURL est une URL
relative &agrave; la racine.
• L'argument siteRoot est le chemin d'acc&egrave;s &agrave; la racine du site, exprim&eacute; sous la forme d'une URL de type file://, ou une
cha&icirc;ne vide si relURL est une URL relative &agrave; un document.
• L'argument relURL est l'URL &agrave; convertir.
Valeurs renvoy&eacute;es
URL absolue. La valeur renvoy&eacute;e est g&eacute;n&eacute;r&eacute;e conform&eacute;ment aux principes suivants :
• Si relURL est une URL absolue, aucune conversion n'a lieu et la valeur renvoy&eacute;e est identique &agrave; relURL.
• Si relURL est une URL relative &agrave; un document, la valeur renvoy&eacute;e est une combinaison de docPath et relURL.
• Si relURL est une URL relative &agrave; la racine, la valeur renvoy&eacute;e est une combinaison de siteRoot et relURL.
DWUri.isValidURI()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;termine si l'objet URI est valide ou non. L'objet URI n'est valide que lorsqu'il est construit ou initialis&eacute; avec l'URI
valide.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'URI est valide.
Derni&egrave;re mise &agrave; jour le 22/6/2011
283
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
DWUri.isAbsolute()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;termine si l'objet URI est un URI complet. L'objet URI n'est valide que lorsqu'il est construit ou initialis&eacute; avec l'URI
valide.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'URI est complet.
DWUri.isRelative()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;termine si l'objet URI est un URI relatif. L'objet URI n'est valide que lorsqu'il est construit ou initialis&eacute; avec l'URI
valide.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'URI est relatif.
DWUri.isDirectory()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;termine si l'objet URI est un r&eacute;pertoire. L'objet URI n'est valide que lorsqu'il est construit ou initialis&eacute; avec l'URI
valide.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'URI est un r&eacute;pertoire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
284
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
DWUri.isHierarchical()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;termine si l'objet URI est hi&eacute;rarchique. L'objet URI n'est valide que lorsqu'il est construit ou initialis&eacute; avec l'URI
valide.
Les objets URI hi&eacute;rarchiques pointent vers une ressource poss&eacute;dant une structure hi&eacute;rarchique et dont la hi&eacute;rarchie
peut &ecirc;tre travers&eacute;e, comme &laquo; http://undomaine/pi&egrave;ces/commandes/index.html &raquo;. Les objets URI non
hi&eacute;rarchiques ne peuvent pas &ecirc;tre travers&eacute;s. Exemple : &laquo; mailto:[email protected] &raquo; ou &laquo; about:blank &raquo;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'URI est hi&eacute;rarchique.
DWUri.isOfType()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;termine si l'objet URI poss&egrave;de le mod&egrave;le de type de service sp&eacute;cifi&eacute;. L'objet URI n'est valide que lorsqu'il est construit
ou initialis&eacute; avec l'URI valide.
Les mod&egrave;les de type de service sont par exemple &laquo; http &raquo;, &laquo; file &raquo; et &laquo; ftp &raquo;. Pour l'URI &laquo; http://www.adobe.com &raquo;,
&laquo; http &raquo; est le mod&egrave;le de type de service.
Arguments
type
L'argument type pr&eacute;cise le mod&egrave;le de type de service &agrave; tester.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'URI est conforme au mod&egrave;le de type de service sp&eacute;cifi&eacute;.
DWUri.isOfFileType()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;termine si l'objet URI pointe vers une ressource dont le type de fichier est bien le type sp&eacute;cifi&eacute;. L'objet URI n'est
valide que lorsqu'il est construit ou initialis&eacute; avec l'URI valide.
Derni&egrave;re mise &agrave; jour le 22/6/2011
285
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Pour l'URI &laquo; http://www.adobe.com/index.html &raquo;, &laquo; html &raquo; est le type de fichier.
Arguments
type
L'argument type pr&eacute;cise le mod&egrave;le de type de service &agrave; tester.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'URI pointe vers une ressource dont le type de fichier est bien le type sp&eacute;cifi&eacute;.
DWUri.getScheme()
Disponibilit&eacute;
Dreamweaver CS5.
Description
R&eacute;cup&egrave;re le mod&egrave;le de type de service. L'objet URI n'est valide que lorsqu'il est construit ou initialis&eacute; avec l'URI valide.
Pour l'URI &laquo; http://www.adobe.com/index.html &raquo;, &laquo; http &raquo; est le mod&egrave;le de type de service.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le mod&egrave;le de type de service de l'objet URI.
DWUri.getAuthority()
Disponibilit&eacute;
Dreamweaver CS5.
Description
R&eacute;cup&egrave;re l'autorit&eacute; de domaine. L'objet URI n'est valide que lorsqu'il est construit ou initialis&eacute; avec l'URI valide.
Pour l'URI &laquo; http://www.adobe.com/index.html &raquo;, &laquo; www.adobe.com &raquo; est l'autorit&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant l'autorit&eacute; de domaine de l'objet URI.
DWUri.getUsername()
Disponibilit&eacute;
Dreamweaver CS5.
Derni&egrave;re mise &agrave; jour le 22/6/2011
286
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Description
R&eacute;cup&egrave;re le nom d'utilisateur. L'objet URI n'est valide que lorsqu'il est construit ou initialis&eacute; avec l'URI valide.
Pour l'URI &laquo; ftp://[email protected] &raquo;, &laquo; jean &raquo; est le nom d'utilisateur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le nom d'utilisateur de l'objet URI.
DWUri.getPassword()
Disponibilit&eacute;
Dreamweaver CS5.
Description
R&eacute;cup&egrave;re le mot de passe. L'objet URI n'est valide que lorsqu'il est construit ou initialis&eacute; avec l'URI valide.
Pour l'URI &laquo; ftp://jean:[email protected] &raquo;, &laquo; xxx &raquo; est le mot de passe.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le mot de passe de l'objet URI.
DWUri.getServerPort()
Disponibilit&eacute;
Dreamweaver CS5.
Description
R&eacute;cup&egrave;re le port du serveur. L'objet URI n'est valide que lorsqu'il est construit ou initialis&eacute; avec l'URI valide.
Pour l'URI &laquo; http://www.adobe.com:8080 &raquo;, &laquo; 8080 &raquo; est le port.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le port du serveur de l'objet URI.
DWUri.getPath()
Disponibilit&eacute;
Dreamweaver CS5.
Derni&egrave;re mise &agrave; jour le 22/6/2011
287
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Description
R&eacute;cup&egrave;re le chemin d'acc&egrave;s qui fait partie du nom de fichier. L'objet URI n'est valide que lorsqu'il est construit ou
initialis&eacute; avec l'URI valide.
Pour l'URI &laquo; http://www.adobe.com/Dreamweaver/CS5/index.htm &raquo;, &laquo; /Dreamweaver/CS5/ &raquo; est le chemin
d'acc&egrave;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le chemin d'acc&egrave;s de l'objet URI.
DWUri.getQuery()
Disponibilit&eacute;
Dreamweaver CS5.
Description
R&eacute;cup&egrave;re la cha&icirc;ne de requ&ecirc;te. L'objet URI n'est valide que lorsqu'il est construit ou initialis&eacute; avec l'URI valide.
Pour l'URI &laquo; http://www.adobe.com/Dreamweaver/CS5/index.htm?q=1502 &raquo;, &laquo; q=1502 &raquo; est la cha&icirc;ne de
requ&ecirc;te.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant la cha&icirc;ne de requ&ecirc;te de l'objet URI.
DWUri.getFragment
Disponibilit&eacute;
Dreamweaver CS5.
Description
R&eacute;cup&egrave;re le fragment d'ancrage de l'URI. L'objet URI n'est valide que lorsqu'il est construit ou initialis&eacute; avec l'URI
valide.
Pour l'URI &laquo; http://www.adobe.com/Dreamweaver/CS5/index.htm#toc &raquo;, &laquo; toc &raquo; est le fragment d'ancrage.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le fragment d'ancrage de l'objet URI.
Derni&egrave;re mise &agrave; jour le 22/6/2011
288
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
DWUri.getNonHierarchical()
Disponibilit&eacute;
Dreamweaver CS5.
Description
R&eacute;cup&egrave;re la cha&icirc;ne d'URI non hi&eacute;rarchique. L'objet URI n'est valide que lorsqu'il est construit ou initialis&eacute; avec l'URI
valide.
Pour l'URI &laquo; mailto:[email protected] &raquo;, &laquo; [email protected] &raquo; est la partie non hi&eacute;rarchique.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant la cha&icirc;ne non hi&eacute;rarchique de l'objet URI.
DWUri.setScheme()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;finit le mod&egrave;le de type de service pour l'URI.
Le mod&egrave;le de type de service peut &ecirc;tre n'importe quelle valeur de cha&icirc;ne, mais il ne peut pas contenir des caract&egrave;res
sp&eacute;ciaux tels que &laquo; : &raquo;, &laquo; / &raquo; ou &laquo; \ &raquo;.
Arguments
scheme
L'argument scheme sp&eacute;cifie le mod&egrave;le de type de service.
Valeurs renvoy&eacute;es
Aucune.
DWUri.setAuthority()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;finit l'autorit&eacute; de domaine pour l'URI.
L'autorit&eacute; de domaine peut &ecirc;tre n'importe quelle valeur de cha&icirc;ne, mais elle ne peut pas contenir des caract&egrave;res
sp&eacute;ciaux tels que &laquo; : &raquo;, &laquo; / &raquo; ou &laquo; \ &raquo;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
289
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Arguments
authority
L'argument authority sp&eacute;cifie le nom ou l'adresse IP de l'autorit&eacute; de domaine.
Valeurs renvoy&eacute;es
Aucune.
DWUri.setUsername()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;finit le nom d'utilisateur de l'URI.
En r&egrave;gle g&eacute;n&eacute;rale, les noms d'utilisateur ne sont utilis&eacute;s que pour les mod&egrave;les de type de service FTP.
Arguments
username
L'argument sp&eacute;cifie le nom d'utilisateur.
Valeurs renvoy&eacute;es
Aucune.
DWUri.setPassword()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;finit le mot de passe de l'URI.
En r&egrave;gle g&eacute;n&eacute;rale, les mots de passe ne sont utilis&eacute;s que pour les mod&egrave;les de type de service FTP.
Arguments
password
Cet argument sp&eacute;cifie le mot de passe.
Valeurs renvoy&eacute;es
Aucune.
DWUri.setPath()
Disponibilit&eacute;
Dreamweaver CS5.
Derni&egrave;re mise &agrave; jour le 22/6/2011
290
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Description
D&eacute;finit le chemin qui fait partie du nom de fichier de l'URI.
Vous pouvez d&eacute;finir une cha&icirc;ne vide ou &laquo; / &raquo; comme chemin afin de fixer la racine comme chemin.
Arguments
path
L'argument sp&eacute;cifie le chemin qui fait partie du nom de fichier.
Valeurs renvoy&eacute;es
Aucune.
DWUri.setServerPort()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;finit le port de l'objet URI.
Chaque mod&egrave;le de type de service poss&egrave;de un port par d&eacute;faut, d&eacute;fini par les normes IETF. Utilisez cette fonction pour
ajouter un port non standard &agrave; l'URI. Le port doit &ecirc;tre une valeur num&eacute;rique entre 1 et 65535.
Arguments
port
L'argument sp&eacute;cifie le port du serveur.
Valeurs renvoy&eacute;es
Aucune.
DWUri.setQuery()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;finit la cha&icirc;ne de requ&ecirc;te de l'objet URI.
La fonction &laquo; DWUri.setQueryValue() &raquo; &agrave; la page 292 permet de ne modifier la valeur que d'un seul param&egrave;tre.
Arguments
query
Cet argument sp&eacute;cifie la cha&icirc;ne de requ&ecirc;te.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
291
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
DWUri.setFragment()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;finit la cha&icirc;ne de fragment d'ancrage de l'objet URI.
Arguments
anchor
Cet argument sp&eacute;cifie le nom de l'ancre.
Valeurs renvoy&eacute;es
Aucune.
DWUri.setNonHierarchical()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;finit la cha&icirc;ne non hi&eacute;rarchique de l'objet URI. L'appel de cette fonction efface les attributs hi&eacute;rarchiques de l'URI.
Arguments
nonHierarchical
Cet argument sp&eacute;cifie la cha&icirc;ne non hi&eacute;rarchique.
Valeurs renvoy&eacute;es
Aucune.
DWUri.getQueryValue()
Disponibilit&eacute;
Dreamweaver CS5.
Description
R&eacute;cup&egrave;re la valeur associ&eacute;e au nom URI transmis comme argument.
Pour l'URI &laquo; http://www.adobe.com/Dreamweaver/CS5/index.htm?q=1502 &raquo;, getQuery(&quot;q&quot;) renverra
&laquo; 1502 &raquo;. La demande d'une valeur pour un nom qui n'existe pas renverra une cha&icirc;ne vide.
Arguments
name
Cet argument sp&eacute;cifie le nom dans la requ&ecirc;te.
Derni&egrave;re mise &agrave; jour le 22/6/2011
292
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Valeurs renvoy&eacute;es
Valeur de cha&icirc;ne repr&eacute;sentant la valeur du nom dans la requ&ecirc;te.
DWUri.setQueryValue()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;finit le nom et la valeur associ&eacute;s &agrave; la cha&icirc;ne de requ&ecirc;te de l'URI. La d&eacute;finition d'une cha&icirc;ne vide comme valeur
supprimera le nom de la cha&icirc;ne de requ&ecirc;te.
Arguments
name
Cet argument sp&eacute;cifie le nom dans la requ&ecirc;te.
value
Cet argument sp&eacute;cifie la valeur du nom dans la requ&ecirc;te.
Valeurs renvoy&eacute;es
Aucune.
DWUri.getQueryByObject()
Disponibilit&eacute;
Dreamweaver CS5.
Description
R&eacute;cup&egrave;re l'objet de propri&eacute;t&eacute; de requ&ecirc;te de l'objet URI.
Les modifications apport&eacute;es &agrave; la carte de propri&eacute;t&eacute; ne sont r&eacute;percut&eacute;es dans l'objet URI que lorsque vous appelez la
fonction &laquo; DWUri.setQueryByObject() &raquo; &agrave; la page 292.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Objet
Carte de propri&eacute;t&eacute; de l'URI.
DWUri.setQueryByObject()
Disponibilit&eacute;
Dreamweaver CS5.
Derni&egrave;re mise &agrave; jour le 22/6/2011
293
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Description
Remplace la carte de propri&eacute;t&eacute; int&eacute;grale de l'objet URI par la carte sp&eacute;cifi&eacute;e.
Par exemple,
function main{
var referrer = new Object;
referrer.page = &quot;index.html&quot;;
referrer.user = &quot;jon&quot;;
DWUri uri = new DWUri;
uri.setQueryByObject ( referrer );
}
Arguments
objectMap
Carte de propri&eacute;t&eacute; de l'URI.
Valeurs renvoy&eacute;es
Aucune.
DWUri.getRelation()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;termine la relation entre 2 URI.
Arguments
other
L'URI &agrave; comparer. Sp&eacute;cifiez une cha&icirc;ne valide ou un objet DWUri.
Valeurs renvoy&eacute;es
Entier qui sp&eacute;cifie la constante de valeur de manifeste. Les constantes possibles sont les suivantes :
•
DWUri.NOT_REALTED
•
DWUri.CHILD
•
DWUri.EQUAL
•
DWUri.PARENT
DWUri.getCommonParent()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;termine le parent commun aux 2 URI.
Derni&egrave;re mise &agrave; jour le 22/6/2011
294
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
S'il n'existe aucun parent commun, cette fonction renverra un objet DWUri vide qui doit &ecirc;tre valid&eacute; en appelant la
fonction &laquo; DWUri.isValidURI() &raquo; &agrave; la page 282.
Arguments
other
L'URI &agrave; comparer. Sp&eacute;cifiez une cha&icirc;ne valide ou un objet DWUri.
Valeurs renvoy&eacute;es
Objet
Objet DWUri qui repr&eacute;sente le parent commun.
DWUri.makeAbsolute()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Construit un URI complet en employant l'URI transmis comme argument.
Arguments
other
Sp&eacute;cifiez une cha&icirc;ne valide ou un objet DWUri.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi.
DWUri.makeRelative()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Construit un URI relatif en trouvant le parent commun depuis l'URI transmis comme argument.
Arguments
other
Sp&eacute;cifiez une cha&icirc;ne valide ou un objet DWUri.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi.
Derni&egrave;re mise &agrave; jour le 22/6/2011
295
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
DWUri.chDir()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Passe au r&eacute;pertoire indiqu&eacute;. La cha&icirc;ne &laquo; .. &raquo; permet de passer au r&eacute;pertoire parent.
Arguments
dir
Sp&eacute;cifiez une cha&icirc;ne valide comme r&eacute;pertoire.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi.
DWUri.getFileName()
Disponibilit&eacute;
Dreamweaver CS5.
Description
R&eacute;cup&egrave;re le nom de fichier depuis l'objet URI.
Arguments
stripExtension
Valeur bool&eacute;enne : true pour supprimer l'extension du r&eacute;sultat. Choisissez false pour inclure l'extension dans le
r&eacute;sultat renvoy&eacute;. Le comportement par d&eacute;faut consiste &agrave; inclure l'extension. Cet argument est facultatif.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui sp&eacute;cifie le nom de fichier.
DWUri.getExtension()
Disponibilit&eacute;
Dreamweaver CS5.
Description
R&eacute;cup&egrave;re l'extension depuis l'objet URI.
Arguments
stripDot
Valeur bool&eacute;enne : true pour supprimer le point initial du r&eacute;sultat. Choisissez false pour inclure le point initial dans
le r&eacute;sultat renvoy&eacute;. Le comportement par d&eacute;faut consiste &agrave; inclure le point initial. Cet argument est facultatif.
Derni&egrave;re mise &agrave; jour le 22/6/2011
296
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Valeurs renvoy&eacute;es
Cha&icirc;ne qui sp&eacute;cifie l'extension.
DWUri.getLastPathComponent()
Disponibilit&eacute;
Dreamweaver CS5.
Description
R&eacute;cup&egrave;re la derni&egrave;re partie du composant de chemin d'acc&egrave;s du nom de fichier.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui sp&eacute;cifie la derni&egrave;re partie du chemin.
Pour l'URI &laquo; http://www.adobe.com/Dreamweaver/CS5/index.htm &raquo;, getLastPathComponent() renverra
&laquo; CS5 &raquo;.
DWUri.removeLastPathComponent()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Supprime la derni&egrave;re partie du composant de chemin d'acc&egrave;s du nom de fichier.
Pour l'URI &laquo; http://www.adobe.com/Dreamweaver/CS5/index.htm &raquo;, removeLastPathComponent() renverra
&laquo; CS5 &raquo; et supprimera cette cha&icirc;ne de l'URI.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui sp&eacute;cifie la derni&egrave;re partie du chemin.
DWUri.isUnderDirectory()
Disponibilit&eacute;
Dreamweaver CS5.
Description
D&eacute;termine si l'URI se trouve sous un URI parent sp&eacute;cifi&eacute;.
Notez que les comparaisons de noms de r&eacute;pertoire respectent toujours la casse.
Derni&egrave;re mise &agrave; jour le 22/6/2011
297
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Arguments
Cha&icirc;ne qui repr&eacute;sente l'URI parent.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'URI se trouve sous l'URI parent sp&eacute;cifi&eacute;.
DWUri.toLocalPath()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Convertit un URI poss&eacute;dant un mod&egrave;le de type de service &laquo; fichier &raquo; en cha&icirc;ne compatible avec un syst&egrave;me de fichiers.
La valeur renvoy&eacute;e est une cha&icirc;ne sp&eacute;cifique &agrave; la plate-forme. Chaque plate-forme repr&eacute;sente le nom de fichier
diff&eacute;remment.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui repr&eacute;sente un chemin de syst&egrave;me de fichiers qui peut &ecirc;tre utilis&eacute; pour ouvrir les fichiers &agrave; l'aide des API de
niveau syst&egrave;me. Cette cha&icirc;ne peut &ecirc;tre transmise comme argument &agrave; d'autres fonctions DWFile.
DWUri.localPathToURI()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Convertit un chemin d'acc&egrave;s &agrave; un fichier local en objet URI.
Arguments
Cha&icirc;ne qui sp&eacute;cifie le nom de fichier local devant &ecirc;tre cod&eacute; sous la forme d'un URI.
Valeurs renvoy&eacute;es
Aucune.
Fonctions relatives &agrave; la s&eacute;lection
Ces fonctions permettent d'obtenir et de d&eacute;finir la s&eacute;lection dans les documents ouverts. Pour savoir comment obtenir
et d&eacute;finir la s&eacute;lection dans le panneau Site, voir &laquo; Fonctions relatives aux sites &raquo; &agrave; la page 223.
Derni&egrave;re mise &agrave; jour le 22/6/2011
298
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
dom.getSelectedNode()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient le nœud s&eacute;lectionn&eacute;. Revient &agrave; appeler la fonction dom.getSelection() et &agrave; transmettre la valeur renvoy&eacute;e
&agrave; la fonction dom.offsetsToNode().
Arguments
Aucun.
Valeurs renvoy&eacute;es
Objet balise, texte ou commentaire contenant la s&eacute;rie de caract&egrave;res sp&eacute;cifi&eacute;e.
dom.getSelection()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient la s&eacute;lection, exprim&eacute;e en d&eacute;calages de caract&egrave;res, dans le code source du document.
Arguments
{bAllowMultiple}
• L'argument bAllowMultiple (facultatif) est une valeur bool&eacute;enne qui indique si la fonction doit renvoyer plusieurs
d&eacute;calages lorsque plusieurs calques, cellules de tableau ou zones r&eacute;actives de carte graphique sont s&eacute;lectionn&eacute;s.
Si cet argument n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Pour les s&eacute;lections simples, un tableau contenant deux nombres entiers. Le premier entier correspond au d&eacute;calage de
caract&egrave;res &agrave; l'ouverture de la s&eacute;lection. Le second correspond au d&eacute;calage de caract&egrave;res &agrave; la fermeture de la s&eacute;lection.
Si les deux valeurs sont identiques, la s&eacute;lection en cours correspond &agrave; un point d'insertion.
Pour les s&eacute;lections complexes (lorsque la s&eacute;lection se compose de plusieurs cellules de tableau, calques ou zones
r&eacute;actives de carte graphique), tableau contenant 2n nombres entiers, o&ugrave; n repr&eacute;sente le nombre d'&eacute;l&eacute;ments
s&eacute;lectionn&eacute;s. Le premier entier de chaque paire correspond au d&eacute;calage de caract&egrave;res de l'ouverture de la s&eacute;lection
(balise d'ouverture TD, DIV, SPAN, LAYER, ILAYER ou MAP comprise) ; le second entier correspond au d&eacute;calage de
caract&egrave;res &agrave; la fermeture de la s&eacute;lection (balise de fermeture TD, DIV, SPAN, LAYER, ILAYER ou MAP). Si plusieurs rang&eacute;es
d'un tableau sont s&eacute;lectionn&eacute;es, le d&eacute;calage de chaque cellule de chaque rang&eacute;e est renvoy&eacute;. La s&eacute;lection n'inclut jamais
les balises TR.
dom.getSelectorsDefinedInStylesheet()
Disponibilit&eacute;
Dreamweaver 8.
Derni&egrave;re mise &agrave; jour le 22/6/2011
299
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Description
Obtient un tableau de s&eacute;lecteurs correspondant au type transmis comme attribut.
Arguments
selector
• L'argument selector est une cha&icirc;ne dont la valeur est class ou ID. Il sp&eacute;cifie si la fonction renvoie des s&eacute;lecteurs
de type class ou ID.
Valeurs renvoy&eacute;es
Tableau de s&eacute;lecteurs pouvant &ecirc;tre de type class ou ID.
Exemple
Le code suivant permet d'obtenir un tableau de s&eacute;lecteurs de type class :
var dom=dw.getDocumentDOM();
var classSelectors = dom.getSelectorsDefinedInStylesheet('class');
Le code suivant permet d'obtenir un tableau de s&eacute;lecteurs de type ID :
var dom=dw.getDocumentDOM();
var classSelectors = dom.getSelectorsDefinedInStylesheet('ID');
dom.nodeToOffsets()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient la position d'un nœud donn&eacute; dans l'arborescence DOM, exprim&eacute;e en d&eacute;calages de caract&egrave;res dans le code
source du document. Fonction valide pour n'importe quel document sur un lecteur local.
Arguments
node
• L'argument node doit &ecirc;tre une balise, un commentaire ou un texte correspondant &agrave; un nœud de l'arborescence
renvoy&eacute;e par la fonction dreamweaver.getDocumentDOM().
Valeurs renvoy&eacute;es
Tableau qui contient deux nombres entiers. Le premier entier correspond au d&eacute;calage du d&eacute;but de la balise, du texte
ou du commentaire. Le second correspond au d&eacute;calage de la fin du nœud, par rapport au d&eacute;but du document HTML.
Exemple
L'exemple de code suivant s&eacute;lectionne le premier objet image du document actif :
var theDOM = dw.getDocumentDOM();
var theImg = theDOM.images[0];
var offsets = theDom.nodeToOffsets(theImg);
theDom.setSelection(offsets[0], offsets[1]);
Derni&egrave;re mise &agrave; jour le 22/6/2011
300
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
dom.offsetsToNode()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient l'objet de l'arborescence DOM qui contient la s&eacute;rie enti&egrave;re de caract&egrave;res situ&eacute;e entre l'ouverture et la fermeture
d&eacute;finies. Fonction valide pour n'importe quel document sur un lecteur local.
Arguments
offsetBegin, offsetEnd
• L'argument offsetBegin indique le d&eacute;calage depuis le d&eacute;but du document jusqu'au d&eacute;but d'une s&eacute;rie de caract&egrave;res
correspondant &agrave; un objet dans l'arborescence DOM.
• L'argument offsetEnd indique le d&eacute;calage depuis le d&eacute;but du document jusqu'&agrave; la fin d'une s&eacute;rie de caract&egrave;res
correspondant &agrave; un objet dans l'arborescence DOM.
Valeurs renvoy&eacute;es
Objet balise, texte ou commentaire contenant la s&eacute;rie de caract&egrave;res sp&eacute;cifi&eacute;e.
Exemple
Le code suivant affiche une alerte si la s&eacute;lection est une image.
var offsets = dom.getSelection();
var theSelection = dreamweaver.offsetsToNode(offsets[0], &not;
offsets[1]);
if (theSelection.nodeType == Node.ELEMENT_NODE &amp;&amp; &not;
theSelection.tagName == 'IMG'){
alert('The current selection is an image.');
}
dom.selectAll()
Disponibilit&eacute;
Dreamweaver 3.
Description
Effectue une op&eacute;ration S&eacute;lectionner tout.
Remarque : Dans la plupart des cas, cette fonction s&eacute;lectionne le contenu entier du document actif. Dans certains cas
toutefois (lorsque le point d'insertion se trouve dans un tableau, par exemple), elle ne s&eacute;lectionne qu'une partie du
document actif. Pour d&eacute;finir le document entier comme s&eacute;lection, utilisez la fonction dom.setSelection().
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
301
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
dom.getSelectedNode()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;finit le nœud s&eacute;lectionn&eacute;. Revient &agrave; appeler la fonction dom.nodeToOffsets() et &agrave; transmettre la valeur renvoy&eacute;e
&agrave; la fonction dom.setSelection().
Arguments
node, {bSelectInside}, {bJumpToNode}
• L'argument node est un nœud de texte, de commentaire ou d'&eacute;l&eacute;ment du document.
• L'argument bSelectInside (facultatif) est une valeur bool&eacute;enne qui indique s'il faut s&eacute;lectionner la propri&eacute;t&eacute;
innerHTML du nœud. Cet argument n'est pertinent que si node est un nœud d'&eacute;l&eacute;ment et qu'il prend par d&eacute;faut la
valeur false lorsqu'il n'est pas d&eacute;fini.
• L'argument bJumpToNode (facultatif) est une valeur bool&eacute;enne qui indique s'il faut, le cas &eacute;ch&eacute;ant, faire d&eacute;filer la
fen&ecirc;tre de document pour rendre la s&eacute;lection visible. S'il n'est pas d&eacute;fini, cet argument prend par d&eacute;faut la valeur
false.
Valeurs renvoy&eacute;es
Aucune.
dom.setSelection()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;finit le d&eacute;but et la fin de la s&eacute;lection dans le document.
Arguments
offsetBegin, offsetEnd
• Ces arguments correspondent respectivement &agrave; l'ouverture et &agrave; la fermeture de la nouvelle s&eacute;lection, exprim&eacute;es en
d&eacute;calages de caract&egrave;res dans le code source du document. Si les deux valeurs sont identiques, la nouvelle s&eacute;lection
correspond &agrave; un point d'insertion. Si la nouvelle s&eacute;lection n'est pas une s&eacute;lection HTML valide, elle inclut les
caract&egrave;res de la premi&egrave;re s&eacute;lection HTML valide. Par exemple, si offsetBegin et offsetEnd d&eacute;finissent
SRC=&quot;myImage.gif&quot; comme s&eacute;lection dans IMG SRC=&quot;myImage.gif&quot;, la s&eacute;lection est &eacute;tendue pour inclure
&eacute;galement la balise IMG.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
302
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
dreamweaver.nodeExists()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si la r&eacute;f&eacute;rence au nœud indiqu&eacute; est toujours valable. Il arrive souvent, lors de la r&eacute;daction d'extensions, que
vous fassiez r&eacute;f&eacute;rence &agrave; un nœud, puis que vous effectuiez une op&eacute;ration qui le supprime (comme d&eacute;finir la propri&eacute;t&eacute;
innerHTML ou outerHTML de son parent). Cette fonction permet de confirmer que le nœud n'a pas &eacute;t&eacute; supprim&eacute; avant
de commencer &agrave; faire r&eacute;f&eacute;rence &agrave; l'une de ses propri&eacute;t&eacute;s ou m&eacute;thodes. Le nœud r&eacute;f&eacute;renc&eacute; ne doit pas n&eacute;cessairement
se trouver dans le document actif.
Arguments
node
• L'argument node correspond au nœud &agrave; v&eacute;rifier.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le nœud existe, false dans le cas contraire.
Exemple
L'exemple ci-dessous permet d'obtenir le nœud en cours, de localiser un tableau, puis d'appeler la fonction
dw.nodeExists() afin de v&eacute;rifier si le nœud original existe encore :
function applyFormatToSelectedTable(){
// get current selection
var selObj = dw.getDocumentDOM().getSelectedNode();
alternateRows(dwscripts.findDOMObject(&quot;presetNames&quot;).selectedIndex,
findTable());
// restore original selection, if it still exists; if not, just select the
// table.
var selArr;
if (dw.nodeExists(selObj))
selArr = dom.nodeToOffsets(selObj);
else
selArr = dom.nodeToOffsets(findTable());
dom.setSelection(selArr[0],selArr[1]);
}
dreamweaver.selectAll()
Disponibilit&eacute;
Dreamweaver 3.
Description
Effectue une op&eacute;ration S&eacute;lectionner tout dans la fen&ecirc;tre de document active, dans le panneau Site ou, sur Macintosh,
dans le champ de texte actif d'une bo&icirc;te de dialogue ou d'un panneau flottant.
Derni&egrave;re mise &agrave; jour le 22/6/2011
303
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Remarque : Si l'op&eacute;ration est effectu&eacute;e dans le document actif, elle s&eacute;lectionne dans la plupart des cas le contenu entier
du document. Dans certains cas toutefois (lorsque le point d'insertion se trouve dans un tableau, par exemple), elle ne
s&eacute;lectionne qu'une partie du document. Pour d&eacute;finir le document entier comme s&eacute;lection, utilisez la fonction
dom.setSelection().
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canSelectAll() &raquo; &agrave; la page 518.
Fonctions de manipulation de cha&icirc;nes
Ces fonctions vous permettent d'obtenir des informations sur une cha&icirc;ne et de convertir une cha&icirc;ne Latin1 en code
national sur la plate-forme de l'utilisateur et vice versa.
dreamweaver.doURLEncoding()
Disponibilit&eacute;
Dreamweaver 1.
Description
Prend une cha&icirc;ne et renvoie une cha&icirc;ne convertie en URL en rempla&ccedil;ant tous les espaces et caract&egrave;res sp&eacute;ciaux par les
entit&eacute;s sp&eacute;cifi&eacute;es.
Arguments
stringToConvert
• L'argument stringToConvert est une cha&icirc;ne qui contient l'URL non cod&eacute;e qui est cod&eacute;e par la fonction.
Valeurs renvoy&eacute;es
Une cha&icirc;ne convertie en format d'URL.
Exemple
L'exemple suivant indique la valeur URL pour &quot;My URL-encoded string&quot; :
var URL = dw.doURLEncoding(theURL.value);
returns &quot;My%20URL-encoded%20string&quot;
dreamweaver.getTokens()
Disponibilit&eacute;
Dreamweaver 1.
Derni&egrave;re mise &agrave; jour le 22/6/2011
304
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Description
Accepte une cha&icirc;ne et la divise en expressions.
Arguments
searchString, separatorCharacters
• L'argument searchString est la cha&icirc;ne &agrave; diviser en expressions.
• L'argument separatorCharacters est le ou les caract&egrave;res indiquant la fin d'une expression. Les s&eacute;parateurs figurant
dans des cha&icirc;nes entre guillemets sont ignor&eacute;s. Tous les espaces &eacute;ventuellement contenus dans
separatorCharacters (les tabulations, par exemple) sont trait&eacute;s comme des s&eacute;parateurs, comme si vous les aviez
d&eacute;finis explicitement. Deux espaces cons&eacute;cutifs ou plus sont trait&eacute;s comme un seul s&eacute;parateur.
Valeurs renvoy&eacute;es
Tableau d'expressions.
Exemple
L'appel de la fonction dw.getTokens() ci-dessous renvoie les expressions indiqu&eacute;es &agrave; la suite :
dreamweaver.getTokens('foo(&quot;my arg1&quot;, 34)', '(),')
•
foo
•
&quot;my arg 1&quot;
•
34
dreamweaver.latin1ToNative()
Disponibilit&eacute;
Dreamweaver 2.
Description
Convertit une cha&icirc;ne Latin 1 en code national sur l'ordinateur de l'utilisateur. Cette fonction permet d'afficher
l'interface utilisateur d'un fichier d'extension dans une autre langue.
Remarque : Sous Windows, cette fonction est sans effet, car le code Windows repose sur Latin 1.
Arguments
stringToConvert
• L'argument stringToConvert est la cha&icirc;ne &agrave; convertir de Latin 1 en code national.
Valeurs renvoy&eacute;es
Cha&icirc;ne convertie.
dreamweaver.nativeToLatin1()
Disponibilit&eacute;
Dreamweaver 2.
Derni&egrave;re mise &agrave; jour le 22/6/2011
305
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
Description
Convertit une cha&icirc;ne de code national en code Latin 1.
Remarque : Sous Windows, cette fonction est sans effet, car le code Windows repose sur Latin 1.
Arguments
stringToConvert
• L'argument stringToConvert est la cha&icirc;ne &agrave; convertir du code national en code Latin 1.
Valeurs renvoy&eacute;es
Cha&icirc;ne convertie.
dreamweaver.scanSourceString()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Analyse une cha&icirc;ne de code HTML et recherche les balises, les attributs, les directives et le texte. Pour chaque balise,
attribut, directive et texte trouv&eacute;, la fonction scanSourceString() lance une fonction de rappel fournie par
l'appelant. Dreamweaver prend en charge les fonctions de rappel suivantes :
•
openTagBegin()
•
openTagEnd()
•
closeTagBegin()
•
closeTagEnd()
•
directive()
•
attribute()
•
text()
Dreamweaver appelle les sept fonctions de rappel dans les cas suivants :
• Dreamweaver appelle openTagBegin() pour chaque balise d'ouverture (par exemple &lt;font&gt;, et non &lt;/font&gt;) et
chaque balise vide (par exemple, &lt;img&gt; ou &lt;hr&gt;). La fonction openTagBegin() accepte deux arguments : le nom
de la balise &agrave; fermer (par exemple, &quot;font&quot; ou &quot;img&quot;) et le d&eacute;calage du document, qui correspond au nombre
d'octets contenus dans le document avant le d&eacute;but de la balise de fermeture. La fonction renvoie la valeur true si
l'analyse doit continuer et false si elle doit s'arr&ecirc;ter.
• Une fois openTagBegin() ex&eacute;cut&eacute;e, Dreamweaver appelle attribute() pour chaque attribut HTML. La fonction
attribute() accepte deux arguments: une cha&icirc;ne contenant le nom de l'attribut (par exemple &quot;color&quot; ou &quot;src&quot;)
et une cha&icirc;ne contenant la valeur de l'attribut (par exemple &quot;#000000&quot; ou &quot;foo.gif&quot;). La fonction attribute()
renvoie une valeur bool&eacute;enne indiquant si l'analyse doit continuer.
• Une fois que tous les attributs de la balise ont &eacute;t&eacute; analys&eacute;s, Dreamweaver appelle openTagEnd(). La fonction
openTagEnd() accepte un argument : le d&eacute;calage du document, qui est le nombre d'octets contenus dans le
document avant la fin de la balise d'ouverture. Elle renvoie une valeur bool&eacute;enne qui indique si l'analyse doit
continuer.
Derni&egrave;re mise &agrave; jour le 22/6/2011
306
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
• Dreamweaver appelle closeTagBegin() pour chaque balise de fermeture (par exemple &lt;/font&gt;). Cette fonction
accepte deux arguments: le nom de la balise &agrave; fermer (par exemple, &quot;font&quot;) et le d&eacute;calage du document, qui
correspond au nombre d'octets contenus dans le document avant le d&eacute;but de la balise de fermeture. La fonction
renvoie une valeur bool&eacute;enne qui indique si l'analyse doit continuer.
• Une fois closeTagBegin() termin&eacute;e, Dreamweaver appelle la fonction closeTagEnd(). La fonction
closeTagEnd() accepte un argument : le d&eacute;calage du document, qui correspond au nombre d'octets contenus dans
le document avant la fin de la balise de fermeture. Elle renvoie une valeur bool&eacute;enne qui indique si l'analyse doit
continuer.
• Dreamweaver appelle la fonction directive() pour chaque commentaire HTML, script ASP, script JSP ou script
PHP. La fonction directive() accepte deux arguments : une cha&icirc;ne contenant la directive et le d&eacute;calage du
document, qui correspond au nombre d'octets contenus dans le document avant la fin de la balise de fermeture. La
fonction renvoie une valeur bool&eacute;enne qui indique si l'analyse doit continuer.
• Dreamweaver appelle la fonction text() pour chaque portion de texte du document, c'est-&agrave;-dire tout ce qui n'est
pas une balise ni une directive. Les portions de texte incluent le texte qui n'est pas visible pour l'utilisateur, par
exemple le texte contenu &agrave; l'int&eacute;rieur d'une balise title ou option. La fonction text() accepte deux arguments:
une cha&icirc;ne contenant le texte et le d&eacute;calage du document, qui correspond au nombre d'octets contenus dans le
document avant la fermeture de la balise de fermeture. La fonction text() renvoie une valeur bool&eacute;enne qui
indique si l'analyse doit continuer.
Arguments
HTMLstr, parserCallbackObj
• L'argument HTMLstr est une cha&icirc;ne qui contient un code.
• L'argument parserCallbackObj est un objet JavaScript comportant une ou plusieurs des m&eacute;thodes suivantes :
openTagBegin(), openTagEnd(), closeTagBegin(), closeTagEnd(), directive(), attribute() et text().
Pour de meilleurs r&eacute;sultats, parserCallbackObj doit &ecirc;tre une biblioth&egrave;que partag&eacute;e d&eacute;finie &agrave; l'aide de l'interface
Extension C. Vous obtiendrez &eacute;galement de meilleures performances si la fonction parserCallbackObj d&eacute;finit
uniquement les fonctions de rappel dont elle a besoin.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si l'op&eacute;ration a r&eacute;ussi et false dans le cas contraire.
Exemple
La s&eacute;quence d'&eacute;tapes suivante offre un exemple d'utilisation de la fonction dreamweaver.scanSourceString() :
1 Cr&eacute;ez une impl&eacute;mentation pour une ou plusieurs des sept fonctions de rappel.
2 Ecrivez un script qui appelle la fonction dreamweaver.scanSourceString().
3 La fonction dreamweaver.scanSourceString() transmet une cha&icirc;ne contenant le code HTML et les pointeurs
des fonctions de rappel que vous avez &eacute;crits. Par exemple, supposons que la cha&icirc;ne HTML soit &lt;&quot;font
size=hello/font&gt;&quot;.
4 Dreamweaver analyse la cha&icirc;ne et d&eacute;termine si elle contient une balise de police. Dreamweaver appelle les fonctions
de rappel dans l'ordre suivant :
• Fonction openTagBegin()
• Fonction attribute() (pour l'attribut de taille)
• Fonction openTagEnd()
• Fonction text() (pour la cha&icirc;ne &quot;hello&quot;)
Derni&egrave;re mise &agrave; jour le 22/6/2011
307
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
• Fonctions closeTagBegin() et closeTagEnd()
Fonctions relatives &agrave; la traduction
Ces fonctions permettent d'agir directement sur les traducteurs de donn&eacute;es ou sur les r&eacute;sultats de la traduction. Elles
permettent d'ex&eacute;cuter ou d'obtenir des informations sur un traducteur, de modifier le contenu d'une r&eacute;gion verrouill&eacute;e
et de stipuler que le code traduit doit &ecirc;tre utilis&eacute; lors de l'obtention et de la d&eacute;finition de d&eacute;calages de s&eacute;lection.
dom.runTranslator()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction ex&eacute;cute le traducteur sp&eacute;cifi&eacute; sur le document. Cette fonction n'est valide que pour le document actif.
Arguments
translatorName
• L'argument translatorName est le nom d'un traducteur tel qu'il appara&icirc;t dans les pr&eacute;f&eacute;rences de traduction.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.editLockedRegions()
Disponibilit&eacute;
Dreamweaver 2.
Description
Selon la valeur de l'argument, autorise ou non la modification des r&eacute;gions verrouill&eacute;es. Par d&eacute;faut, les r&eacute;gions
verrouill&eacute;es ne peuvent pas &ecirc;tre modifi&eacute;es. Si vous tentez de modifier une r&eacute;gion verrouill&eacute;e avant de la rendre
modifiable avec cette fonction, Dreamweaver &eacute;met un bip et interdit la modification.
Remarque : La modification de r&eacute;gions verrouill&eacute;es peut avoir des cons&eacute;quences inattendues sur les &eacute;l&eacute;ments de
biblioth&egrave;que et les mod&egrave;les. N'utilisez cette fonction qu'avec les traducteurs de donn&eacute;es.
Arguments
bAllowEdits
• L'argument bAllowEdits est une valeur bool&eacute;enne : true indique que les modifications sont interdites et false le
contraire. Dreamweaver restaure automatiquement l'&eacute;tat par d&eacute;faut (non modifiable) des r&eacute;gions verrouill&eacute;es
lorsque l'ex&eacute;cution du script qui appelle la fonction prend fin.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
308
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
dreamweaver.getTranslatorList()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction obtient la liste des traducteurs de donn&eacute;es install&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes, chacune repr&eacute;sentant le nom d'un traducteur tel qu'il appara&icirc;t dans les pr&eacute;f&eacute;rences de traduction.
dreamweaver.useTranslatedSource()
Disponibilit&eacute;
Dreamweaver 2.
Description
Cette fonction indique les valeurs renvoy&eacute;es par dom.nodeToOffsets() et dom.getSelection(). Elles sont utilis&eacute;es
par dom.offsetsToNode() et dom.setSelection() et doivent &ecirc;tre d&eacute;cal&eacute;es dans le code source converti (code
HTML contenu dans l'arborescence DOM apr&egrave;s l'ex&eacute;cution du traducteur) et non dans le code source non converti.
Remarque : Cette fonction ne s'applique qu'aux fichiers de l'inspecteur Propri&eacute;t&eacute;s.
Arguments
bUseTranslatedSource
• L'argument bUseTranslatedSource est une valeur bool&eacute;enne : true si la fonction utilise des d&eacute;calages dans la source
traduite, et false si elle utilise la source non traduite.
La valeur par d&eacute;faut de l'argument est false. Lorsque le script appelant la fonction dw.useTranslatedSource()
prend fin, Dreamweaver utilise automatiquement le code source non converti pour les appels suivants de
dw.getSelection(), dw.setSelection(), dw.nodeToOffsets() et dw.offsetsToNode(), sauf si la fonction
dw.useTranslatedSource() est appel&eacute;e explicitement avec l'argument false avant la fin de l'ex&eacute;cution du
script.
Valeurs renvoy&eacute;es
Aucune.
Fonctions XSLT
Les fonctions XSLT permettent d'agir sur les fichiers XML. Elles permettent d'obtenir des informations sur les
documents XML, y compris l'arborescence de sch&eacute;mas ou la r&eacute;f&eacute;rence &agrave; un document XML, et invitent l'utilisateur &agrave;
indiquer le document XML associ&eacute; au document XSLT actif.
Derni&egrave;re mise &agrave; jour le 22/6/2011
309
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
MMXSLT.getXML()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Obtient une cha&icirc;ne de source XML pour un fichier XML.
Arguments
xmlSourceURI
• Cha&icirc;ne repr&eacute;sentant un URI vers un fichier XML. Cet URI peut &ecirc;tre absolu (http ou https), relatif au site ou relatif
au document.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant le contenu du fichier XML.
Exemple
var xmlSource = MMXSLT.getXML(this.fileDataSetURL);
MMXSLT.getXMLSchema()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction renvoie l'arborescence de sch&eacute;mas du fichier XML sp&eacute;cifi&eacute;.
Arguments
schemaURI, {bRefresh}
• L'argument obligatoire schemaURI est une cha&icirc;ne correspondant &agrave; une r&eacute;f&eacute;rence &agrave; un fichier XML local ou distant.
• L'argument facultatif bRefresh est une valeur bool&eacute;enne : true force l'actualisation du sch&eacute;ma et false renvoie la
copie du sch&eacute;ma &agrave; partir du cache de sch&eacute;mas XML. La valeur par d&eacute;faut est false.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant l'arborescence de sch&eacute;mas XML.
Exemple
L'exemple suivant obtient l'arborescence de sch&eacute;mas &agrave; partir du cache de sch&eacute;mas XML pour le fichier menus.xml :
var theSchema = MMXSLT.getXMLSchema(&quot;file:///c:/Program Files/Adobe/&not;
Adobe Dreamweaver CS5/Configuration/Menus/menus.xml&quot;&quot;);
Derni&egrave;re mise &agrave; jour le 22/6/2011
310
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
MMXSLT.getXMLSourceURI()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction obtient une r&eacute;f&eacute;rence au document source XML associ&eacute; au document XSLT actif.
Arguments
xsltfileURI, {bUseTempForRemote}
• L'argument xsltfileURI est une cha&icirc;ne correspondant &agrave; l'URI du fichier local qui pointe vers l'emplacement du
fichier XSL.
• L'argument facultatif bUseTempForRemote est une valeur bool&eacute;enne : true renvoie une r&eacute;f&eacute;rence au fichier XML
temporaire (par exemple file:///C:/Documents and Settings/username/Local Settings/Temporary
Internet Files/Content.IE5/GTSLQ9KZ/rss[1].xml) qui est t&eacute;l&eacute;charg&eacute; lorsque le fichier XML est distant
(par exemple http://myHost/rssfeed.xml) ; false renvoie une r&eacute;f&eacute;rence absolue.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant la r&eacute;f&eacute;rence au document source XML associ&eacute; au document XSLT actif. Si la r&eacute;f&eacute;rence &agrave; la
source XML est une r&eacute;f&eacute;rence distante, la fonction renvoie le chemin d'acc&egrave;s &agrave; l'emplacement temporaire du fichier
t&eacute;l&eacute;charg&eacute;.
Exemple
L'exemple suivant obtient la r&eacute;f&eacute;rence au document source XML associ&eacute; &agrave; c:\myxslt\myxsltdocument.xsl :
var theXMLSource = MMXSLT.getXMLSourceURI(&quot;file:///c:/myxslt/myxsltdocument.xsl&quot;);
MMXSLT.launchXMLSourceDialog()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction invite l'utilisateur &agrave; indiquer le document source XML associ&eacute; au document XSLT actif. L'utilisateur
peut choisir une r&eacute;f&eacute;rence soit locale soit distante &agrave; un document XML.
Arguments
{xsltfileURI}, {bUseTempForRemote}, {bAddSchemaReference}
• L'argument xsltfileURI est facultatif. Il s'agit d'une cha&icirc;ne correspondant &agrave; l'URI du fichier local qui pointe vers
l'emplacement du fichier XSL. Si cet argument n'est pas d&eacute;fini, il prend comme valeur par d&eacute;faut le document
actuellement ouvert.
• L'argument facultatif bUseTempForRemote est une valeur bool&eacute;enne : true renvoie une r&eacute;f&eacute;rence au fichier XML
temporaire (par exemple file:///C:/Documents and Settings/username/Local Settings/Temporary
Internet Files/Content.IE5/GTSLQ9KZ/rss[1].xml) qui est t&eacute;l&eacute;charg&eacute; lorsque le fichier XML est distant
(par exemple http://myHost/rssfeed.xml) ; false renvoie une r&eacute;f&eacute;rence absolue.
Derni&egrave;re mise &agrave; jour le 22/6/2011
311
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Document
• L'argument bAddSchemaReference est facultatif. Il ajoute une r&eacute;f&eacute;rence dans le document actif qui pointe vers l'URI
de la source XML sp&eacute;cifi&eacute;e dans la bo&icirc;te de dialogue de la source XML. Si cet argument n'est pas d&eacute;fini, il prend
comme valeur par d&eacute;faut le document actuellement ouvert.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant la r&eacute;f&eacute;rence au document source XML associ&eacute; au document XSLT actif. Si la r&eacute;f&eacute;rence &agrave; la
source XML est une r&eacute;f&eacute;rence distante, la fonction renvoie le chemin d'acc&egrave;s &agrave; l'emplacement temporaire du fichier
t&eacute;l&eacute;charg&eacute;.
Exemple
L'exemple suivant ouvre la bo&icirc;te de dialogue Document source XML sans indiquer de valeur :
MMXSLT.launchXMLSourceDialog()
Derni&egrave;re mise &agrave; jour le 22/6/2011
312
Chapitre 15 : Contenu de page
Les fonctions relatives au contenu de page d'Adobe&reg; Dreamweaver&reg; permettent d'effectuer des op&eacute;rations qui affectent
le contenu d'une page Web. Ces op&eacute;rations sont les suivantes :
• Manipulation d'actifs dans le panneau Actifs
• Ajout de comportements
• Manipulation d'&eacute;l&eacute;ments en les coupant et en les collant dans le Presse-papiers
• Application d'un mod&egrave;le
• Insertion d'un fragment de code
• Cr&eacute;ation d'ensembles de donn&eacute;es XML Spry
• Modification am&eacute;lior&eacute;e de Spry et d'autres widgets
• Insertion de widgets
• Cr&eacute;ation de mises en page qui fonctionnent dans divers navigateurs, gr&acirc;ce aux fonctions de v&eacute;rification de la
compatibilit&eacute; avec les navigateurs
Fonctions du panneau Actifs
Ces fonctions, programm&eacute;es dans l'API comme panneau d'actifs, vous permettent de g&eacute;rer et d'utiliser les &eacute;l&eacute;ments
contenus dans le panneau Actifs (mod&egrave;les, biblioth&egrave;ques, images, contenu Adobe Shockwave et Adobe Flash, URL,
couleurs et scripts).
dreamweaver.assetPalette.addToFavoritesFrom Document()
Disponibilit&eacute;
Dreamweaver 4.
Description
Ajoute l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; dans la fen&ecirc;tre de document &agrave; la liste des favoris. Cette fonction prend uniquement en
charge les images, les fichiers Shockwave, les fichiers Flash, les couleurs de police et les URL.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.assetPalette.addToFavoritesFromSiteAssets()
Disponibilit&eacute;
Dreamweaver 4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
313
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Description
Ajoute les &eacute;l&eacute;ments s&eacute;lectionn&eacute;s dans la liste des sites &agrave; la liste des favoris et donne &agrave; chaque &eacute;l&eacute;ment un surnom. Cette
fonction ne supprime pas les &eacute;l&eacute;ments de la liste des sites.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.assetPalette.addToFavoritesFromSiteWindow()
Disponibilit&eacute;
Dreamweaver 4.
Description
Ajoute les &eacute;l&eacute;ments s&eacute;lectionn&eacute;s dans le panneau Site &agrave; la liste des favoris. Cette fonction ne prend en charge que les
images, les films, les scripts, les fichiers Shockwave et les fichiers FLA. Si d'autres dossiers ou fichiers sont s&eacute;lectionn&eacute;s,
ils sont ignor&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.assetPalette.copyToSite()
Disponibilit&eacute;
Dreamweaver 4.
Description
Copie les &eacute;l&eacute;ments s&eacute;lectionn&eacute;s dans un autre site et les place dans la liste des favoris de celui-ci. Si ces &eacute;l&eacute;ments sont
des fichiers (autres que des couleurs ou des URL), le fichier r&eacute;el est copi&eacute; dans ce site.
Arguments
targetSite.
• L'argument targetSite est le nom du site cible renvoy&eacute; par l'appel site.getSites().
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
314
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
dreamweaver.assetPalette.edit()
Disponibilit&eacute;
Dreamweaver 4.
Description
Modifie les &eacute;l&eacute;ments s&eacute;lectionn&eacute;s &agrave; l'aide de l'&eacute;diteur externe principal ou de la commande d'&eacute;dition personnalis&eacute;e.
Pour les couleurs, le s&eacute;lecteur de couleur s'affiche. S'il s'agit d'URL, une bo&icirc;te de dialogue invite l'utilisateur &agrave; entrer
une URL et un surnom. Cette fonction n'est pas disponible pour la liste de couleurs et les URL du site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.assetPalette.canEdit() &raquo; &agrave; la page 511.
dreamweaver.assetPalette.getSelectedCategory()
Disponibilit&eacute;
Dreamweaver 4.
Description
Renvoie la cat&eacute;gorie s&eacute;lectionn&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
La cat&eacute;gorie actuellement s&eacute;lectionn&eacute;e, qui peut &ecirc;tre l'une des suivantes : &quot;templates&quot;, &quot;library&quot;, &quot;images&quot;,
&quot;movies&quot;, &quot;shockwave&quot;, &quot;flash&quot;, &quot;scripts&quot;, &quot;colors&quot; ou &quot;urls&quot;.
dreamweaver.assetPalette.getSelectedItems()
Disponibilit&eacute;
Dreamweaver 4.
Description
Renvoie un tableau des &eacute;l&eacute;ments s&eacute;lectionn&eacute;s dans le panneau Actifs, soit dans la liste des sites, soit dans celle des
favoris.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
315
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Valeurs renvoy&eacute;es
Tableau de trois cha&icirc;nes pour chaque &eacute;l&eacute;ment s&eacute;lectionn&eacute; :
• La cha&icirc;ne name est le nom, le nom de fichier ou le surnom qui s'affiche dans le panneau Actifs.
• La cha&icirc;ne value est le chemin entier, l'URL compl&egrave;te ou la valeur chromatique, selon l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;.
• La cha&icirc;ne type, qui peut &ecirc;tre &quot;folder&quot; ou l'une des cat&eacute;gories suivantes : &quot;templates&quot;,
&quot;library&quot;, &quot;images&quot;,
&quot;movies&quot;, &quot;shockwave&quot;, &quot;flash&quot;, &quot;scripts&quot;, &quot;colors&quot; ou &quot;urls&quot;.
Remarque : Si aucun &eacute;l&eacute;ment n'est s&eacute;lectionn&eacute; dans le panneau Actifs, cette fonction renvoie un tableau contenant une
seule cha&icirc;ne vide.
Exemple
Si &laquo; URL &raquo; est la cat&eacute;gorie et que le dossier &laquo; MyFolderName &raquo; et l'URL &laquo; MyFavoriteURL &raquo; sont s&eacute;lectionn&eacute;s dans la
liste des favoris, la fonction renvoie :
items[0]
items[1]
items[2]
items[3]
items[4]
items[5]
=
=
=
=
=
=
&quot;MyFolderName&quot;
&quot;//path/FolderName&quot;
&quot;folder&quot;
&quot;MyFavoriteURL&quot;
&quot;http://www.MyFavoriteURL.com&quot;
&quot;urls&quot;
dreamweaver.assetPalette.getSelectedView()
Disponibilit&eacute;
Dreamweaver 4.
Description
Indique quelle liste est affich&eacute;e dans le panneau Actifs.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Renvoie une cha&icirc;ne comportant la valeur &quot;site&quot; ou &quot;favorites&quot;.
dreamweaver.assetPalette.insertOrApply()
Disponibilit&eacute;
Dreamweaver 4.
Description
Ins&egrave;re les &eacute;l&eacute;ments s&eacute;lectionn&eacute;s ou applique l'&eacute;l&eacute;ment &agrave; la s&eacute;lection en cours. Cette fonction applique des mod&egrave;les, des
couleurs et des URL &agrave; la s&eacute;lection. Elle ins&egrave;re &eacute;galement des URL et d'autres &eacute;l&eacute;ments au niveau du point d'insertion.
Si aucun document n'est ouvert, la fonction n'est pas disponible.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
316
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.assetPalette.canInsertOrApply() &raquo; &agrave; la page 512.
dreamweaver.assetPalette.locateInSite()
Disponibilit&eacute;
Dreamweaver 4.
Description
S&eacute;lectionne les fichiers associ&eacute;s aux &eacute;l&eacute;ments s&eacute;lectionn&eacute;s du c&ocirc;t&eacute; local du panneau Site. Cette fonction n'est pas
applicable aux couleurs ni aux URL. Elle est disponible dans la liste des sites et la liste des favoris. Si un dossier est
s&eacute;lectionn&eacute; dans la liste des favoris, il est ignor&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.assetPalette.newAsset()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cr&eacute;e un nouvel &eacute;l&eacute;ment correspondant &agrave; la cat&eacute;gorie en cours dans la liste des favoris. Dans le cas des biblioth&egrave;ques et
des mod&egrave;les, l'&eacute;l&eacute;ment cr&eacute;&eacute; est un nouveau fichier de biblioth&egrave;que ou de mod&egrave;le vierge auquel l'utilisateur peut
imm&eacute;diatement attribuer un nom. Pour les couleurs, le s&eacute;lecteur de couleur s'affiche. S'il s'agit d'URL, une bo&icirc;te de
dialogue invite l'utilisateur &agrave; entrer une URL et un surnom. Cette fonction n'est pas disponible pour les images, les
fichiers Shockwave, les fichiers Flash ou les scripts.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.assetPalette.newFolder()
Disponibilit&eacute;
Dreamweaver 4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
317
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Description
Cr&eacute;e un nouveau dossier ayant un nom par d&eacute;faut (sans nom) dans la cat&eacute;gorie en cours et place une zone de texte
autour du nom. Cette fonction est uniquement disponible dans la liste des favoris.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.assetPalette.recreateLibraryFrom Document()
Disponibilit&eacute;
Dreamweaver 4.
Description
Remplace l'ancienne fonction libraryPalette, recreateLibraryFromDocument(). Il remplace un fichier
d'&eacute;l&eacute;ment de biblioth&egrave;que (Library item ou LBI) pour l'instance s&eacute;lectionn&eacute;e d'un &eacute;l&eacute;ment de biblioth&egrave;que dans le
document actif. Revient &agrave; cliquer sur Cr&eacute;er &agrave; nouveau dans l'inspecteur Propri&eacute;t&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.assetPalette.refreshSiteAssets()
Disponibilit&eacute;
Dreamweaver 4.
Description
Analyse le site, affiche la liste des sites et y ajoute des donn&eacute;es.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.assetPalette.removeFromFavorites()
Disponibilit&eacute;
Dreamweaver 4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
318
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Description
Supprime les &eacute;l&eacute;ments s&eacute;lectionn&eacute;s de la liste des favoris. Cette fonction ne supprime pas les fichiers du disque, sauf
dans le cas d'une biblioth&egrave;que ou d'un mod&egrave;le o&ugrave; l'utilisateur est invit&eacute; &agrave; confirmer l'op&eacute;ration avant que le fichier ne
soit supprim&eacute;. Cette fonction est uniquement disponible dans la liste des favoris ou si la cat&eacute;gorie est Library ou
Templates.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.assetPalette.renameNickname()
Disponibilit&eacute;
Dreamweaver 4.
Description
Affiche une zone de texte autour du nom du dossier ou du surnom du fichier pour pouvoir le modifier. Cette fonction
est uniquement disponible dans la liste des favoris ou pour la cat&eacute;gorie Library ou Template.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.assetPalette.setSelectedCategory()
Disponibilit&eacute;
Dreamweaver 4.
Description
Affiche une cat&eacute;gorie diff&eacute;rente.
Arguments
categoryType.
• L'argument categoryType peut &ecirc;tre l'une des cat&eacute;gories suivantes : &quot;templates&quot;, &quot;library&quot;, &quot;images&quot;,
&quot;movies&quot;, &quot;shockwave&quot;, &quot;flash&quot;, &quot;scripts&quot;, &quot;colors&quot; ou &quot;urls&quot;.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
319
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
dreamweaver.assetPalette.setSelectedView()
Disponibilit&eacute;
Dreamweaver 4.
Description
Passe de la liste des sites &agrave; la liste des favoris et vice versa.
Arguments
viewType.
• L'argument viewType est une cha&icirc;ne qui peut &ecirc;tre &quot;site&quot; ou &quot;favorites&quot;.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.referencePalette.getFontSize()
Disponibilit&eacute;
Dreamweaver 4.
Description
Renvoie la taille de police actuelle de la zone d'affichage du panneau R&eacute;f&eacute;rence.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Les tailles de police relatives exprim&eacute;es par les valeurs small, medium ou large.
dreamweaver.referencePalette.setFontSize()
Disponibilit&eacute;
Dreamweaver 4.
Description
Modifie la taille de police affich&eacute;e dans le panneau R&eacute;f&eacute;rence.
Arguments
fontSize.
• L'argument fontSize est l'une des tailles relatives suivantes : small, medium ou large.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
320
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Fonctions relatives aux comportements
Ces fonctions vous permettent d'associer des comportements &agrave; un objet ou de les en dissocier, d'identifier les
comportements associ&eacute;s &agrave; un objet, d'obtenir des informations sur un objet auquel est associ&eacute; un comportement, etc.
Les m&eacute;thodes de l'objet dreamweaver.behaviorInspector contr&ocirc;lent ou agissent uniquement sur la s&eacute;lection dans
le panneau Comportements et non sur la s&eacute;lection dans le document actif.
dom.addBehavior()
Disponibilit&eacute;
Dreamweaver 3.
Description
Associe un nouveau couple &eacute;v&eacute;nement/action (comportement) &agrave; l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;. Cette fonction n'est valide que
pour le document actif.
Arguments
event, action, {eventBasedIndex}
• L'argument event est le gestionnaire d'&eacute;v&eacute;nements JavaScript &agrave; utiliser pour associer le comportement &agrave; l'&eacute;l&eacute;ment
(par exemple, onClick, onMouseOver ou onLoad).
• L'argument action est l'appel de fonction qui serait renvoy&eacute; par applyBehavior() si l'action &eacute;tait ajout&eacute;e &agrave; l'aide
du panneau Comportements (par exemple, &quot;MM_popupMsg('Hello World')&quot;).
• L'argument facultatif eventBasedIndex est la position &agrave; laquelle cette action doit &ecirc;tre ajout&eacute;e. L'argument
eventBasedIndex est un index de r&eacute;f&eacute;rence z&eacute;ro. Par cons&eacute;quent, s'il existe d&eacute;j&agrave; deux actions associ&eacute;es &agrave; l'&eacute;v&eacute;nement
en question et que vous sp&eacute;cifiez eventBasedIndex comme &eacute;tant l'action 1, cette derni&egrave;re sera ins&eacute;r&eacute;e et ex&eacute;cut&eacute;e
entre les deux autres. Si vous ne d&eacute;finissez pas cet argument, l'action est ins&eacute;r&eacute;e &agrave; la suite des actions d&eacute;j&agrave; associ&eacute;es
&agrave; l'&eacute;v&eacute;nement sp&eacute;cifi&eacute;.
Valeurs renvoy&eacute;es
Aucune.
dom.getBehavior()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient l'action qui se trouve &agrave; la position indiqu&eacute;e dans l'&eacute;v&eacute;nement sp&eacute;cifi&eacute;. Cette fonction agit sur la s&eacute;lection en
cours et n'est valide que pour le document actif.
Arguments
event, {eventBasedIndex}
• L'argument event est le gestionnaire d'&eacute;v&eacute;nements JavaScript &agrave; utiliser pour associer le comportement &agrave; l'&eacute;l&eacute;ment
(par exemple, onClick, onMouseOver ou onLoad).
Derni&egrave;re mise &agrave; jour le 22/6/2011
321
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
• L'argument facultatif eventBasedIndex est la position de l'action &agrave; obtenir. Par exemple, si deux actions sont
associ&eacute;es &agrave; l'&eacute;v&eacute;nement sp&eacute;cifi&eacute;, 0 est la premi&egrave;re et 1 la seconde. Si cet argument n'est pas d&eacute;fini, la fonction renvoie
toutes les actions associ&eacute;es &agrave; l'&eacute;v&eacute;nement sp&eacute;cifi&eacute;.
Valeurs renvoy&eacute;es
Cha&icirc;ne repr&eacute;sentant l'appel de fonction (par exemple
&quot;MM_swapImage('document.Image1','document.Image1','foo.gif','#933292969950')&quot;) ou tableau de
cha&icirc;nes, si vous n'avez pas d&eacute;fini l'argument eventBasedIndex.
dom.reapplyBehaviors()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si les fonctions associ&eacute;es aux appels de comportement sur le nœud sp&eacute;cifi&eacute; sont pr&eacute;sentes dans la section HEAD
du document et, dans le cas contraire, les y ins&egrave;re.
Arguments
elementNode.
• L'argument elementNode est un nœud d'&eacute;l&eacute;ment du document actif. Si cet argument n'est pas d&eacute;fini, Dreamweaver
recherche les appels de comportement orphelins sur tous les nœuds d'&eacute;l&eacute;ment du document.
Valeurs renvoy&eacute;es
Aucune.
dom.removeBehavior()
Disponibilit&eacute;
Dreamweaver 3.
Description
Supprime l'action qui se trouve &agrave; la position indiqu&eacute;e dans l'&eacute;v&eacute;nement sp&eacute;cifi&eacute;. Cette fonction agit sur la s&eacute;lection en
cours et n'est valide que pour le document actif.
Arguments
event, {eventBasedIndex}
• L'argument event est le gestionnaire d'&eacute;v&eacute;nements JavaScript &agrave; utiliser pour associer le comportement &agrave; l'&eacute;l&eacute;ment
(par exemple, onClick, onMouseOver ou onLoad). Si cet argument n'est pas d&eacute;fini, toutes les actions sont
supprim&eacute;es de l'&eacute;l&eacute;ment.
• L'argument facultatif eventBasedIndex est la position de l'action &agrave; supprimer. Par exemple, si deux actions sont
associ&eacute;es &agrave; l'&eacute;v&eacute;nement sp&eacute;cifi&eacute;, 0 est la premi&egrave;re et 1 la seconde. Si cet argument n'est pas d&eacute;fini, toutes les actions
associ&eacute;es &agrave; l'&eacute;v&eacute;nement s&eacute;lectionn&eacute; sont supprim&eacute;es.
Derni&egrave;re mise &agrave; jour le 22/6/2011
322
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.getBehaviorElement()
Disponibilit&eacute;
Dreamweaver 2, mise &agrave; jour dans CS4.
Description
Obtient l'objet DOM correspondant &agrave; la balise &agrave; laquelle le comportement est appliqu&eacute;. Cette fonction ne s'applique
qu'aux fichiers d'action de comportement.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Un objet DOM ou une valeur null. Cette fonction renvoie la valeur null dans les cas suivants :
• lorsque le script en cours d'ex&eacute;cution n'est pas actif dans le contexte du panneau Comportements ;
• lorsque dreamweaver.popupAction() d&eacute;marre le script en cours d'ex&eacute;cution ;
• lorsque le panneau Comportements associe un &eacute;v&eacute;nement &agrave; un empaqueteur de lien et que ce dernier n'existe pas ;
• lorsque cette fonction se trouve en dehors d'un fichier d'action.
Exemple
La fonction dreamweaver.getBehaviorElement() peut &ecirc;tre utilis&eacute;e de la m&ecirc;me fa&ccedil;on que
&laquo; dreamweaver.getBehaviorTag() &raquo; &agrave; la page 323 afin de d&eacute;terminer si l'action s&eacute;lectionn&eacute;e est appropri&eacute;e pour la
balise HTML s&eacute;lectionn&eacute;e. Elle s'en distingue par le fait qu'elle donne acc&egrave;s &agrave; plus d'informations au sujet de la balise
et de ses attributs. Si vous &eacute;crivez une action qui ne peut &ecirc;tre appliqu&eacute;e qu'&agrave; un lien hypertexte (A HREF) qui ne prend
pas pour cible un autre cadre ou une autre fen&ecirc;tre, vous pouvez utiliser la fonction getBehaviorElement(). Vous
pouvez utiliser la fonction getBehaviorElement() au sein de la fonction qui initialise l'interface utilisateur pour la bo&icirc;te
de dialogue Param&egrave;tres. Ce principe est illustr&eacute; dans l'exemple suivant :
function initializeUI(){
var theTag = dreamweaver.getBehaviorElement();
var CANBEAPPLIED = (theTag.tagName == &quot;A&quot; &amp;&amp; &not;
theTag.getAttribute(&quot;HREF&quot;) != null &amp;&amp; &not;
theTag.getAttribute(&quot;TARGET&quot;) == null);
if (CANBEAPPLIED) {
// display the action user interface
} else{
// display a helpful message that tells the user
// that this action can only be applied to a
// link without an explicit target]
}
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
323
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
dreamweaver.getBehaviorTag()
Disponibilit&eacute;
Dreamweaver 1.2.
Description
Obtient la source de la balise &agrave; laquelle le comportement est appliqu&eacute;. Cette fonction ne s'applique qu'aux fichiers
d'action.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne repr&eacute;sentant la source de la balise. Il s'agit de la cha&icirc;ne transmise &agrave; la fonction canAcceptBehavior() sous forme
d'argument (HTMLelement). Si cette fonction appara&icirc;t en dehors d'un fichier d'action, la valeur renvoy&eacute;e est une cha&icirc;ne vide.
Exemple
Si vous cr&eacute;ez une action qui ne peut &ecirc;tre appliqu&eacute;e qu'&agrave; un lien hypertexte (A HREF), vous pouvez utiliser la fonction
getBehaviorTag(), comme indiqu&eacute; dans l'exemple suivant, dans la fonction qui initialise l'interface utilisateur de la
bo&icirc;te de dialogue Param&egrave;tres :
function initializeUI(){
var theTag = dreamweaver.getBehaviorTag().toUpperCase();
var CANBEAPPLIED = (theTag.indexOf('HREF') != -1));
if (CANBEAPPLIED) {
// display the action UI
} else{
// display a helpful message that tells the user
// that this action can only be applied to a
// hyperlink
}
}
dreamweaver.popupAction()
Disponibilit&eacute;
Dreamweaver 2, mise &agrave; jour dans CS4.
Description
Lance une bo&icirc;te de dialogue de param&egrave;tres correspondant &agrave; l'action de comportement sp&eacute;cifi&eacute;e. Pour l'utilisateur, cela
revient &agrave; s&eacute;lectionner l'action dans le menu d&eacute;roulant des actions du panneau Comportements. Cette fonction permet
aux fichiers d'extension autres que des actions d'associer des comportements aux objets dans le document de
l'utilisateur. L'utilisateur ne peut effectuer aucune autre modification tant qu'il n'a pas ferm&eacute; la bo&icirc;te de dialogue.
Remarque : Cette fonction peut &ecirc;tre appel&eacute;e au sein de la fonction objectTag() ou dans tout script de fichier de
commande ou dans le fichier de l'inspecteur Propri&eacute;t&eacute;s.
Derni&egrave;re mise &agrave; jour le 22/6/2011
324
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Arguments
actionName, {funcCall}
• L'argument actionName est une cha&icirc;ne qui contient le nom d'un fichier dans le dossier
Configuration/Behaviors/Actions. Ce fichier contient une action de comportement JavaScript (par exemple, &laquo; Swap
Image.htm &raquo;).
• L'argument facultatif funcCall est une cha&icirc;ne contenant un appel de fonction pour l'action d&eacute;finie dans
actionName (par exemple, &quot;MM_SwapImage(...)&quot;). La fonction applyBehavior() du fichier d'action fournit cet
argument, s'il a &eacute;t&eacute; sp&eacute;cifi&eacute;.
Valeurs renvoy&eacute;es
Appel de fonction de l'action de comportement. Lorsque l'utilisateur clique sur OK dans la bo&icirc;te de dialogue
Param&egrave;tres, le comportement est ajout&eacute; au document actuel. Les fonctions appropri&eacute;es sont ajout&eacute;es &agrave; la section HEAD
du document. Du code HTML est ajout&eacute; &agrave; la section BODY et d'autres modifications peuvent &ecirc;tre apport&eacute;es au
document. L'appel de fonction (&quot;MM_SwapImage(...)&quot;, par exemple) n'est pas ajout&eacute; au document ; il devient la valeur
renvoy&eacute;e par cette fonction.
dreamweaver.behaviorInspector.getBehaviorAt()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient le couple &eacute;v&eacute;nement/action (comportement) qui se trouve &agrave; la position indiqu&eacute;e dans le panneau
Comportements.
Arguments
positionIndex.
• L'argument positionIndex est la position de l'action dans le panneau Comportements. La premi&egrave;re action de la liste
est &agrave; la position 0.
Valeurs renvoy&eacute;es
Tableau constitu&eacute; de deux &eacute;l&eacute;ments :
• un gestionnaire d'&eacute;v&eacute;nements ;
• un appel de fonction ou une instruction JavaScript.
Exemple
positionIndex &eacute;tant un index en base z&eacute;ro, si le panneau Comportements affiche la liste, un appel de la fonction
dreamweaver.behaviorInspector.getBehaviorAt(2) renvoie un tableau contenant deux &eacute;l&eacute;ments :
&quot;onMouseOver&quot; et &quot;MM_changeProp('document.moon','document.moon','src','sun.gif','MG')&quot;.
dreamweaver.behaviorInspector.getBehaviorCount()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
325
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Description
Compte le nombre d'actions associ&eacute;es &agrave; l'&eacute;l&eacute;ment actuellement s&eacute;lectionn&eacute; &agrave; l'aide de gestionnaires d'&eacute;v&eacute;nements.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Nombre entier qui repr&eacute;sente le nombre d'actions attach&eacute;es &agrave; l'&eacute;l&eacute;ment. Ce nombre est &eacute;quivalent au nombre d'actions
visibles dans le panneau Comportements et comprend les actions de comportement Dreamweaver et le code JavaScript
personnalis&eacute;.
Exemple
Un appel &agrave; la fonction dreamweaver.behaviorInspector.getBehaviorCount() pour le lien s&eacute;lectionn&eacute; &lt;A
HREF=&quot;javascript:setCookie()&quot; onClick=&quot;MM_popupMsg('Un cookie a &eacute;t&eacute;
d&eacute;fini.');parent.rightframe.location.href='aftercookie.html'&gt;&quot; renvoie la valeur 2.
dreamweaver.behaviorInspector.getSelectedBehavior()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient la position de l'action s&eacute;lectionn&eacute;e dans le panneau Comportements.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Un nombre entier qui repr&eacute;sente la position de l'action s&eacute;lectionn&eacute;e dans le panneau Comportements ou –1 si aucune
action n'est s&eacute;lectionn&eacute;e.
Exemple
Si la premi&egrave;re action du panneau Comportements est s&eacute;lectionn&eacute;e, un appel de la fonction
dreamweaver.behaviorInspector.getSelectedBehavior() renvoie 0.
dreamweaver.behaviorInspector.moveBehaviorDown()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place une action de comportement vers le bas, &agrave; l'int&eacute;rieur d'une s&eacute;quence, en modifiant son ordre d'ex&eacute;cution au
sein d'un &eacute;v&eacute;nement.
Derni&egrave;re mise &agrave; jour le 22/6/2011
326
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Arguments
positionIndex.
• L'argument positionIndex est la position de l'action dans le panneau Comportements. La premi&egrave;re action de la liste
est &agrave; la position 0.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'appel de la fonction dreamweaver.behaviorInspector.moveBehaviorDown(2) inverse les positions des actions
Pr&eacute;charger les images et Changer la propri&eacute;t&eacute; de l'&eacute;v&eacute;nement onMouseDown. Pour toute autre position, la fonction
dreamweaver.behaviorInspector.moveBehaviorDown() n'a aucun effet, car un seul comportement est associ&eacute;
aux &eacute;v&eacute;nements onClick et onFocus et le comportement figurant &agrave; la position 3 se trouve d&eacute;j&agrave; &agrave; la fin du groupe
onMouseDown.
Voir aussi
&laquo; dreamweaver.behaviorInspector.getSelectedBehavior() &raquo; &agrave; la page 325
Derni&egrave;re mise &agrave; jour le 22/6/2011
327
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
dreamweaver.behaviorInspector.moveBehaviorUp()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place un comportement vers le haut, &agrave; l'int&eacute;rieur d'une s&eacute;quence, en modifiant son ordre d'ex&eacute;cution au sein d'un
&eacute;v&eacute;nement.
Arguments
positionIndex.
• L'argument positionIndex est la position de l'action dans le panneau Comportements. La premi&egrave;re action de la liste
est &agrave; la position 0.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
328
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Exemple
L'appel de la fonction dreamweaver.behaviorInspector.moveBehaviorUp(3) inverse les positions des actions
Pr&eacute;charger les images et Changer la propri&eacute;t&eacute; de l'&eacute;v&eacute;nement onMouseOver. Pour toute autre position, la fonction
dreamweaver.behaviorInspector.moveBehaviorUp() n'a aucun effet, car un seul comportement est associ&eacute; aux
&eacute;v&eacute;nements onClick et onFocus et le comportement figurant &agrave; la position 2 se trouve d&eacute;j&agrave; au d&eacute;but du groupe
onMouseDown.
Voir aussi
&laquo; dreamweaver.behaviorInspector.getSelectedBehavior() &raquo; &agrave; la page 325
dreamweaver.behaviorInspector.setSelectedBehavior()
Disponibilit&eacute;
Dreamweaver 3.
Description
S&eacute;lectionne l'action qui se trouve &agrave; la position indiqu&eacute;e dans le panneau Comportements.
Derni&egrave;re mise &agrave; jour le 22/6/2011
329
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Arguments
positionIndex.
• L'argument positionIndex est la position de l'action dans le panneau Comportements. La premi&egrave;re action de la liste
est &agrave; la position 0. Pour d&eacute;s&eacute;lectionner toutes les actions, sp&eacute;cifiez l'index de position (positionIndex) sur –1.
Sp&eacute;cifier une position &agrave; laquelle ne correspond aucune action revient &agrave; sp&eacute;cifier –1.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'appel de la fonction dreamweaver.behaviorInspector.setSelection(2) s&eacute;lectionne l'action Changer la
propri&eacute;t&eacute; qui est associ&eacute;e &agrave; l'&eacute;v&eacute;nement onMouseDown :
Voir aussi
&laquo; dreamweaver.behaviorInspector.getSelectedBehavior() &raquo; &agrave; la page 325
Derni&egrave;re mise &agrave; jour le 22/6/2011
330
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Presse-papiers, fonctions
Ces fonctions permettent de copier, de couper et de coller des informations &agrave; l'aide du Presse-papiers. Sur un
ordinateur Macintosh, certaines fonctions du Presse-papiers peuvent &eacute;galement &ecirc;tre appliqu&eacute;es aux champs de texte
des bo&icirc;tes de dialogue et des panneaux flottants. Dans ce cas, elles peuvent &ecirc;tre impl&eacute;ment&eacute;es en tant que m&eacute;thodes de
l'objet dreamweaver ou en tant que m&eacute;thodes de l'objet DOM. La version dreamweaver de cette fonction agit sur la
s&eacute;lection dans la fen&ecirc;tre active : la fen&ecirc;tre de document actuelle, l'inspecteur de code ou le panneau Site. Sur un
ordinateur Macintosh, la fonction peut &eacute;galement &ecirc;tre appliqu&eacute;e au contenu s&eacute;lectionn&eacute; d'une zone de texte s'il s'agit
du champ en cours. La version DOM de la fonction agit toujours sur la s&eacute;lection dans le document sp&eacute;cifi&eacute;.
dom.clipCopy()
Disponibilit&eacute;
Dreamweaver 3.
Description
Copie la s&eacute;lection dans le Presse-papiers avec toutes les balises HTML correspondantes.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.clipCopyText()
Disponibilit&eacute;
Dreamweaver 3.
Description
Copie le texte s&eacute;lectionn&eacute; dans le Presse-papiers sans les balises HTML correspondantes.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canClipCopyText() &raquo; &agrave; la page 502.
dom.clipCut()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
331
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Description
Coupe la s&eacute;lection et la place dans le Presse-papiers, avec toutes les balises HTML correspondantes.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.clipPaste()
Disponibilit&eacute;
Dreamweaver 3.
Description
Colle le contenu du Presse-papiers dans le document actif, au niveau du point d'insertion ou par dessus la s&eacute;lection en
cours. Si le Presse-papiers contient des balises HTML, celles-ci sont interpr&eacute;t&eacute;es comme telles.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canClipPaste() &raquo; &agrave; la page 502.
Exemple
Si le Presse-papiers contient ABC Widgets, un appel &agrave; la fonction dw.getDocumentDOM().clipPaste() produira le
r&eacute;sultat suivant :
Derni&egrave;re mise &agrave; jour le 22/6/2011
332
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
dreamweaver.clipCopy()
Disponibilit&eacute;
Dreamweaver 3.
Description
Copie la s&eacute;lection &agrave; partir de la fen&ecirc;tre de document, la bo&icirc;te de dialogue, le panneau Site ou le panneau flottant en
cours dans le Presse-papiers.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canClipCopy() &raquo; &agrave; la page 512.
dreamweaver.clipCut()
Disponibilit&eacute;
Dreamweaver 3.
Description
Supprime la s&eacute;lection dans la fen&ecirc;tre de document, la bo&icirc;te de dialogue, le panneau Site ou le panneau flottant actif
pour la placer dans le Presse-papiers.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canClipCut() &raquo; &agrave; la page 512.
dreamweaver.clipPaste()
Disponibilit&eacute;
Dreamweaver 3. Ajout de l'argument strPasteOption dans Dreamweaver8.
Description
Colle le contenu du Presse-papiers dans la fen&ecirc;tre de document, la bo&icirc;te de dialogue, le panneau flottant ou le panneau
Site actif.
Derni&egrave;re mise &agrave; jour le 22/6/2011
333
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Arguments
{strPasteOption}
• L'argument facultatif strPasteOption indique le type de collage &agrave; effectuer. Les valeurs sont &quot;text&quot;, &quot;structured&quot;,
&quot;basicFormat&quot; ou &quot;fullFormat&quot;.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canClipPaste() &raquo; &agrave; la page 513.
Exemple
L'exemple suivant colle le contenu du Presse-papiers sous forme de texte :
dw.clipPaste(&quot;text&quot;);
dreamweaver.getClipboardText()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient tout le texte m&eacute;moris&eacute; dans le Presse-papiers.
Arguments
{bAsText}
• La valeur bool&eacute;enne facultative bAsText sp&eacute;cifie si le contenu du Presse-papiers est extrait sous forme de texte. Si
bAsText a la valeur true, le contenu du Presse-papiers est extrait sous forme de texte. Si bAsText a la valeur false,
le contenu conserve sa mise en forme. Par d&eacute;faut, cet argument renvoie la valeur false.
Valeurs renvoy&eacute;es
Cha&icirc;ne repr&eacute;sentant le contenu du Presse-papiers (il peut s'agir de balises HTML) ou, si le Presse-papiers est vide, rien
ne se passe.
Exemple
si dreamweaver.getClipboardText() renvoie &quot;text &lt;b&gt;bold&lt;/b&gt; text&quot;,
dreamweaver.getClipboardText(true) renvoie &quot;text bold text&quot;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
334
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Fonctions relatives aux &eacute;l&eacute;ments de biblioth&egrave;que et aux
mod&egrave;les
Ces fonctions permettent d'effectuer des op&eacute;rations associ&eacute;es aux &eacute;l&eacute;ments de biblioth&egrave;que et aux mod&egrave;les, telles que
la cr&eacute;ation, la mise &agrave; jour et la rupture de liens entre un document et un &eacute;l&eacute;ment de la biblioth&egrave;que ou un mod&egrave;le. Les
m&eacute;thodes de l'objet dreamweaver.libraryPalette contr&ocirc;lent ou agissent sur la s&eacute;lection dans les &eacute;l&eacute;ments de
biblioth&egrave;que du panneau Actifs, et non dans le document actif. De m&ecirc;me, les m&eacute;thodes de l'objet
dreamweaver.templatePalette contr&ocirc;lent ou agissent sur la s&eacute;lection dans les objets de mod&egrave;le du panneau Actifs.
dom.applyTemplate()
Disponibilit&eacute;
Dreamweaver 3.
Description
Applique un mod&egrave;le au document actif. Si vous ne sp&eacute;cifiez aucun argument, la bo&icirc;te de dialogue S&eacute;lectionner le
mod&egrave;le s'affiche. Cette fonction n'est valide que pour le document actif.
Arguments
{templateURL}, bMaintainLink
• L'argument templateURL est le chemin d'un mod&egrave;le disponible sur le site en cours, exprim&eacute; sous la forme d'une
URL de type file://.
• L'argument bMaintainLink est une valeur bool&eacute;enne qui indique si le lien au mod&egrave;le d'origine doit &ecirc;tre conserv&eacute;
(true) ou non (false).
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canApplyTemplate() &raquo; &agrave; la page 501.
dom.detachFromLibrary()
Disponibilit&eacute;
Dreamweaver 3.
Description
Rompt le lien entre l'instance actuellement s&eacute;lectionn&eacute;e d'un &eacute;l&eacute;ment de biblioth&egrave;que et le fichier LBI qui lui est associ&eacute;
en supprimant les balises de verrouillage autour de la s&eacute;lection. Revient &agrave; cliquer sur D&eacute;tacher de l'original dans
l'inspecteur Propri&eacute;t&eacute;s.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
335
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Valeurs renvoy&eacute;es
Aucune.
dom.detachFromTemplate()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;tache le document actif du mod&egrave;le qui lui est associ&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.getAttachedTemplate()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient le chemin du mod&egrave;le associ&eacute; au document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient le chemin d'acc&egrave;s du mod&egrave;le, exprim&eacute; sous la forme d'une URL de type file://.
dom.getEditableRegionList()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient la liste des r&eacute;gions modifiables dans le corps du document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de nœuds d'&eacute;l&eacute;ment.
Derni&egrave;re mise &agrave; jour le 22/6/2011
336
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Exemple
&laquo; dom.getSelectedEditableRegion() &raquo; &agrave; la page 336.
dom.getIsLibraryDocument()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si le document est un &eacute;l&eacute;ment de biblioth&egrave;que.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne qui indique si le document est un fichier LBI.
dom.getIsTemplateDocument()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si le document est un mod&egrave;le.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne qui indique si le document est un fichier DWT.
dom.getSelectedEditableRegion()
Disponibilit&eacute;
Dreamweaver 3.
Description
Si la s&eacute;lection ou le point d'insertion se trouve &agrave; l'int&eacute;rieur d'une r&eacute;gion modifiable, cette fonction obtient la position
de cette derni&egrave;re parmi toutes celles qui existent dans le corps du document.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
337
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Valeurs renvoy&eacute;es
Un index dans le tableau renvoy&eacute; par la fonction dom.getEditbableRegionList(). Pour plus d’informations, voir
&laquo; dom.getEditableRegionList() &raquo; &agrave; la page 335.
Exemple
Le code suivant affiche une bo&icirc;te de dialogue pr&eacute;sentant le contenu de la r&eacute;gion modifiable s&eacute;lectionn&eacute;e :
var theDOM = dw.getDocumentDOM();
var edRegs = theDOM.getEditableRegionList();
var selReg = theDOM.getSelectedEditableRegion();
alert(edRegs[selReg].innerHTML);
dom.insertLibraryItem()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ins&egrave;re une instance d'un &eacute;l&eacute;ment de biblioth&egrave;que dans le document.
Arguments
libraryItemURL.
• L'argument libraryItemURL est le chemin d'acc&egrave;s &agrave; un fichier LBI, exprim&eacute; sous la forme d'une URL de type file://.
Valeurs renvoy&eacute;es
Aucune.
dom.markSelectionAsEditable()
Disponibilit&eacute;
Dreamweaver 3.
Description
Affiche la bo&icirc;te de dialogue Nouvelle r&eacute;gion modifiable. Lorsque l'utilisateur clique sur Nouvelle r&eacute;gion, Dreamweaver
marque la s&eacute;lection comme &eacute;tant modifiable et laisse le texte tel quel.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canMarkSelectionAsEditable() &raquo; &agrave; la page 507.
Derni&egrave;re mise &agrave; jour le 22/6/2011
338
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
dom.newEditableRegion()
Disponibilit&eacute;
Dreamweaver 3.
Description
Affiche la bo&icirc;te de dialogue Nouvelle r&eacute;gion modifiable. Lorsque l'utilisateur clique sur Nouvelle r&eacute;gion, Dreamweaver
ins&egrave;re le nom de la r&eacute;gion dans le document, entre accolades ({ }), &agrave; l'emplacement du point d'insertion.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canMakeNewEditableRegion() &raquo; &agrave; la page 507.
dom.removeEditableRegion()
Disponibilit&eacute;
Dreamweaver 3.
Description
Supprime une r&eacute;gion modifiable du document. Si cette r&eacute;gion poss&egrave;de un contenu, celui-ci est conserv&eacute; ; seuls les
marqueurs de r&eacute;gion modifiable sont supprim&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canRemoveEditableRegion() &raquo; &agrave; la page 508.
dom.updateCurrentPage()
Disponibilit&eacute;
Dreamweaver 3.
Description
Met &agrave; jour les mod&egrave;les ou les &eacute;l&eacute;ments de biblioth&egrave;que du document, ou les deux. Cette fonction n'est valide que pour
le document actif.
Derni&egrave;re mise &agrave; jour le 22/6/2011
339
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Arguments
{typeOfUpdate}
• L'argument facultatif typeOfUpdate doit &ecirc;tre &quot;library&quot;, &quot;template&quot; ou &quot;both&quot;. S'il n'est pas d&eacute;fini, il prend par
d&eacute;faut la valeur &quot;both&quot;.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.updatePages()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Mettre &agrave; jour les pages et s&eacute;lectionne les options sp&eacute;cifi&eacute;es.
Arguments
{typeOfUpdate}
• L'argument facultatif typeOfUpdate, si vous le sp&eacute;cifiez, doit &ecirc;tre &quot;library&quot;, &quot;template&quot; ou &quot;both&quot;. S'il n'est pas
d&eacute;fini, il prend par d&eacute;faut la valeur &quot;both&quot;.
Valeurs renvoy&eacute;es
Aucune.
Fonctions du panneau Fragments de code
Avec Dreamweaver, les d&eacute;veloppeurs Web peuvent modifier et enregistrer des blocs de code r&eacute;utilisables dans le
panneau Fragments de code, puis les extraire si besoin est.
Le panneau Fragments de code stocke chaque fragment de code dans un fichier CSN enregistr&eacute; dans le dossier
Configuration\Snippets. Les fragments de code fournis avec Dreamweaver sont stock&eacute;s dans les dossiers suivants :
• Accessible
• Comments
• Content_tables
• Filelist.txt
• Footers
• Form_elements
• Headers
• Javascript
• Meta
• Navigation
• Text
Derni&egrave;re mise &agrave; jour le 22/6/2011
340
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Les fichiers de fragment de code sont des documents XML. Par cons&eacute;quent, vous pouvez sp&eacute;cifier le codage dans la
directive XML de la mani&egrave;re suivante :
&lt;?XML version=&quot;1.0&quot; encoding=&quot;utf-8&quot;&gt;
Voici un exemple de fichier de fragment de code :
&lt;snippet name=&quot;Detect Flash&quot; description=&quot;VBscript to check for Flash ActiveX control&quot;
preview=&quot;code&quot; factory=&quot;true&quot; type=&quot;wrap&quot; &gt;
&lt;insertText location=&quot;beforeSelection&quot;&gt;
&lt;![CDATA[ ------- code --------- ]]&gt;
&lt;/insertText&gt;
&lt;insertText location=&quot;afterSelection&quot;&gt;
&lt;![CDATA[ ------- code --------- ]]&gt;
&lt;/insertText&gt;
&lt;/snippet&gt;
Les balises de fragment de code des fichiers CSN ont les attributs suivants :
Attribut
Description
name
Nom du fragment de code
description
Description du fragment de code
preview
Type d'aper&ccedil;u : code&quot; pour afficher le fragment de code dans la zone d'aper&ccedil;u ou &quot;design&quot; pour
afficher le fragment de code rendu en code HTML dans la zone d'aper&ccedil;u.
type
&quot;wrap&quot; si le fragment de code sert &agrave; envelopper la s&eacute;lection de l'utilisateur, &quot;block&quot; si le fragment
de code doit &ecirc;tre ins&eacute;r&eacute; avant la s&eacute;lection.
Vous pouvez faire appel aux m&eacute;thodes suivantes pour ajouter les fonctions du panneau Fragments de code &agrave; vos
extensions.
dreamweaver.snippetPalette.getCurrentSnippetPath()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Renvoie le chemin du fragment actuellement s&eacute;lectionn&eacute; dans le panneau Fragments de code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Chemin, selon le dossier Snippets, du fragment actuellement s&eacute;lectionn&eacute; dans le panneau Fragments de code. Renvoie
une cha&icirc;ne vide si aucun fragment n'est s&eacute;lectionn&eacute;.
dreamweaver.snippetPalette.newFolder()
Disponibilit&eacute;
Dreamweaver MX.
Derni&egrave;re mise &agrave; jour le 22/6/2011
341
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Description
Cr&eacute;e un nouveau dossier ayant un nom par d&eacute;faut (sans titre) et place une zone de texte autour du nom.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.snippetPalette.newSnippet()
Disponibilit&eacute;
Dreamweaver MX.
Description
Ouvre la bo&icirc;te de dialogue Ajouter un fragment de code et l'affiche au premier plan.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.snippetPalette.editSnippet()
Disponibilit&eacute;
Dreamweaver MX.
Description
Ouvre la bo&icirc;te de dialogue Modifier le fragment de code et l'affiche au premier plan pour que vous puissiez modifier
l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.snippetpalette.canEditSnippet() &raquo; &agrave; la page 528.
dreamweaver.snippetPalette.insert()
Disponibilit&eacute;
Dreamweaver MX.
Derni&egrave;re mise &agrave; jour le 22/6/2011
342
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Description
Applique le fragment s&eacute;lectionn&eacute; dans le panneau Fragment de code &agrave; la s&eacute;lection en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.snippetpalette.canInsert() &raquo; &agrave; la page 529.
dreamweaver.snippetPalette.insertSnippet()
Disponibilit&eacute;
Dreamweaver MX.
Description
Ins&egrave;re le fragment s&eacute;lectionn&eacute; dans la s&eacute;lection en cours.
Arguments
path
• Cha&icirc;ne sp&eacute;cifiant le chemin du fragment par rapport au dossier Snippets.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne.
Activateur
Voir &laquo; dreamweaver.snippetpalette.canInsert() &raquo; &agrave; la page 529.
Exemple
L'appel de la fonction dw.snippetPalette.insertSnippet() ins&egrave;re le fragment de code &agrave; l'emplacement sp&eacute;cifi&eacute;
par l'argument dans le document actif, au point d'insertion :
dw.snippetPalette.insertSnippet('Text\\Different_Link_Color.csn');
dreamweaver.snippetPalette.rename()
Disponibilit&eacute;
Dreamweaver MX.
Description
Affiche une zone de texte autour du nom du dossier ou du surnom du fichier s&eacute;lectionn&eacute; pour permettre de le
modifier.
Derni&egrave;re mise &agrave; jour le 22/6/2011
343
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.snippetPalette.remove()
Disponibilit&eacute;
Dreamweaver MX.
Description
Supprime l'&eacute;l&eacute;ment ou le dossier s&eacute;lectionn&eacute; du panneau Fragment de code et supprime le fichier du disque.
Valeurs renvoy&eacute;es
Aucune.
Fonctions de modification de widgets Spry
Dreamweaver CS5 fournit des fonctions de modification avanc&eacute;es pour les widgets Spry et autres widgets dynamiques.
element.getTranslatedAttribute()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Cette fonction est la m&ecirc;me que la fonction getAttribute() du W3C, mais agit sur les attributs traduits. La fonction
element.getTranslatedAttribute() extrait une valeur d'attribut en fonction du nom.
Arguments
name
• L'argument name est une cha&icirc;ne de type DOMString correspondant au nom de l'attribut &agrave; extraire.
Valeurs renvoy&eacute;es
Renvoie le nom de l'attribut sous forme de cha&icirc;ne DOMString. Si l'attribut n'a pas de valeur sp&eacute;cifi&eacute;e ni de valeur par
d&eacute;faut, cette fonction renvoie une cha&icirc;ne vide.
element.removeTranslatedAttribute()
Disponibilit&eacute;
Dreamweaver CS3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
344
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Description
Cette fonction est la m&ecirc;me que la fonction removeAttribute() du W3C, mais agit sur les attributs traduits. La
fonction element.removeTranslatedAttribute() supprime un attribut en fonction du nom. Si l'attribut poss&egrave;de
une valeur par d&eacute;faut, l'attribut qui s'affiche contient la valeur par d&eacute;faut ainsi que l'URI d'espace de nom, le nom local
et le pr&eacute;fixe correspondants, le cas &eacute;ch&eacute;ant.
Arguments
name
• L'argument name est une cha&icirc;ne de type DOMString correspondant au nom de l'attribut &agrave; supprimer.
Valeurs renvoy&eacute;es
Aucune.
element.setTranslatedAttribute()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Cette fonction est la m&ecirc;me que la fonction setAttribute() du W3C, mais agit sur les attributs traduits. La fonction
element.setTranslatedAttribute() ajoute un nouvel attribut avec la valeur sp&eacute;cifi&eacute;e. Si un attribut ayant le nom
sp&eacute;cifi&eacute; existe d&eacute;j&agrave; dans l'&eacute;l&eacute;ment, sa valeur est remplac&eacute;e par celle qui est sp&eacute;cifi&eacute;e dans l'argument value.
L'argument value est une cha&icirc;ne simple ; il n'est pas analys&eacute; du fait qu'il est en cours de d&eacute;finition. Par cons&eacute;quent,
toute syntaxe incluse dans la cha&icirc;ne est trait&eacute;e en tant que texte simple et doit &ecirc;tre ignor&eacute;e de fa&ccedil;on appropri&eacute;e par
l'impl&eacute;mentation lorsqu'elle sera &eacute;crite.
Pour affecter une valeur d'attribut contenant de la syntaxe devant &ecirc;tre reconnue en tant que r&eacute;f&eacute;rence d'entit&eacute;, vous
devez cr&eacute;er un nœud Attr ainsi que des nœuds Text et EntityReference, cr&eacute;er l'arborescence secondaire appropri&eacute;e
et utiliser setAttributeNode afin de l'affecter en tant que valeur d'un attribut.
Arguments
name, value
• L'argument name est une cha&icirc;ne de type DOMString correspondant au nom de l'attribut &agrave; cr&eacute;er ou &agrave; modifier.
• L'argument value est une cha&icirc;ne de type DOMString correspondant &agrave; la valeur &agrave; d&eacute;finir pour l'attribut.
Valeurs renvoy&eacute;es
Aucune.
element.translatedClassName
Disponibilit&eacute;
Dreamweaver CS3.
Description
Cette fonction est identique &agrave; element.ClassName() mais agit sur l'attribut className traduit.
Derni&egrave;re mise &agrave; jour le 22/6/2011
345
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
element.translatedStyle
Disponibilit&eacute;
Dreamweaver CS3.
Description
Cette fonction est identique &agrave; element.style() mais agit sur l'attribut de style traduit.
Exemple
var div1 = dom.getElementById(&quot;div1&quot;);
div1.translatedStyle.display = &quot;none&quot;;
Insertion de fonctions relatives aux widgets Spry
Dreamweaver fournit les fonctions suivantes pour faciliter l'insertion de widgets Spry.
dom.addJavaScript()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Cette fonction indique &agrave; Dreamweaver d'ins&eacute;rer un bloc JavaScript soit dans la section head, soit dans la section body.
Si le point d'insertion est &agrave; l'int&eacute;rieur de la section body, le bloc JavaScript sera ins&eacute;r&eacute; juste avant la balise &lt;/body&gt;. Si
le document contient d&eacute;j&agrave; un bloc JavaScript &agrave; cet endroit, Dreamweaver n'ins&eacute;rera pas de nouvelle balise &lt;script&gt;,
mais ajoutera &quot;code&quot; au contenu du &lt;script&gt;.
Arguments
code, insideHead
• L'argument code est une cha&icirc;ne contenant le code JavaScript &agrave; ins&eacute;rer dans la page.
• L'argument insideHead est une valeur bool&eacute;enne indiquant si le bloc JavaScript doit &ecirc;tre ins&eacute;r&eacute; dans la section
head ou dans la section body. La valeur par d&eacute;faut est true ; elle sp&eacute;cifie l'insertion du code dans la section head. Si
la valeur est false, le code est ins&eacute;r&eacute; dans la section body juste avant &lt;/body&gt;. Cet argument est facultatif.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
346
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Exemple
function objectTag()
{
.
.
.
var dom = dw.getDocumentDOM();
var id = dwscripts.getUniqueId(&quot;accordion&quot;);
var code = &quot;new Accordion('&quot; + id + &quot;',250,{duration:200,step:20})&quot;;
dom.addJavaScript(code, false);
return retVal;
}
dom.copyAssets()
Disponibilit&eacute;
Dreamweaver CS3, mise &agrave; jour dans CS4.
Description
Un auteur d'extension peut utiliser cette API pour copier des fichiers d&eacute;pendants externes sur le site de l'utilisateur. Il
peut &eacute;galement ajouter les r&eacute;f&eacute;rences requises au fichier dans l'en-t&ecirc;te de la page.
Arguments
assetArray
Tableau d'objets JavaScript. Chaque objet JavaScript poss&egrave;de des champs srcURL, destURL, referenceType,
useDefaultFolder et documentRelative.
• L'argument srcURL est un chemin d'acc&egrave;s &agrave; l'actif, exprim&eacute; sous la forme d'une URL file://.
• L'argument destURL est un chemin d'acc&egrave;s relatif qui d&eacute;finit la destination de la copie de l'actif. Ce &agrave; quoi destURL
est relatif d&eacute;pend de la valeur de useDefaultFolder. Si useDefaultFolder a la valeur true, le chemin est relatif
au dossier Asset par d&eacute;faut. Si useDefaultFolder a la valeur false, le chemin est relatif &agrave; la racine du site. Si le
site n'est pas d&eacute;fini, le chemin est relatif au document. Reportez-vous &agrave; la description de useDefaultFolder.
• L'argument referenceType est n&eacute;cessaire pour que l'auteur d'extension ins&egrave;re une r&eacute;f&eacute;rence de fichier dans la
section head. Les valeurs autoris&eacute;es pour referenceType sont les suivantes :
•
link pour ins&eacute;rer une balise LINK pour un fichier CSS externe
•
import pour ins&eacute;rer une balise STYLE avec @import
•
javascript pour ins&eacute;rer une balise SCRIPT avec type=text/javascript
•
vbscript pour ins&eacute;rer une balise SCRIPT avec type=text/vbscript
•
&quot;&quot; pour n'ins&eacute;rer aucune r&eacute;f&eacute;rence dans la section head
• L'argument useDefaultFolder est une valeur bool&eacute;enne qui indique si le chemin sp&eacute;cifi&eacute; dans destURL est relatif
au dossier Assets par d&eacute;faut. Si sa valeur est false, ce qui signifie que cette propri&eacute;t&eacute; n'a pas &eacute;t&eacute; d&eacute;finie, destURL
est suppos&eacute; &ecirc;tre relatif &agrave; la racine du site. Si le site n'est pas d&eacute;fini, destURL est suppos&eacute; &ecirc;tre relatif au document. La
valeur par d&eacute;faut de cet argument est false.
Derni&egrave;re mise &agrave; jour le 22/6/2011
347
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
• L'argument documentRelative est une valeur bool&eacute;enne. La valeur par d&eacute;faut est false. Lorsque ce param&egrave;tre a
la valeur false, les actifs sont copi&eacute;s dans le dossier sp&eacute;cifi&eacute; dans destURL par rapport &agrave; la racine du site, lorsque
le fichier est enregistr&eacute; dans un site. Si sa valeur est true, les actifs sont copi&eacute;s dans le chemin sp&eacute;cifi&eacute; dans destURL
par rapport au document.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes qui s'expriment sous la forme d'URL file://. Chaque cha&icirc;ne repr&eacute;sente un fichier qui a &eacute;t&eacute; inclus
dans la section head du document par l'interm&eacute;diaire d'un script ou d'une balise link.
Exemple
function objectTag()
{
.
.
.
var dom = dw.getDocumentDOM();
var assetList = new Array();
var assetInfo = new AssetInfo(&quot;Objects/Ajax/Accordion.css&quot;,
&quot;Objects/Ajax/Accordion.css&quot;,
&quot;Accordion.css&quot;, &quot;link&quot;);
assetList.push(assetInfo);
assetInfo = new AssetInfo(&quot;Objects/Ajax/Accordion.js&quot;, &quot;Accordion.js&quot;,
&quot;javascript&quot;);
assetList.push(assetInfo);
assetInfo = new AssetInfo(&quot;Objects/Ajax/Images&quot;, &quot;Images&quot;, &quot;&quot;);
assetList.push(assetInfo);
dom.copyAssets(assetList);
return retVal;
}
dom.getDefaultAssetFolder()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Extrait le dossier d'actifs par d&eacute;faut du document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient le nom du dossier d'actifs par d&eacute;faut.
Derni&egrave;re mise &agrave; jour le 22/6/2011
348
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Exemple
function objectTag()
{
.
.
.
var defaultAssetFolder = dom.getDefaultAssetFolder();
.
.
.
return retVal;
}
Fonctions de v&eacute;rification de la compatibilit&eacute; avec les
navigateurs
Les fonctions suivantes facilitent la localisation des combinaisons de code HTML et de feuilles de style CSS qui peuvent
d&eacute;clencher des bogues de rendu de navigateur (pour plus d'informations, consultez le chapitre &laquo; API de v&eacute;rification
des probl&egrave;mes de compatibilit&eacute; entre les navigateurs &raquo; du manuel Extension de Dreamweaver), mais elles peuvent
&eacute;galement &ecirc;tre utilis&eacute;es dans d'autres types d'extensions (telles que des commandes).
Remarque : Les valeurs que ces fonctions renvoient repr&eacute;sentent les styles en vigueur en mode Cr&eacute;ation. Lorsque les
fonctions sont utilis&eacute;es dans des fichiers de probl&egrave;mes dans le cadre d'une v&eacute;rification de compatibilit&eacute; avec les
navigateurs, Dreamweaver filtre automatiquement les styles en fonction de la fa&ccedil;on dont les navigateurs cible les
traiteraient (par exemple, les styles d&eacute;finis &agrave; l'aide de Star HTML sont pris en compte si le navigateur cible est Internet
Explorer version 6 ou ult&eacute;rieure), mais ce filtrage n'est pas effectu&eacute; lorsque vous utilisez les fonctions en dehors du contexte
d'une v&eacute;rification de compatibilit&eacute; avec les navigateurs.
elem.getComputedStyleProp()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Obtient la valeur de la propri&eacute;t&eacute; CSS sp&eacute;cifi&eacute;e qui est utilis&eacute;e pour restituer l'&eacute;l&eacute;ment sp&eacute;cifi&eacute;, que la propri&eacute;t&eacute; soit ou
non sp&eacute;cifi&eacute;e dans la cascade. Les longueurs sont rapport&eacute;es en pixels (bien que, &agrave; la diff&eacute;rence des navigateurs,
l'indication &quot;px&quot; ne soit pas fournie avec la valeur).
Arguments
propName, pseudoElt
• L'argument propName est le nom d'une propri&eacute;t&eacute; CSS (utiliser une casse mixte au lieu de traits d'union ; par
exemple, &quot;font-size&quot; devient &quot;fontSize&quot;).
• L'argument pseudoElt est le pseudo-&eacute;l&eacute;ment CSS, ou une valeur null s'il n'en existe aucun.
Valeurs renvoy&eacute;es
Une cha&icirc;ne contenant la valeur calcul&eacute;e pour la propri&eacute;t&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
349
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Remarque : Les valeurs num&eacute;riques sont &eacute;galement renvoy&eacute;es en tant que cha&icirc;nes ; pour utiliser ces valeurs dans des
calculs, convertissez-les en nombres &agrave; l'aide de parseInt() ou parseFloat().
Exemple
var dom = dw.getDocumentDOM();
var myDiv = dom.getElementsByTagName('myDiv');
var float = myDiv.getComputedStyleProp(&quot;float&quot;);
if (float == &quot;left&quot;)
alert(&quot;This div is floated left.&quot;);
window.getDeclaredStyle()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Obtient les styles CSS qui sont d&eacute;clar&eacute;s pour l'&eacute;l&eacute;ment sp&eacute;cifi&eacute;. Diff&egrave;re de la fonction getComputedStyle() en ce sens
que les styles qui ne sont pas sp&eacute;cifiquement d&eacute;clar&eacute;s sont ind&eacute;finis, et qu'elle donne les valeurs de longueur r&eacute;elles
telles qu'elles sont d&eacute;clar&eacute;es dans la feuille de style (par exemple, 20%, .8em) au lieu des valeurs calcul&eacute;es en pixels. Si
bGetInherited a pour valeur false (cas par d&eacute;faut), la fonction getDeclaredStyle() n'extrait &eacute;galement que les
styles qui s'appliquent directement &agrave; l'&eacute;l&eacute;ment ; elle n'inclut pas les styles h&eacute;rit&eacute;s d'un parent.
Arguments
elt, pseudoElt, psuedoClassList, bGetInherited
• elt est le nœud du document dont les informations de style sont souhait&eacute;es.
• pseudoElt est le pseudo-&eacute;l&eacute;ment CSS, ou une valeur null s'il n'en existe aucun.
• pseudoClassList est une cha&icirc;ne facultative compos&eacute;e d'une liste de pseudo-classes s&eacute;par&eacute;es par des espaces.
• bGetInherited est une valeur bool&eacute;enne facultative indiquant s'il faut inclure les styles h&eacute;rit&eacute;s d'anc&ecirc;tres (false par
d&eacute;faut).
Valeurs renvoy&eacute;es
Un objet en lecture seule contenant des propri&eacute;t&eacute;s de style qui sont accessibles &agrave; partir de leur nom.
Exemple
var dom = dw.getDocumentDOM();
var myDiv = dom.getElementById('myDiv');
var props = window.getDeclaredStyle(myDiv);
var marleft = &quot;&quot;;
var units = &quot;&quot;;
if (typeof(props.marginLeft) != &quot;undefined&quot;){
marleft = props.marginLeft;
units = marleft.replace(/\d+/,&quot;&quot;); // remove digits, leaving units
alert(units); // should show %, px, pt, em, etc.
}
else
alert(&quot;no margin-left property has been set for myDiv.&quot;);
Derni&egrave;re mise &agrave; jour le 22/6/2011
350
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
dom.getMinDisplayWidth()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Obtient la largeur minimale requise pour qu'un conteneur de niveau bloc puisse afficher l'int&eacute;gralit&eacute; de son contenu.
Remarque : La largeur r&eacute;elle du conteneur peut &ecirc;tre plus petite si une valeur inf&eacute;rieure &agrave; la valeur que la fonction
dom.minDisplayWidth() renvoie est sp&eacute;cifi&eacute;e &agrave; l'aide de feuilles de style CSS.
Arguments
container
• container est l'&eacute;l&eacute;ment contenant pour lequel une largeur minimale est requise.
Valeurs renvoy&eacute;es
Un entier repr&eacute;sentant la largeur d'affichage minimale du conteneur sp&eacute;cifi&eacute;, en pixels, ou -1 n'est pas un conteneur
ou si sa largeur minimale ne peut pas &ecirc;tre d&eacute;termin&eacute;e.
Exemple
var dom = dw.getDocumentDOM();
var myDiv = dom.getElementById('myDiv');
var props = window.getComputedStyle(myDiv);
var minW = dom.getMinDisplayWidth(myDiv);
var setW = props.width;
if (minW &gt; setW)
alert(&quot;Depending on the browser, your content will either be \n&quot; +
&quot;clipped, or the container will expand beyond its set width.&quot;);
dom.getBlockElements() elem.getBlockElements()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Analyse le document (ou l'&eacute;l&eacute;ment) &agrave; la recherche de descendants ayant 'block' comme valeur d'affichage
intrins&egrave;que ou sp&eacute;cifi&eacute;e.
Arguments
Aucun
Valeurs renvoy&eacute;es
Tableau de nœuds d'&eacute;l&eacute;ment.
Derni&egrave;re mise &agrave; jour le 22/6/2011
351
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Exemple
[...]
var blocks = DOM.getBlockElements();
var dProps = null, children = null;
for (var i=0; i &lt; blocks.length; i++){
// get the declared styles so we can see whether width
// or height have been specified explicitly
dProps = window.getDeclaredStyle(blocks[i]);
// if the block has children, border-left, and padding-bottom
// but no width or height
if (blocks[i].hasChildNodes() &amp;&amp; |
issueUtils.hasBorder(blocks[i],null,&quot;left&quot;) &amp;&amp;
(parseFloat(blocks[i].getComputedStyleProp(&quot;padding-bottom&quot;)) &gt; 0) &amp;&amp;
typeof(dProps.width) == &quot;undefined&quot; &amp;&amp; typeof(dProps.height) == &quot;undefined&quot;){
children = blocks[i].getBlockElements();
var hasLayout = false;
// loop through the block-level children to see if
// any have width or height defined. width or height on any
// of the children of the outer block will prevent the bug.
for (var j=0; j &lt; children.length; j++){
dProps = window.getDeclaredStyle(children[j]);
if (typeof(dProps.width) != &quot;undefined&quot; || typeof(dProps.height) !=
&quot;undefined&quot;){
hasLayout = true;
break;
}
}
[...]
}
}
[...]
dom.getInlineElements() elem.getInlineElements()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Analyse le document (ou l'&eacute;l&eacute;ment) &agrave; la recherche de descendants ayant 'inline' comme valeur d'affichage
intrins&egrave;que ou sp&eacute;cifi&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de nœuds d'&eacute;l&eacute;ment.
Derni&egrave;re mise &agrave; jour le 22/6/2011
352
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Exemple
[...]
var DOM = dw.getDocumentDOM();
var inEls = DOM.body.getInlineElements();
var next = null, prev = null, parent = null;
var props = null;
// look through all inline elements for replaced elements.
// if no replaced elements are found, don't bother going forward.
for (var i=0; i &lt; inEls.length; i++){
if (inEls[i].tagName == 'IMG' ||
inEls[i].tagName == 'INPUT' ||
inEls[i].tagName == 'TEXTAREA' ||
inEls[i].tagName == 'SELECT' ||
inEls[i].tagName == 'OBJECT'){
// do something
}
}
[...]
dom.getHeaderElements() elem.getHeaderElements()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Analyse le document (ou l'&eacute;l&eacute;ment) &agrave; la recherche de balises d'en-t&ecirc;te (H1 &agrave; H6).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de nœuds d'&eacute;l&eacute;ment.
Exemple
var DOM = dw.getDocumentDOM();
var headers = DOM.getHeaderElements();
for (var i=0; i &lt; headers.length; i++){
alert(headers[i].tagName);
}
dom.getListElements() elem.getListElements()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Analyse le document (ou l'&eacute;l&eacute;ment) &agrave; la recherche de listes num&eacute;rot&eacute;es, non num&eacute;rot&eacute;es et de listes de d&eacute;finitions.
Derni&egrave;re mise &agrave; jour le 22/6/2011
353
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de nœuds d'&eacute;l&eacute;ment.
Exemple
[...]
var DOM = dw.getDocumentDOM();
// get all the UL, OL, and DL elements in the document.
var lists = DOM.getListElements();
var props = null;
for (var i=0; i &lt; lists.length; i++){
props = window.getDeclaredStyle(lists[i]);
if ((props.cssFloat == &quot;left&quot; || props.cssFloat == &quot;right&quot;) &amp;&amp; props.overflow == &quot;auto&quot;){
// do something
}
}
[...]
elem.isBlockElement()
Disponibilit&eacute;
Dreamweaver CS3.
Description
V&eacute;rifie si l'&eacute;l&eacute;ment poss&egrave;de la valeur 'block' comme valeur d'affichage intrins&egrave;que ou sp&eacute;cifi&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Une valeur bool&eacute;enne indiquant si l'objet est un &eacute;l&eacute;ment de niveau bloc.
Exemple
[...]
var
var
var
for
DOM = dw.getDocumentDOM();
blocks = DOM.body.getBlockElements();
next = null;
(var i=0; i &lt; blocks.length; i++){
// next is the node right after blocks[i]
next = blocks[i].nextSibling;
// if next isn't null AND next is an element node AND next is a block element,
// we've met the &quot;second of two consecutive block elements&quot; test.
if (next &amp;&amp; (next.nodeType == 1) &amp;&amp; next.isBlockElement()){
// do something
}
}
[...]
Derni&egrave;re mise &agrave; jour le 22/6/2011
354
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
elem.isInlineElement()
Disponibilit&eacute;
Dreamweaver CS3.
Description
V&eacute;rifie si l'&eacute;l&eacute;ment poss&egrave;de la valeur 'inline' comme valeur d'affichage intrins&egrave;que ou sp&eacute;cifi&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Une valeur bool&eacute;enne indiquant si l'objet est un &eacute;l&eacute;ment en ligne.
Exemple
[...]
var DOM = dw.getDocumentDOM();
var floats = issueUtils.getFloats(DOM.body);
var next = null;
for (var i=0; i &lt; floats.length; i++){
next = floats[i].nextSibling;
// if nextSibling of float is a text node or an inline element
if (next &amp;&amp; (next.nodeType == Node.TEXT_NODE ||
(next.nodeType == Node.ELEMENT_NODE &amp;&amp; next.isInlineElement()))){
// do something
}
}
[...]
elem.isHeaderElement()
Disponibilit&eacute;
Dreamweaver CS3.
Description
V&eacute;rifie si l'&eacute;l&eacute;ment est l'une des balises suivantes : h1, h2, h3, h4, h5, h6.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Une valeur bool&eacute;enne indiquant si l'objet est un &eacute;l&eacute;ment d'en-t&ecirc;te.
Derni&egrave;re mise &agrave; jour le 22/6/2011
355
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Contenu de page
Exemple
[...]
var DOM = dw.getDocumentDOM();
var floats = issueUtils.getFloats(DOM.body);
var prev = null;
// first float in the document isn't affected, so start
// at 1.
for (var i=1; i &lt; floats.length; i++){
prev = floats[i].previousSibling;
// if the element before the float is a header
if (prev &amp;&amp; prev.isHeaderElement()){
// do something
}
}
[...]
elem.isListElement()
Disponibilit&eacute;
Dreamweaver CS3.
Description
V&eacute;rifie si l'&eacute;l&eacute;ment est l'une des balises suivantes : ul, ol, dl.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Une valeur bool&eacute;enne indiquant si l'objet est un &eacute;l&eacute;ment de liste.
Exemple
[...]
var DOM = dw.getDocumentDOM();
var floats = issueUtils.getFloats(DOM.body);
var prev = null, children = null;
for (var i=0; i &lt; floats.length; i++){
children = floats[i].childNodes;
for (var k=0; k &lt; children.length; k++){
if (children[k].isListElement()){
// do something
}
}
}
[...]
Derni&egrave;re mise &agrave; jour le 22/6/2011
356
Chapitre 16 : Documents dynamiques
Les fonctions de document dynamique d'Adobe&reg; Dreamweaver&reg; effectuent des op&eacute;rations li&eacute;es aux pages de serveur
Web. Ces op&eacute;rations sont les suivantes :
• Renvoi d'une propri&eacute;t&eacute; pour le nœud s&eacute;lectionn&eacute; dans le panneau Composants
• Obtention d'une liste de toutes les sources de donn&eacute;es dans le document de l'utilisateur
• Affichage de contenu dynamique en mode Cr&eacute;ation
• Application d'un comportement de serveur &agrave; un document
• Obtention des noms de tous les mod&egrave;les de serveur actuellement d&eacute;finis
Fonctions de composants de serveur
Ces fonctions permettent d'acc&eacute;der au nœud s&eacute;lectionn&eacute; dans la commande d'arborescence Composants de serveur
qui appara&icirc;t dans le panneau Composants. Vous pouvez &eacute;galement les utiliser pour actualiser l'affichage de
l'arborescence de composants.
dreamweaver.serverComponents.getSelectedNode()
Disponibilit&eacute;
Dreamweaver MX.
Description
Renvoie la propri&eacute;t&eacute; ComponentRec s&eacute;lectionn&eacute;e dans la commande d'arborescence Composants de serveur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
La propri&eacute;t&eacute; ComponentRec.
dreamweaver.serverComponents.refresh()
Disponibilit&eacute;
Dreamweaver MX.
Description
Actualise l'affichage de l'arborescence de composants.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
357
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Valeurs renvoy&eacute;es
Aucune.
Fonctions relatives aux sources de donn&eacute;es
Les fichiers de source de donn&eacute;es sont stock&eacute;s dans le dossier Configuration/DataSources. Chaque mod&egrave;le de serveur
poss&egrave;de son propre dossier : ASP.Net/C#, ASP.Net/VisualBasic, ASP/JavaScript, ASP/VBScript, ColdFusion, JSP et
PHP/MySQL. Le sous-dossier de chaque mod&egrave;le contient des fichiers HTML et EDML associ&eacute;s aux sources de
donn&eacute;es de ce mod&egrave;le de serveur.
Pour plus d'informations sur l'utilisation de sources de donn&eacute;es dans Dreamweaver, voir Sources de donn&eacute;es dans
Extension de Dreamweaver.
dreamweaver.dbi.getDataSources
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Appelle la fonction findDynamicSources() pour chaque fichier contenu dans le dossier Configuration/DataSources.
Vous pouvez utiliser cette fonction pour g&eacute;n&eacute;rer une liste de toutes les sources de donn&eacute;es du document de
l'utilisateur. Cette fonction est r&eacute;p&eacute;t&eacute;e sur tous les fichiers du dossier Configuration/DataSources, appelle la fonction
findDynamicSources() dans chaque fichier, concat&egrave;ne tous les tableaux renvoy&eacute;s et renvoie le tableau de sources de
donn&eacute;es concat&eacute;n&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Un tableau contenant une liste concat&eacute;n&eacute;e de toutes les sources de donn&eacute;es contenues dans le document de
l'utilisateur. Chaque &eacute;l&eacute;ment du tableau est un objet et chaque objet a les propri&eacute;t&eacute;s suivantes :
• La propri&eacute;t&eacute; title correspond au libell&eacute; qui appara&icirc;t &agrave; droite de l'ic&ocirc;ne de chaque nœud parent. La propri&eacute;t&eacute;
title est toujours d&eacute;finie.
• La propri&eacute;t&eacute; imageFile est le chemin de fichier contenant l'ic&ocirc;ne (une image GIF) qui repr&eacute;sente le nœud parent
dans les bo&icirc;tes de dialogue Donn&eacute;es dynamiques et Texte dynamique ou dans le panneau Liaisons. La propri&eacute;t&eacute;
imageFile est toujours d&eacute;finie.
• La propri&eacute;t&eacute; allowDelete est facultative. Si cette propri&eacute;t&eacute; est d&eacute;finie sur la valeur false, lorsque l'utilisateur
clique sur ce nœud dans le panneau Liaisons, le bouton Moins (-) est d&eacute;sactiv&eacute;. Si elle est d&eacute;finie sur la valeur true,
le bouton Moins (-) est activ&eacute;. Si la propri&eacute;t&eacute; n'est pas d&eacute;finie, le bouton Moins (-) est activ&eacute; lorsque l'utilisateur
clique sur l'&eacute;l&eacute;ment (comme si la propri&eacute;t&eacute; &eacute;tait d&eacute;finie sur la valeur true).
• La propri&eacute;t&eacute; dataSource est le nom du fichier dans lequel la fonction findDynamicSources() est d&eacute;finie. Par
exemple, la fonction findDynamicSources() dans le fichier Session.htm, situ&eacute; dans le dossier
Configuration/DataSources/ASP_Js, d&eacute;finit la propri&eacute;t&eacute; dataSource sur session.htm. Cette propri&eacute;t&eacute; est
toujours d&eacute;finie.
Derni&egrave;re mise &agrave; jour le 22/6/2011
358
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
• La propri&eacute;t&eacute; name est le nom du comportement de serveur associ&eacute; &agrave; la source de donn&eacute;es dataSource, s'il existe.
La propri&eacute;t&eacute; name est toujours d&eacute;finie, mais il peut s'agir d'une cha&icirc;ne vide (&quot;&quot;) si aucun comportement de serveur
n'est associ&eacute; &agrave; la source de donn&eacute;es (tel qu'une variable de session).
dw.dbi.setExpanded()
Disponibilit&eacute;
Dreamweaver CS3.
Description
D&eacute;finit le nœud &agrave; d&eacute;velopper ou &agrave; r&eacute;duire.
Arguments
data-source-node-name, expanded
• data-source-node-name est une cha&icirc;ne indiquant le nom de la source de donn&eacute;es &agrave; d&eacute;velopper ou &agrave; r&eacute;duire.
• expanded est une valeur bool&eacute;enne indiquant si le nœud du jeu de donn&eacute;es doit &ecirc;tre d&eacute;velopp&eacute; ou r&eacute;duit.
Valeurs renvoy&eacute;es
Aucune.
Exemple
dw.dbi.setExpanded(dsName, true);
//expand the data source node
Fonctions de l'Extension Data Manager
Le gestionnaire de donn&eacute;es d'extension (Extension Data Manager, EDM) se compose des API de cette section. Vous
pouvez programmer l'acc&egrave;s et la manipulation des donn&eacute;es contenues dans les fichiers groupe et participant en
appelant ces fonctions. L'EDM fonctionne de la mani&egrave;re suivante :
• L'EDM ex&eacute;cute toutes les entr&eacute;es/sorties de fichier EDML pour les fichiers Groupe et Participant.
• En ex&eacute;cutant toutes les demandes de donn&eacute;es pour le mod&egrave;le de serveur en cours, l 'EDM agit comme un filtre de
mod&egrave;le de serveur.
dreamweaver.getExtDataValue()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Cette fonction extrait les valeurs de champ d'un fichier EDML pour les nœuds sp&eacute;cifi&eacute;s.
Derni&egrave;re mise &agrave; jour le 22/6/2011
359
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Arguments
qualifier(s)
• L'argument qualifier(s) est une liste, de longueur variable (selon le niveau d'information demand&eacute;) de qualificateurs
de nœuds s&eacute;par&eacute;s par des virgules comprenant le nom du groupe ou du participant, le sous-bloc (le cas &eacute;ch&eacute;ant) et
le nom du champ.
Valeurs renvoy&eacute;es
Dreamweaver attend une valeur de champ. Si la valeur n'est pas sp&eacute;cifi&eacute;e, Dreamweaver utilise la valeur par d&eacute;faut.
Exemple
L'exemple suivant extrait la valeur de l'attribut d'emplacement pour la balise insertText du participant
recordset_main :
dw.getExtDataValue(&quot;recordset_main&quot;, &quot;insertText&quot;, &quot;location&quot;);
dreamweaver.getExtDataArray()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Cette fonction extrait un tableau de valeurs d'un fichier EDML pour les nœuds sp&eacute;cifi&eacute;s.
Arguments
qualifier(s)
• L'argument qualifier(s) est une liste, de longueur variable, de qualificateurs de nœuds s&eacute;par&eacute;s par des virgules,
comprenant le nom du groupe ou du participant, le sous-bloc (le cas &eacute;ch&eacute;ant) et le nom du champ.
Valeurs renvoy&eacute;es
Dreamweaver attend un tableau de noms de nœuds enfants.
dreamweaver.getExtParticipants()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Cette fonction extrait la liste de participants d'un fichier de groupe EDML ou de fichiers participants.
Arguments
value, qualifier(s)
• L'argument value est une valeur de propri&eacute;t&eacute;. Il est ignor&eacute; s'il n'est pas renseign&eacute;. Par exemple,
dreamweaver.getExtParticipants(&quot;&quot;, &quot;participant&quot;);
• L'argument qualifier(s) est une liste, de longueur variable, de qualificateurs de nœuds ayant la propri&eacute;t&eacute; requise,
s&eacute;par&eacute;s par des virgules.
Derni&egrave;re mise &agrave; jour le 22/6/2011
360
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Valeurs renvoy&eacute;es
Dreamweaver attend un tableau de noms de participants ayant la propri&eacute;t&eacute; requise, si elle est sp&eacute;cifi&eacute;e, et la propri&eacute;t&eacute;
correspondante, si elle est sp&eacute;cifi&eacute;e.
dreamweaver.getExtGroups()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Extrait le nom du groupe, qui est l'&eacute;quivalent du nom du comportement de serveur, d'un fichier groupe EDML.
Arguments
value, qualifier(s)
• L'argument value est une valeur de propri&eacute;t&eacute;. Il est ignor&eacute; s'il n'est pas renseign&eacute;.
• L'argument qualifier(s) est une liste, de longueur variable, de qualificateurs de nœuds ayant la propri&eacute;t&eacute; requise,
s&eacute;par&eacute;s par des virgules.
Valeurs renvoy&eacute;es
Dreamweaver attend un tableau de noms de groupes ayant la propri&eacute;t&eacute; requise, si elle est sp&eacute;cifi&eacute;e, et la propri&eacute;t&eacute;
correspondante, si elle est sp&eacute;cifi&eacute;e.
dreamweaver.refreshExtData()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
Recharge tous les fichiers de donn&eacute;es d'extension.
Vous pouvez cr&eacute;er une commande utile &agrave; partir de cette fonction, qui vous permettra de recharger les modifications
apport&eacute;es aux fichiers EDML de comportement de serveur sans avoir &agrave; red&eacute;marrer Dreamweaver.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Dreamweaver attend des donn&eacute;es recharg&eacute;es.
Fonctions Live data
Vous pouvez utiliser les fonctions Live Data suivantes pour reproduire les fonctionnalit&eacute;s de menu :
• La fonction showLiveDataDialog() s'utilise pour l'&eacute;l&eacute;ment de menu Affichage &gt; Param&egrave;tres Live Data.
Derni&egrave;re mise &agrave; jour le 22/6/2011
361
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
• La fonction setLiveDataMode() s'utilise pour les &eacute;l&eacute;ments de menu Affichage &gt; Live Data et Affichage &gt;
Actualiser les donn&eacute;es dynamiques.
• La fonction getLiveDataMode() d&eacute;termine si le mode Live Data est actif.
Vous pouvez utiliser les autres fonctions Live Data lorsque vous impl&eacute;mentez la fonction
liveDataTranslateMarkup() pour l'API du traducteur.
dreamweaver.getLiveDataInitTags()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Renvoie les balises d'initialisation pour le document actif. Les balises d'initialisation sont les balises HTML que
l'utilisateur fournit dans la bo&icirc;te de dialogue Param&egrave;tres Live Data. Cette fonction est g&eacute;n&eacute;ralement appel&eacute;e &agrave; partir de
la fonction liveDataTranslateMarkup() d'un traducteur, de fa&ccedil;on &agrave; ce que le traducteur puisse transmettre les
balises &agrave; la fonction liveDataTranslate().
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient les balises d'initialisation.
dreamweaver.getLiveDataMode()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
D&eacute;termine si la fen&ecirc;tre Live Data est actuellement visible.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la fen&ecirc;tre Live Data est visible, false dans le cas contraire.
dreamweaver.getLiveDataParameters ()
Disponibilit&eacute;
Dreamweaver MX.
Description
Obtient les param&egrave;tres d'URL d&eacute;finis comme param&egrave;tres Live Data.
Derni&egrave;re mise &agrave; jour le 22/6/2011
362
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Le mode Live Data vous permet d'afficher une page Web au stade de conception (comme si elle avait &eacute;t&eacute; traduite par
le serveur d'application et renvoy&eacute;e). En g&eacute;n&eacute;rant un contenu dynamique affichable en mode Cr&eacute;ation, vous pouvez
visualiser la mise en forme d'une page avec ses donn&eacute;es dynamiques et l'ajuster, le cas &eacute;ch&eacute;ant.
Avant d'afficher les donn&eacute;es dynamiques, vous devez saisir les param&egrave;tres Live Data de tout param&egrave;tre d'URL auquel
le document fait r&eacute;f&eacute;rence. Cela &eacute;vite que le serveur Web ne renvoie des erreurs pour des param&egrave;tres qui ne sont pas
encore d&eacute;finis au stade de la simulation.
La saisie des param&egrave;tres d'URL s'effectue par paire nom/valeur. Ainsi, si les scripts de serveur d'un document font
r&eacute;f&eacute;rence aux variables d'URL ID et Name, vous devez d&eacute;finir ces param&egrave;tres d'URL avant d'afficher les donn&eacute;es
dynamiques.
Vous pouvez saisir les param&egrave;tres Live Data depuis les endroits suivants :
• Depuis la bo&icirc;te de dialogue Param&egrave;tres Live Data, accessible &agrave; partir du menu Affichage.
• Dans le champ de texte URL qui appara&icirc;t dans la partie sup&eacute;rieure du document lorsque vous cliquez sur le bouton
Affichage des donn&eacute;es dynamiques, situ&eacute; dans la barre d'outils.
Pour les param&egrave;tres ID et Name mentionn&eacute;s ci-dessus, vous pouvez saisir les paires suivantes :
ID
Name
22
Samuel
Dans l'URL, ces param&egrave;tres apparaissent alors comme indiqu&eacute; dans l'exemple ci-dessous :
http://someURL?ID=22&amp;Name=Samuel
Cette fonction vous permet d'obtenir les param&egrave;tres Live Data par le biais de JavaScript.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau qui contient les param&egrave;tres d'URL du document actif. Le tableau contient un nombre pair de cha&icirc;nes de
param&egrave;tres. Chaque association de deux &eacute;l&eacute;ments repr&eacute;sente une paire nom/valeur de param&egrave;tre d'URL. L'&eacute;l&eacute;ment
pair correspond au nom du param&egrave;tre et l'&eacute;l&eacute;ment impair &agrave; sa valeur. Dans l'exemple ci-dessus,
getLiveDataParameters() renvoie donc le tableau suivant pour les param&egrave;tres ID et Name :
['ID,'22','Name','Samuel'].
Exemple
L'exemple suivant renvoie les param&egrave;tres sp&eacute;cifi&eacute;s comme param&egrave;tres Live Data et les conserve dans paramsArray :
var paramsArray = dreamweaver.getLiveDataParameters();
dreamweaver.liveDataTranslate()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Derni&egrave;re mise &agrave; jour le 22/6/2011
363
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Description
Envoie un document HTML entier &agrave; un serveur d'application, demande au serveur d'ex&eacute;cuter les scripts dans le
document, puis renvoie le document HTML r&eacute;sultant. Cette fonction peut &eacute;galement &ecirc;tre appel&eacute;e &agrave; partir de la
fonction liveDataTranslateMarkup() d'un traducteur ; si vous tentez de l'appeler &agrave; un autre moment, il en r&eacute;sulte
une erreur. La fonction dreamweaver.liveDataTranslate() effectue les op&eacute;rations suivantes :
• Elle lit l'image anim&eacute;e (qui s'affiche &agrave; c&ocirc;t&eacute; du bord droit de la fen&ecirc;tre Live Data).
• Elle analyse les donn&eacute;es saisies par l'utilisateur. Si vous cliquez sur l'ic&ocirc;ne Arr&ecirc;ter, la fonction est imm&eacute;diatement
termin&eacute;e.
• Elle accepte un argument contenant une seule cha&icirc;ne de l'appelant. Cette cha&icirc;ne repr&eacute;sente g&eacute;n&eacute;ralement le code
source entier du document de l'utilisateur. Il s'agit de la m&ecirc;me cha&icirc;ne que celle utilis&eacute;e dans l'op&eacute;ration suivante.
• Elle enregistre la cha&icirc;ne HTML du document de l'utilisateur dans un fichier temporaire stock&eacute; sur le serveur Live Data.
• Elle envoie une requ&ecirc;te HTTP au serveur Live Data, en utilisant les param&egrave;tres d&eacute;finis dans la bo&icirc;te de dialogue
Param&egrave;tres Live Data.
• Elle re&ccedil;oit la r&eacute;ponse HTML du serveur Live Data.
• Elle supprime le fichier temporaire du serveur Live Data.
• Elle arr&ecirc;te la lecture du fichier d'animation.
• Elle renvoie la r&eacute;ponse HTML &agrave; l'appelant.
Arguments
string
• Une seule cha&icirc;ne, repr&eacute;sentant g&eacute;n&eacute;ralement le code source entier du document actif de l'utilisateur.
Valeurs renvoy&eacute;es
Objet httpReply. Cet objet est le m&ecirc;me que la valeur renvoy&eacute;e par la fonction MMHttp.getText(). Si l'utilisateur
clique sur l'ic&ocirc;ne Arr&ecirc;ter, le code httpReply.statusCode de la valeur de retour est &eacute;gal &agrave; 200 (&eacute;tat OK) et sa valeur
httpReply.data est &eacute;gale &agrave; une cha&icirc;ne vide. Pour plus d'informations sur l'objet httpReply, voir &laquo; L'API HTTP &raquo; &agrave;
la page 14.
dreamweaver.setLiveDataError()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
D&eacute;termine le message d'erreur qui s'affiche si une erreur se produit lors de l'ex&eacute;cution de la fonction
liveDataTranslateMarkup() dans un traducteur. Si le document transmis par Dreamweaver &agrave;
liveDataTranslate() contient des erreurs, le serveur retransmet un message d'erreur au format HTML. Si le
traducteur (code ayant appel&eacute; liveDataTranslate()) d&eacute;termine que le serveur a renvoy&eacute; un message d'erreur, il
appelle setLiveDataError() pour afficher le message d'erreur dans Dreamweaver. Ce message s'affiche une fois que
la fonction liveDataTranslateMarkup() a &eacute;t&eacute; ex&eacute;cut&eacute;e ; Dreamweaver affiche la description dans une bo&icirc;te de
dialogue d'erreur. La fonction setLiveDataError() doit uniquement &ecirc;tre appel&eacute;e &agrave; partir de la fonction
liveDataTranslateMarkup().
Derni&egrave;re mise &agrave; jour le 22/6/2011
364
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Arguments
source
• L'argument source est une cha&icirc;ne qui contient le code source, qui est analys&eacute; et affich&eacute; dans la bo&icirc;te de dialogue du
message d'erreur.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.getLiveDataMode()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Active ou d&eacute;sactive l'affichage de la fen&ecirc;tre Live Data.
Arguments
bIsVisible
• L'argument bIsVisible est une valeur bool&eacute;enne qui indique si la fen&ecirc;tre Live Data doit &ecirc;tre visible. Si vous
transmettez la valeur true &agrave; cette fonction et que Dreamweaver est d&eacute;fini pour afficher la fen&ecirc;tre Live Data, l'effet
est le m&ecirc;me que si l'utilisateur cliquait sur le bouton Actualiser.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.getLiveDataParameters ()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;finit les param&egrave;tres d'URL r&eacute;f&eacute;renc&eacute;s dans le document pour une utilisation en mode Live Data.
Le mode Live Data vous permet d'afficher une page Web au stade de conception (comme si elle avait &eacute;t&eacute; traduite par
le serveur d'application et renvoy&eacute;e). En g&eacute;n&eacute;rant un contenu dynamique affichable en mode Cr&eacute;ation, vous pouvez
visualiser la mise en forme d'une page avec ses donn&eacute;es dynamiques et l'ajuster, le cas &eacute;ch&eacute;ant.
Avant d'afficher les donn&eacute;es dynamiques, vous devez saisir les param&egrave;tres Live Data de tout param&egrave;tre d'URL auquel
le document fait r&eacute;f&eacute;rence. Cela &eacute;vite que le serveur Web ne renvoie des erreurs pour des param&egrave;tres qui ne sont pas
encore d&eacute;finis au stade de la simulation.
La saisie des param&egrave;tres d'URL s'effectue par paire nom/valeur. Ainsi, si les scripts de serveur d'un document font
r&eacute;f&eacute;rence aux variables d'URL ID et Name, vous devez d&eacute;finir ces param&egrave;tres d'URL avant d'afficher les donn&eacute;es
dynamiques.
Cette fonction vous permet de d&eacute;finir les valeurs Live Data par le biais de JavaScript.
Derni&egrave;re mise &agrave; jour le 22/6/2011
365
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Arguments
liveDataString
• L'argument liveDataString est une cha&icirc;ne qui contient les param&egrave;tres d'URL &agrave; d&eacute;finir, au sein de paires nom/valeur.
Valeurs renvoy&eacute;es
Aucune.
Exemple
dreamweaver.setLiveDataParameters(&quot;ID=22&amp;Name=Samuel&quot;)
dreamweaver.showLiveDataDialog()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Affiche la bo&icirc;te de dialogue Param&egrave;tres Live Data.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Fonctions relatives au mode En direct
Les fonctions du mode En direct s'emploient aux fins suivantes :
• Obtention et d&eacute;finition du mode Cr&eacute;ation
• Obtention et d&eacute;finition du mode En direct &agrave; l'aide du serveur
• Obtention des valeurs par d&eacute;faut du mode En direct
• Obtention et d&eacute;finition des &eacute;l&eacute;ments d&eacute;pendants du mode En direct
• Consultation des param&egrave;tres du mode En direct
dom.getDesignViewMode()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction obtient l'affichage ou le mode du mode Cr&eacute;ation. Le mode Cr&eacute;ation peut se trouver en mode d'affichage
Cr&eacute;ation modifiable classique ou En direct.
Derni&egrave;re mise &agrave; jour le 22/6/2011
366
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur de cha&icirc;ne. Renvoie live si le mode Cr&eacute;ation se trouve en mode En direct. Renvoie editable si le mode
Cr&eacute;ation se trouve en mode Cr&eacute;ation modifiable classique.
dom.setDesignViewMode()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction active le mode du mode Cr&eacute;ation. Par exemple, elle peut activer le mode En direct.
Arguments
mode
• L'argument mode est une cha&icirc;ne qui peut avoir la valeur live ou editable.
Valeurs renvoy&eacute;es
Aucune.
dom.getLiveViewUsingServer()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction permet de savoir si la page actuelle est pr&eacute;visualis&eacute;e &agrave; l'aide d'un serveur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la page doit &ecirc;tre pr&eacute;visualis&eacute;e &agrave; l'aide d'un serveur, false dans le cas contraire.
dom.setLiveViewUsingServer()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction permet de sp&eacute;cifier si une page peut &ecirc;tre pr&eacute;visualis&eacute;e &agrave; l'aide d'un serveur.
Derni&egrave;re mise &agrave; jour le 22/6/2011
367
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Arguments
bool
• L'argument bool est une valeur bool&eacute;enne qui indique si une page peut &ecirc;tre pr&eacute;visualis&eacute;e &agrave; l'aide d'un serveur. Si
vous transmettez true &agrave; cette fonction, la page peut &ecirc;tre pr&eacute;visualis&eacute;e &agrave; l'aide d'un serveur.
Valeurs renvoy&eacute;es
Aucune.
dom.getLiveViewDefaultsToUsingServer()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction sert &agrave; d&eacute;terminer si l'action par d&eacute;faut consiste &agrave; pr&eacute;visualiser &agrave; l'aide d'un serveur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne. Si l'action par d&eacute;faut consiste &agrave; pr&eacute;visualiser une page &agrave; l'aide d'un serveur, la valeur bool&eacute;enne est
true, et false dans le cas contraire.
dom.getLiveViewDependentsUsingServer()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction permet de d&eacute;terminer si des fichiers CSS et JavaScript d&eacute;pendants sont demand&eacute;s depuis le serveur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne. Si les fichiers CSS et JavaScript d&eacute;pendants sont demand&eacute;s depuis le serveur, la valeur bool&eacute;enne
est true, et false dans le cas contraire.
dom.setLiveViewDependentsUsingServer()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction permet de sp&eacute;cifier si des fichiers CSS et JavaScript d&eacute;pendants doivent &ecirc;tre demand&eacute;s depuis le serveur.
Derni&egrave;re mise &agrave; jour le 22/6/2011
368
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Arguments
bool
• Valeur bool&eacute;enne qui indique si les fichiers CSS et JavaScript d&eacute;pendants sont demand&eacute;s depuis le serveur. Si vous
envoyez true &agrave; cette fonction, les fichiers sont demand&eacute;s depuis le serveur.
Valeurs renvoy&eacute;es
Aucune.
dom.showLiveViewParamatersDialog()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction permet d'afficher la bo&icirc;te de dialogue des param&egrave;tres en direct.
Arguments
Aucun
Valeurs renvoy&eacute;es
Aucune.
dom.setLiveViewFollowsLinks()
Description
Cette fonction permet d'activer la fonctionnalit&eacute; de suivi des liens dans le document actif. En mode En direct, le suivi
des liens permet &agrave; l'utilisateur de d&eacute;terminer le comportement du document lorsqu'on clique sur un lien.
Disponibilit&eacute;
Dreamweaver CS5.
Arguments
bool
Valeur bool&eacute;enne qui indique si la fonctionnalit&eacute; de suivi des liens doit &ecirc;tre activ&eacute;e.
Valeurs renvoy&eacute;es
Aucune.
dom.getLiveViewFollowsLinks()
Disponibilit&eacute;
Dreamweaver CS5.
Derni&egrave;re mise &agrave; jour le 22/6/2011
369
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Description
Cette fonction permet de d&eacute;terminer si la fonctionnalit&eacute; de suivi des liens est activ&eacute;e pour le document.
Arguments
Aucun
Valeurs renvoy&eacute;es
bool
Valeur bool&eacute;enne qui indique si la fonctionnalit&eacute; de suivi des liens est activ&eacute;e.
dom.isLiveViewBrowsingHomeURI()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;terminer si l'URL visualis&eacute;e dans le navigateur du mode En direct est identique &agrave; l'URL
dans l'onglet du document principal.
Arguments
Aucun
Valeurs renvoy&eacute;es
bool
Valeur bool&eacute;enne qui indique si le mode En direct est activ&eacute;. La valeur false est renvoy&eacute;e si l'utilisateur a suivi un lien
vers n autre document apr&egrave;s avoir activ&eacute; le mode En direct.
dreamweaver.findSiteForURI()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;terminer le site auquel l'URI fait r&eacute;f&eacute;rence.
Arguments
DWUri
URI qui fait r&eacute;f&eacute;rence &agrave; un fichier local ou un site distant (indiqu&eacute; sous la forme d'un chemin d'acc&egrave;s file:// ou d'un
lien http://).
Valeurs renvoy&eacute;es
Objet
Objet comportant le contexte du site. L'objet renvoy&eacute; poss&egrave;de les propri&eacute;t&eacute;s suivantes :
Derni&egrave;re mise &agrave; jour le 22/6/2011
370
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Propri&eacute;t&eacute;
Description
siteName
Nom du site auquel l'URI fait r&eacute;f&eacute;rence.
localURI
L'objet DWUri qui repr&eacute;sente l'URI du site local. Si l'URI fait r&eacute;f&eacute;rence &agrave; un site distant, la valeur de la
propri&eacute;t&eacute;localURI sera nulle.
dom.browser.isCmdEnabled()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;terminer si une commande de navigateur sp&eacute;cifique est disponible.
Arguments
Cha&icirc;ne
Cha&icirc;ne repr&eacute;sentant la commande de navigateur. Le tableau suivant pr&eacute;sente les cha&icirc;nes de commande valides :
Propri&eacute;t&eacute;
Description
cut
Indique si l'action Couper est autoris&eacute;e en mode Navigateur.
copy
Indique si l'action Copier est autoris&eacute;e en mode Navigateur.
paste
Indique si l'action Coller est autoris&eacute;e en mode Navigateur.
clear
Indique si l'action Effacer est autoris&eacute;e en mode Navigateur.
selectAll
Indique si la s&eacute;lection du contenu entier est autoris&eacute;e en mode Navigateur.
find
Indique si l'action Rechercher est autoris&eacute;e en mode Navigateur.
undo
Indique si l'action Annuler est autoris&eacute;e en mode Navigateur.
redo
Indique si l'action R&eacute;p&eacute;ter est autoris&eacute;e en mode Navigateur.
print
Indique si l'action Imprimer est autoris&eacute;e en mode Navigateur.
back
Indique si l'action Pr&eacute;c&eacute;dent est disponible par l'interm&eacute;diaire de la barre de navigation du
navigateur.
forward
Indique si l'action Suivant est disponible par l'interm&eacute;diaire de la barre de navigation du navigateur.
stop
Indique si l'action Arr&ecirc;ter est disponible par l'interm&eacute;diaire de la barre de navigation du navigateur.
refresh
Indique si l'action Actualiser est disponible par l'interm&eacute;diaire de la barre de navigation du
navigateur.
setURL
Indique si une URL peut &ecirc;tre d&eacute;finie en mode Navigateur.
Derni&egrave;re mise &agrave; jour le 22/6/2011
371
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Propri&eacute;t&eacute;
Description
pageNavigationHistory
Indique si les fonctions d'historique de navigation dans les pages sont disponibles.
Les fonctions d'historique de navigation dans les pages sont les suivantes :
dom.browser.isPageNavigationHistoryEnabled(),
dom.browser.enablePageNavigationHistory(),
dom.browser.getPageNavigationHistoryLength(),
dom.browser.getPageNavigationHistoryPosition(),
dom.browser.goToPageNavigationHistoryPosition(),
dom.browser.getNavigationHistoryItem(), dom.browser.setHomePage() et
dom.browser.getHomePage().
home
Indique si l'action Accueil est disponible par l'interm&eacute;diaire de la barre de navigation du navigateur.
followLinkContextMenuItem
Indique si un lien peut &ecirc;tre s&eacute;lectionn&eacute; et suivi.
Valeurs renvoy&eacute;es
bool
Valeur bool&eacute;enne qui indique si la commande de navigateur concern&eacute;e est disponible.
dom.browser.isPageNavigationHistoryEnabled()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;terminer si le navigateur assure le suivi des pages que l'utilisateur a consult&eacute;es.
Arguments
Aucun
Valeurs renvoy&eacute;es
bool
Valeur bool&eacute;enne indiquant si le navigateur assure le suivi des pages.
dom.browser.enablePageNavigationHistory()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet d'activer ou de d&eacute;sactiver l'historique du navigateur.
Arguments
bool
Valeur bool&eacute;enne qui indique si l'historique du navigateur doit &ecirc;tre activ&eacute; ou d&eacute;sactiv&eacute;. Choisissez true pour activer
l'historique de navigation.
Derni&egrave;re mise &agrave; jour le 22/6/2011
372
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Valeurs renvoy&eacute;es
bool
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi.
dom.browser.getPageNavigationHistoryLength()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;terminer le nombre d'&eacute;l&eacute;ments dans la liste d'historique du navigateur.
Arguments
Aucun
Valeurs renvoy&eacute;es
int
Entier repr&eacute;sentant le nombre d'&eacute;l&eacute;ments dans la liste d'historique du navigateur.
dom.browser.getPageNavigationHistoryPosition()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet de d&eacute;terminer la position actuelle de l'utilisateur dans la liste d'historique du navigateur. La
position actuelle est g&eacute;n&eacute;ralement la valeur de getPageNavigationHistoryLength()-1 pour la page la plus r&eacute;cente.
Toutefois, si l'utilisateur est revenu en arri&egrave;re dans la liste d'historique, la valeur de la position actuelle est modifi&eacute;e.
Arguments
Aucun
Valeurs renvoy&eacute;es
int
Entier repr&eacute;sentant la position actuelle de l'utilisateur dans la liste d'historique du navigateur.
dom.browser.goToPageNavigationHistoryPosition()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet d'ordonner au navigateur d'acc&eacute;der &agrave; la position indiqu&eacute;e dans la liste d'historique.
Derni&egrave;re mise &agrave; jour le 22/6/2011
373
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Arguments
int
Entier repr&eacute;sentant la position dans la liste d'historique du navigateur.
Valeurs renvoy&eacute;es
Aucun
dom.browser.getPageNavigationHistoryItem()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet d'obtenir des informations sur un &eacute;l&eacute;ment sp&eacute;cifique de la liste d'historique du navigateur.
Arguments
int
Entier repr&eacute;sentant la position dans la liste d'historique du navigateur.
Valeurs renvoy&eacute;es
Objet
Objet qui poss&egrave;de les informations au sujet de l'&eacute;l&eacute;ment dans la liste d'historique du navigateur. L'objet renvoy&eacute;
poss&egrave;de les propri&eacute;t&eacute;s suivantes :
Propri&eacute;t&eacute;
Description
uri
L'URI utilis&eacute; par le navigateur pour l'&eacute;l&eacute;ment d'historique. Le type de propri&eacute;t&eacute; est un objet DWUri.
originalUri
URI d'origine de l'&eacute;l&eacute;ment d'historique. La valeur de l'URI d'origine est g&eacute;n&eacute;ralement identique &agrave;
celle de l'URI. Le type de propri&eacute;t&eacute; est un objet DWUri.
title
Titre de la page qui a &eacute;t&eacute; consult&eacute;e. Le type de propri&eacute;t&eacute; est une cha&icirc;ne.
isPost
Indique si l'&eacute;l&eacute;ment renverra les donn&eacute;es de formulaire lors de son chargement. Le type de propri&eacute;t&eacute;
est une valeur bool&eacute;enne.
dom.browser.setHomePage()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet d'ordonner au navigateur de d&eacute;finir une URL pr&eacute;cise comme page d'accueil.
Arguments
DWUri
Objet DWUri contenant les informations sur l'URI.
Derni&egrave;re mise &agrave; jour le 22/6/2011
374
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Valeurs renvoy&eacute;es
bool
Valeur bool&eacute;enne : true si l'op&eacute;ration a r&eacute;ussi.
dom.browser.getHomePage()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction sert &agrave; obtenir la page d'accueil actuelle du navigateur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Objet DWUri
Objet DWUri contenant les informations sur l'URI.
dom.browser.getSelection()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction permet d'obtenir la s&eacute;lection actuelle depuis le navigateur en mode En direct.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Renvoie une plage avec deux d&eacute;calages pour les positions de d&eacute;but et de fin de la s&eacute;lection dans le code source.
dom.browser.getStatusText()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction sert &agrave; obtenir le texte d'&eacute;tat actuel pour le navigateur. Il s'agit g&eacute;n&eacute;ralement d'une cha&icirc;ne vide ou de la
cha&icirc;ne &laquo; chargement du fichier... &raquo;.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
375
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Valeurs renvoy&eacute;es
Renvoie le texte qui s'affiche dans la zone d'&eacute;tat du chrome d'un navigateur.
dom.browser.getWindow()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction sert &agrave; obtenir l'objet de fen&ecirc;tre pour le contr&ocirc;le de navigateur. Vous pouvez acc&eacute;der au mod&egrave;le d'objet
de document du navigateur &agrave; partir de l'objet de fen&ecirc;tre.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Renvoie un objet.
dom.browserEle.loadHTML()
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette fonction charge directement une cha&icirc;ne HTML dans le contr&ocirc;le de navigateur. Elle peut &ecirc;tre utile si vous
disposez de cha&icirc;nes HTML pr&ecirc;tes &agrave; l'emploi. Les cha&icirc;nes HTML ne doivent pas &ecirc;tre associ&eacute;es &agrave; un document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.browser.interactivityPaused
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette propri&eacute;t&eacute; permet de savoir si l'interactivit&eacute; est activ&eacute;e.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
376
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'interactivit&eacute; est activ&eacute;e et false dans le cas contraire.
dom.browser.javaScriptEnabled
Disponibilit&eacute;
Dreamweaver CS4.
Description
Cette propri&eacute;t&eacute; permet de savoir si JavaScript est activ&eacute;. Cette propri&eacute;t&eacute; fonctionne comme
dom.interactivityPaused(), mais uniquement pour le code JavaScript.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si JavaScript est activ&eacute; et false dans le cas contraire.
&lt;mm:browsercontrol&gt;
Vous pouvez utiliser cette balise dans les bo&icirc;tes de dialogue extensibles, afin d'y afficher un navigateur. Cette balise ne
poss&egrave;de aucun attribut sp&eacute;cial. Vous pouvez contr&ocirc;ler la taille de la fen&ecirc;tre de navigateur &agrave; l'aide de styles CSS. L'objet
DOM renvoy&eacute; par la balise est du m&ecirc;me type que dom.browser, mais il ne s'agit pas de la m&ecirc;me instance. La fonction
dom.browser n'est pas utilisable dans les commandes ; vous devez obtenir l'objet de navigateur dans le DOM. Voici
un exemple de cette balise :
&lt;mm:browsercontol id=&quot;myBrowser&quot; style=&quot;width: 500px; height:300px;&quot; /&gt;
Dans l'en-t&ecirc;te du document, vous devez placer un script semblable au suivant :
var browserEle = document.getElementById(&quot;myBrowser&quot;);
alert(browserEle.getWindow().document.documentElement.outerHTML);
Le contr&ocirc;le de navigateur diffuse &eacute;galement deux &eacute;v&eacute;nements sp&eacute;ciaux :
BrowserControlLoad Cet &eacute;v&eacute;nement est appel&eacute; imm&eacute;diatement apr&egrave;s que le navigateur a appel&eacute; son &eacute;v&eacute;nement de
chargement, ce qui vous permet de joindre vos propres &eacute;l&eacute;ments au DOM de navigateur charg&eacute;.
BrowserControlBeforeNavigation Cet &eacute;v&eacute;nement est appel&eacute; lorsque le navigateur est sur le point d'acc&eacute;der &agrave; une
nouvelle page. Si l'&eacute;v&eacute;nement est annul&eacute;, la demande de navigation l'est &eacute;galement et le contr&ocirc;le de navigateur reste
sur la page actuelle. Le contexte de l'&eacute;v&eacute;nement contient &eacute;galement l'URL demand&eacute;e.
L'exemple suivant illustre le fonctionnement de ces &eacute;v&eacute;nements :
var browserEle = document.getElementById(&quot;myBrowser&quot;);
browserEle.addEventListener(&quot;BrowserControlBeforeNavigation&quot;,
function(e){ if (e.requestedLocation = &quot;foo.com&quot;)
e.preventDefault(); //don't allow navigation to this site!}, true);
Derni&egrave;re mise &agrave; jour le 22/6/2011
377
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Fonctions relatives aux comportements de serveur
Ces fonctions vous permettent de manipuler le panneau Comportements de serveur, accessible sous Fen&ecirc;tre &gt;
Comportements de serveur. Vous pouvez utiliser ces fonctions pour rechercher tous les comportements de serveur sur
une page. Vous pouvez aussi les utiliser pour appliquer un nouveau comportement &agrave; un document ou pour modifier
un comportement existant, et ce par le biais d'un programme.
Remarque : Vous pouvez abr&eacute;ger dw.serverBehaviorInspector en dw.sbi.
dreamweaver.getParticipants()
Disponibilit&eacute;
Dreamweaver UltraDev 4.
Description
La fonction JavaScript dreamweaver.getParticipants() r&eacute;pertorie les participants pr&eacute;sents dans le document
utilisateur. Une fois tous les participants du comportement trouv&eacute;s, Dreamweaver m&eacute;morise ces listes de participants.
En g&eacute;n&eacute;ral, cette fonction est utilis&eacute;e avec la fonction findServerBehaviors() (pour plus d'informations, voir
&laquo; Comportements de serveur &raquo; dans Extension de Dreamweaver) pour rep&eacute;rer les instances d'un comportement dans
le document utilisateur.
Arguments
edmlFilename
• L'argument edmlFilename est le nom du fichier groupe ou participant qui contient les noms des participants &agrave;
localiser dans le document utilisateur. Cette cha&icirc;ne est le nom de fichier, sans l'extension .edml.
Valeurs renvoy&eacute;es
Cette fonction renvoie un tableau contenant toutes les instances du participant sp&eacute;cifi&eacute; (ou, dans le cas d'un fichier
groupe, une instance d'un participant dans le groupe) apparaissant dans le document utilisateur. Le tableau contient
des objets JavaScript, avec un &eacute;l&eacute;ment pour chaque instance de participant trouv&eacute;e dans le document utilisateur. Le
tableau est tri&eacute; selon l'ordre dans lequel les participants apparaissent dans le document. Chaque objet JavaScript
poss&egrave;de les propri&eacute;t&eacute;s suivantes :
• La propri&eacute;t&eacute; participantNode est un pointeur reli&eacute; au nœud participant dans le document utilisateur.
• La propri&eacute;t&eacute; participantName est le nom du fichier EDML du participant (sans l'extension .edml).
• La propri&eacute;t&eacute; parameters est un objet JavaScript qui stocke toutes les paires param&egrave;tre/valeur.
• La propri&eacute;t&eacute; matchRangeMin d&eacute;finit le d&eacute;calage de caract&egrave;res &agrave; partir du nœud participant du document jusqu'au
d&eacute;but du contenu du participant.
• La propri&eacute;t&eacute; matchRangeMax est un nombre entier du participant d&eacute;finissant le d&eacute;calage depuis le d&eacute;but du nœud
participant jusqu'au dernier caract&egrave;re du contenu du participant.
dreamweaver.serverBehaviorInspector.getServer Behaviors()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Derni&egrave;re mise &agrave; jour le 22/6/2011
378
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Description
Affiche une liste de tous les comportements sur une page. Si Dreamweaver d&eacute;termine que la liste interne des
comportements de serveur n'est peut-&ecirc;tre pas &agrave; jour, il appelle la fonction findServerBehaviors() pour chaque
comportement install&eacute;. Chaque fonction renvoie un tableau. Dreamweaver fusionne tous les tableaux en un seul
tableau et le trie dans l'ordre o&ugrave; chaque objet selectedNode de comportement appara&icirc;t dans le document.
Dreamweaver stocke le tableau fusionn&eacute; localement. La fonction getServerBehaviors() renvoie un pointeur au
tableau fusionn&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau d'objets JavaScript. L'appel findServerBehaviors() renvoie les objets dans le tableau. Ils sont tri&eacute;s dans leur
ordre d'apparition dans le panneau Comportements de serveur.
dreamweaver.popupServerBehavior()
Disponibilit&eacute;
Dreamweaver UltraDev 1.
Description
Applique un nouveau comportement de serveur au document ou modifie un comportement existant. Si l'utilisateur
doit d&eacute;finir les param&egrave;tres du comportement, une bo&icirc;te de dialogue s'affiche.
Arguments
{behaviorName} ou {behaviorObject}
• L'argument facultatif behaviorName est une cha&icirc;ne qui repr&eacute;sente le nom du comportement, la balise de titre d'un
fichier ou un nom de fichier.
• L'argument facultatif behaviorObject est un objet comportement.
Si vous ne d&eacute;finissez pas cet argument, Dreamweaver ex&eacute;cute le comportement de serveur s&eacute;lectionn&eacute;. Si
l'argument est le nom d'un comportement de serveur, Dreamweaver ajoute ce comportement &agrave; la page. Si
l'argument est l'un des objets du tableau renvoy&eacute; par la fonction getServerBehaviors(), une bo&icirc;te de dialogue
s'affiche pour permettre &agrave; l'utilisateur de modifier les param&egrave;tres du comportement.
Valeurs renvoy&eacute;es
Aucune.
Fonctions de mod&egrave;le de serveur
Dans Dreamweaver, tous les documents ont un type de document associ&eacute;. Pour les types de documents dynamiques,
Dreamweaver associe &eacute;galement un mod&egrave;le de serveur (tel que ASP-JS, ColdFusion ou PHP-MySQL).
Les mod&egrave;les de serveur sont utilis&eacute;s pour regrouper une fonctionnalit&eacute; sp&eacute;cifique &agrave; une technologie de serveur.
Diff&eacute;rents comportements de serveur, sources de donn&eacute;es, etc., apparaissent en fonction du mod&egrave;le de serveur associ&eacute;
au document.
Derni&egrave;re mise &agrave; jour le 22/6/2011
379
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Utilisez les fonctions de mod&egrave;le de serveur pour d&eacute;terminer l'ensemble des mod&egrave;les de serveur actuellement d&eacute;finis,
le nom, la langue et la version du mod&egrave;le de serveur en cours, et si le mod&egrave;le de serveur en cours prend en charge un
ensemble nomm&eacute; de caract&egrave;res (tel que UTF-8).
Remarque : Dreamweaver lit toutes les informations contenues dans le fichier HTML du mod&egrave;le de serveur et stocke ces
informations lors du premier chargement du mod&egrave;le de serveur. Lorsqu'une extension appelle des fonctions telles que
dom.serverModel.getServerName(), dom.serverModel.getServerLanguage() et
dom.serverModel.getServerVersion(), ces fonctions renvoient les valeurs stock&eacute;es.
dom.serverModel.getAppURLPrefix()
Disponibilit&eacute;
Dreamweaver MX.
Description
Renvoie l'URL du dossier racine du site sur le serveur d'&eacute;valuation. Cette URL est la m&ecirc;me que celle qui a &eacute;t&eacute; sp&eacute;cifi&eacute;e
pour le serveur d'&eacute;valuation dans l'onglet Avanc&eacute; de la bo&icirc;te de dialogue D&eacute;finition du site.
Lorsque Dreamweaver communique avec votre serveur d'&eacute;valuation, il utilise HTTP (de la m&ecirc;me mani&egrave;re qu'un
navigateur). Il utilise alors cette URL pour acc&eacute;der au dossier racine de votre site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui maintient l'URL au serveur d'application utilis&eacute; pour les donn&eacute;es dynamiques et le d&eacute;bogage.
Exemple
Si l'utilisateur cr&eacute;e un site et pr&eacute;cise que le serveur d'&eacute;valuation est sur l'ordinateur local et que le dossier racine est
intitul&eacute; &quot;employeeapp&quot;, un appel &agrave; la fonction dom.serverModel.getAppURLPrefix() renvoie la cha&icirc;ne suivante :
http://localhost/employeeapp/
dom.serverModel.getDelimiters()
Disponibilit&eacute;
Dreamweaver MX.
Description
Permet au code JavaScript d'obtenir le d&eacute;limiteur de script pour chaque mod&egrave;le de serveur, afin de pouvoir s&eacute;parer la
gestion du mod&egrave;le de serveur et celle du code utilisateur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau d'objets dans lequel tous les objets contiennent les trois propri&eacute;t&eacute;s suivantes :
• La propri&eacute;t&eacute; startPattern est une expression r&eacute;guli&egrave;re qui correspond au d&eacute;limiteur d'ouverture de script.
Derni&egrave;re mise &agrave; jour le 22/6/2011
380
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
• La propri&eacute;t&eacute; endPattern est une expression r&eacute;guli&egrave;re qui correspond au d&eacute;limiteur de fermeture de script.
• Le mod&egrave;le participateInMerge est une valeur bool&eacute;enne qui indique si le contenu entre les d&eacute;limiteurs utilis&eacute;s doit
(true) ou non (false) prendre part &agrave; la fusion de blocs.
dom.serverModel.getDisplayName()
Disponibilit&eacute;
Dreamweaver MX.
Description
Obtient le nom du mod&egrave;le de serveur qui appara&icirc;t dans l'interface utilisateur (UI).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne dont la valeur est le nom du mod&egrave;le de serveur.
dom.serverModel.getFolderName()
Disponibilit&eacute;
Dreamweaver MX.
Description
Obtient le nom du dossier utilis&eacute; pour ce mod&egrave;le de serveur dans le dossier Configuration (tel que le sous-dossier
ServerModels).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne dont la valeur est le nom du dossier.
dom.serverModel.getServerIncludeUrlPatterns()
Disponibilit&eacute;
Dreamweaver MX.
Description
Renvoie la liste de propri&eacute;t&eacute;s, qui vous permet d'acc&eacute;der aux &eacute;l&eacute;ments suivants :
• Mod&egrave;les URL du traducteur
• R&eacute;f&eacute;rences du fichier
• Type
Derni&egrave;re mise &agrave; jour le 22/6/2011
381
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Arguments
Aucun.
Valeurs renvoy&eacute;es
Liste d'objets, un pour chaque searchPattern. Chaque objet pr&eacute;sente les trois propri&eacute;t&eacute;s suivantes :
Propri&eacute;t&eacute;
Description
pattern
Expression r&eacute;guli&egrave;re JavaScript sp&eacute;cifi&eacute;e dans le champ searchPattern d'un fichier EDML. Une
expression r&eacute;guli&egrave;re est d&eacute;limit&eacute;e par deux barres obliques (//).
fileRef
L'index de base 1 de la sous-correspondance de l'expression r&eacute;guli&egrave;re qui correspond &agrave; la r&eacute;f&eacute;rence
du fichier inclus.
type
La portion de la valeur paramName qui reste apr&egrave;s avoir &ocirc;t&eacute; le suffixe _includeUrl. Ce type est affect&eacute;
&agrave; l'attribut du type de balise &lt;MM:BeginLock&gt;. Vous en trouverez un exemple dans le fichier
ServerModelSSI.htm, dans le dossier Configuration/Translators.
Exemple
Le fragment de code suivant d'un fichier participant illustre une balise searchPatterns de traducteur :
&lt;searchPatterns whereToSearch=&quot;comment&quot;&gt;
&lt;searchPattern paramNames=&quot;,ssi_comment_includeUrl&quot;&gt;
&lt;![CDATA[/&lt;!--\s*#include\s+(file|virtual)\s*=\s*&quot;([^&quot;]*)&quot;\s*--&gt;/i]]&gt;
&lt;/searchPattern&gt;
&lt;/searchPatterns&gt;
Le mod&egrave;le de recherche contient une expression r&eacute;guli&egrave;re JavaScript qui sp&eacute;cifie deux sous-correspondances (toutes
deux entre parenth&egrave;ses). La premi&egrave;re sous-correspondance est pour la cha&icirc;ne de texte file ou virtual. La deuxi&egrave;me
sous-correspondance est une r&eacute;f&eacute;rence de fichier.
Pour acc&eacute;der au mod&egrave;le URL du traducteur, votre code doit ressembler &agrave; l'exemple suivant :
var serverModel = dw.getDocumentDOM().serverModel;
var includeArray = new Array();
includeArray = serverModel.getServerIncludeUrlPatterns();
L'appel &agrave; la fonction serverModel.getServerIncludeUrlPatterns() renvoie les trois propri&eacute;t&eacute;s suivantes :
Propri&eacute;t&eacute;
Valeur renvoy&eacute;e
pattern
/&lt;!--\s*#include\s+(file|virtual)\s*=\s*&quot;([^&quot;]*)&quot;\s*--&gt;/i
fileRef
2
type
ssi_comment
dom.serverModel.getServerInfo()
Disponibilit&eacute;
Dreamweaver MX.
Description
Renvoie des informations sp&eacute;cifiques au mod&egrave;le de serveur en cours. Ces informations figurent dans le fichier de
d&eacute;finition HTML correspondant au mod&egrave;le de serveur, situ&eacute; dans le dossier Configuration/ServerModels.
Derni&egrave;re mise &agrave; jour le 22/6/2011
382
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Vous pouvez modifier les informations contenues dans le fichier de d&eacute;finition HTML ou placer des valeurs ou
fonctions de variable suppl&eacute;mentaires dans le fichier. Vous pouvez par exemple modifier les propri&eacute;t&eacute;s serverName,
serverLanguage et serverVersion. La fonction dom.serverModel.getServerInfo() renvoie les informations
ajout&eacute;es par l'auteur du mod&egrave;le de serveur au fichier de d&eacute;finition.
Remarque : Les autres valeurs d&eacute;finies dans les fichiers de mod&egrave;les de serveur par d&eacute;faut sont r&eacute;serv&eacute;es &agrave; un usage interne.
Les propri&eacute;t&eacute;s serverName, serverLanguage et serverVersion sont sp&eacute;cifiques, accessibles directement au moyen
des fonctions correspondantes suivantes :
•
dom.serverModel.getServerName()
•
dom.serverModel.getServerLanguage()
•
dom.serverModel.getServerVersion()
Arguments
Aucun.
Valeurs renvoy&eacute;es
Objet JavaScript qui contient diverses informations sp&eacute;cifiques au mod&egrave;le de serveur en cours.
dom.serverModel.getServerName()
Disponibilit&eacute;
Dreamweaver 1 ; am&eacute;lior&eacute; dans Dreamweaver MX.
Description
Extrait le nom du serveur associ&eacute; au document et renvoie cette valeur. Le nom de serveur varie selon les technologies
de serveur (comme ASP.NET et JSP) et non selon les langages d'une m&ecirc;me technologie de serveur (comme ASP.NET
VB et ASP.NET C#). Parmi les valeurs possibles, on retrouve ASP,ASP.NET, Cold Fusion, JSP et PHP.
Pour extraire le nom de mod&egrave;le de serveur associ&eacute; au document, voir &laquo; dom.serverModel.getDisplayName() &raquo; &agrave; la
page 380 ou &laquo; dom.serverModel.getFolderName() &raquo; &agrave; la page 380.
Remarque : Pour Dreamweaver MX ou version ult&eacute;rieure, la fonction dom.serverModel.getServerName() lit la
propri&eacute;t&eacute; serverName de l'objet renvoy&eacute; par un appel &agrave; la fonction getServerInfo() dans l'API de mod&egrave;le de serveur
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient le nom du serveur.
dom.serverModel.getServerSupportsCharset()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;termine si le mod&egrave;le de serveur associ&eacute; au document prend en charge le jeu de caract&egrave;res nomm&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
383
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Remarque : Dreamweaver vous permet d'appeler cette fonction &agrave; partir du calque JavaScript mais aussi lorsque
l'utilisateur modifie l'encodage dans la bo&icirc;te de dialogue des propri&eacute;t&eacute;s. Si le mod&egrave;le de serveur ne prend pas en charge le
nouvel encodage des caract&egrave;res, cette fonction renvoie la valeur false et Dreamweaver affiche une bo&icirc;te de
dialogue d'avertissement demandant &agrave; l'utilisateur s'il souhaite faire la conversion. Cela peut
se produire par exemple lorsqu'un utilisateur essaie de convertir un document ColdFusion 4.5 en UTF-8, car ColdFusion
ne prend pas en charge l'encodage UTF-8.
Arguments
metaCharSetString
• L'argument metaCharSetString est une valeur de cha&icirc;ne qui d&eacute;nomme un jeu de caract&egrave;res donn&eacute;. Cette valeur est
la m&ecirc;me que celle de l'attribut &quot;charset=&quot; d'une balise meta associ&eacute;e &agrave; un document. Les valeurs prises en charge
pour un mod&egrave;le de serveur donn&eacute; sont d&eacute;finies dans le fichier de d&eacute;finition HTML pour le mod&egrave;le de serveur, situ&eacute;
dans le dossier Configuration/ServerModels.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le mod&egrave;le de serveur prend en charge le jeu de caract&egrave;res nomm&eacute;, false dans le cas
contraire.
dom.serverModel.getServerVersion()
Disponibilit&eacute;
UltraDev 1; am&eacute;lior&eacute; dans Dreamweaver MX.
Description
D&eacute;termine le mod&egrave;le de serveur associ&eacute; au document et renvoie cette valeur. Chaque mod&egrave;le de serveur a une fonction
getVersionArray() (dans l'API de mod&egrave;le de serveur), qui renvoie un tableau de couples nom-version.
Remarque : Pour Dreamweaver, la fonction dom.serverModel.getServerVersion() lit d'abord la propri&eacute;t&eacute;
serverVersion de l'objet renvoy&eacute; par un appel &agrave; la fonction getServerInfo() dans l'API de mod&egrave;le de serveur. Si cette
propri&eacute;t&eacute; n'existe pas, la fonction dom.serverModel.getServerVersion() la lit &agrave; partir de la fonction
getVersionArray().
Arguments
name
• L'argument name est une cha&icirc;ne repr&eacute;sentant le nom d'un mod&egrave;le de serveur.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient la version du mod&egrave;le de serveur nomm&eacute;.
dom.serverModel.testAppServer()
Disponibilit&eacute;
Dreamweaver MX.
Description
Teste s'il est possible d'&eacute;tablir une connexion au serveur d'application.
Derni&egrave;re mise &agrave; jour le 22/6/2011
384
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Documents dynamiques
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne qui indique si la demande de connexion au serveur d'application a &eacute;t&eacute; accept&eacute;e.
dreamweaver.getServerModels()
Disponibilit&eacute;
Dreamweaver MX.
Description
Obtient les noms de tous les mod&egrave;les de serveur actuellement d&eacute;finis. Les noms sont les m&ecirc;mes que ceux qui
apparaissent dans la zone de texte Mod&egrave;le de serveur de la bo&icirc;te de dialogue D&eacute;finition du site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes. Tous les &eacute;l&eacute;ments de cha&icirc;ne contiennent le nom d'un mod&egrave;le de serveur actuellement d&eacute;fini.
Derni&egrave;re mise &agrave; jour le 22/6/2011
385
Chapitre 17 : Cr&eacute;ation
Les fonctions de conception d'Adobe&reg; Dreamweaver&reg; permettent d'effectuer des op&eacute;rations en rapport avec la
personnalisation de l'apparence d'un document. Ces op&eacute;rations comprennent des fonctions qui vous permettent
d'effectuer les activit&eacute;s suivantes :
• Application d'une feuille de style en cascade (CSC) sp&eacute;cifi&eacute;e
• Fractionnement vertical ou horizontal d'un cadre s&eacute;lectionn&eacute;
• Alignement des zones r&eacute;actives ou des calques s&eacute;lectionn&eacute;s
• Lecture d'un &eacute;l&eacute;ment de plug-in s&eacute;lectionn&eacute;
• Cr&eacute;er une cellule de mise en forme
• Manipulation de lignes ou de colonnes de tableau
Fonctions relatives aux mises en forme CSS
Ces fonctions permettent d'appliquer, de retirer, de cr&eacute;er et de supprimer des styles CSS. Les m&eacute;thodes de l'objet
dreamweaver.cssRuleTracker contr&ocirc;lent ou agissent sur l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; dans le panneau de suivi des r&egrave;gles
CSS de l'inspecteur de s&eacute;lections. Les m&eacute;thodes de l'objet dreamweaver.cssStylePalette contr&ocirc;lent ou agissent sur
la s&eacute;lection dans le panneau Styles CSS, et non dans le document actif.
dom.applyLayout()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Applique une mise en forme CSS au document. Le corps du document doit &ecirc;tre vide, et le document doit &ecirc;tre une page
dans laquelle vous pouvez appliquer une mise en forme. C'est-&agrave;-dire :
• une page bas&eacute;e sur le code HTML, telle que HTML, XHTML, ColdFusion, PHP, etc. (mais pas CSS, XML,
JavaScript, etc.) ;
• une page qui n'est pas un jeu de cadres ni une instance de mod&egrave;le (bien qu'un mod&egrave;le soit appropri&eacute;).
Arguments
layout-index, CSS, cssFileName, preventOverwrite
• layout-index est un entier d'index de base z&eacute;ro sp&eacute;cifiant la mise en forme &agrave; utiliser. Il s'agit d'un index dans la liste
des mises en forme qui sert &agrave; renvoyer les valeurs layoutNames et layoutDescriptions dans les fonctions
correspondantes.
• CSS indique o&ugrave; placer la mise en forme CSS. Les valeurs possibles sont les suivantes :
• &quot;embed&quot; - incorporer le fichier CSS dans la section head du document.
• &quot;link&quot; - &eacute;tablir un lien vers cssFileName.
Derni&egrave;re mise &agrave; jour le 22/6/2011
386
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
• &quot;create_and_link&quot; - &eacute;crire un fichier CSS dans cssFileName et &eacute;tablir un lien vers lui.
• &quot;import&quot;- importer cssFileName.
• &quot;create_and_import&quot; - &eacute;crire un fichier CSS dans cssFileName et importer.
• cssFileName est le nom du fichier CSS vers lequel &eacute;tablir un lien ou &agrave; importer et &agrave; cr&eacute;er, le cas &eacute;ch&eacute;ant.
• preventOverwrite est une valeur bool&eacute;enne o&ugrave; true : lors de la cr&eacute;ation d'un nouveau fichier CSS, &eacute;choue si le
fichier existe d&eacute;j&agrave; ; false : &eacute;crase le fichier s'il existe d&eacute;j&agrave;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la mise en page a &eacute;t&eacute; appliqu&eacute;e, false dans le cas contraire.
Exemple
dw.getLayoutNames();
var theDOM = dw.getDocumentDOM();
alert (theDOM.canApplyLayout());
if (theDOM.canApplyLayout())
theDOM.applyLayout(1, &quot;embed&quot;);
else
alert(&quot;can't apply layout to this doc&quot;);
dom.canApplyLayout()
Disponibilit&eacute;
Dreamweaver CS3.
Description
V&eacute;rifie si une mise en forme CSS peut &ecirc;tre appliqu&eacute;e au document. Cette fonction v&eacute;rifie que le corps du document
est vide, et qu'il s'agit d'une page dans laquelle vous pouvez appliquer une mise en forme. C'est-&agrave;-dire :
• une page bas&eacute;e essentiellement sur le code HTML, telle que HTML, XHTML, ColdFusion, PHP, etc. (mais pas CSS,
XML, JavaScript, etc.) ;
• une page qui n'est pas un jeu de cadres ni une instance de mod&egrave;le (bien qu'un mod&egrave;le soit appropri&eacute;). evelyn
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne o&ugrave; true : la mise en page peut &ecirc;tre appliqu&eacute;e. false : la mise en forme ne peut pas &ecirc;tre appliqu&eacute;e.
dw.getFilesForLayout()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Obtient les chemins des fichiers de configuration pour la mise en forme sp&eacute;cifi&eacute;e.
Derni&egrave;re mise &agrave; jour le 22/6/2011
387
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Arguments
layoutIndex
• layoutIndex est un entier d'index de base z&eacute;ro sp&eacute;cifiant la mise en forme. Il s'agit d'un index dans la liste des mises
en forme qui sert &agrave; renvoyer les valeurs layoutNames et layoutDescriptions dans les fonctions correspondantes.
Valeurs renvoy&eacute;es
Un tableau de cha&icirc;nes contenant les chemins complets des fichiers HTML et des fichiers d'image d'aper&ccedil;u (pouvant
&ecirc;tre null).
dw.getLayoutNames()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Obtient les noms des mises en forme CSS disponibles.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Un tableau de cha&icirc;nes des noms des mises en forme.
dw.getLayoutDescriptions()
Disponibilit&eacute;
Dreamweaver CS3.
Description
Obtient les descriptions des mises en forme CSS disponibles.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Un tableau de cha&icirc;nes des descriptions des mises en forme.
dom.applyCSSStyle()
Disponibilit&eacute;
Dreamweaver 4.
Description
Applique le style sp&eacute;cifi&eacute; &agrave; l'&eacute;l&eacute;ment sp&eacute;cifi&eacute;. Cette fonction n'est valide que pour le document actif.
Derni&egrave;re mise &agrave; jour le 22/6/2011
388
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Arguments
elementNode, styleName, {classOrID}, {bForceNesting}
• L'argument elementNode d&eacute;signe un nœud d'&eacute;l&eacute;ment dans le DOM. Si l'argument elementNode a pour valeur NULL
ou est exprim&eacute; sous forme d'une cha&icirc;ne vide (&quot;&quot;), la fonction agit sur la s&eacute;lection en cours.
• L'argument styleName est le nom d'un style CSS.
• L'argument facultatif classOrID est l'attribut avec lequel le style doit &ecirc;tre appliqu&eacute; (&quot;class&quot; ou &quot;id&quot;). Si l'argument
elementNode a pour valeur NULL ou s'il est exprim&eacute; sous forme d'une cha&icirc;ne vide et qu'aucune balise n'entoure
compl&egrave;tement la s&eacute;lection, le style est appliqu&eacute; avec des balises SPAN. Si la s&eacute;lection est un point d'insertion,
Dreamweaver utilise la m&eacute;thode heuristique pour d&eacute;terminer &agrave; quelle balise le style doit &ecirc;tre appliqu&eacute;.
• L'argument facultatif bForceNesting est une valeur bool&eacute;enne qui indique si l'imbrication est autoris&eacute;e ou non. Si le
drapeau bForceNesting est d&eacute;fini, Dreamweaver ins&egrave;re une nouvelle balise SPAN au lieu de tenter de modifier les
balises existantes dans le document. S'il n'est pas d&eacute;fini, cet argument a la valeur false par d&eacute;faut.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Le code suivant applique le style red &agrave; la s&eacute;lection, soit en entourant cette derni&egrave;re de balises SPAN, soit en appliquant
un attribut CLASS aux balises qui entourent la s&eacute;lection :
var theDOM = dreamweaver.getDocumentDOM('document');
theDOM.applyCSSStyle('','red');
dom.getElementView()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction renvoie le mode El&eacute;ment pour l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; dans le document. Si l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est
normal, la fonction getElementView() recherche le premier anc&ecirc;tre de l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; qui est soit full soit
hidden.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Une cha&icirc;ne indiquant l'&eacute;tat de l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;. Ces valeurs sont :
•
&quot;hidden&quot;, indique que l'&eacute;l&eacute;ment poss&egrave;de des propri&eacute;t&eacute;s CSS pouvant entra&icirc;ner un affichage masqu&eacute; partiel ou total
du contenu en mode Cr&eacute;ation. Les propri&eacute;t&eacute;s CSS prises en charge sont les suivantes :
• overflow : hidden, scroll ou auto
• display : aucune
•
&quot;full&quot;, indique que par d&eacute;faut l'&eacute;l&eacute;ment est &quot;hidden&quot;, mais que la valeur actuelle est &quot;full&quot; comme d&eacute;finie par la
fonction setElementView(&quot;full&quot;).
•
&quot;normal&quot;, indique que l'&eacute;l&eacute;ment n'a pour valeur ni &quot;hidden&quot; ni &quot;full&quot;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
389
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Exemple
L'exemple suivant modifie l'&eacute;tat de l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; en &quot;full&quot; s'il a pour valeur &quot;hidden&quot; :
var currentDOM = dw.getDocumentDOM();
if (currentDOM &amp;&amp; getElementView() == &quot;hidden&quot;){
currentDOM.setElementView(&quot;full&quot;);
}
dom.getShowDivBackgrounds()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction renvoie l'&eacute;tat de l'assistance visuelle Arri&egrave;re-plans des blocs de mise en forme.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne; true si l'assistance visuelle Arri&egrave;re-plans des blocs de mise en forme est
activ&eacute;e, false dans le cas contraire.
Exemple
L'exemple suivant v&eacute;rifie si l'assistance visuelle Arri&egrave;re-plans des blocs de mise en forme est activ&eacute;e et, si ce n'est pas le
cas, l'active :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowDivBackgrounds() == false){
currentDOM.setShowDivBackgrounds(true);
}
dom.getShowDivBoxModel()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction renvoie l'&eacute;tat de l'assistance visuelle Mod&egrave;le de bo&icirc;te des blocs de mise en forme.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne ; true si l'assistance visuelle Mod&egrave;le de bo&icirc;te des blocs de mise en forme est activ&eacute;e, false dans le
cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
390
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Exemple
L'exemple suivant v&eacute;rifie si l'assistance visuelle Mod&egrave;le de bo&icirc;te des blocs de mise en forme est activ&eacute;e et, si ce n'est pas
le cas, l'active :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowDivBoxModel() == false){
currentDOM.setShowDivBoxModel(true);
}
dom.getShowDivOutlines()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction renvoie l'&eacute;tat de l'assistance visuelle Contours des blocs de mise en forme.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne; true si l'assistance visuelle Contours des blocs de mise en forme est activ&eacute;e,
false dans le cas contraire.
Exemple
L'exemple suivant v&eacute;rifie si l'assistance visuelle Contours des blocs de mise en forme est activ&eacute;e et, si ce n'est pas le cas,
l'active :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowDivOutlines() == false){
currentDOM.setShowDivOutlines(true);
}
dom.removeCSSStyle()
Disponibilit&eacute;
Dreamweaver 3.
Description
Supprime l'attribut CLASS ou ID de l'&eacute;l&eacute;ment sp&eacute;cifi&eacute; ou supprime les balises SPAN qui entourent compl&egrave;tement
l'&eacute;l&eacute;ment sp&eacute;cifi&eacute;. Cette fonction n'est valide que pour le document actif.
Arguments
elementNode, {classOrID}
• L'argument elementNode d&eacute;signe un nœud d'&eacute;l&eacute;ment dans le DOM. Si l'argument elementNode est une cha&icirc;ne vide
(&quot;&quot;), la fonction est appliqu&eacute;e &agrave; la s&eacute;lection en cours.
Derni&egrave;re mise &agrave; jour le 22/6/2011
391
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
• L'argument facultatif classOrID est l'attribut qui doit &ecirc;tre supprim&eacute; (&quot;class&quot; ou &quot;id&quot;). Si l'argument classOrID
n'est pas sp&eacute;cifi&eacute;, il prend par d&eacute;faut la valeur &quot;class&quot;. Si aucun attribut CLASS n'est d&eacute;fini pour l'argument
elementNode, la balise SPAN entourant l'argument elementNode est supprim&eacute;e.
Valeurs renvoy&eacute;es
Aucune.
dom.resetAllElementViews()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction r&eacute;tablit le mode El&eacute;ment original de tous les &eacute;l&eacute;ments du document en supprimant tous les styles CSS
g&eacute;n&eacute;r&eacute;s en interne.
Arguments
{forceRefresh}
• L'argument facultatif forceRefresh est une valeur bool&eacute;enne qui indique s'il faut actualiser le rendu de la totalit&eacute; du
document lorsqu'il n'y a pas de style CSS interne &agrave; supprimer. La valeur true provoque l'actualisation. La valeur
par d&eacute;faut est false.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant r&eacute;tablit le mode El&eacute;ment de tous les &eacute;l&eacute;ments du document sans avoir &agrave; actualiser le rendu :
var currentDOM = dw.getDocumentDOM();
currentDOM.resetAllElementViews(false);
dom.setElementView()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;finit le mode El&eacute;ment pour l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; dans le document. Si l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est
&quot;normal&quot;, la fonction setElementView() recherche le premier anc&ecirc;tre de l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; qui est &quot;full&quot; ou
&quot;hidden&quot;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
392
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Arguments
view
• L'argument obligatoire view est une cha&icirc;ne qui d&eacute;finit l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; comme &quot;full&quot; ou &quot;hidden&quot;. Si
l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est &quot;normal&quot;, la fonction setElementView() recherche le premier anc&ecirc;tre de l'&eacute;l&eacute;ment
s&eacute;lectionn&eacute;, qui correspond soit &agrave; &quot;full&quot; soit &agrave; &quot;hidden&quot;. Pour des informations suppl&eacute;mentaires, consultez la
section &laquo; dom.getElementView() &raquo; &agrave; la page 388. Les valeurs possibles sont les suivantes :
•
&quot;full&quot; : Supprime le style CSS interne qui place l'&eacute;l&eacute;ment en mode &quot;full&quot; pour permettre &agrave; l'&eacute;l&eacute;ment de
retrouver son &eacute;tat original.
•
&quot;hidden&quot; : Si l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; est en mode &quot;hidden&quot;, Dreamweaver g&eacute;n&egrave;re le style CSS permettant
d'afficher tout le contenu puis l'applique comme une feuille de style interne au moment de la conception.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Voir &laquo; dom.getElementView() &raquo; &agrave; la page 388.
dom.setShowDivBackgrounds()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction active ou d&eacute;sactive l'assistance visuelle Arri&egrave;re-plans des blocs de mise en forme.
Arguments
show
• L'argument obligatoire show est une valeur bool&eacute;enne qui indique s'il faut activer l'assistance visuelle Arri&egrave;re-plans
des blocs de mise en forme. D&eacute;finir l'argument show sur true active l'assistance visuelle Arri&egrave;re-plans des blocs de
mise en forme.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Voir &laquo; dom.getShowDivBackgrounds() &raquo; &agrave; la page 389.
dom.setShowDivBoxModel()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction active ou d&eacute;sactive l'assistance visuelle Mod&egrave;le de bo&icirc;te des blocs de mise en forme.
Derni&egrave;re mise &agrave; jour le 22/6/2011
393
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Arguments
show
• L'argument obligatoire show est une valeur bool&eacute;enne qui indique s'il faut activer l'assistance visuelle Mod&egrave;le de
bo&icirc;te des blocs de mise en forme. D&eacute;finir l'argument show sur true active l'assistance visuelle Mod&egrave;le de bo&icirc;te des
blocs de mise en forme.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Voir &laquo; dom.getShowDivBoxModel() &raquo; &agrave; la page 389.
dom.setShowDivOutlines()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction active ou d&eacute;sactive l'assistance visuelle Contours des blocs de mise en forme.
Arguments
show
• L'argument obligatoire show est une valeur bool&eacute;enne qui indique s'il faut activer l'assistance visuelle Contours des
blocs de mise en forme. D&eacute;finir l'argument show sur true active l'assistance visuelle Contours des blocs de mise en
forme.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Voir &laquo; dom.getShowDivOutlines() &raquo; &agrave; la page 390.
dom.getLiveViewInspectMode()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction sera &agrave; d&eacute;terminer si le mode Inspection du mode Code en direct est activ&eacute; pour le document actif. Pour
plus d'informations, voir Inspection de CSS dans le mode En direct.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
394
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le mode Inspection est activ&eacute; pour le document actif.
dom.setLiveViewInspectMode()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet d'activer ou de d&eacute;sactiver le mode Inspection du mode En direct pour le document actif. Pour
plus d'informations, voir Inspection de CSS dans le mode En direct.
Arguments
Valeur bool&eacute;enne. Indiquez true pour activer le mode Inspection du mode En direct.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.cssRuleTracker.editSelectedRule()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Permet &agrave; l'utilisateur de modifier la r&egrave;gle s&eacute;lectionn&eacute;e dans l'outil de suivi des r&egrave;gles. Cette fonction affiche la r&egrave;gle
s&eacute;lectionn&eacute;e dans la grille des propri&eacute;t&eacute;s CSS et, si cela s'av&egrave;re n&eacute;cessaire, affiche la grille des propri&eacute;t&eacute;s ainsi que la
palette qui la contient.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.cssRuleTracker.canEditSelectedRule() &raquo; &agrave; la page 520.
dreamweaver.cssRuleTracker.newRule()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Ouvre la bo&icirc;te de dialogue Nouveau style CSS pour permettre &agrave; l'utilisateur de cr&eacute;er une nouvelle r&egrave;gle.
Derni&egrave;re mise &agrave; jour le 22/6/2011
395
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.cssStylePalette.applySelectedStyle()
Disponibilit&eacute;
Dreamweaver MX.
Description
Applique le style s&eacute;lectionn&eacute; au document actif ou &agrave; la feuille de style associ&eacute;e, en fonction de l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;
dans le panneau Styles CSS.
Arguments
{pane}
• L'argument facultatif pane est une cha&icirc;ne sp&eacute;cifiant le volet du panneau Styles CSS auquel cette fonction est
appliqu&eacute;e. Les valeurs possibles sont les suivantes : &quot;stylelist&quot;, qui correspond &agrave; la liste des styles en mode
&laquo; Tout &raquo; ; &quot;cascade&quot;, qui correspond &agrave; la liste des r&egrave;gles applicables concern&eacute;es en mode &laquo; Courant &raquo; ; &quot;summary&quot;,
qui correspond &agrave; la liste des propri&eacute;t&eacute;s de la s&eacute;lection en cours en mode &laquo; Courant &raquo; et &quot;ruleInspector&quot;, qui
correspond &agrave; la liste ou grille de propri&eacute;t&eacute;s modifiable en mode &laquo; Courant &raquo;. La valeur par d&eacute;faut est &quot;stylelist&quot;.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.cssStylePalette.canApplySelectedStyle() &raquo; &agrave; la page 520.
dreamweaver.cssStylePalette.attachStyleSheet()
Disponibilit&eacute;
Dreamweaver 4.
Description
Affiche une bo&icirc;te de dialogue qui permet aux utilisateurs d'attacher une feuille de style au document actif ou &agrave; l'une
des feuilles de style qui y sont associ&eacute;es en fonction de l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; dans le panneau Styles CSS.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
396
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
dreamweaver.cssStylePalette.deleteSelectedStyle()
Disponibilit&eacute;
Dreamweaver 3.
Description
Supprime du document le style actuellement s&eacute;lectionn&eacute; dans le panneau Styles CSS.
Arguments
{pane}
• L'argument facultatif pane est une cha&icirc;ne sp&eacute;cifiant le volet du panneau Styles CSS auquel cette fonction est
appliqu&eacute;e. Les valeurs possibles sont les suivantes : &quot;stylelist&quot;, qui correspond &agrave; la liste des styles en mode
&laquo; Tout &raquo; ; &quot;cascade&quot;, qui correspond &agrave; la liste des r&egrave;gles applicables concern&eacute;es en mode &laquo; Courant &raquo; ; &quot;summary&quot;,
qui correspond &agrave; la liste des propri&eacute;t&eacute;s de la s&eacute;lection en cours en mode &laquo; Courant &raquo; et &quot;ruleInspector&quot;, qui
correspond &agrave; la liste ou grille de propri&eacute;t&eacute;s modifiable en mode &laquo; Courant &raquo;. La valeur par d&eacute;faut est &quot;stylelist&quot;.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.cssStylePalette.canDeleteSelectedStyle() &raquo; &agrave; la page 521.
dreamweaver.cssStylePalette.duplicateSelectedStyle()
Disponibilit&eacute;
Dreamweaver 3.
Description
Duplique le style actuellement s&eacute;lectionn&eacute; dans le panneau Styles CSS et affiche la bo&icirc;te de dialogue Dupliquer le style
afin de permettre &agrave; l'utilisateur d'attribuer un nom ou un s&eacute;lecteur au nouveau style.
Arguments
{pane}
• L'argument facultatif pane est une cha&icirc;ne sp&eacute;cifiant le volet du panneau Styles CSS auquel cette fonction est
appliqu&eacute;e. Les valeurs possibles sont les suivantes : &quot;stylelist&quot;, qui correspond &agrave; la liste des styles en mode
&laquo; Tout &raquo; ; &quot;cascade&quot;, qui correspond &agrave; la liste des r&egrave;gles applicables concern&eacute;es en mode &laquo; Courant &raquo; ; &quot;summary&quot;,
qui correspond &agrave; la liste des propri&eacute;t&eacute;s de la s&eacute;lection en cours en mode &laquo; Courant &raquo; et &quot;ruleInspector&quot;, qui
correspond &agrave; la liste ou grille de propri&eacute;t&eacute;s modifiable en mode &laquo; Courant &raquo;. La valeur par d&eacute;faut est &quot;stylelist&quot;.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.cssStylePalette.canDuplicateSelectedStyle() &raquo; &agrave; la page 521.
Derni&egrave;re mise &agrave; jour le 22/6/2011
397
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
dreamweaver.cssStylePalette.editSelectedStyle()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue D&eacute;finition du style correspondant au style s&eacute;lectionn&eacute; dans le panneau Styles CSS.
Arguments
{pane}
• L'argument facultatif pane est une cha&icirc;ne sp&eacute;cifiant le volet du panneau Styles CSS auquel cette fonction est
appliqu&eacute;e. Les valeurs possibles sont les suivantes : &quot;stylelist&quot;, qui correspond &agrave; la liste des styles en mode
&laquo; Tout &raquo; ; &quot;cascade&quot;, qui correspond &agrave; la liste des r&egrave;gles applicables concern&eacute;es en mode &laquo; Courant &raquo; ; &quot;summary&quot;,
qui correspond &agrave; la liste des propri&eacute;t&eacute;s de la s&eacute;lection en cours en mode &laquo; Courant &raquo; et &quot;ruleInspector&quot;, qui
correspond &agrave; la liste ou grille de propri&eacute;t&eacute;s modifiable en mode &laquo; Courant &raquo;. La valeur par d&eacute;faut est &quot;stylelist&quot;.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.cssStylePalette.canEditSelectedStyle() &raquo; &agrave; la page 521.
dreamweaver.cssStylePalette.editSelectedStyleInCodeview()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction affiche le mode Code et d&eacute;place le curseur de la souris jusqu'au code du style actuellement s&eacute;lectionn&eacute;
dans le panneau Styles CSS.
Arguments
{pane}
• L'argument facultatif pane est une cha&icirc;ne sp&eacute;cifiant le volet du panneau Styles CSS auquel cette fonction est
appliqu&eacute;e. Les valeurs possibles sont les suivantes : &quot;stylelist&quot;, qui correspond &agrave; la liste des styles en mode
&laquo; Tout &raquo; ; &quot;cascade&quot;, qui correspond &agrave; la liste des r&egrave;gles applicables concern&eacute;es en mode &laquo; Courant &raquo; ; &quot;summary&quot;,
qui correspond &agrave; la liste des propri&eacute;t&eacute;s de la s&eacute;lection en cours en mode &laquo; Courant &raquo; et &quot;ruleInspector&quot;, qui
correspond &agrave; la liste ou grille de propri&eacute;t&eacute;s modifiable en mode &laquo; Courant &raquo;. La valeur par d&eacute;faut est &quot;stylelist&quot;.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.cssStylePalette.canEditSelectedStyleInCodeview() &raquo; &agrave; la page 522.
Derni&egrave;re mise &agrave; jour le 22/6/2011
398
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
dreamweaver.cssStylePalette.editStyleSheet()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Modifier feuille de style.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.cssStylePalette.canEditStyleSheet() &raquo; &agrave; la page 522.
dreamweaver.cssStylePalette.getDisplayStyles()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;termine si les styles CSS sont rendus. La valeur par d&eacute;faut est true.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les styles CSS sont rendus, false dans le cas contraire.
Exemple
var areStylesRendered = dw.cssStylePalette.getDisplayStyles();
dreamweaver.cssStylePalette.getMediaType()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Permet d'obtenir le type de m&eacute;dia cible pour le rendu. Le type de m&eacute;dia par d&eacute;faut est &quot;screen&quot;.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
399
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Valeurs renvoy&eacute;es
Cha&icirc;ne indiquant le type de m&eacute;dia cible.
Exemple
var mediaType = dw.cssStylePalette.getMediaType();
dreamweaver.cssStylePalette.getSelectedStyle()
Disponibilit&eacute;
Dreamweaver 3 ; fullSelector disponible dans Dreamweaver MX.
Description
Obtient le nom du style actuellement s&eacute;lectionn&eacute; dans le panneau Styles CSS.
Arguments
fullSelector.
• L'argument fullSelector est une valeur bool&eacute;enne qui indique si le s&eacute;lecteur complet ou la classe uniquement doivent
&ecirc;tre renvoy&eacute;s. Si rien n'est pr&eacute;cis&eacute;, seul le nom de classe est renvoy&eacute;. Par exemple, p.class1 est un s&eacute;lecteur qui
signifie que le style est appliqu&eacute; &agrave; n'importe quelle balise p de class1, mais il ne s'applique pas, par exemple, &agrave; une
balise div de class1. Sans l'argument fullSelector , la fonction
dreamweaver.cssStylePalette.getSelectedStyle() renvoie uniquement le nom de classe, class1, pour le
s&eacute;lecteur. L'argument fullSelector ordonne &agrave; la fonction de renvoyer p.class1 au lieu de class1.
Valeurs renvoy&eacute;es
Lorsque l'argument fullSelector a la valeur true, la fonction renvoie soit le s&eacute;lecteur complet, soit une cha&icirc;ne vide
lorsque le nœud de la feuille de style est s&eacute;lectionn&eacute;.
Lorsque l'argument fullSelector a la valeur false ou est ignor&eacute;, une cha&icirc;ne qui repr&eacute;sente le nom de classe du style
s&eacute;lectionn&eacute; est renvoy&eacute;e. Si le style s&eacute;lectionn&eacute; n'a pas de classe ou si un nœud de feuille de style est s&eacute;lectionn&eacute;, une
cha&icirc;ne vide est renvoy&eacute;e.
Exemple
Si le style red est s&eacute;lectionn&eacute;, un appel &agrave; la fonction dw.cssStylePalette.getSelectedStyle() renvoie &quot;red&quot;.
dreamweaver.cssStylePalette.getStyles()
Disponibilit&eacute;
Dreamweaver 3.
Description
Renvoie la liste de tous les styles de classe que contient le document actif. Sans arguments, il renvoie simplement les
noms de s&eacute;lecteurs de classes. Si l'argument bGetIDs est true, il renvoie simplement les noms des s&eacute;lecteurs d'ID. Dans
les deux cas, si l'argument bGetFullSelector est true, il renvoie le nom de s&eacute;lecteur complet.
Prenons par exemple un fichier HTML avec le code suivant :
Derni&egrave;re mise &agrave; jour le 22/6/2011
400
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
&lt;style&gt;
.test{ background:none };
p.foo{ background:none };
#bar {background:none };
div#hello p.world {background:none};
Les appels dans le tableau suivant renvoient les valeurs dans la colonne R&eacute;sultat.
Appel de fonction
R&eacute;sultat
dw.cssStylePalette.getStyles()
foo,test,world
dw.cssStylePalette.getStyles(true)
bar,hello
dw.cssStylePalette.getStyles(false, true)
p.foo,.test,div#hello p.world
dw.cssStylePalette.getStyles(true, true)
#bar,div#hello p.world
Arguments
{bGetIDs}, {bGetFullSelector}
• L'argument bGetIDs est facultatif. Il s'agit d'une valeur bool&eacute;enne qui, si d&eacute;fini sur true, oblige la fonction &agrave;
renvoyer uniquement les noms des s&eacute;lecteurs d'ID (la partie situ&eacute;e apr&egrave;s le &quot;#&quot;). La valeur par d&eacute;faut est false.
• L'argument bGetFullSelector est facultatif. Il s'agit d'une valeur bool&eacute;enne qui, si d&eacute;fini sur true, renvoie la cha&icirc;ne
du s&eacute;lecteur compl&egrave;te, et non uniquement les noms. La valeur par d&eacute;faut est false.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes repr&eacute;sentant les noms de tous les styles de classe contenus dans le document.
Derni&egrave;re mise &agrave; jour le 22/6/2011
401
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Exemple
Si la configuration du panneau Styles CSS est calqu&eacute;e sur l'exemple suivant, un appel &agrave; la fonction
dreamweaver.cssStylePalette.getStyles() renvoie un tableau qui contient ces cha&icirc;nes : &quot;BreadcrumbEnd&quot;,
&quot;change&quot;, &quot;doctitle&quot;, &quot;heading&quot; et &quot;highlight&quot;.
dreamweaver.cssStylePalette.newStyle()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Nouveau style.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.cssStylePalette.renameSelectedStyle()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
402
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Description
Modifie le nom de classe utilis&eacute; dans la r&egrave;gle s&eacute;lectionn&eacute;e dans le panneau Styles CSS ainsi que toutes les instances du
nom de classe figurant dans la r&egrave;gle s&eacute;lectionn&eacute;e.
Arguments
{pane}
• L'argument facultatif pane est une cha&icirc;ne sp&eacute;cifiant le volet du panneau Styles CSS auquel cette fonction est
appliqu&eacute;e. Les valeurs possibles sont les suivantes : &quot;stylelist&quot;, qui correspond &agrave; la liste des styles en mode
&laquo; Tout &raquo; ; &quot;cascade&quot;, qui correspond &agrave; la liste des r&egrave;gles applicables concern&eacute;es en mode &laquo; Courant &raquo; ; &quot;summary&quot;,
qui correspond &agrave; la liste des propri&eacute;t&eacute;s de la s&eacute;lection en cours en mode &laquo; Courant &raquo; et &quot;ruleInspector&quot;, qui
correspond &agrave; la liste ou grille de propri&eacute;t&eacute;s modifiable en mode &laquo; Courant &raquo;. La valeur par d&eacute;faut est &quot;stylelist&quot;.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.cssStylePalette.canRenameSelectedStyle() &raquo; &agrave; la page 523.
dreamweaver.cssStylePalette.setDisplayStyles()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;termine si les styles CSS doivent &ecirc;tre rendus et actualise le rendu de tous les documents ouverts.
Arguments
display
• L'argument display est une valeur bool&eacute;enne : true pour rendre les styles CSS et false dans le cas contraire.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant d&eacute;sactive le rendu des styles CSS :
dw.cssStylePalette.setDisplayStyles(false);
dreamweaver.cssStylePalette.setMediaType()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Permet de d&eacute;finir le type de m&eacute;dia cible pour le rendu. Actualise le rendu de tous les documents ouverts.
Derni&egrave;re mise &agrave; jour le 22/6/2011
403
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Arguments
mediaType.
• L'argument mediaType indique le nouveau type de m&eacute;dia cible.
Valeurs renvoy&eacute;es
Aucune.
Exemple
dw.cssStylePalette.setMediaType(&quot;print&quot;);
dreamweaver.getBlockVisBoxModelColors()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction permet d'obtenir les couleurs utilis&eacute;es pour rendre le mod&egrave;le de bo&icirc;te d'un bloc s&eacute;lectionn&eacute; lorsque
l'assistance visuelle Mod&egrave;le de bo&icirc;te des blocs de mise en forme est activ&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes contenant deux cha&icirc;nes :
•
marginColor, qui correspond &agrave; la valeur hexad&eacute;cimale de la couleur RVB, sous la forme #RRVVBB.
•
paddingColor, qui correspond &agrave; la valeur hexad&eacute;cimale de la couleur RVB, sous la forme #RRVVBB.
Exemple
L'exemple suivant v&eacute;rifie la valeur de la couleur des marges et du remplissage ; si aucune n'est blanche, elles sont toutes
deux d&eacute;finies sur blanc :
var boxColors = dreamweaver.getBlockVisBoxModelColors();
if ((boxColors[0] != &quot;#FFFFFF&quot;) || (boxColors[1] != &quot;#FFFFFF)){
currentDOM.setBlockVisBoxModelColors(&quot;#FFFFFF&quot;, &quot;#FFFFFF&quot;);
}
dreamweaver.getBlockVisOutlineProperties()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction renvoie les propri&eacute;t&eacute;s de contour pour l'assistance visuelle de repr&eacute;sentation des blocs.
Derni&egrave;re mise &agrave; jour le 22/6/2011
404
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Arguments
forWhat
• L'argument obligatoire forWhat est une cha&icirc;ne. Les valeurs possibles sont les suivantes : &quot;divs&quot;, &quot;selectedDiv&quot;
ou &quot;layers&quot;. Si l'argument forWhat a pour valeur &quot;divs&quot;, la fonction renvoie les propri&eacute;t&eacute;s utilis&eacute;es pour
l'assistance visuelle qui met en surbrillance tous les blocs de mise en forme. Si l'argument forWhat a pour valeur
&quot;selectedDiv&quot;, la fonction renvoie les propri&eacute;t&eacute;s utilis&eacute;es pour l'assistance visuelle qui met en surbrillance les
blocs de mise en forme s&eacute;lectionn&eacute;s. La valeur layers d&eacute;finit les calques.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes contenant trois cha&icirc;nes :
•
color, qui correspond &agrave; la valeur hexad&eacute;cimale de la couleur RVB, sous la forme #RRVVBB ;
•
width, qui indique la largeur en pixels ;
•
style, dont la valeur est soit &quot;SOLID&quot;, &quot;DOTTED&quot;, &quot;DASHED&quot; ou &quot;OUTSET&quot;.
Exemple
L'exemple suivant renvoie les propri&eacute;t&eacute;s de contour de &quot;divs&quot; et d&eacute;finit le style de contour sur &quot;SOLID&quot; :
var outlineStyle = dw.getBlockVisOutlineProperties(&quot;divs&quot;);
if (outlineStyle[2] != &quot;SOLID&quot;){
dw.setBlockVisOutlineProperties(&quot;divs&quot;, outlineStyle[0], outlineStyle[1], &quot;SOLID&quot;);
}
dreamweaver.getDivBackgroundColors()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction renvoie les couleurs utilis&eacute;es par l'assistance visuelle Arri&egrave;re-plans des blocs de mise en forme.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes contenant les 16couleurs, chaque couleur &eacute;tant repr&eacute;sent&eacute;e par la valeur hexad&eacute;cimale de la
couleur RVB, sous la forme #RRVVBB.
Exemple
L'exemple suivant renvoie les couleurs d'arri&egrave;re-plans utilis&eacute;es par l'assistance visuelle Arri&egrave;re-plans des blocs de mise
en forme :
var backgroundColors = dreamweaver.getDivBackgroundColors();
dreamweaver.setBlockVisOutlineProperties()
Disponibilit&eacute;
Dreamweaver 8.
Derni&egrave;re mise &agrave; jour le 22/6/2011
405
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Description
Cette fonction d&eacute;finit les propri&eacute;t&eacute;s de contour pour l'assistance visuelle de repr&eacute;sentation des blocs.
Arguments
forWhat, color, width, {style}
• L'argument obligatoire forWhat est une cha&icirc;ne indiquant l'utilisation pr&eacute;vue pour la couleur et la largeur sp&eacute;cifi&eacute;es.
Les valeurs possibles sont les suivantes : &quot;divs&quot;, &quot;selectedDiv&quot; ou &quot;layers&quot;. Si la valeur est &quot;layers&quot;, la
couleur et la largeur sp&eacute;cifi&eacute;es sont utilis&eacute;es pour mettre en surbrillance tous les calques lorsque l'assistance visuelle
Contours des blocs de mise en forme est activ&eacute;e. Si la valeur est &quot;divs&quot;, les arguments color et width permettent de
mettre en surbrillance tous les divs et autres blocs de mise en forme. Si la valeur est &quot;selectedDiv&quot;, les arguments
color et width permettent de mettre en surbrillance tout div ou bloc de mise en forme s&eacute;lectionn&eacute;.
• L'argument obligatoire color est une cha&icirc;ne qui contient la valeur hexad&eacute;cimale indiquant la couleur RVB sous la
forme #RRVVBB.
• L'argument obligatoire width est un entier qui indique la largeur du contour, en pixels.
• L'argument facultatif style est une cha&icirc;ne qui indique le style du contour. Les valeurs possibles sont les suivantes :
&quot;SOLID&quot;, &quot;DOTTED&quot;, &quot;DASHED&quot; et &quot;OUTSET&quot;. La valeur &quot;OUTSET&quot; est applicable aux calques uniquement. Cet
argument est ignor&eacute; lorsque la valeur de l'argument forWhat est &quot;selectedDiv&quot;.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Voir &laquo; dreamweaver.getBlockVisOutlineProperties() &raquo; &agrave; la page 403.
dreamweaver.setDivBackgroundColors()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;finit les couleurs utilis&eacute;es par l'assistance visuelle Arri&egrave;re-plans des blocs de mise en forme.
Arguments
couleurs
• L'argument obligatoire colors est un tableau de cha&icirc;nes contenant toutes les couleurs, repr&eacute;sent&eacute;es par des valeurs
hexad&eacute;cimales sous la forme #RRVVBB. Ce tableau doit contenir 16 couleurs.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant v&eacute;rifie qu'il y ait 16 couleurs maximum sp&eacute;cifi&eacute;es comme couleurs d'arri&egrave;re-plan div et, le cas
&eacute;ch&eacute;ant, d&eacute;finit les couleurs utilis&eacute;es comme couleurs d'arri&egrave;re-plan en fonction des nuances de gris :
Derni&egrave;re mise &agrave; jour le 22/6/2011
406
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
var currentDOM = dw.getDocumentDOM();
var divColors = currentDOM.getDivBackgroundColors(&quot;divs&quot;);
var shadesOfGray = new Array[&quot;#000000&quot;, &quot;#111111&quot;, &quot;#222222&quot;, &quot;#333333&quot;,&not;
&quot;#444444&quot;, &quot;#555555&quot;, &quot;#666666&quot;, &quot;#777777&quot;, &quot;#888888&quot;, &quot;#999999&quot;, &not;
&quot;#AAAAAA&quot;, &quot;#BBBBBB&quot;, &quot;#CCCCCC&quot;, &quot;#DDDDDD&quot;, &quot;#EEEEEE&quot;, &quot;#FFFFFF&quot;]&not;
var howManyColors = divColors.length;
if howManyColors &lt;= 16{
for (var i = 0; i &lt; howManyColors; i++)
{
currentDOM.setDivBackgroundColors(&quot;divs&quot;, shadeOfGray[i]);
}
dreamweaver.getSelectedStyleIsDisabled()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction obtient l'&eacute;tat du style s&eacute;lectionn&eacute;, que la d&eacute;claration CSS s&eacute;lectionn&eacute;e soit d&eacute;sactiv&eacute;e ou non.
La fonctionnalit&eacute; D&eacute;sactiver/Activer la propri&eacute;t&eacute; CSS permet de mettre en commentaire des parties de code CSS
depuis le panneau Styles CSS, sans devoir apporter directement des modifications dans le code. Lorsque vous mettez
en commentaire certaines parties du code CSS, vous pouvez voir quel effet des propri&eacute;t&eacute;s et des valeurs sp&eacute;cifiques ont
sur votre page. Lorsque vous d&eacute;sactivez une propri&eacute;t&eacute; CSS, Dreamweaver ajoute des balises de commentaire CSS et un
libell&eacute; [d&eacute;sactiv&eacute;] &agrave; la propri&eacute;t&eacute; CSS que vous avez d&eacute;sactiv&eacute;e.
Pour plus d'informations, voir D&eacute;sactivation/Activation de CSS.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le style s&eacute;lectionn&eacute; est d&eacute;sactiv&eacute;.
dreamweaver.setSelectedStyleIsDisabled()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction d&eacute;finit l'&eacute;tat du style s&eacute;lectionn&eacute;.
Arguments
Valeur bool&eacute;enne qui permet d'activer ou de d&eacute;sactiver le style s&eacute;lectionn&eacute;. Indiquez true pour d&eacute;sactiver le style
s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
407
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
dreamweaver.deleteAllDisabled()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction supprime toutes les d&eacute;clarations d&eacute;sactiv&eacute;es dans la r&egrave;gle CSS s&eacute;lectionn&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.enableAllDisabled()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction active toutes les d&eacute;clarations d&eacute;sactiv&eacute;es dans la r&egrave;gle CSS s&eacute;lectionn&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.canDisableSelectedStyle()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction v&eacute;rifie si le style s&eacute;lectionn&eacute; peut &ecirc;tre d&eacute;sactiv&eacute; dans la s&eacute;lection en cours.
Arguments
pane. Cha&icirc;ne qui repr&eacute;sente le volet. Cet argument est facultatif. Les valeurs possibles sont les suivantes :
•
styleList : volet Toutes les r&egrave;gles en mode Tout. Il s'agit de la valeur par d&eacute;faut.
•
summary : volet R&eacute;sum&eacute; du mode Actif.
•
cascade : volet R&egrave;gles du mode Actif.
•
ruleInspector : volet Propri&eacute;t&eacute;s du mode Tout ou du mode Actif.
Pour plus d'informations sur les modes du panneau Styles CSS, voir Panneau Styles CSS.
Derni&egrave;re mise &agrave; jour le 22/6/2011
408
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le style s&eacute;lectionn&eacute; peut &ecirc;tre d&eacute;sactiv&eacute;.
dreamweaver.canDeleteAllDisabled()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction v&eacute;rifie si la fonction &laquo; dreamweaver.deleteAllDisabled() &raquo; &agrave; la page 407 peut &ecirc;tre ex&eacute;cut&eacute;e sur la
s&eacute;lection actuelle dans le panneau.
Arguments
pane. Cha&icirc;ne qui repr&eacute;sente le volet. Cet argument est facultatif. Les valeurs admises sont identiques &agrave; celles sp&eacute;cifi&eacute;es
dans la fonction &laquo; dreamweaver.canDisableSelectedStyle() &raquo; &agrave; la page 407.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la commande est disponible.
dreamweaver.canEnableAllDisabled()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction v&eacute;rifie si la fonction &laquo; dreamweaver.enableAllDisabled() &raquo; &agrave; la page 407 peut &ecirc;tre ex&eacute;cut&eacute;e sur la
s&eacute;lection actuelle dans le panneau.
Arguments
pane. Cha&icirc;ne qui repr&eacute;sente le volet. Cet argument est facultatif. Les valeurs admises sont identiques &agrave; celles sp&eacute;cifi&eacute;es
dans la fonction &laquo; dreamweaver.canDisableSelectedStyle() &raquo; &agrave; la page 407.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la commande est disponible.
Fonctions relatives aux cadres et aux jeux de cadres
Les fonctions relatives aux cadres et aux jeux de cadres remplissent deux r&ocirc;les : obtention des noms des cadres d'un jeu
de cadres et fractionnement d'un cadre en deux.
dom.getFrameNames()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
409
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Description
Renvoie la liste de tous les cadres nomm&eacute;s du jeu de cadres.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes o&ugrave; chaque cha&icirc;ne correspond au nom d'un cadre dans le jeu de cadres en cours. La fonction ignore
tous les cadres sans nom. Si aucun des cadres du jeu n'est nomm&eacute;, un tableau vide est renvoy&eacute;.
Exemple
Pour un document contenant quatre cadres, dont deux sont nomm&eacute;s, un appel &agrave; la fonction dom.getFrameNames()
pourrait renvoyer un tableau contenant les cha&icirc;nes suivantes :
•
&quot;navframe&quot;
•
&quot;main_content&quot;
dom.isDocumentInFrame()
Disponibilit&eacute;
Dreamweaver 4.
Description
Indique si le document actif est affich&eacute; &agrave; l'int&eacute;rieur d'un jeu de cadres.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le document se trouve dans un jeu de cadres et false dans le cas contraire.
dom.saveAllFrames()
Disponibilit&eacute;
Dreamweaver 4.
Description
Si un document est un jeu de cadres ou se trouve &agrave; l'int&eacute;rieur d'un jeu de cadres, cette fonction enregistre tous les cadres
ou les jeux de la fen&ecirc;tre de document. Si le document sp&eacute;cifi&eacute; ne se trouve pas dans un jeu de cadres, cette fonction
enregistre le document. Cette fonction ouvre la bo&icirc;te de dialogue Enregistrer sous pour tous les documents qui n'ont
pas &eacute;t&eacute; enregistr&eacute;s pr&eacute;c&eacute;demment.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
410
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Valeurs renvoy&eacute;es
Aucune.
dom.splitFrame()
Disponibilit&eacute;
Dreamweaver 3.
Description
Fractionne le cadre s&eacute;lectionn&eacute; verticalement ou horizontalement.
Arguments
splitDirection.
• L'argument splitDirection est une cha&icirc;ne qui doit d&eacute;finir l'une des directions suivantes : &quot;up&quot;, &quot;down&quot;, &quot;left&quot; ou
&quot;right&quot;.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canSplitFrame() &raquo; &agrave; la page 510.
Fonctions relatives aux calques et aux cartes d'images
Ces fonctions permettent d'aligner, de redimensionner et de d&eacute;placer des calques et des zones r&eacute;actives de carte
d'images. Il est indiqu&eacute;, dans la description de chaque fonction, si cette derni&egrave;re s'applique aux calques ou aux zones
r&eacute;actives.
dom.align()
Disponibilit&eacute;
Dreamweaver 3.
Description
Aligne &agrave; gauche, &agrave; droite, en haut ou en bas les calques ou zones r&eacute;actives s&eacute;lectionn&eacute;s.
Arguments
alignDirection.
• L'argument alignDirection est une cha&icirc;ne qui repr&eacute;sente le bord par rapport auquel aligner les calques ou les zones
r&eacute;actives, &agrave; savoir &quot;left&quot;, &quot;right&quot;, &quot;top&quot; ou &quot;bottom&quot;.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
411
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Activateur
Voir &laquo; dom.canAlign() &raquo; &agrave; la page 501.
dom.arrange()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place les zones r&eacute;actives s&eacute;lectionn&eacute;es dans le sens indiqu&eacute;.
Arguments
toBackOrFront.
• L'argument toBackOrFront correspond au sens du d&eacute;placement des zones r&eacute;actives, &agrave; savoir front ou back.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canArrange() &raquo; &agrave; la page 502.
dom.makeSizesEqual()
Disponibilit&eacute;
Dreamweaver 3.
Description
Affecte aux calques ou aux zones r&eacute;actives s&eacute;lectionn&eacute;s la m&ecirc;me hauteur ou la m&ecirc;me largeur, ou les deux. Le dernier
calque ou la derni&egrave;re zone r&eacute;active s&eacute;lectionn&eacute;e sert de guide.
Arguments
bHoriz, bVert.
• L'argument bHoriz est une valeur bool&eacute;enne qui indique si les calques ou les zones r&eacute;actives doivent &ecirc;tre
redimensionn&eacute;s horizontalement.
• L'argument bVert est une valeur bool&eacute;enne qui indique si les calques ou les zones r&eacute;actives doivent &ecirc;tre
redimensionn&eacute;s verticalement.
Valeurs renvoy&eacute;es
Aucune.
dom.moveSelectionBy()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
412
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Description
D&eacute;place les calques ou les zones r&eacute;actives s&eacute;lectionn&eacute;s horizontalement et verticalement du nombre de pixels sp&eacute;cifi&eacute;s.
Arguments
x, y
• L'argument x est le nombre de pixels dont la s&eacute;lection doit &ecirc;tre d&eacute;plac&eacute;e horizontalement.
• L'argument y est le nombre de pixels dont la s&eacute;lection doit &ecirc;tre d&eacute;plac&eacute;e verticalement.
Valeurs renvoy&eacute;es
Aucune.
dom.resizeSelectionBy()
Disponibilit&eacute;
Dreamweaver 3.
Description
Redimensionne le calque ou la zone r&eacute;active s&eacute;lectionn&eacute;e.
Arguments
left, top, bottom, right.
• L'argument left est la nouvelle position de la limite gauche du calque ou de la zone r&eacute;active.
• L'argument top est la nouvelle position de la limite sup&eacute;rieure du calque ou de la zone r&eacute;active.
• L'argument bottom est la nouvelle position de la limite inf&eacute;rieure du calque ou de la zone r&eacute;active.
• L'argument right est la nouvelle position de la limite droite du calque ou de la zone r&eacute;active.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Si le calque s&eacute;lectionn&eacute; poss&egrave;de les propri&eacute;t&eacute;s Gauche (left), Sommet (top), Largeur (width) et Hauteur (height)
indiqu&eacute;es, un appel &agrave; la fonction dw.getDocumentDOM().resizeSelectionBy(10,30,30,10) revient &agrave; restaurer
Gauche &agrave; 40, Sommet &agrave; 20, Largeur &agrave; 240 et Hauteur &agrave; 240.
dom.setLayerTag()
Disponibilit&eacute;
Dreamweaver 3.
Description
Sp&eacute;cifie la balise HTML d&eacute;finissant le ou les calques s&eacute;lectionn&eacute;s.
Derni&egrave;re mise &agrave; jour le 22/6/2011
413
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Arguments
tagName
• L'argument tagName doit &ecirc;tre &quot;layer&quot;,&quot;ilayer&quot;,
&quot;div&quot; ou &quot;span&quot;.
Valeurs renvoy&eacute;es
Aucune.
Fonctions d'environnement de mise en forme
Ces fonctions permettent d'effectuer des op&eacute;rations associ&eacute;es aux param&egrave;tres d'utilisation d'un document. Elles
permettent de modifier la source, la position et l'opacit&eacute; du trac&eacute; de l'image, d'obtenir et de d&eacute;finir l'origine et les unit&eacute;s
de mesure de la r&egrave;gle, d'activer et de d&eacute;sactiver la grille et d'en modifier les param&egrave;tres, de d&eacute;marrer et d'arr&ecirc;ter
l'ex&eacute;cution des plug-ins.
dom.getRulerOrigin()
Disponibilit&eacute;
Dreamweaver 3.
Description
Renvoie l'origine de la r&egrave;gle.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau contenant deux nombres entiers. Le premier entier correspond &agrave; la coordonn&eacute;e x de l'origine, le second &agrave; la
coordonn&eacute;e y. Les deux valeurs sont exprim&eacute;es en pixels.
dom.getRulerUnits()
Disponibilit&eacute;
Dreamweaver 3.
Description
Renvoie les unit&eacute;s de mesure actuelles de la r&egrave;gle.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient l'une des valeurs suivantes :
•
&quot;in&quot;
Derni&egrave;re mise &agrave; jour le 22/6/2011
414
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
•
&quot;cm&quot;
•
&quot;px&quot;
dom.getTracingImageOpacity()
Disponibilit&eacute;
Dreamweaver 3.
Description
Renvoie le param&egrave;tre d'opacit&eacute; du trac&eacute; de l'image dans le document actif.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur comprise entre 0 et 100, ou rien si l'opacit&eacute; n'est pas d&eacute;finie.
Activateur
Voir &laquo; dom.hasTracingImage() &raquo; &agrave; la page 511.
dom.loadTracingImage()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue S&eacute;lectionner source de l'image. Si l'utilisateur s&eacute;lectionne une image et clique sur OK, la
bo&icirc;te de dialogue Propri&eacute;t&eacute;s de la page s'ouvre et le champ Trac&eacute; de l'image contient une valeur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.playAllPlugins()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ex&eacute;cute tous les plug-ins dans le document.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
415
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Valeurs renvoy&eacute;es
Aucune.
dom.playPlugin()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ex&eacute;cute le plug-in s&eacute;lectionn&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canPlayPlugin() &raquo; &agrave; la page 508.
dom.getRulerOrigin()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;finit l'origine de la r&egrave;gle.
Arguments
xCoordinate, yCoordinate
• L'argument xCoordinate est une valeur, exprim&eacute;e en pixels, sur l'axe horizontal.
• L'argument yCoordinate est une valeur, exprim&eacute;e en pixels, sur l'axe vertical.
Valeurs renvoy&eacute;es
Aucune.
dom.setRulerUnits()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;finit les unit&eacute;s de mesure de la r&egrave;gle.
Derni&egrave;re mise &agrave; jour le 22/6/2011
416
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Arguments
units
• L'argument units doit &ecirc;tre &quot;px&quot;, &quot;in&quot; ou &quot;cm&quot;.
Valeurs renvoy&eacute;es
Aucune.
dom.setTracingImagePosition()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place le coin sup&eacute;rieur gauche du trac&eacute; de l'image vers les coordonn&eacute;es sp&eacute;cifi&eacute;es. Si les arguments ne sont pas
d&eacute;finis, la bo&icirc;te de dialogue Ajuster la position du trac&eacute; de l'image s'affiche.
Arguments
x, y
• L'argument x est le nombre de pixels d&eacute;finissant la coordonn&eacute;e horizontale.
• L'argument y est le nombre de pixels d&eacute;finissant la coordonn&eacute;e verticale.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.hasTracingImage() &raquo; &agrave; la page 511.
dom.setTracingImageOpacity()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;finit le pourcentage d'opacit&eacute; du trac&eacute; de l'image.
Arguments
opacityPercentage.
• L'argument opacityPercentage doit &ecirc;tre un nombre entre 0 et 100.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.hasTracingImage() &raquo; &agrave; la page 511.
Derni&egrave;re mise &agrave; jour le 22/6/2011
417
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Exemple
Le code suivant r&egrave;gle l'opacit&eacute; du trac&eacute; de l'image sur 30% :
dw.getDocumentDOM().setTracingOpacity('30');
dom.snapTracingImageToSelection()
Disponibilit&eacute;
Dreamweaver 3.
Description
Aligne le coin sup&eacute;rieur gauche du trac&eacute; de l'image avec le coin sup&eacute;rieur gauche de la s&eacute;lection en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.hasTracingImage() &raquo; &agrave; la page 511.
dom.stopAllPlugins()
Disponibilit&eacute;
Dreamweaver 3.
Description
Arr&ecirc;te l'ex&eacute;cution de tous les plug-ins en cours dans le document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.stopPlugin()
Disponibilit&eacute;
Dreamweaver 3.
Description
Arr&ecirc;te le plug-in s&eacute;lectionn&eacute;.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
418
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne qui indique si la s&eacute;lection est ex&eacute;cut&eacute;e actuellement avec un plug-in.
Activateur
Voir &laquo; dom.canStopPlugin() &raquo; &agrave; la page 510.
dreamweaver.arrangeFloatingPalettes()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;place les panneaux flottants visibles vers leur position par d&eacute;faut.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.showGridSettingsDialog()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Param&egrave;tres de la grille.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Fonctions relatives au mode de Mise en forme
Ces fonctions permettent de modifier les &eacute;l&eacute;ments de mise en forme d'un document. Elles s'appliquent aux param&egrave;tres
de tableau, colonnes et cellules, y compris leur position, propri&eacute;t&eacute;s et aspect.
dom.getClickedHeaderColumn()
Disponibilit&eacute;
Dreamweaver 4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
419
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Description
Si l'utilisateur clique sur un bouton de menu dans l'en-t&ecirc;te d'un tableau du mode de Mise en forme, faisant ainsi
appara&icirc;tre le menu d'en-t&ecirc;te du tableau, cette fonction renvoie l'index de la colonne sur laquelle l'utilisateur a cliqu&eacute;.
Le r&eacute;sultat n'est pas d&eacute;fini si le menu d'en-t&ecirc;te du tableau n'est pas visible.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Nombre entier qui repr&eacute;sente l'index de la colonne.
dom.getShowLayoutTableTabs()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;termine si le document actif affiche les tabulations des tableaux de Mise en forme dans le mode correspondant.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Renvoie la valeur true si le document actif affiche les tabulations des tableaux de Mise en forme dans le mode
correspondant et false si tel n'est pas le cas.
dom.getShowLayoutView()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;termine le mode d'affichage du document actif, Mise en forme ou Standard.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Renvoie la valeur true si le document actif est en mode de Mise en forme et false s'il est en mode Standard.
dom.getShowBlockBackgrounds()
Disponibilit&eacute;
Dreamweaver 8.
Derni&egrave;re mise &agrave; jour le 22/6/2011
420
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Description
Cette fonction renvoie l'&eacute;tat de l'assistance visuelle qui active la coloration de l'arri&egrave;re-plan de tous les blocs ou divs.
Arguments
allblocks
• L'argument obligatoire allblocks est une valeur bool&eacute;enne. D&eacute;finir la valeur sur true pour que l'argument ne soit
appliqu&eacute; qu'aux balises div. D&eacute;finir la valeur sur false pour que l'argument soit appliqu&eacute; &agrave; tous les &eacute;l&eacute;ments de bloc.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne. Si d&eacute;finie sur true, les arri&egrave;re-plans sont impos&eacute;s ; si d&eacute;finie sur false, les arri&egrave;re-plans ne
sont pas impos&eacute;s.
Exemple
L'exemple suivant v&eacute;rifie si la coloration d'arri&egrave;re-plan de tous les blocs est impos&eacute;e et, si ce n'est pas le cas, active la
coloration d'arri&egrave;re-plan de tous les blocs ::
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowBlockBackgrounds(false) == false){
currentDOM.setShowBlockBackgrounds(false);
}
dom.getShowBlockBorders()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction renvoie l'&eacute;tat de l'assistance visuelle qui dessine les bordures de tous les blocs ou divs.
Arguments
allblocks
• L'argument obligatoire allblocks est une valeur bool&eacute;enne. D&eacute;finir la valeur sur true pour obtenir uniquement l'&eacute;tat
des balises div. D&eacute;finir la valeur sur false pour obtenir l'&eacute;tat de tous les &eacute;l&eacute;ments de bloc.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne ; si d&eacute;finie sur true, les bordures sont affich&eacute;es ; si d&eacute;finie sur false, les bordures ne sont pas
affich&eacute;es.
Exemple
L'exemple suivant v&eacute;rifie si l'assistance visuelle des bordures de blocs est activ&eacute;e et, si ce n'est pas le cas, l'active :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowBlockBorders(false) == false){
currentDOM.setShowBlockBorders(true);
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
421
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
dom.getShowBlockIDs()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction renvoie l'&eacute;tat de l'assistance visuelle qui affiche les informations relatives &agrave; la classe et &agrave; l'ID de tous les
blocs ou divs.
Arguments
allblocks
• L'argument obligatoire allblocks est une valeur bool&eacute;enne. D&eacute;finir la valeur sur true pour afficher uniquement la
classe et l'ID des balises div. D&eacute;finir la valeur sur false pour afficher la classe et l'ID de tous les &eacute;l&eacute;ments de bloc.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : si d&eacute;finie sur true, les ID sont affich&eacute;s ; si d&eacute;finie sur false, les ID ne sont pas affich&eacute;s.
Exemple
L'exemple suivant v&eacute;rifie si les ID de blocs sont affich&eacute;s et, si ce n'est pas le cas, les affiche :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowBlockIDs(false) == false){
currentDOM.setShowBlockIDs(true);
}
dom.getShowBoxModel()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction active ou d&eacute;sactive l'assistance visuelle qui colore le mod&egrave;le de bo&icirc;te complet du bloc s&eacute;lectionn&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant v&eacute;rifie si le mod&egrave;le de bo&icirc;te complet de la bo&icirc;te s&eacute;lectionn&eacute;e est affich&eacute; en couleur et, si ce n'est pas
le cas, le colore :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.getShowBoxModel() == false){
currentDOM.setShowBoxModel(true);
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
422
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
dom.setShowBlockBackgrounds()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction active ou d&eacute;sactive l'assistance visuelle qui commande la coloration de l'arri&egrave;re-plan de tous les blocs
ou divs.
Arguments
allblocks
• L'argument obligatoire allblocks est une valeur bool&eacute;enne. D&eacute;finir la valeur sur true pour appliquer la coloration
d'arri&egrave;re-plan aux balises div uniquement. D&eacute;finir la valeur sur false pour appliquer la coloration d'arri&egrave;re-plan &agrave;
tous les &eacute;l&eacute;ments de bloc.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Voir &laquo; dom.getShowBlockBackgrounds() &raquo; &agrave; la page 419.
dom.setShowBlockBorders()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction active ou d&eacute;sactive l'assistance visuelle qui dessine les bordures de tous les blocs ou divs.
Arguments
allblocks
• L'argument obligatoire allblocks est une valeur bool&eacute;enne. D&eacute;finir la valeur sur true pour appliquer les bordures
aux balises div uniquement. D&eacute;finir la valeur sur false pour appliquer les bordures &agrave; tous les &eacute;l&eacute;ments de bloc.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Voir &laquo; dom.getShowBlockBorders() &raquo; &agrave; la page 420.
dom.setShowBlockIDs()
Disponibilit&eacute;
Dreamweaver 8.
Derni&egrave;re mise &agrave; jour le 22/6/2011
423
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Description
Cette fonction active ou d&eacute;sactive l'assistance visuelle qui affiche l'ID et la classe de tous les blocs ou divs.
Arguments
allblocks
• L'argument obligatoire allblocks est une valeur bool&eacute;enne. D&eacute;finir la valeur sur true pour afficher la classe et l'ID
des balises div uniquement. D&eacute;finir la valeur sur false pour afficher la classe et l'ID de tous les &eacute;l&eacute;ments de bloc.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Voir &laquo; dom.getShowBlockIDs() &raquo; &agrave; la page 421.
dom.setShowBoxModel()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;finit l'&eacute;tat de l'assistance visuelle qui colore le mod&egrave;le de bo&icirc;te complet du bloc s&eacute;lectionn&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le mod&egrave;le de bo&icirc;te est affich&eacute;, false dans le cas contraire.
Exemple
Voir &laquo; dom.getShowBoxModel() &raquo; &agrave; la page 421.
dom.setShowLayoutTableTabs()
Disponibilit&eacute;
Dreamweaver 4.
Description
Configure le document actif pour qu'il affiche les tabulations des tableaux de Mise en forme chaque fois qu'il est en
mode de Mise en forme. Cette fonction ne place pas le document en mode de Mise en forme.
Arguments
bShow.
• L'argument bShow indique si les tabulations des tableaux de Mise en forme doivent s'afficher lorsque le document
actif est en mode de Mise en forme. Si bShow a la valeur true, Dreamweaver affiche les tabulations ; si bShow a la
valeur false, il ne les affiche pas.
Derni&egrave;re mise &agrave; jour le 22/6/2011
424
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Valeurs renvoy&eacute;es
Aucune.
dom.getShowLayoutView()
Disponibilit&eacute;
Dreamweaver 4.
Description
Met le document actif en mode de Mise en forme si bShow a pour valeur true.
Arguments
bShow.
• L'argument bShow est une valeur bool&eacute;enne qui fait passer le document actif du mode de Mise en forme au mode
Standard, et vice versa. Si la valeur de l'argument bShow est true, le document actif est en mode de Mise en forme ;
si la valeur de bShow est false, il est en mode Standard.
Valeurs renvoy&eacute;es
Aucune.
Fonctions de gestion de r&eacute;solution
dreamweaver.canFitSize()
Disponibilit&eacute;
Dreamweaver CS5.5.
Description
V&eacute;rifie s'il existe une s&eacute;lection dans un mode Cr&eacute;ation actif. S'il existe une s&eacute;lection, fitAll() et fitWidth() peuvent
&ecirc;tre appel&eacute;es.
Arguments
Aucun
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true s'il existe un mode Cr&eacute;ation actif, false dans le cas contraire.
dom.getViewSizeMenuItems()
Disponibilit&eacute;
Dreamweaver CS5.5.
Derni&egrave;re mise &agrave; jour le 22/6/2011
425
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Description
Renvoie un tableau de cha&icirc;nes pour le menu Taille du mode Cr&eacute;ation ou de l'affichage en direct, qui comprennent des
tailles pr&eacute;d&eacute;finies d&eacute;finies par l'utilisateur et des requ&ecirc;tes multim&eacute;dias avec informations de dimensionnement.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes.
dom.isViewSizeMenuItemChecked()
Disponibilit&eacute;
Dreamweaver CS5.5.
Description
Sert &agrave; s&eacute;lectionner une option dans la liste des options de menu obtenue &agrave; partir de &laquo; dom.getViewSizeMenuItems() &raquo;
&agrave; la page 424.
Arguments
Index de base z&eacute;ro pour l'option de menu.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'&eacute;l&eacute;ment est activ&eacute;.
dom.isViewSizeMenuItemEnabled()
Disponibilit&eacute;
Dreamweaver CS5.5.
Description
Sert &agrave; activer ou d&eacute;sactiver les options de menu Taille d'affichage obtenues &agrave; partir de
&laquo; dom.getViewSizeMenuItems() &raquo; &agrave; la page 424.
Arguments
Index de base z&eacute;ro pour l'option de menu.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si cette option est activ&eacute;e, false si elle est d&eacute;sactiv&eacute;e.
dom.isViewSizeMenuItemEnabled()
Disponibilit&eacute;
Dreamweaver CS5.5.
Derni&egrave;re mise &agrave; jour le 22/6/2011
426
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Description
Sert &agrave; activer ou d&eacute;sactiver les options de menu Taille d'affichage obtenues &agrave; partir de
dom.getViewSizeMenuItems().
Arguments
Index de base z&eacute;ro pour l'&eacute;l&eacute;ment de menu.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si cette option est activ&eacute;e, false si elle est d&eacute;sactiv&eacute;e.
Requ&ecirc;te multim&eacute;dia
dw.mediaQueryListToJSON(strMediaQueryList)
Disponibilit&eacute;
Dreamweaver CS5.5.
Description
Analyse une cha&icirc;ne Liste de requ&ecirc;tes multim&eacute;dias et renvoie une cha&icirc;ne JSON &agrave; l'appelant.
Arguments
strMediaQueryList Cha&icirc;ne qui est une liste de requ&ecirc;tes multim&eacute;dias, de fa&ccedil;on similaire &agrave; l'attribut media d'une
balise de liaison.
Valeurs renvoy&eacute;es
Cha&icirc;ne JSON qui repr&eacute;sente la liste de requ&ecirc;tes multim&eacute;dias analys&eacute;e. L'appelant peut inspecter cette cha&icirc;ne et/ou
appeler eval pour la convertir en objet JavaScript.
Si une erreur est rencontr&eacute;e pendant l'analyse, l'appelant peut utiliser errorStr, un objet JSON, &agrave; des fins de test. Si
cette propri&eacute;t&eacute; n'existe pas ou est vide, il n'y a pas d'erreur. Lorsque l'analyse r&eacute;ussit, l'objet JSON comportera une
propri&eacute;t&eacute; appel&eacute;e mediaQueryList, qui est un tableau.
Exemple
var strJSON = dw.mediaQueryListToJSON('only screen and (min-width:769px)');
//strJSON is now:
{ mediaQueryList : [ { restrictor : 'only',
mediaType : 'screen',
mediaFeatures : [ { feature : 'width', comparisonType : 'min', value
: '769px' } ] }
],
errorStr : ''
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
427
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
site.getMediaQueryFile()
Disponibilit&eacute;
Dreamweaver CS5.5.
Description
Fournit l'emplacement du fichier de requ&ecirc;te multim&eacute;dia &agrave; l'&eacute;chelle du site pour le site en cours. Par exemple,
C:\Documents and Settings\nom d'utilisateur\Mes Documents\dw sites\slash site\css\devices.css.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le chemin d'acc&egrave;s complet du fichier de requ&ecirc;te multim&eacute;dia &agrave; l'&eacute;chelle du site.
site.setMediaQueryFile()
Disponibilit&eacute;
Dreamweaver CS5.5.
Description
D&eacute;finit le fichier de requ&ecirc;te multim&eacute;dia &agrave; l'&eacute;chelle du site pour le site en cours.
Valeurs renvoy&eacute;es
Aucun
dom.collectMediaQueries()
Disponibilit&eacute;
Dreamweaver CS5.5.
Description
R&eacute;cup&egrave;re les infos de requ&ecirc;te multim&eacute;dia (CSS, requ&ecirc;te multim&eacute;dia, description/commentaire, d&eacute;calage) dans le
document.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes.
Exemple
{ type: 'link', offsets: {start: 109, end: 213}, desc: 'for phone', descOffsets: {start: 89,
end: 107}, mq: 'only screen and (max-width:320px)', css: 'phone.css' },{ type: 'link', offsets:
{start: 236, end: 364}, desc: 'for tablet', descOffsets: {start: 215, end: 234}, mq: 'only
screen and (min-width:3210px) and (max-width:700px)', css: 'tablet.css' }
Fonctions relatives aux zooms
Fonctions de zoom avant et arri&egrave;re en mode Cr&eacute;ation.
Derni&egrave;re mise &agrave; jour le 22/6/2011
428
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
dreamweaver.activeViewScale()
Disponibilit&eacute;
Dreamweaver 8.
Description
La propri&eacute;t&eacute; activeViewScale obtient ou d&eacute;finit une virgule flottante modifiable. Lorsque vous obtenez la valeur,
Dreamweaver renvoie l'&eacute;chelle de la vue active telle qu'elle figure dans la zone de liste modifiable Zoom, divis&eacute;e par
100. Par exemple, 100% est indiqu&eacute; par 1,0, 50% par 0,5, et ainsi de suite. Lorsque vous d&eacute;finissez la valeur,
Dreamweaver d&eacute;finit la valeur dans la zone de liste modifiable Zoom. Cette valeur peut &ecirc;tre comprise entre 0,06 et 64,
ce qui correspond &agrave; 6% et 6400%.
Exemple
L'exemple suivant obtient la valeur de l'&eacute;chelle du mode actuel. Il effectue aussi un zoom avant, s'il le peut et si l'&eacute;chelle
est inf&eacute;rieure ou &eacute;gale &agrave; 100% :
if (canZoom() &amp;&amp; dreamweaver.activeViewScale &lt;= 1.0) {
zoomIn();
}
L'exemple suivant fixe la valeur de l'&eacute;chelle du mode actuel &agrave; 50% :
dreamweaver.activeViewScale = 0.50;
dreamweaver.fitAll()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction effectue un zoom avant ou arri&egrave;re de mani&egrave;re &agrave; ce que la totalit&eacute; du document s'adapte &agrave; la zone
actuellement visible du mode Cr&eacute;ation.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canZoom() &raquo; &agrave; la page 519.
Exemple
if (canZoom()){
fitAll();
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
429
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
dreamweaver.fitSelection()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction effectue un zoom avant ou arri&egrave;re de mani&egrave;re &agrave; ce que la s&eacute;lection en cours s'adapte &agrave; la zone
actuellement visible du mode Cr&eacute;ation.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canFitSelection() &raquo; &agrave; la page 514.
Exemple
if (canFitSeletion()){
fitSelection();
}
dreamweaver.fitWidth()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction effectue un zoom avant ou arri&egrave;re de mani&egrave;re &agrave; ce que la largeur totale du document s'adapte &agrave; la zone
actuellement visible du mode Cr&eacute;ation.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canZoom() &raquo; &agrave; la page 519.
Exemple
if (canZoom()){
fitWidth();
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
430
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
dreamweaver.zoomIn()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction effectue un zoom avant sur la fen&ecirc;tre de mode Cr&eacute;ation ou d'affichage en direct active. Le niveau de
zoom correspond &agrave; la valeur pr&eacute;d&eacute;finie dans le menu Zoom. Si aucune valeur n'est pr&eacute;d&eacute;finie, cette fonction est
inactive.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canZoom() &raquo; &agrave; la page 519.
Exemple
if (canZoom()){
zoomIn();
}
dreamweaver.zoomOut()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction effectue un zoom avant sur la fen&ecirc;tre de mode Cr&eacute;ation ou d'affichage en direct active. Le niveau de
zoom correspond &agrave; la valeur pr&eacute;d&eacute;finie dans le menu Zoom. Si aucune valeur n'est pr&eacute;d&eacute;finie, cette fonction est
inactive.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canZoom() &raquo; &agrave; la page 519.
Exemple
if (canZoom()){
zoomOut();
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
431
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Propri&eacute;t&eacute;s et fonctions de rep&egrave;re
Les propri&eacute;t&eacute;s et fonctions de rep&egrave;re permettent d'afficher, de manipuler et de supprimer des rep&egrave;res utilis&eacute;s par les
utilisateurs pour mesurer et mettre en forme des &eacute;l&eacute;ments sur leurs pages HTML.
dom.clearGuides()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;termine si tous les rep&egrave;res du document doivent &ecirc;tre supprim&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant supprime tous les rep&egrave;res contenus dans le document si ce dernier en contient au moins un :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.hasGuides() == true) {
currentDOM.clearGuides();
}
dom.createHorizontalGuide()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction cr&eacute;e un rep&egrave;re horizontal &agrave; l'emplacement sp&eacute;cifi&eacute; dans le document.
Arguments
location
• L'argument location repr&eacute;sente l'emplacement du rep&egrave;re, qui correspond &agrave; une cha&icirc;ne unique contenant &agrave; la fois la
valeur et les unit&eacute;s de mesure sans espace entre les deux. Les unit&eacute;s possibles sont &quot;px&quot; pour les pixels et &quot;%&quot; pour
les pourcentages. Par exemple, pour indiquer 10 pixels, location = &quot;10px&quot; ; pour indiquer 50 pour cent,
location = &quot;50%&quot;.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
432
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Exemple
L'exemple suivant cr&eacute;e un rep&egrave;re horizontal &agrave; l'emplacement sp&eacute;cifi&eacute; dans le document :
var currentDOM = dw.getDocumentDOM();
currentDOM.createHorizontalGuide(&quot;10px&quot;);
dom.createVerticalGuide()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction cr&eacute;e un rep&egrave;re vertical &agrave; l'emplacement sp&eacute;cifi&eacute; dans le document.
Arguments
location
• L'argument location repr&eacute;sente l'emplacement du rep&egrave;re, qui correspond &agrave; une cha&icirc;ne unique contenant &agrave; la fois la
valeur et les unit&eacute;s de mesure sans espace entre les deux. Les unit&eacute;s possibles sont &quot;px&quot; pour les pixels et &quot;%&quot; pour
les pourcentages. Par exemple, pour indiquer 10 pixels, location = &quot;10px&quot; ; pour indiquer 50 pour cent,
location = &quot;50%&quot;.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant cr&eacute;e un rep&egrave;re vertical &agrave; l'emplacement sp&eacute;cifi&eacute; dans le document:
var currentDOM = dw.getDocumentDOM();
currentDOM.createVerticalGuide(&quot;10px&quot;);
dom.deleteHorizontalGuide()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction supprime le rep&egrave;re horizontal &agrave; l'emplacement sp&eacute;cifi&eacute;.
Arguments
location
• L'argument location est une cha&icirc;ne unique repr&eacute;sentant l'emplacement &agrave; tester dans le document, contenant &agrave; la
fois la valeur et les unit&eacute;s de mesure sans espace entre les deux. Les unit&eacute;s possibles sont &quot;px&quot; pour les pixels et &quot;%&quot;
pour les pourcentages. Par exemple, pour indiquer 10 pixels, location = &quot;10px&quot; ; pour indiquer 50 pour cent,
location = &quot;50%&quot;.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
433
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Exemple
L'exemple suivant supprime le rep&egrave;re horizontal &agrave; l'emplacement sp&eacute;cifi&eacute; dans le document :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.hasHorizontalGuide(&quot;10px&quot;) == true) {
currentDOM.deleteHorizonalGuide(&quot;10px&quot;);
}
dom.deleteVerticalGuide()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction supprime le rep&egrave;re vertical &agrave; l'emplacement sp&eacute;cifi&eacute;.
Arguments
location
• L'argument location est une cha&icirc;ne unique repr&eacute;sentant l'emplacement &agrave; tester dans le document, contenant &agrave; la
fois la valeur et les unit&eacute;s de mesure sans espace entre les deux. Les unit&eacute;s possibles sont &quot;px&quot; pour les pixels et &quot;%&quot;
pour les pourcentages. Par exemple, pour indiquer 10 pixels, location = &quot;10px&quot; ; pour indiquer 50 pour cent,
location = &quot;50%&quot;.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant supprime le rep&egrave;re vertical &agrave; l'emplacement sp&eacute;cifi&eacute; dans le document :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.hasVerticalGuide(&quot;10px&quot;) == true) {
currentDOM.deleteVerticalGuide(&quot;10px&quot;);
}
dom.guidesColor
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette propri&eacute;t&eacute; de couleur modifiable d&eacute;termine la couleur des rep&egrave;res contenus dans le document. Vous pouvez
d&eacute;finir et consulter cette propri&eacute;t&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
434
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Exemple
L'exemple suivant affiche les rep&egrave;res en gris :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.guidesColor != &quot;#444444&quot;){
currentDOM.guidesColor = &quot;#444444&quot;;
}
dom.guidesDistanceColor
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette propri&eacute;t&eacute; de couleur modifiable d&eacute;termine la couleur des commentaires distants des rep&egrave;res contenus dans le
document. Vous pouvez d&eacute;finir et consulter cette propri&eacute;t&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant affiche la couleur des commentaires distants des rep&egrave;res en gris :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.guidesDistanceColor != &quot;#CCCCCC&quot;){
currentDOM.guidesDistanceColor = &quot;#CCCCCC&quot;;
}
dom.guidesLocked
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette propri&eacute;t&eacute; bool&eacute;enne modifiable d&eacute;termine si les rep&egrave;res doivent &ecirc;tre verrouill&eacute;s dans le document. Vous pouvez
d&eacute;finir et consulter cette propri&eacute;t&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant verrouille les rep&egrave;res s'ils ne le sont pas :
Derni&egrave;re mise &agrave; jour le 22/6/2011
435
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
var currentDOM = dw.getDocumentDOM();
if (currentDOM.guidesLocked == false) {
currentDOM.guidesLocked = true;
}
dom.guidesSnapToElements
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette propri&eacute;t&eacute; bool&eacute;enne modifiable d&eacute;termine s'il faut aligner les rep&egrave;res sur les &eacute;l&eacute;ments dans le document. Vous
pouvez d&eacute;finir et consulter cette propri&eacute;t&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant aligne les rep&egrave;res contenus dans le document sur les &eacute;l&eacute;ments :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.guidesSnapToElements == false) {
currentDOM.guidesSnapToElements = true;
}
dom.guidesVisible
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette propri&eacute;t&eacute; bool&eacute;enne modifiable d&eacute;termine si les rep&egrave;res sont visibles dans le document. Vous pouvez d&eacute;finir et
consulter cette propri&eacute;t&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant affiche les rep&egrave;res s'ils ne sont pas visibles :
Derni&egrave;re mise &agrave; jour le 22/6/2011
436
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
var currentDOM = dw.getDocumentDOM();
if (currentDOM.guidesVisible == false) {
currentDOM.guidesVisible = true;
}
dom.hasGuides()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;termine si le document contient au moins un rep&egrave;re. Vous pouvez d&eacute;finir et consulter cette propri&eacute;t&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant supprime tous les rep&egrave;res contenus dans le document si ce dernier en contient au moins un :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.hasGuides() == true) {
currentDOM.clearGuides();
}
dom.hasHorizontalGuide()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;termine si le document contient un rep&egrave;re horizontal &agrave; l'emplacement sp&eacute;cifi&eacute;.
Arguments
location
• L'argument location est une cha&icirc;ne unique repr&eacute;sentant l'emplacement &agrave; tester dans le document, contenant &agrave; la
fois la valeur et les unit&eacute;s de mesure sans espace entre les deux. Les unit&eacute;s possibles sont &quot;px&quot; pour les pixels et &quot;%&quot;
pour les pourcentages. Par exemple, pour indiquer 10 pixels, location = &quot;10px&quot; ; pour indiquer 50 pour cent,
location = &quot;50%&quot;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true s'il y a un rep&egrave;re horizontal &agrave; l'emplacement sp&eacute;cifi&eacute;, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
437
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Exemple
L'exemple suivant supprime tous les rep&egrave;res contenus dans le document si ce dernier contient un rep&egrave;re horizontal &agrave;
l'emplacement sp&eacute;cifi&eacute; :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.hasHorizontalGuide(&quot;10px&quot;) == true) {
currentDOM.clearGuides();
}
dom.hasVerticalGuide()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction d&eacute;termine si le document contient un rep&egrave;re vertical &agrave; l'emplacement sp&eacute;cifi&eacute;.
Arguments
location
• L'argument location est une cha&icirc;ne unique repr&eacute;sentant l'emplacement &agrave; tester dans le document, contenant &agrave; la
fois la valeur et les unit&eacute;s de mesure sans espace entre les deux. Les unit&eacute;s possibles sont &quot;px&quot; pour les pixels et &quot;%&quot;
pour les pourcentages. Par exemple, pour indiquer 10 pixels, location = &quot;10px&quot; ; pour indiquer 50 pour cent,
location = &quot;50%&quot;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true s'il y a un rep&egrave;re vertical &agrave; l'emplacement sp&eacute;cifi&eacute;, false dans le cas contraire.
Exemple
L'exemple suivant supprime tous les rep&egrave;res contenus dans le document si ce dernier contient un rep&egrave;re vertical &agrave;
l'emplacement sp&eacute;cifi&eacute; :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.hasVerticalGuide(&quot;10px&quot;) == true) {
currentDOM.clearGuides();
}
dom.snapToGuides
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette propri&eacute;t&eacute; bool&eacute;enne modifiable d&eacute;termine s'il faut aligner les &eacute;l&eacute;ments sur les rep&egrave;res dans le document. Vous
pouvez d&eacute;finir et consulter cette propri&eacute;t&eacute;.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
438
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant aligne les &eacute;l&eacute;ments du document sur les rep&egrave;res :
var currentDOM = dw.getDocumentDOM();
if (currentDOM.snapToGuides == false) {
currentDOM.snapToGuides = true;
}
Fonctions de modification des tableaux
Ces fonctions permettent d'ins&eacute;rer et de supprimer des lignes et des colonnes dans des tableaux, de modifier la largeur
des colonnes et la hauteur des lignes, de convertir en pourcentage des mesures exprim&eacute;es en pixels (et vice versa) et
d'effectuer d'autres op&eacute;rations standard de modification des tableaux.
dom.convertWidthsToPercent()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction convertit en pourcentage tous les attributs WIDTH exprim&eacute;s en pixels du tableau en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.convertWidthsToPixels()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction convertit en pourcentage tous les attributs WIDTH exprim&eacute;s en pixels du tableau en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
439
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
dom.decreaseColspan()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction diminue l'&eacute;tendue de colonnes de 1.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canDecreaseColspan() &raquo; &agrave; la page 504.
dom.decreaseRowspan()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction diminue l'&eacute;tendue de lignes de 1.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canDecreaseRowspan() &raquo; &agrave; la page 504.
dom.deleteTableColumn()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction supprime du tableau la ou les colonnes s&eacute;lectionn&eacute;es.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
440
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canDeleteTableColumn() &raquo; &agrave; la page 504.
dom.deleteTableRow()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction supprime du tableau la ou les lignes s&eacute;lectionn&eacute;es.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canDeleteTableRow() &raquo; &agrave; la page 505.
dom.doDeferredTableUpdate()
Disponibilit&eacute;
Dreamweaver 3.
Description
Si l'option Modification de tableau plus rapide est activ&eacute;e dans la cat&eacute;gorie G&eacute;n&eacute;ral des pr&eacute;f&eacute;rences, cette fonction
oblige la mise en forme du tableau &agrave; adopter les modifications apport&eacute;es r&eacute;cemment, et ce sans d&eacute;placer la s&eacute;lection &agrave;
l'ext&eacute;rieur du tableau. Cette fonction n'a aucun effet si l'option Modification de tableau plus rapide n'est pas activ&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.getShowTableWidths()
Disponibilit&eacute;
Dreamweaver MX 2004, mise &agrave; jour dans CS4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
441
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Description
Indique si les largeurs d'un tableau s'affichent en mode Standard ou Tableaux d&eacute;velopp&eacute;s. Pour plus d'informations
sur l'affichage des tabulations de tableau en mode de Mise en forme dans Dreamweaver, consultez la section
&laquo; dom.getShowLayoutTableTabs() &raquo; &agrave; la page 419.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si Dreamweaver affiche les largeurs du tableau en mode Standard ou Tableaux d&eacute;velopp&eacute;s,
false dans le cas contraire.
dom.getTableExtent()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction renvoie le nombre de colonnes et de lignes du tableau s&eacute;lectionn&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Tableau contenant deux nombres entiers. Le premier entier correspond au nombre de colonnes, et le second au
nombre de lignes. Si aucun tableau n'est s&eacute;lectionn&eacute;, aucune valeur n'est renvoy&eacute;e.
dom.increaseColspan()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction augmente l'&eacute;tendue de colonnes de 1.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canIncreaseColspan() &raquo; &agrave; la page 505.
Derni&egrave;re mise &agrave; jour le 22/6/2011
442
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
dom.increaseRowspan()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction augmente l'&eacute;tendue de lignes de 1.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canIncreaseRowspan() &raquo; &agrave; la page 506.
dom.insertTableColumns()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction ins&egrave;re le nombre de colonnes sp&eacute;cifi&eacute; dans le tableau en cours.
Arguments
numberOfCols, bBeforeSelection
• L'argument numberOfCols est le nombre de colonnes &agrave; ins&eacute;rer.
• L'argument bBeforeSelection est une valeur bool&eacute;enne : true indique que les colonnes doivent &ecirc;tre ins&eacute;r&eacute;es avant
celle qui contient la s&eacute;lection, et false indique le contraire.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canInsertTableColumns() &raquo; &agrave; la page 506.
dom.insertTableRows()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction ins&egrave;re le nombre de lignes sp&eacute;cifi&eacute; dans le tableau en cours.
Derni&egrave;re mise &agrave; jour le 22/6/2011
443
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Arguments
numberOfRows, bBeforeSelection
• L'argument numberOfRows est le nombre de lignes &agrave; ins&eacute;rer.
• L'argument bBeforeSelection est une valeur bool&eacute;enne : true indique que les lignes doivent &ecirc;tre ins&eacute;r&eacute;es au-dessus
de celle qui contient la s&eacute;lection, et false indique le contraire.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canInsertTableRows() &raquo; &agrave; la page 506.
dom.mergeTableCells()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction fusionne les cellules de tableau s&eacute;lectionn&eacute;es.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canMergeTableCells() &raquo; &agrave; la page 507.
dom.removeAllTableHeights()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction supprime tous les attributs HEIGHT du tableau s&eacute;lectionn&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
444
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
dom.removeAllTableWidths()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction supprime tous les attributs WIDTH du tableau s&eacute;lectionn&eacute;.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.removeColumnWidth()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Cette fonction supprime tous les attributs WIDTH d'une unique colonne s&eacute;lectionn&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.selectTable()
Disponibilit&eacute;
Dreamweaver 3.
Description
S&eacute;lectionne un tableau entier.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canSelectTable() &raquo; &agrave; la page 509.
Derni&egrave;re mise &agrave; jour le 22/6/2011
445
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
dom.setShowTableWidths()
Disponibilit&eacute;
Dreamweaver MX 2004, mis &agrave; jour dans CS 4.
Description
Permet d'activer ou de d&eacute;sactiver l'affichage des largeurs d'un tableau en mode Standard ou Tableaux d&eacute;velopp&eacute;s. Cette
fonction d&eacute;finit la valeur assign&eacute;e au document en cours et &agrave; tous les documents suivants, sauf indication contraire.
Pour plus d'informations sur la d&eacute;finition de l'affichage des tabulations de tableau en mode de Mise en forme dans
Dreamweaver, consultez la section &laquo; dom.setShowLayoutTableTabs() &raquo; &agrave; la page 423.
Arguments
bShow
•
bShow est un argument bool&eacute;en qui indique si les largeurs de tableau doivent s'afficher lorsque le document en
cours est en mode Standard ou Tableaux d&eacute;velopp&eacute;s. Si la valeur de bShow est true, Dreamweaver affiche les
largeurs. Si la valeur de bShow est false, Dreamweaver ne les affiche pas.
Valeurs renvoy&eacute;es
Aucune.
dom.setTableCellTag()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction d&eacute;finit la balise de la cellule s&eacute;lectionn&eacute;e.
Arguments
tdOrTh.
• L'argument tdOrTh doit &ecirc;tre &quot;td&quot; ou &quot;th&quot;.
Valeurs renvoy&eacute;es
Aucune.
dom.setTableColumns()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction d&eacute;finit le nombre de colonnes du tableau s&eacute;lectionn&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
446
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Arguments
numberOfCols.
• L'argument numberOfCols indique le nombre de colonnes &agrave; d&eacute;finir dans le tableau.
Valeurs renvoy&eacute;es
Aucune.
dom.setTableRows()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction d&eacute;finit le nombre de lignes du tableau s&eacute;lectionn&eacute;.
Arguments
numberOfCols.
• L'argument numberOfRows indique le nombre de lignes &agrave; d&eacute;finir dans le tableau s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
dom.showInsertTableRowsOrColumnsDialog()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cette fonction ouvre la bo&icirc;te de dialogue Ins&eacute;rer des lignes ou des colonnes.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canInsertTableColumns() &raquo; &agrave; la page 506 ou &laquo; dom.canInsertTableRows() &raquo; &agrave; la page 506.
dom.splitTableCell()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
447
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Cr&eacute;ation
Description
Cette fonction fractionne la cellule de tableau en cours en un nombre de lignes ou de colonnes donn&eacute;. Si vous ne
d&eacute;finissez pas l'un des deux arguments, ou les deux, la bo&icirc;te de dialogue Fractionner la cellule s'affiche.
Arguments
{colsOrRows}, {numberToSplitInto}
• L'argument facultatif colsOrRows doit &ecirc;tre &quot;columns&quot; ou &quot;rows&quot;.
• L'argument facultatif numberToSplitInto indique en combien de lignes ou de colonnes la cellule doit &ecirc;tre
fractionn&eacute;e.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canSplitTableCell() &raquo; &agrave; la page 510.
Derni&egrave;re mise &agrave; jour le 22/6/2011
448
Chapitre 18 : Code
Les fonctions de code vous permettent d'effectuer des op&eacute;rations sur un document affich&eacute; en mode Code. Ces
op&eacute;rations comprennent l'ajout de nouvelles balises de fonction ou de menu &agrave; un menu de conseils de code, la
recherche et le remplacement de mod&egrave;les de cha&icirc;nes, la suppression de la s&eacute;lection en cours, l'impression de code
complet ou s&eacute;lectionn&eacute;, la modification de balises ou l'application de formatage de syntaxe au code s&eacute;lectionn&eacute;.
Fonctions de code
Les conseils de code sont des menus contextuels qui s'affichent dans Adobe&reg; Dreamweaver&reg; CS5 lorsque vous tapez
certains caract&egrave;res en mode Code. Ils vous &eacute;vitent de saisir tout le texte en proposant une liste de cha&icirc;nes susceptibles
de compl&eacute;ter la cha&icirc;ne que vous tapez. Si la cha&icirc;ne que vous tapez appara&icirc;t dans le menu, s&eacute;lectionnez-la et appuyez
sur Entr&eacute;e ou Retour pour compl&eacute;ter votre saisie. Si vous tapez &lt;, par exemple, un menu contextuel affiche une liste
des noms de balises. Plut&ocirc;t que de taper le reste du nom de la balise, vous pouvez la s&eacute;lectionner dans le menu pour
l'inclure &agrave; votre texte.
Vous pouvez ajouter des menus Conseils de code dans Dreamweaver en les d&eacute;finissant dans le fichier CodeHints.xml.
Pour plus d'informations sur le fichier CodeHints.xml, voir Extension de Dreamweaver.
Vous pouvez &eacute;galement ajouter de nouveaux menus de conseils de code de fa&ccedil;on dynamique via JavaScript apr&egrave;s
chargement du contenu du fichier CodeHints.xml par Dreamweaver. Par exemple, le code JavaScript ajoute des
donn&eacute;es &agrave; la liste des variables de session dans le panneau Liaisons. Vous pouvez utiliser le m&ecirc;me code pour ajouter
un menu Conseils de code. Ainsi, Dreamweaver affiche un menu de variables de session lorsqu'un utilisateur tape
Session en mode Code.
Le fichier CodeHints.xml et l'API JavaScript contiennent un sous-ensemble utile du moteur Conseils de code, mais
certaines fonctionnalit&eacute;s de Dreamweaver ne sont pas accessibles. Par exemple, comme il n'existe pas d'accroche
JavaScript pouvant afficher un s&eacute;lecteur de couleur, Dreamweaver ne peut pas exprimer le menu Valeurs des attributs
&agrave; l'aide de JavaScript. Vous pouvez uniquement afficher un menu d'&eacute;l&eacute;ments de texte permettant d'ins&eacute;rer du texte.
La coloration du code vous permet de d&eacute;finir des styles de couleur de code et de modifier des mod&egrave;les de coloration
de code ou d'en cr&eacute;er de nouveaux. Vous pouvez sp&eacute;cifier ces styles et mod&egrave;les en modifiant le fichier Colors.xml et
celui de mod&egrave;le de coloration. Pour plus d'informations sur ces fichiers, voir Extension de Dreamweaver.
L'API JavaScript pour les conseils et la coloration de code comprend les fonctions suivantes :
dreamweaver.codeHints.addMenu()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;finit dynamiquement une nouvelle balise menu dans le fichier CodeHints.xml. S'il existe une balise de menu
poss&eacute;dant le m&ecirc;me mod&egrave;le et le m&ecirc;me type de document, la fonction ajoute les &eacute;l&eacute;ments au menu existant.
Derni&egrave;re mise &agrave; jour le 22/6/2011
449
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Arguments
menuGroupId, pattern, labelArray, {valueArray}, {iconArray}, {doctypes}, {casesensitive}, {object},
{descriptionArray}, {dismissChars}, {allowWhitespacePrefix}, {restriction}, {type}, {bForcedOnly},
{allowMultipleTimes}, {docURI}, {alias}
• L'argument menuGroupId est l'attribut ID de l'une des balises menugroup.
• L'argument pattern est l'attribut de mod&egrave;le de la nouvelle balise menu.
• L'argument labelArray est un tableau de cha&icirc;nes. Chaque cha&icirc;ne constitue le texte d'un &eacute;l&eacute;ment de menu dans le
menu contextuel.
• L'argument facultatif valueArray est un tableau de cha&icirc;nes qui doit avoir la m&ecirc;me longueur que l'argument
labelArray. Lorsqu'un utilisateur s&eacute;lectionne un &eacute;l&eacute;ment dans le menu contextuel, la cha&icirc;ne de ce tableau est
ins&eacute;r&eacute;e dans son document. Si la cha&icirc;ne &agrave; ins&eacute;rer est toujours identique &agrave; celle de l'&eacute;tiquette du menu, la valeur de
cet argument peut &ecirc;tre null.
• L'argument facultatif iconArray
peut &ecirc;tre une cha&icirc;ne ou un tableau de cha&icirc;nes. S'il s'agit d'une cha&icirc;ne,
elle sp&eacute;cifie l'URL d'un fichier d'image utilis&eacute; par Dreamweaver pour tous les &eacute;l&eacute;ments du menu. S'il s'agit d'un
tableau de cha&icirc;nes, il doit &ecirc;tre de la m&ecirc;me longueur que l'argument labelArray. Chaque cha&icirc;ne est une URL
(dossier Configuration de Dreamweaver) d&eacute;signant un fichier d'image que Dreamweaver utilise comme une ic&ocirc;ne
pour l'&eacute;l&eacute;ment de menu correspondant. Si cet argument a la valeur null, Dreamweaver affiche le menu sans les
ic&ocirc;nes.
• L'argument facultatif doctypes indique que le menu est actif pour certains types de documents uniquement. Vous
pouvez sp&eacute;cifier l'argument doctypes en tant que liste d'ID de types de documents s&eacute;par&eacute;s par des virgules. Pour
obtenir une liste des types de documents de Dreamweaver, consultez le fichier
Configuration/Documenttypes/MMDocumentTypes.xml.
• L'argument facultatif casesensitive indique si le mod&egrave;le fait la distinction entre les majuscules et les minuscules.
Les valeurs possibles de l'argument casesensitive sont les valeurs bool&eacute;ennes true ou false. Par d&eacute;faut, la
valeur est false si vous omettez cet argument. Si l'argument casesensitive a la valeur true, le menu des conseils
de code s'affiche. Ce menu ne s'affiche que si le texte tap&eacute; par l'utilisateur correspond au mod&egrave;le sp&eacute;cifi&eacute; par
l'attribut de mod&egrave;le. Dans le cas o&ugrave; l'argument casesensitive aurait la valeur false, le menu s'affiche, m&ecirc;me si
le mod&egrave;le est en minuscules et que le texte est enmajuscules.
• L'argument object sp&eacute;cifie le nom de la cha&icirc;ne. Cet argument est facultatif. Il s'emploie si l'objet est de type
statique.
• L'argument descriptionArray donne une description d&eacute;taill&eacute;e des &eacute;l&eacute;ments figurant dans les conseils de code.
Cet argument est facultatif.
• L'argument dismissChars sp&eacute;cifie les caract&egrave;res non standard que l'utilisateur doit taper pour masquer le menu
des conseils de code. Cet argument est facultatif.
• L'argument allowWhitespacePrefix est une valeur bool&eacute;enne qui autorise les blancs avant le conseil. Cet
argument est facultatif ; sa valeur par d&eacute;faut est false.
• L'argument restriction est une cha&icirc;ne. Cet argument est facultatif et n'est pas sp&eacute;cifi&eacute; s'il n'impose aucune
contrainte. Sur une page Web contenant des langages c&ocirc;t&eacute; client et c&ocirc;t&eacute; serveur, vous pouvez utiliser cet argument
pour limiter l'emploi de conseils de code &agrave; l'un des &eacute;l&eacute;ments suivants :
• Une section de langage sp&eacute;cifique
• Un bloc de code
• L'argument type sert &agrave; d&eacute;finir les types de menus d'interface utilisateur. Cet argument est facultatif ; sa valeur par
d&eacute;faut est &quot;Enumerated drop down UI&quot;. Les autres valeurs possibles sont color, font et url.
Derni&egrave;re mise &agrave; jour le 22/6/2011
450
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
• L'argument bForcedOnly est une valeur bool&eacute;enne. S'il a la valeur true, le menu des conseils de code ne s'affiche
qu'en cas d'utilisation du raccourci clavier (CTRL+espace). Cet argument est facultatif ; sa valeur par d&eacute;faut est
false.
• L'argument allowMultipleTimes est une valeur bool&eacute;enne. S'il a la valeur true, il autorise le m&ecirc;me menu &agrave;
s'afficher &agrave; plusieurs reprises. Cet argument est facultatif ; sa valeur par d&eacute;faut est false.
• L'argument docURI permet &agrave; l'utilisateur de limiter les conseils de code &agrave; un document sp&eacute;cifique en fournissant
l'URI (chemin d'acc&egrave;s au fichier natif du SE) de ce document. Cet argument est facultatif et, si l'URI du document
n'est pas sp&eacute;cifi&eacute;, il n'impose aucune contrainte.
• L'argument alias permet &agrave; l'utilisateur d'appeler les conseils de code avec une variante de motif diff&eacute;rente de celle
qui figure dans un argument pattern ou classpattern. Cet argument est facultatif.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Si l'utilisateur cr&eacute;e un jeu d'enregistrements appel&eacute; &quot;myRs&quot;, le code suivant cr&eacute;e un menu pour myRS :
dw.codeHints.addMenu(
&quot;CodeHints_object_methods&quot;,
&quot;myRS.&quot;,
new Array(&quot;firstName&quot;, &quot;lastName&quot;),
new Array(&quot;firstName&quot;, &quot;lastName&quot;),
null,
&quot;ASP_VB, ASP_JS&quot;);
//
//
//
//
//
menu is enabled if object methods are enabled
pop up menu if user types &quot;myRS.&quot;
items in pop-up menu for myRS
text to actually insert in document
no icons for this menu
// specific to the ASP doc types
dreamweaver.codeHints.addFunction()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;finit dynamiquement une nouvelle balise function. Si une balise function est d&eacute;finie par le m&ecirc;me mod&egrave;le et le
m&ecirc;me type de document, cette fonction remplace la balise function existante.
Arguments
menuGroupId, pattern, {doctypes}, {casesensitive}, {object}, {description}, {icon}, source, {docURI},
{bClassPattern}, {bAddToObjectMethodList}, {restriction}
• L'argument menuGroupId est l'attribut de cha&icirc;ne d'ID de la balise menugroup.
• L'argument pattern est une cha&icirc;ne qui sp&eacute;cifie l'attribut de mod&egrave;le de la nouvelle balise function.
• L'argument facultatif doctypes d&eacute;finit que cette fonction est active pour certains types de documents uniquement.
Vous pouvez sp&eacute;cifier l'argument doctypes en tant que liste d'ID de types de documents s&eacute;par&eacute;s par des virgules.
Pour obtenir une liste des types de documents de Dreamweaver, consultez le fichier
Configuration/Documenttypes/MMDocumentTypes.xml.
Derni&egrave;re mise &agrave; jour le 22/6/2011
451
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
• L'argument facultatif casesensitive indique si le mod&egrave;le fait la distinction entre les majuscules et les minuscules.
Les valeurs possibles de l'argument casesensitive sont les valeurs bool&eacute;ennes true ou false. Par d&eacute;faut, la
valeur est false si vous omettez cet argument. Si l'argument casesensitive a la valeur true, le menu des conseils
de code s'affiche. Ce menu ne s'affiche que si le texte tap&eacute; par l'utilisateur correspond au mod&egrave;le sp&eacute;cifi&eacute; par
l'attribut de mod&egrave;le. Si l'argument casesensitive est false, le menu s'affiche m&ecirc;me si le mod&egrave;le est en
minuscules et le texte en majuscules.
• L'argument object sp&eacute;cifie le nom de la cha&icirc;ne. Cet argument est facultatif. Il s'emploie si l'objet est de type
statique.
• L'argument description contient une description d&eacute;taill&eacute;e de la fonction. Cet argument est facultatif.
• L'argument icon d&eacute;finit le chemin d'acc&egrave;s &agrave; une ic&ocirc;ne personnalis&eacute;e &agrave; utiliser dans le menu d&eacute;roulant de la
fonction. Cet argument est facultatif.
• L'argument source contient une valeur affich&eacute;e dans la seconde colonne de le conseil de code. La valeur par d&eacute;faut
de cet argument est empty.
• L'argument docURI permet &agrave; l'utilisateur de limiter les conseils de code &agrave; un document sp&eacute;cifique en fournissant
l'URI (chemin d'acc&egrave;s au fichier natif du SE) de ce document. Cet argument est facultatif et, si l'URI du document
n'est pas sp&eacute;cifi&eacute;, il n'impose aucune contrainte.
• L'argument bClassPattern est une valeur bool&eacute;enne. S'il a la valeur true, il sp&eacute;cifie que la fonction appartient &agrave;
une instance de &laquo; class &raquo; et qu'il n'est pas statique. La valeur par d&eacute;faut est false. Cet argument est facultatif.
• L'argument bAddToObjectMethodList est une valeur bool&eacute;enne. S'il a la valeur &laquo; true &raquo;, il permet &agrave; l'utilisateur
d'ajouter une liste de fonctions statiques. La valeur par d&eacute;faut est true. Cet argument est facultatif.
• L'argument restriction est une cha&icirc;ne. Cet argument est facultatif et n'est pas sp&eacute;cifi&eacute; s'il n'impose aucune
contrainte. Sur une page Web contenant des langages c&ocirc;t&eacute; client et c&ocirc;t&eacute; serveur, vous pouvez utiliser cet argument
pour limiter l'emploi de conseils de code &agrave; l'un des &eacute;l&eacute;ments suivants :
• Une section de langage sp&eacute;cifique
• Un bloc de code
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant de la fonction dw.codeHints.addFunction() ajoute le mod&egrave;le de nom de fonction
out.newLine() au groupe de menu de conseils de code CodeHints_Object_Methods et l'active uniquement pour les
documents de type JSP :
dw.codeHints.addFunction(
&quot;CodeHints_Object_Methods&quot;,
&quot;out.newLine()&quot;,
&quot;JSP&quot;)
dreamweaver.codeHints.resetMenu()
Disponibilit&eacute;
Dreamweaver MX.
Derni&egrave;re mise &agrave; jour le 22/6/2011
452
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
R&eacute;initialise la balise de menu ou de fonction sp&eacute;cifi&eacute;e &agrave; l'&eacute;tat dans lequel elle se trouvait juste apr&egrave;s la lecture du fichier
CodeHints.xml par Dreamweaver. En d'autres termes, l'appel de cette fonction annule l'effet des appels pr&eacute;c&eacute;dents des
fonctions addMenu() et addFunction().
Arguments
menuGroupId, pattern, {doctypes}
• L'argument menuGroupId est l'attribut de cha&icirc;ne d'ID d'une balise menugroup.
• L'argument pattern est une cha&icirc;ne qui sp&eacute;cifie l'attribut de mod&egrave;le de la nouvelle balise menu ou function &agrave;
r&eacute;initialiser.
• L'argument facultatif doctypes indique que le menu est actif pour certains types de documents uniquement. Vous
pouvez sp&eacute;cifier l'argument doctypes en tant que liste d'ID de types de documents s&eacute;par&eacute;s par des virgules. Pour
obtenir une liste des types de documents de Dreamweaver, consultez le fichier
Configuration/Documenttypes/MMDocumentTypes.xml.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Votre code JavaScript peut cr&eacute;er un menu Conseils de code qui contient toutes les variables de session d&eacute;finies par
l'utilisateur. D&egrave;s que la liste des variables de session est modifi&eacute;e, ce code met le menu &agrave; jour. Avant de charger la
nouvelle liste de variables de session dans le menu, le code doit supprimer l'ancienne liste. L'appel de cette fonction
supprime les anciennes variables de session.
dreamweaver.codeHints.showCodeHints()
Disponibilit&eacute;
Dreamweaver MX.
Description
Dreamweaver appelle cette fonction lorsque l'utilisateur ouvre l'&eacute;l&eacute;ment de menu Edition &gt; Afficher les conseils de
code. La fonction ouvre le menu Conseils de code &agrave; l'emplacement de la s&eacute;lection en mode Code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
L'exemple suivant ouvre le menu de conseils de code au niveau du point d'insertion dans le document en mode Code.
dw.codeHints.showCodeHints()
Derni&egrave;re mise &agrave; jour le 22/6/2011
453
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
dreamweaver.reloadCodeColoring()
Description
Recharge les fichiers de coloration de code dans le dossier Configuration/Code Coloring de Dreamweaver.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
dreamweaver.reloadCodeColoring()
Fonctions relatives &agrave; la recherche et au remplacement
Comme leur nom l'indique, ces fonctions permettent d'effectuer des recherches et des remplacements. Elles vont de la
simple recherche de l'instance suivante d'une cha&icirc;ne donn&eacute;e &agrave; des op&eacute;rations plus complexes de remplacement
automatique.
dreamweaver.findNext()
Disponibilit&eacute;
Dreamweaver 3 ; modifi&eacute; dans Dreamweaver MX 2004.
Description
Recherche l'instance suivante de la cha&icirc;ne de recherche pr&eacute;c&eacute;demment d&eacute;finie par &laquo; dreamweaver.setUpFind() &raquo; &agrave; la
page 456, par &laquo; dreamweaver.setUpComplexFind() &raquo; &agrave; la page 455 ou par l'utilisateur (&agrave; l'aide de la bo&icirc;te de dialogue
Rechercher), puis la s&eacute;lectionne dans le document.
Arguments
{bUseLastSetupSearch}, {document}, {clearSearchResults}
• L'argument facultatif bUseLastSetupSearch est une valeur bool&eacute;enne. Si bUseLastSetupSearch a la valeur true
(valeur par d&eacute;faut si aucun argument n'est fourni), la fonction recherche l'occurrence suivante selon les param&egrave;tres
d&eacute;finis lors de l'appel pr&eacute;c&eacute;dent &agrave; la fonction dreamweaver.setupComplexFind() ou &agrave; la fonction
dreamweaver.setupComplexFindReplace(). Si vous d&eacute;finissez bUseLastSetupSearch sur la valeur false, la
fonction ignore la recherche pr&eacute;c&eacute;dente et recherche l'instance suivante du texte s&eacute;lectionn&eacute; dans le document.
• L'argument facultatifdocument repr&eacute;sente le document dans lequel effectuer la recherche.
• L'argument facultatifclearSearchResults indique si le contenu du panneau Rechercher les r&eacute;sultats doit &ecirc;tre effac&eacute;
avant l'ex&eacute;cution d'une recherche.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
454
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Activateur
Voir &laquo; dreamweaver.canFindNext() &raquo; &agrave; la page 514.
dreamweaver.findAll()
Disponibilit&eacute;
Dreamweaver 3.
Description
Recherche toutes les instances de la cha&icirc;ne de recherche pr&eacute;c&eacute;demment d&eacute;finie par dreamweaver.setUpFind(), par
dreamweaver.setUpComplexFind() ou par l'utilisateur (&agrave; l'aide de la bo&icirc;te de dialogue Rechercher), puis s&eacute;lectionne
toutes les instances dans le document.
Arguments
Les arguments sont identiques &agrave; ceux de la fonction dreamweaver.findNext(). Voir &laquo; dreamweaver.findNext() &raquo; &agrave;
la page 453.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.replace()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie que la s&eacute;lection actuelle correspond aux crit&egrave;res de recherche sp&eacute;cifi&eacute;s par
&laquo; dreamweaver.setUpFindReplace() &raquo; &agrave; la page 457, par &laquo; dreamweaver.setUpComplexFindReplace() &raquo; &agrave; la page 455
ou par l'utilisateur dans la bo&icirc;te de dialogue Remplacer ; la fonction remplace ensuite la s&eacute;lection par le texte de
substitution sp&eacute;cifi&eacute; dans la demande de recherche.
Arguments
Les arguments sont identiques &agrave; ceux de la fonction dreamweaver.findNext(). Voir &laquo; dreamweaver.findNext() &raquo; &agrave;
la page 453.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.replaceAll()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
455
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Remplace chaque section du document actif correspondant aux crit&egrave;res de recherche pr&eacute;c&eacute;demment d&eacute;finis par la
fonction &laquo; dreamweaver.setUpFindReplace() &raquo; &agrave; la page 457 ou &laquo; dreamweaver.setUpComplexFindReplace() &raquo; &agrave; la
page 455 ou par l'utilisateur (dans la bo&icirc;te de dialogue Remplacer) par le contenu de remplacement sp&eacute;cifi&eacute;.
Arguments
Les arguments sont identiques &agrave; ceux de la fonction dreamweaver.findNext(). Voir &laquo; dreamweaver.findNext() &raquo; &agrave;
la page 453.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.setUpComplexFind()
Disponibilit&eacute;
Dreamweaver 3.
Description
Pr&eacute;pare le terrain pour une recherche avanc&eacute;e de texte ou de balises en chargeant la requ&ecirc;te XML sp&eacute;cifi&eacute;e.
Arguments
xmlQueryString
• L'argument xmlQueryString est une cha&icirc;ne de code XML commen&ccedil;ant par dwquery et se terminant par /dwquery.
Pour obtenir une cha&icirc;ne format&eacute;e correctement, vous pouvez d&eacute;finir la requ&ecirc;te &agrave; l'aide de la bo&icirc;te de dialogue
Rechercher, cliquer sur le bouton Enregistrer la requ&ecirc;te, ouvrir ce fichier de requ&ecirc;te dans un &eacute;diteur de texte et
copier tout ce qui est compris entre le d&eacute;but de la balise dwquery et la fin de la balise /dwquery.
Remarque : Dans une requ&ecirc;te, certains caract&egrave;res sp&eacute;ciaux, tels que la barre oblique inverse (\), doivent &ecirc;tre ignor&eacute;s.
Par cons&eacute;quent, pour utiliser une barre oblique inverse dans une requ&ecirc;te, vous devez &eacute;crire \\.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Dans l'exemple ci-apr&egrave;s, la premi&egrave;re ligne de code d&eacute;finit une recherche de balise et pr&eacute;cise que la recherche doit porter
sur le document actif ; la deuxi&egrave;me ligne ex&eacute;cute la recherche.
dreamweaver.setUpComplexFind('&lt;dwquery&gt;&lt;queryparams matchcase=&quot;false&quot; &not;
ignorewhitespace=&quot;true&quot; useregexp=&quot;false&quot;/&gt;&lt;find&gt;&not;
&lt;qtag qname=&quot;a&quot;&gt;&lt;qattribute qname=&quot;href&quot; qcompare=&quot;=&quot; qvalue=&quot;#&quot;&gt;&not;
&lt;/qattribute&gt;&lt;qattribute qname=&quot;onMouseOut&quot; qcompare=&quot;=&quot; qvalue=&quot;&quot; qnegate=&quot;true&quot;&gt;&not;
&lt;/qattribute&gt;&lt;/qtag&gt;&lt;/find&gt;&lt;/dwquery&gt;');
dw.findNext();
dreamweaver.setUpComplexFindReplace()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
456
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Pr&eacute;pare le terrain pour une recherche avanc&eacute;e de texte ou de balises en chargeant la requ&ecirc;te XML sp&eacute;cifi&eacute;e.
Arguments
xmlQueryString
• L'argument xmlQueryString est une cha&icirc;ne du codeXML qui commence par la balise dwquery et se termine par la
balise /dwquery. Pour obtenir une cha&icirc;ne ayant format&eacute;e correctement, vous pouvez d&eacute;finir la requ&ecirc;te &agrave; l'aide de
la bo&icirc;te de dialogue Rechercher, cliquer sur le bouton Enregistrer la requ&ecirc;te, ouvrir ce fichier de requ&ecirc;te dans un
&eacute;diteur de texte et copier tout ce qui est compris entre le d&eacute;but de la balise dwquery et la fin de la balise /dwquery.
Remarque : Dans une requ&ecirc;te, certains caract&egrave;res sp&eacute;ciaux, tels que la barre oblique inverse (\), doivent &ecirc;tre ignor&eacute;s.
Par cons&eacute;quent, pour utiliser une barre oblique inverse dans une requ&ecirc;te, vous devez &eacute;crire \\.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Dans l'exemple ci-apr&egrave;s, la premi&egrave;re ligne de code d&eacute;finit une recherche de balise et pr&eacute;cise que la recherche doit porter
sur quatre fichiers ; la deuxi&egrave;me ligne ex&eacute;cute la recherche et le remplacement.
dreamweaver.setUpComplexFindReplace('&lt;dwquery&gt;&lt;queryparams &not;
matchcase=&quot;false&quot; ignorewhitespace=&quot;true&quot; useregexp=&quot;false&quot;/&gt;&not;
&lt;find&gt;&lt;qtag qname=&quot;a&quot;&gt;&lt;qattribute qname=&quot;href&quot; qcompare=&quot;=&quot; qvalue=&quot;#&quot;&gt;&not;
&lt;/qattribute&gt;&lt;qattribute qname=&quot;onMouseOut&quot; &not;qcompare=&quot;=&quot; qvalue=&quot;&quot; qnegate=&quot;true&quot;&gt;&not;
&lt;/qattribute&gt;&lt;/qtag&gt;&lt;/find&gt;&lt;replace action=&quot;setAttribute&quot; param1=&quot;onMouseOut&quot; &not;
param2=&quot;this.style.color='#000000';this.style.&not;
fontWeight='normal'&quot;/&gt;&lt;/dwquery&gt;');
dw.replaceAll();
dreamweaver.setUpFind()
Disponibilit&eacute;
Dreamweaver 3.
Description
Pr&eacute;pare le terrain pour l'ex&eacute;cution d'une recherche de texte ou de code source HTML en d&eacute;finissant les crit&egrave;res de
recherche de l'op&eacute;ration dreamweaver.findNext() qui va suivre.
Arguments
searchObject
L'argument searchObject est un objet pour lequel les propri&eacute;t&eacute;s suivantes peuvent &ecirc;tre d&eacute;finies :
• La propri&eacute;t&eacute; searchString est le texte &agrave; rechercher.
• searchWhat est l'endroit o&ugrave; la recherche doit &ecirc;tre lanc&eacute;e. Les valeurs possibles sont les suivantes :
•
document : recherche dans le document actif.
•
allOpenDocuments : recherche dans tous les documents ouverts.
•
site : recherche dans le site actuel.
•
selectedFiles : recherche dans les fichiers s&eacute;lectionn&eacute;s.
Derni&egrave;re mise &agrave; jour le 22/6/2011
457
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
•
selectedText : recherche dans le texte s&eacute;lectionn&eacute; ou le chemin d'un dossier.
• La propri&eacute;t&eacute; searchSource est une valeur bool&eacute;enne indiquant si la recherche doit &eacute;galement porter sur le code
sourceHTML.
• La propri&eacute;t&eacute; facultative {matchCase} est une valeur bool&eacute;enne indiquant si la recherche doit respecter les
majuscules et les minuscules. Si cette propri&eacute;t&eacute; n'est pas d&eacute;finie, elle prend par d&eacute;faut la valeur false.
• La propri&eacute;t&eacute; facultative {matchWholeWord} est une valeur bool&eacute;enne qui indique si les r&eacute;sultats doivent &ecirc;tre des
mots entiers.
• La propri&eacute;t&eacute; facultative {ignoreWhitespace} est une valeur bool&eacute;enne indiquant si les diff&eacute;rences entre les espaces
blancs doivent &ecirc;tre ignor&eacute;es. La propri&eacute;t&eacute;s ignoreWhitespace prend sa valeur par d&eacute;faut, false, si la valeur de la
propri&eacute;t&eacute; useRegularExpressions est true, et true si la valeur de la propri&eacute;t&eacute; useRegularExpressions est false.
• La propri&eacute;t&eacute; {useRegularExpressions} est une valeur bool&eacute;enne indiquant que la propri&eacute;t&eacute; searchString utilise des
expressions r&eacute;guli&egrave;res. Si cette propri&eacute;t&eacute; n'est pas d&eacute;finie, elle prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.setUpFindReplace()
Disponibilit&eacute;
Dreamweaver 3.
Description
Pr&eacute;pare une recherche de texte ou de code source HTML en d&eacute;finissant les crit&egrave;res de recherche et le cadre
d'application de l'op&eacute;ration dreamweaver.replace()dreamweaver.replaceAll() qui va suivre.
Arguments
searchObject
L'argument searchObject est un objet pour lequel les propri&eacute;t&eacute;s suivantes peuvent &ecirc;tre d&eacute;finies :
• La propri&eacute;t&eacute; searchString est le texte &agrave; rechercher.
• searchWhat est l'endroit o&ugrave; la recherche doit &ecirc;tre lanc&eacute;e. Les valeurs possibles sont les suivantes :
•
document : recherche dans le document actif.
•
allOpenDocuments : recherche dans tous les documents ouverts.
•
site : recherche dans le site actuel.
•
selectedFiles : recherche dans les fichiers s&eacute;lectionn&eacute;s.
•
selectedText : recherche dans le texte s&eacute;lectionn&eacute;.
• La propri&eacute;t&eacute; replaceString est le texte &agrave; substituer au texte recherch&eacute;.
• La propri&eacute;t&eacute; searchSource est une valeur bool&eacute;enne indiquant si la recherche doit &eacute;galement porter sur le code
sourceHTML.
• La propri&eacute;t&eacute; facultative {matchCase} est une valeur bool&eacute;enne indiquant si la recherche doit respecter les
majuscules et les minuscules. Si cette propri&eacute;t&eacute; n'est pas d&eacute;finie, elle prend par d&eacute;faut la valeur false.
• La propri&eacute;t&eacute; facultative {matchWholeWord} est une valeur bool&eacute;enne qui indique si les r&eacute;sultats doivent &ecirc;tre
consid&eacute;r&eacute;s comme des mots entiers.
Derni&egrave;re mise &agrave; jour le 22/6/2011
458
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
• La propri&eacute;t&eacute; facultative {ignoreWhitespace} est une valeur bool&eacute;enne indiquant si les diff&eacute;rences entre les espaces
blancs doivent &ecirc;tre ignor&eacute;es. La propri&eacute;t&eacute; ignoreWhitespace prend la valeur false si la propri&eacute;t&eacute;
useRegularExpressions a la valeur true et prend la valeur true si l'expression useRegularExpressions a la valeur
false.
• La propri&eacute;t&eacute; {useRegularExpressions} est une valeur bool&eacute;enne indiquant que la propri&eacute;t&eacute; searchString utilise des
expressions r&eacute;guli&egrave;res. Si cette propri&eacute;t&eacute; n'est pas d&eacute;finie, elle prend par d&eacute;faut la valeur false.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.showFindDialog()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Rechercher.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canShowFindDialog() &raquo; &agrave; la page 519.
dreamweaver.showFindReplaceDialog()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Remplacer.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canShowFindDialog() &raquo; &agrave; la page 519.
Derni&egrave;re mise &agrave; jour le 22/6/2011
459
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Fonctions de modifications g&eacute;n&eacute;rales
Ces fonctions s'utilisent depuis la fen&ecirc;tre de document. Elles permettent d'ins&eacute;rer du texte, du code HTML et des
objets, d'appliquer, de modifier et de supprimer des marqueurs de police et de caract&egrave;re, de modifier des balises et des
attributs, etc.
dom.applyCharacterMarkup()
Disponibilit&eacute;
Dreamweaver 3.
Description
Applique &agrave; la s&eacute;lection le type de marqueur de caract&egrave;re sp&eacute;cifi&eacute;. Si la s&eacute;lection est un point d'insertion, la fonction
applique les marqueurs de caract&egrave;re sp&eacute;cifi&eacute;s au texte saisi apr&egrave;s le point d'insertion.
Arguments
tagName
• L'argument tagName est le nom de la balise associ&eacute; au marqueur de caract&egrave;re. Il doit s'agir d'une des cha&icirc;nes
suivantes : &quot;b&quot;, &quot;cite&quot;, &quot;code&quot;, &quot;dfn&quot;, &quot;em&quot;, &quot;i&quot;, &quot;kbd&quot;, &quot;samp&quot;, &quot;s&quot;, &quot;strong&quot;, &quot;tt&quot;, &quot;u&quot; ou &quot;var&quot;.
Valeurs renvoy&eacute;es
Aucune.
dom.applyFontMarkup()
Disponibilit&eacute;
Dreamweaver 3.
Description
Applique &agrave; la s&eacute;lection en cours la balise FONT, ainsi que l'attribut sp&eacute;cifi&eacute; et sa valeur.
Arguments
attribute, value
• L'argument attribute doit &ecirc;tre &quot;face&quot;, &quot;size&quot; ou &quot;color&quot;.
• L'argument value est la valeur &agrave; affecter &agrave; l'attribut, comme &quot;Arial, Helvetica, sans-serif&quot;, &quot;5&quot; ou &quot;#FF0000&quot;.
Valeurs renvoy&eacute;es
Aucune.
dom.deleteSelection()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
460
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Supprime la s&eacute;lection du document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.editAttribute()
Disponibilit&eacute;
Dreamweaver 3.
Description
Affiche l'interface permettant de modifier l'attribut de document sp&eacute;cifi&eacute;. Dans la plupart des cas, il s'agit d'une bo&icirc;te
de dialogue. Cette fonction n'est valide que pour le document actif.
Arguments
attribute
• attribute est une cha&icirc;ne qui sp&eacute;cifie l'attribut de balise &agrave; modifier.
Valeurs renvoy&eacute;es
Aucune.
dom.exitBlock()
Disponibilit&eacute;
Dreamweaver 3.
Description
Quitte le bloc de paragraphe ou d'en-t&ecirc;te en cours et place le point d'insertion &agrave; l'ext&eacute;rieur de tous les &eacute;l&eacute;ments de bloc.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.getCharSet()
Disponibilit&eacute;
Dreamweaver 4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
461
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Renvoie l'attribut charset dans la balise Meta du document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
L'identit&eacute; de codage du document. Par exemple, pour un document Latin1, la fonction renvoie iso-8859-1.
dom.getFontMarkup()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient la valeur de l'attribut sp&eacute;cifi&eacute; de la balise FONT pour la s&eacute;lection en cours.
Arguments
attribute
• L'argument attribute doit &ecirc;tre &quot;face&quot;, &quot;size&quot; ou &quot;color&quot;.
Valeurs renvoy&eacute;es
Soit une cha&icirc;ne contenant la valeur de l'attribut sp&eacute;cifi&eacute;, soit une cha&icirc;ne vide si l'attribut n'est pasd&eacute;fini.
dom.getLineFromOffset()
Disponibilit&eacute;
Dreamweaver MX.
Description
Trouve le num&eacute;ro de ligne d'un d&eacute;calage de caract&egrave;re pr&eacute;cis dans le texte (le code HTML ou JavaScript) du fichier.
Arguments
offset
• L'argument offset est un nombre entier qui repr&eacute;sente l'emplacement du caract&egrave;re &agrave; partir du d&eacute;but du fichier.
Valeurs renvoy&eacute;es
Nombre entier qui repr&eacute;sente le num&eacute;ro de la ligne dans le document.
dom.getLinkHref()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
462
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Obtient le lien qui entoure la s&eacute;lection en cours. Revient &agrave; effectuer une boucle sur les parents et les grands-parents du
nœud en cours jusqu'&agrave; ce qu'un lien soit rencontr&eacute;, puis &agrave; appeler la fonction getAttribute('HREF') sur ce lien.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui contient le nom du fichier li&eacute;, exprim&eacute; sous la forme d'une URL de type file://.
dom.getLinkTarget()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient la cible du lien qui entoure la s&eacute;lection en cours. Revient &agrave; effectuer une boucle sur les parents et les grandsparents du nœud en cours jusqu'&agrave; ce qu'un lien soit rencontr&eacute;, puis &agrave; appeler la fonction getAttribute('TARGET')
sur ce lien.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Soit une cha&icirc;ne contenant la valeur de l'attribut TARGET sp&eacute;cifi&eacute; pour le lien, soit une cha&icirc;ne vide si aucune cible n'est
d&eacute;finie.
dom.getListTag()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient le style de la liste s&eacute;lectionn&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Soit une cha&icirc;ne contenant la balise associ&eacute;e &agrave; la liste (&quot;ul&quot;, &quot;ol&quot; ou &quot;dl&quot;), soit une cha&icirc;ne vide si aucune balise n'est
associ&eacute;e &agrave; la liste. Cette valeur est toujours renvoy&eacute;e en minuscules.
Derni&egrave;re mise &agrave; jour le 22/6/2011
463
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
dom.getTextAlignment()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient l'alignement du bloc contenant la s&eacute;lection.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Soit une cha&icirc;ne contenant la valeur de l'attribut ALIGN de la balise associ&eacute;e au bloc, soit une cha&icirc;ne vide si l'attribut
ALIGN n'est pas d&eacute;fini. Cette valeur est toujours renvoy&eacute;e en minuscules.
dom.getTextFormat()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient le format du bloc contenant la s&eacute;lection.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Soit une cha&icirc;ne contenant la balise de bloc associ&eacute;e au texte (comme &quot;p&quot;, &quot;h1&quot;, &quot;pre&quot;, etc.), soit une cha&icirc;ne vide si
aucune balise de bloc n'est associ&eacute;e &agrave; la s&eacute;lection. Cette valeur est toujours renvoy&eacute;e en minuscules.
dom.hasCharacterMarkup()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si le marqueur de caract&egrave;re sp&eacute;cifi&eacute; est d&eacute;j&agrave; associ&eacute; &agrave; la s&eacute;lection.
Arguments
markupTagName
• L'argument markupTagName est le nom de la balise &agrave; v&eacute;rifier. Il doit s'agir d'une des cha&icirc;nes suivantes : &quot;b&quot;,
&quot;cite&quot;, &quot;code&quot;, &quot;dfn&quot;, &quot;em&quot;, &quot;i&quot;, &quot;kbd&quot;, &quot;samp&quot;, &quot;s&quot;, &quot;strong&quot;, &quot;tt&quot;, &quot;u&quot; ou &quot;var&quot;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
464
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne qui indique si le marqueur de caract&egrave;re sp&eacute;cifi&eacute; est associ&eacute; &agrave; la s&eacute;lection enti&egrave;re. Cette fonction
renvoie la valeur false si le marqueur sp&eacute;cifi&eacute; n'est associ&eacute; qu'&agrave; une partie de la s&eacute;lection.
dom.indent()
Disponibilit&eacute;
Dreamweaver 3.
Description
Applique un retrait &agrave; la s&eacute;lection &agrave; l'aide des balises BLOCKQUOTE. Si la s&eacute;lection est un &eacute;l&eacute;ment de liste, cette fonction
lui applique un retrait en convertissant l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; en liste imbriqu&eacute;e. La liste imbriqu&eacute;e est du m&ecirc;me type
que la liste externe et contient un seul &eacute;l&eacute;ment (la s&eacute;lection d'origine).
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.insertHTML()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ins&egrave;re un contenu HTML dans le document, au niveau du point d'insertion en cours.
Arguments
contentToInsert, {bReplaceCurrentSelection}
• L'argument contentToInsert est le contenu &agrave; ins&eacute;rer.
• L'argument facultatif bReplaceCurrentSelection est une valeur bool&eacute;enne qui indique si le contenu sp&eacute;cifi&eacute; doit
remplacer la s&eacute;lection en cours. Si la valeur de l'argument bReplaceCurrentSelection est true, le contenu remplace
la s&eacute;lection actuelle. Si sa valeur est false, le contenu est ins&eacute;r&eacute; apr&egrave;s la s&eacute;lection actuelle.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Le code suivant ins&egrave;re la cha&icirc;ne HTML &lt;b&gt;130&lt;/b&gt; dans le document actuel :
var theDOM = dw.getDocumentDOM();
theDOM.insertHTML('&lt;b&gt;130&lt;/b&gt;');
Le r&eacute;sultat s'affiche dans la fen&ecirc;tre de document.
Derni&egrave;re mise &agrave; jour le 22/6/2011
465
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
dom.insertObject()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ins&egrave;re l'objet sp&eacute;cifi&eacute; et invite l'utilisateur &agrave; d&eacute;finir des param&egrave;tres, le cas &eacute;ch&eacute;ant.
Arguments
objectName
• L'argument objectName est le nom d'un objet dans le dossier Configuration/Objects.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Un appel &agrave; la fonction dom.insertObject('Button') ins&egrave;re un bouton de formulaire dans le document actif, apr&egrave;s
la s&eacute;lection en cours. Si aucun &eacute;l&eacute;ment n'est s&eacute;lectionn&eacute;, cette fonction ins&egrave;re le bouton au niveau du point d'insertion
en cours.
Remarque : M&ecirc;me si les fichiers d'objets peuvent &ecirc;tre conserv&eacute;s dans des dossiers s&eacute;par&eacute;s, le nom de chaque fichier doit
imp&eacute;rativement &ecirc;tre unique. En effet, si le dossier Forms et le dossier MyObjects contiennent chacun un fichier nomm&eacute;
Button.htm, par exemple, Dreamweaver n'est pas capable de faire la diff&eacute;rence entre les deux.
dom.insertText()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ins&egrave;re un contenu dans le document, au niveau du point d'insertion en cours.
Arguments
contentToInsert, {bReplaceCurrentSelection}
• L'argument contentToInsert est le contenu &agrave; ins&eacute;rer.
• L'argument facultatif bReplaceCurrentSelection est une valeur bool&eacute;enne qui indique si le contenu sp&eacute;cifi&eacute; doit
remplacer la s&eacute;lection en cours. Si la valeur de l'argument bReplaceCurrentSelection est true, le contenu remplace
la s&eacute;lection actuelle. Si sa valeur est false, le contenu est ins&eacute;r&eacute; apr&egrave;s la s&eacute;lection actuelle.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Le code suivant ins&egrave;res le texte &amp;lt;b&amp;gt;130&amp;lt;/b&amp;gt; dans le document actuel :
var theDOM = dreamweaver.getDocumentDOM();
theDOM.insertText('&lt;b&gt;130&lt;/b&gt;');
Derni&egrave;re mise &agrave; jour le 22/6/2011
466
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Les r&eacute;sultats s'affichent dans la fen&ecirc;tre de document.
dom.newBlock()
Disponibilit&eacute;
Dreamweaver 3.
Description
Cr&eacute;e un bloc dot&eacute; de la m&ecirc;me balise et des m&ecirc;mes attributs que le bloc contenant la s&eacute;lection en cours ou, si le pointeur
se trouve &agrave; l'ext&eacute;rieur de tous les blocs, cr&eacute;e un paragraphe.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Si la s&eacute;lection en cours se trouve &agrave; l'int&eacute;rieur d'un paragraphe centr&eacute;, un appel &agrave; la fonction dom.newBlock() ins&egrave;re
&lt;p align=&quot;center&quot;&gt; apr&egrave;s le paragraphe en cours.
dom.notifyFlashObjectChanged()
Disponibilit&eacute;
Dreamweaver 4.
Description
Indique &agrave; Dreamweaver que le fichier Flash en cours a &eacute;t&eacute; modifi&eacute;. Dreamweaver met &agrave; jour la fen&ecirc;tre d'aper&ccedil;u en la
redimensionnant, le cas &eacute;ch&eacute;ant, et en veillant &agrave; conserver le rapport hauteur/largeur d'origine.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.outdent()
Disponibilit&eacute;
Dreamweaver 3.
Description
Applique un retrait n&eacute;gatif &agrave; la s&eacute;lection.
Derni&egrave;re mise &agrave; jour le 22/6/2011
467
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.removeCharacterMarkup()
Disponibilit&eacute;
Dreamweaver 3.
Description
Supprime de la s&eacute;lection le type de marqueur de caract&egrave;re sp&eacute;cifi&eacute;.
Arguments
tagName
• L'argument tagName est le nom de la balise associ&eacute; au marqueur de caract&egrave;re. Il doit s'agir d'une des cha&icirc;nes
suivantes : &quot;b&quot;, &quot;cite&quot;, &quot;code&quot;, &quot;dfn&quot;, &quot;em&quot;, &quot;i&quot;, &quot;kbd&quot;, &quot;samp&quot;, &quot;s&quot;, &quot;strong&quot;, &quot;tt&quot;, &quot;u&quot; ou &quot;var&quot;.
Valeurs renvoy&eacute;es
Aucune.
dom.removeFontMarkup()
Disponibilit&eacute;
Dreamweaver 3.
Description
Supprime d'une balise FONT l'attribut sp&eacute;cifi&eacute;, ainsi que sa valeur. Si, apr&egrave;s suppression de l'attribut, il ne reste que la
balise FONT, la balise FONT est &eacute;galement supprim&eacute;e.
Arguments
attribute
• L'argument attribute doit &ecirc;tre &quot;face&quot;, &quot;size&quot; ou &quot;color&quot;.
Valeurs renvoy&eacute;es
Aucune.
dom.resizeSelection()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
468
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Redimensionne l'objet s&eacute;lectionn&eacute; et lui applique les nouvelles dimensions sp&eacute;cifi&eacute;es.
Arguments
newWidth, newHeight
• L'argument newWidth sp&eacute;cifie la nouvelle largeur d&eacute;finie pour l'objets&eacute;lectionn&eacute; par la fonction.
• L'argument newHeight sp&eacute;cifie la nouvelle hauteur d&eacute;finie pour l'objets&eacute;lectionn&eacute; par la fonction.
Valeurs renvoy&eacute;es
Aucune.
dom.setAttributeWithErrorChecking()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;finit l'attribut sp&eacute;cifi&eacute; sur la valeur indiqu&eacute;e pour la s&eacute;lection en cours et affiche une invite utilisateursile type de
valeur est incorrect ou si la valeur n'est pas comprise dans la plage sp&eacute;cifi&eacute;e. Cette fonction n'est valide que pour le
document actif.
Arguments
attribute, value
• L'argument attribute sp&eacute;cifie l'attribut &agrave; d&eacute;finir pour la s&eacute;lection actuelle.
• L'argument value sp&eacute;cifie la valeur &agrave; d&eacute;finir pour l'attribut.
Valeurs renvoy&eacute;es
Aucune.
dom.setLinkHref()
Disponibilit&eacute;
Dreamweaver 3.
Description
Transforme la s&eacute;lection en lien hypertexte ou modifie la valeur de l'URL pour la balise HREF qui entoure la s&eacute;lection
en cours.
Arguments
linkHREF
• L'argument linkHREF est une URL (chemin relatif au document ou &agrave; la racine, ou URL absolue) contenant le lien.
Si aucun argument n'est d&eacute;fini, la bo&icirc;te de dialogue S&eacute;lectionner fichier HTMLs'affiche.
Derni&egrave;re mise &agrave; jour le 22/6/2011
469
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canSetLinkHref() &raquo; &agrave; la page 509.
dom.getLinkTarget()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;finit la cible du lien qui entoure la s&eacute;lection en cours. Revient &agrave; effectuer une boucle sur les parents et les grandsparents du nœud en cours jusqu'&agrave; ce qu'un lien soit rencontr&eacute;, puis &agrave; appeler la fonction setAttribute('TARGET')
sur ce lien.
Arguments
{linkTarget}
• L'argument linkTarget est une cha&icirc;ne qui repr&eacute;sente le nom d'un cadre ou d'une fen&ecirc;tre, ou l'une des cibles r&eacute;serv&eacute;es
(&quot;_self&quot;, &quot;_parent&quot;, &quot;_top&quot; ou &quot;_blank&quot;). Si aucun argument n'est d&eacute;fini, la bo&icirc;te de dialogue D&eacute;finir la cible
s'affiche.
Valeurs renvoy&eacute;es
Aucune.
dom.setListBoxKind()
Disponibilit&eacute;
Dreamweaver 3.
Description
Modifie le type du menu SELECT s&eacute;lectionn&eacute;.
Arguments
kind
• L'argument kind doit &ecirc;tre &quot;menu&quot; ou &quot;list
box&quot;.
Valeurs renvoy&eacute;es
Aucune.
dom.showListPropertiesDialog()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
470
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Ouvre la bo&icirc;te de dialogue Propri&eacute;t&eacute;s de la liste.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dom.canShowListPropertiesDialog() &raquo; &agrave; la page 509.
dom.setListTag()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;finit le style de la liste s&eacute;lectionn&eacute;e.
Arguments
listTag
• L'argument listTag est la balise associ&eacute;e &agrave; la liste. Il doit s'agir de &quot;ol&quot;, &quot;ul&quot;, &quot;dl&quot; ou d'une cha&icirc;ne vide.
Valeurs renvoy&eacute;es
Aucune.
dom.setTextAlignment()
Disponibilit&eacute;
Dreamweaver 3.
Description
Affecte la valeur sp&eacute;cifi&eacute;e &agrave; l'attribut ALIGN du bloc contenant la s&eacute;lection.
Arguments
alignValue
• L'argument alignValue doit &ecirc;tre &quot;left&quot;, &quot;center&quot; ou &quot;right&quot;.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
471
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
dom.setTextFieldKind()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;finit le format du champ de texte s&eacute;lectionn&eacute;.
Arguments
fieldType
• L'argument fieldType doit &ecirc;tre &quot;input&quot;, &quot;textarea&quot; ou &quot;password&quot;.
Valeurs renvoy&eacute;es
Aucune.
dom.setTextFormat()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;finit le format de bloc du texte s&eacute;lectionn&eacute;.
Arguments
blockFormat
• L'argument blockFormat est une cha&icirc;ne qui sp&eacute;cifie l'un des formats suivants : &quot;&quot; (for no format), &quot;p&quot;, &quot;h1&quot;, &quot;h2&quot;,
&quot;h3&quot;, &quot;h4&quot;, &quot;h5&quot;, &quot;h6&quot; ou &quot;pre&quot;.
Valeurs renvoy&eacute;es
Aucune.
dom.showFontColorDialog()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue du s&eacute;lecteur de couleur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
472
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
dreamweaver.deleteSelection()
Disponibilit&eacute;
Dreamweaver 3.
Description
Supprime la s&eacute;lection du document actif, du panneau Site ou, sur Macintosh, il supprime la zone de texte active dans
une bo&icirc;te de dialogue ou un panneau flottant.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canDeleteSelection() &raquo; &agrave; la page 513.
dreamweaver.editFontList()
Disponibilit&eacute;
Dreamweaver 3.
Description
Ouvre la bo&icirc;te de dialogue Modifier la liste des polices.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.getFontList()
Disponibilit&eacute;
Dreamweaver 3.
Description
Obtient la liste de tous les groupes de polices apparaissant dans l'inspecteur Propri&eacute;t&eacute;s de texte et la bo&icirc;te de dialogue
D&eacute;finition du style.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
473
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes dont chaque cha&icirc;ne repr&eacute;sente un &eacute;l&eacute;ment de la liste des polices.
Exemple
Si vous avez effectu&eacute; une installation par d&eacute;faut de Dreamweaver, un appel &agrave; la fonction
dreamweaver.getFontList() renvoie un tableau contenant les &eacute;l&eacute;ments suivants :
•
&quot;Arial, Helvetica, sans-serif&quot;
•
&quot;Times New Roman, Times, serif&quot;
•
&quot;Courier New, Courier, mono&quot;
•
&quot;Georgia, Times New Roman, Times, serif&quot;
•
&quot;Verdana, Arial, Helvetica, sans-serif&quot;
dreamweaver.getFontStyles()
Disponibilit&eacute;
Dreamweaver 4.
Description
Renvoie les styles pris en charge par la police TrueType sp&eacute;cifi&eacute;e.
Arguments
fontName
• L'argument fontName est une cha&icirc;ne contenant le nom de la police.
Valeurs renvoy&eacute;es
Tableau de trois valeurs bool&eacute;ennes qui indique les styles pris en charge par la police. La premi&egrave;re valeur indique si la
police prend en charge le style Gras, la deuxi&egrave;me le style Italique et la troisi&egrave;me les styles Gras et Italique.
dreamweaver.getKeyState()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si la touche de modification sp&eacute;cifi&eacute;e est enfonc&eacute;e.
Arguments
key
• L'argument key doit avoir l'une des valeurs suivantes : &quot;Cmd&quot;, &quot;Ctrl&quot;, &quot;Alt&quot; ou &quot;Shift&quot;. Sous Windows, &quot;Cmd&quot;
et &quot;Ctrl&quot; d&eacute;signent la touche Contr&ocirc;le ; sur Macintosh, &quot;Alt&quot; d&eacute;signe la touche Option.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne qui indique si la touche est enfonc&eacute;e.
Derni&egrave;re mise &agrave; jour le 22/6/2011
474
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Exemple
Le code suivant v&eacute;rifie si les touches Maj et Ctrl (Windows) ou Maj et Commande (Macintosh) sont enfonc&eacute;es avant
d'effectuer une op&eacute;ration.
if (dw.getKeyState(&quot;Shift&quot;) &amp;&amp; dw.getKeyState(&quot;Cmd&quot;)){
// execute code
}
dreamweaver.getNaturalSize()
Disponibilit&eacute;
Dreamweaver 4.
Description
Renvoie la largeur et la hauteur d'un objet graphique.
Arguments
url
• L'argument url pointe vers un objet graphique dont les dimensions sont requises. Dreamweaver doit prendre en
charge cet objet (GIF, JPEG, PNG, Flash ou Shockwave). L'URL fournie comme argument de la fonction
getNaturalSize() doit correspondre &agrave; une URL absolue pointant vers un fichier local ; il ne peut pas s'agir d'une
URL relative.
Valeurs renvoy&eacute;es
Tableau contenant deux nombres entiers, le premier d&eacute;finissant la largeur de l'objet et le second sa hauteur.
dreamweaver.getSystemFontList()
Disponibilit&eacute;
Dreamweaver 4.
Description
Renvoie une liste de polices &agrave; utiliser pour le syst&egrave;me. Cette fonction peut appeler toutes les polices ou uniquement les
polices TrueType.
Arguments
fontTypes
• L'argument fontTypes est une cha&icirc;ne qui contient soit all, soit TrueType.
Valeurs renvoy&eacute;es
Tableau de cha&icirc;nes qui contient le nom de toutes les polices ; renvoie la valeur null si aucune police n'est trouv&eacute;e.
dreamweaver.getSystemFontName()
Disponibilit&eacute;
Dreamweaver CS5.
Derni&egrave;re mise &agrave; jour le 22/6/2011
475
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Renvoie le nom de la police syst&egrave;me.
Arguments
Aucune.
Valeurs renvoy&eacute;es
Cha&icirc;ne contenant le nom de la police syst&egrave;me.
Fonction relative &agrave; l'impression
Cette fonction permet &agrave; l'utilisateur d'imprimer le code depuis le mode Code.
dreamweaver.printCode()
Disponibilit&eacute;
Dreamweaver MX.
Description
Sous Windows, cette fonction imprime toutes les portions de code ou seulement une s&eacute;lection de code depuis le mode
Code. Sur Macintosh, elle imprime toutes les portions de code ou seulement une plage de pages de code.
Arguments
showPrintDialog, document
• L'argument showPrintDialog est true ou false. Sous Windows, si cet argument a pour valeur true, la fonction
dreamweaver.PrintCode() affiche la bo&icirc;te de dialogue d'impression pour demander &agrave; l'utilisateur s'il souhaite
imprimer tout le texte ou seulement une s&eacute;lection de texte. Sur Macintosh, la fonction dreamweaver.PrintCode()
affiche la bo&icirc;te de dialogue d'impression pour demander &agrave; l'utilisateur s'il souhaite imprimer tout le texte ou
seulement une plage de pages.
Si l'argument a pour valeur false, dreamweaver.PrintCode() utilise la s&eacute;lection pr&eacute;c&eacute;dente de l'utilisateur. La
valeur par d&eacute;faut est true.
• L'argument document est le DOM du document &agrave; imprimer. Pour plus d'informations sur la fa&ccedil;on d'obtenir le
DOM d'un document, voir &laquo; dreamweaver.getDocumentDOM() &raquo; &agrave; la page 263.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si l'impression du code est possible, false dans le cas contraire.
Exemple
L'exemple suivant appelle dw.PrintCode() pour lancer la bo&icirc;te de dialogue d'impression pour le document
utilisateur. Si la fonction renvoie la valeur false, le code affiche un message d'alerte informant l'utilisateur qu'il n'est
pas possible d'ex&eacute;cuter la demande d'impression.
Derni&egrave;re mise &agrave; jour le 22/6/2011
476
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
var theDOM = dreamweaver.getDocumentDOM(&quot;document&quot;);
if(!dreamweaver.PrintCode(true, theDOM))
{
alert(&quot;Unable to execute your print request!&quot;);
}
Fonctions relatives &agrave; Quick Tag Editor
Ces fonctions permettent de se d&eacute;placer d'une balise &agrave; l'autre &agrave; l'int&eacute;rieur et autour de la s&eacute;lection en cours. Elles
permettent de supprimer n'importe laquelle de ces balises, d'envelopper la s&eacute;lection &agrave; l'int&eacute;rieur d'une nouvelle balise
et d'afficher Quick Tag Editor pour permettre &agrave; l'utilisateur de modifier certains attributs d'une balise.
dom.selectChild()
Disponibilit&eacute;
Dreamweaver 3.
Description
S&eacute;lectionne un enfant de la s&eacute;lection en cours. Revient &agrave; s&eacute;lectionner la balise situ&eacute;e imm&eacute;diatement &agrave; droite dans le
s&eacute;lecteur de balises, en bas de la fen&ecirc;tre de document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.selectParent()
Disponibilit&eacute;
Dreamweaver 3.
Description
S&eacute;lectionne le parent de la s&eacute;lection en cours. Revient &agrave; s&eacute;lectionner la balise situ&eacute;e imm&eacute;diatement &agrave; gauche dans le
s&eacute;lecteur de balises, en bas de la fen&ecirc;tre de document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
477
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
dom.stripTag()
Disponibilit&eacute;
Dreamweaver 3.
Description
Supprime les balises qui entourent la s&eacute;lection actuelle, laissant intact leur contenu. Si la s&eacute;lection contient plusieurs
balises ou n'en contient aucune, Dreamweaver affiche un message d'erreur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.wrapTag()
Disponibilit&eacute;
Dreamweaver 3.
Description
Place la balise sp&eacute;cifi&eacute;e autour de la s&eacute;lection en cours. Si la balise n'est pas compl&egrave;te, Dreamweaver affiche un message
d'erreur.
Arguments
startTag, {bAlwaysBalance}, {bMakeLegal}
• L'argument startTag est la source associ&eacute;e &agrave; la balise d'ouverture.
• L'argument bAlwaysBalance est une valeur bool&eacute;enne qui indique si la s&eacute;lection doit &ecirc;tre &eacute;quilibr&eacute;e avant d'&ecirc;tre
envelopp&eacute;e. Cet argument est facultatif.
• L'argument bMakeLegal est une valeur bool&eacute;enne qui indique s'il faut v&eacute;rifier que l'enveloppement produit du code
HTML valide. Cet argument est facultatif.
Valeurs renvoy&eacute;es
Aucune.
Exemple
Le code suivant place un lien autour de la s&eacute;lection en cours.
var theDOM = dw.getDocumentDOM();
var theSel = theDOM.getSelectedNode();
if (theSel.nodeType == Node.TEXT_NODE){
theDOM.wrapTag('&lt;a href=&quot;foo.html&quot;&gt;');
}
Derni&egrave;re mise &agrave; jour le 22/6/2011
478
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
dreamweaver.showQuickTagEditor()
Disponibilit&eacute;
Dreamweaver 3.
Description
Affiche Quick Tag Editor pour la s&eacute;lection en cours.
Arguments
{nearWhat}, {mode}
• L'argument facultatif nearWhat doit, s'il est sp&eacute;cifi&eacute;, &ecirc;tre &quot;selection&quot; ou &quot;tag
selector&quot;. Si cet argument n'est
pas d&eacute;fini, il prend par d&eacute;faut la valeur &quot;selection&quot;.
• L'argument facultatif mode doit, s'il est sp&eacute;cifi&eacute;, &ecirc;tre &quot;default&quot;, &quot;wrap&quot;, &quot;insert&quot; ou &quot;edit&quot;. Si l'argument mode
a pour valeur &quot;default&quot; ou qu'il n'est pas d&eacute;fini, Dreamweaver utilise la m&eacute;thode heuristique afin de d&eacute;terminer
le mode &agrave; utiliser pour la s&eacute;lection en cours. Si l'argument nearWhat a pour valeur &quot;tag selector&quot;, l'argument mode
est ignor&eacute;.
Valeurs renvoy&eacute;es
Aucune.
Fonctions relatives au mode Code
Ces fonctions incluent les op&eacute;rations associ&eacute;es &agrave; la modification du code source d'un document (et tous les
changements ayant une incidence sur le mode Cr&eacute;ation). Les fonctions de cette section vous permettent d'ajouter des
commandes de navigation aux modes Code au sein d'une fen&ecirc;tre de document affich&eacute;e dans deux volets ou dans la
fen&ecirc;tre de l'inspecteur de code.
dom.formatRange()
Disponibilit&eacute;
Dreamweaver MX.
Description
Applique le formatage de syntaxe automatique de Dreamweaver &agrave; une plage d&eacute;finie de caract&egrave;res en mode Code, et ce
conform&eacute;ment aux param&egrave;tres de la bo&icirc;te de dialogue Pr&eacute;f&eacute;rences &gt; Format de code.
Arguments
startOffset, endOffset
• L'argument startOffset est un nombre entier qui repr&eacute;sente le d&eacute;but de la plage d&eacute;finie, et ce sous la forme d'un
d&eacute;calage par rapport au d&eacute;but du document.
• L'argument endOffset est un nombre entier qui repr&eacute;sente la fin de la plage d&eacute;finie, et ce sous la forme d'un d&eacute;calage
par rapport au d&eacute;but du document.
Derni&egrave;re mise &agrave; jour le 22/6/2011
479
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Valeurs renvoy&eacute;es
Aucune.
dom.formatSelection()
Disponibilit&eacute;
Dreamweaver MX.
Description
Applique le formatage de syntaxe automatique de Dreamweaver au contenu s&eacute;lectionn&eacute; (ce qui revient &agrave; utiliser
l'option Commandes &gt; Appliquer le format source &agrave; la s&eacute;lection), conform&eacute;ment aux param&egrave;tres de la bo&icirc;te de
dialogue Pr&eacute;f&eacute;rences &gt; Format de code.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.getShowNoscript()
Disponibilit&eacute;
Dreamweaver MX.
Description
Obtient l'&eacute;tat actuel de l'option de contenu noscript (depuis l'option de menu Affichage &gt; Contenu Noscript).
Activ&eacute;e par d&eacute;faut, la balise noscript identifie un script de page pouvant, au choix, &ecirc;tre affich&eacute; ou non dans le
navigateur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le contenu de la balise noscript est actuellement affich&eacute;, false dans le cas contraire.
dom.getAutoValidationCount()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Obtient le nombre d'erreurs, d'avertissements et de messages d'information pour la derni&egrave;re auto-validation (ou
validation en ligne) du document. Actuellement seule une v&eacute;rification du navigateur cible est effectu&eacute;e durant l'autovalidation (voir &laquo; dom.runValidation() &raquo; &agrave; la page 272).
Derni&egrave;re mise &agrave; jour le 22/6/2011
480
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Remarque : Cette fonction renvoie uniquement les r&eacute;sultats actuellement affich&eacute;s dans la fen&ecirc;tre de r&eacute;sultats du
document. Pour vous assurer que les comptes sont &agrave; jour, vous pouvez appeler dom.runValidation() avant
d'appeler cette fonction.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Objet dot&eacute; des propri&eacute;t&eacute;s suivantes :
• la propri&eacute;t&eacute; numError, qui est le nombre d'erreurs ;
• la propri&eacute;t&eacute; numWarning, qui est le nombre d'avertissements ;
• la propri&eacute;t&eacute; numInfo, qui est le nombre de messages d'information.
Exemple
theDom = dw.getDocumentDOM();
theDom.runValidation();
theDom.getAutoValidationCount();
dom.isDesignViewUpdated()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;termine si le contenu des modes Cr&eacute;ation et Texte est synchronis&eacute; pour les op&eacute;rations Dreamweaver qui requi&egrave;rent
un &eacute;tat de document correct.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le mode Cr&eacute;ation (WYSIWIG) est synchronis&eacute; avec le texte du mode Texte et false dans
le cas contraire.
dom.isSelectionValid()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;termine si une s&eacute;lection est valide, ce qui signifie qu'elle est synchronis&eacute;e avec le mode Cr&eacute;ation, ou s'il faut la
d&eacute;placer avant qu'une op&eacute;ration n'ait lieu.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
481
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la s&eacute;lection en cours contient un segment de code correct; false si le document n'a pas
encore &eacute;t&eacute; synchronis&eacute;, &eacute;tant donn&eacute; que la s&eacute;lection n'a pas &eacute;t&eacute; mise &agrave; jour.
dom.setShowNoscript()
Disponibilit&eacute;
Dreamweaver MX.
Description
Active ou d&eacute;sactive l'option de contenu noscript (ce qui revient &agrave; utiliser l'option Affichage &gt; Contenu Noscript).
Activ&eacute;e par d&eacute;faut, la balise noscript identifie un script de page pouvant, au choix, &ecirc;tre affich&eacute; ou non dans le
navigateur.
Arguments
{bShowNoscript}
• L'argument facultatif bShowNoscript est une valeur bool&eacute;enne qui indique si le contenu de la balise noscript doit
&ecirc;tre affich&eacute; ; true si le contenu de la balise noscript doit &ecirc;tre affich&eacute;, false dans le cas contraire.
Valeurs renvoy&eacute;es
Aucune.
dom.source.arrowDown()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;place le point d'insertion vers le bas du document affich&eacute; en mode Code, ligne par ligne. Si le contenu est d&eacute;j&agrave;
s&eacute;lectionn&eacute;, cette fonction &eacute;tend la s&eacute;lection ligne par ligne.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de lignes que le point d'insertion doit sauter. Si nTimes n'est pas d&eacute;fini,
il prend par d&eacute;faut la valeur1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si
bShiftIsDown a la valeur true, le contenu est s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
482
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
dom.source.arrowLeft()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;place le point d'insertion vers la gauche de la ligne courante dans le mode Code. Si le contenu est d&eacute;j&agrave; s&eacute;lectionn&eacute;,
cette fonction &eacute;tend la s&eacute;lection vers la gauche.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de caract&egrave;res que le point d'insertion doit sauter. Si nTimes n'est pas
d&eacute;fini, il prend par d&eacute;faut la valeur1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si
bShiftIsDown a la valeur true, le contenu est s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
dom.source.arrowRight()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;place le point d'insertion vers la droite de la ligne courante dans le mode Code. Si le contenu est d&eacute;j&agrave; s&eacute;lectionn&eacute;,
cette fonction &eacute;tend la s&eacute;lection vers la droite.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de caract&egrave;res que le point d'insertion doit sauter. Si nTimes n'est pas
d&eacute;fini, il prend par d&eacute;faut la valeur1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si
bShiftIsDown a la valeur true, le contenu est s&eacute;lectionn&eacute; ; dans le cas contraire, il ne l'est pas.
Valeurs renvoy&eacute;es
Aucune.
dom.source.arrowUp()
Disponibilit&eacute;
Dreamweaver 4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
483
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
D&eacute;place le point d'insertion vers le haut du document affich&eacute; en mode Code, ligne par ligne. Si le contenu est d&eacute;j&agrave;
s&eacute;lectionn&eacute;, cette fonction &eacute;tend la s&eacute;lection ligne par ligne.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument nTimes est le nombre de lignes que le point d'insertion doit d&eacute;placer. Si nTimes n'est pas d&eacute;fini, il prend
par d&eacute;faut la valeur1.
• L'argument bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si bShiftIsDown a la
valeur true, le contenu est s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
dom.source.balanceBracesTextView()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction est une extension du mode Code qui permet d'&eacute;quilibrer les parenth&egrave;ses. vous pouvez appeler
dom.source.balancebracestextview() pour &eacute;tendre une s&eacute;lection ou un point d'insertion actuellement mis en
surbrillance. L'extension va de l'ouverture de l'instruction entre parenth&egrave;ses enveloppante &agrave; la fin de cette instruction.
Elle sert &agrave; &eacute;quilibrer les caract&egrave;res suivants : [], {} et (). Tout nouvel appel &eacute;tend la s&eacute;lection &agrave; des niveaux
suppl&eacute;mentaires de ponctuation imbriqu&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.source.doCodeNavItem()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction charge la fen&ecirc;tre Navigation dans le code et la remplit &agrave; l'aide de cibles pour la s&eacute;lection actuelle.
Toutefois, elle n'ex&eacute;cute pas en soi de t&acirc;ches de navigation ni d'ouverture de fichiers apparent&eacute;s.
Arguments
Aucun
Derni&egrave;re mise &agrave; jour le 22/6/2011
484
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la fen&ecirc;tre Navigation dans le code est ouverte, false s'il est impossible de l'ouvrir parce que
la s&eacute;lection actuelle ne contient pas de cibles de navigation.
dom.source.endOfDocument()
Disponibilit&eacute;
Dreamweaver 4.
Description
Place le point d'insertion &agrave; la fin du document actif affich&eacute; en mode Code. Si le contenu est d&eacute;j&agrave; s&eacute;lectionn&eacute;, cette
fonction &eacute;tend la s&eacute;lection &agrave; la fin du document.
Arguments
bShiftIsDown
• L'argument bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si bShiftIsDown a la
valeur true, le contenu est s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
dom.source.endOfLine()
Disponibilit&eacute;
Dreamweaver 4.
Description
Place le point d'insertion &agrave; la fin de la ligne courante. Si le contenu est d&eacute;j&agrave; s&eacute;lectionn&eacute;, cette fonction &eacute;tend la s&eacute;lection
jusqu'&agrave; la fin de la ligne courante.
Arguments
bShiftIsDown
• L'argument bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si bShiftIsDown a la
valeur true, le contenu est s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
dom.source.endPage()
Disponibilit&eacute;
Dreamweaver 4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
485
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
D&eacute;place le point d'insertion &agrave; la fin de la page en cours ou &agrave; la fin de la page suivante (si le point d'insertion est d&eacute;j&agrave; &agrave;
la fin d'une page). Si le contenu est d&eacute;j&agrave; s&eacute;lectionn&eacute;, cette fonction &eacute;tend la s&eacute;lection page par page.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de pages que le point d'insertion doit sauter. Si nTimes n'est pas d&eacute;fini,
il prend par d&eacute;faut la valeur1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si
bShiftIsDown a la valeur true, le contenu est s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
dom.source.getCurrentLines()
Disponibilit&eacute;
Dreamweaver 4.
Description
Renvoie les num&eacute;ros de ligne des d&eacute;calages sp&eacute;cifi&eacute;s &agrave; partir du d&eacute;but du document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Num&eacute;ros de ligne de la s&eacute;lection en cours.
dom.source.getSelection()
Description
Obtient la s&eacute;lection du document actif, exprim&eacute;e en d&eacute;calages de caract&egrave;res dans le mode Code du document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Paire de nombres entiers repr&eacute;sentant les d&eacute;calages &agrave; partir du d&eacute;but du document source. Le premier nombre entier
correspond au d&eacute;but de la s&eacute;lection et le second &agrave; la fin. Si les deux nombres sont &eacute;gaux, la s&eacute;lection est un point
d'insertion. Si aucun &eacute;l&eacute;ment n'est s&eacute;lectionn&eacute; dans la source, les deux nombres sont -1.
dom.source.getLineFromOffset()
Disponibilit&eacute;
Dreamweaver MX.
Derni&egrave;re mise &agrave; jour le 22/6/2011
486
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Place un d&eacute;calage dans le document source.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Num&eacute;ro de la ligne, ou -1 si le d&eacute;calage est n&eacute;gatif ou se trouve apr&egrave;s la fin du fichier.
dom.source.getText()
Disponibilit&eacute;
Dreamweaver 4.
Description
Renvoie la cha&icirc;ne de texte de la source comprise entre les d&eacute;calages d&eacute;finis.
Arguments
startOffset, endOffset
• L'argument startOffset est un nombre entier qui repr&eacute;sente le d&eacute;calage &agrave; partir du d&eacute;but dudocument.
• L'argument endOffset est un nombre entier qui repr&eacute;sente la fin du document.
Valeurs renvoy&eacute;es
Cha&icirc;ne qui repr&eacute;sente le texte du code source compris entre les d&eacute;calages start et end.
dom.source.getValidationErrorsForOffset()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
Renvoie la liste des erreurs de validation au point de d&eacute;calage sp&eacute;cifi&eacute; ou recherche l'erreur suivante apr&egrave;s le d&eacute;calage.
Si aucune n'est trouv&eacute;e dans la fonction, la valeur null est renvoy&eacute;e.
Arguments
offset, {searchDirection}
• L'argument offset est un nombre qui sp&eacute;cifie le d&eacute;calage dans le code pour lequel la fonction renvoie des erreurs.
• L'argument facultatif searchDirection est une cha&icirc;ne qui sp&eacute;cifie &quot;empty&quot;, &quot;forward&quot; ou &quot;back&quot;. Si sp&eacute;cifi&eacute;, la
fonction recherche vers la fin ou le d&eacute;but du document, en partant du d&eacute;calage d&eacute;fini, les caract&egrave;res comportant
des erreurs et les renvoie. Si cela n'est pas sp&eacute;cifi&eacute;, la fonction v&eacute;rifie la pr&eacute;sence d'erreur au point de d&eacute;calage d&eacute;fini.
Valeurs renvoy&eacute;es
Tableau d'objets ou valeur null. Chaque objet du tableau poss&egrave;de les propri&eacute;t&eacute;s suivantes :
• L'objet message est une cha&icirc;ne qui contient le message d'erreur.
Derni&egrave;re mise &agrave; jour le 22/6/2011
487
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
• L'objet floaterName est une cha&icirc;ne qui contient le nom de la fen&ecirc;tre de r&eacute;sultats. Vous pouvez transmettre cette
valeur aux fonctions showResults() ou setFloaterVisibility().
• L'objet floaterIndex est un index d'&eacute;l&eacute;ments dans la liste de r&eacute;sultats de palette.
• L'objet start est l'index d'ouverture du code soulign&eacute;.
• L'objet end est l'index de fermeture du code soulign&eacute;.
Remarque : Les index de palette renvoy&eacute;s ne doivent pas &ecirc;tre conserv&eacute;s car ils varient fr&eacute;quemment, par exemple, lors de
l'ouverture ou de la fermeture de documents.
Exemple
L'exemple suivant appelle getValidationErrorsForOffset() pour v&eacute;rifier qu'il n'y a pas d'erreur au d&eacute;calage de la
s&eacute;lection actuelle. Si la fonction renvoie une erreur, le code appelle la fonction alert() pour afficher le message
d'erreur &agrave; l'utilisateur.
var offset = dw.getDocumentDOM().source.getSelection()[0];
var errors = dw.getDocumentDOM().source.getValidationErrorsForOffset(offset);
if ( errors &amp;&amp; errors.length &gt; 0 )
alert( errors[0].message );
dom.source.indentTextview()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;place le texte s&eacute;lectionn&eacute; en mode Code d'une marque de tabulation vers la droite.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.source.insert()
Disponibilit&eacute;
Dreamweaver 4.
Description
Ins&egrave;re la cha&icirc;ne sp&eacute;cifi&eacute;e dans le code source au niveau du point de d&eacute;calage d&eacute;fini &agrave; partir du d&eacute;but du fichier source.
Si le d&eacute;calage n'est pas sup&eacute;rieur ou &eacute;gal &agrave; z&eacute;ro, l'insertion &eacute;choue et la fonction renvoie la valeur false.
Arguments
offset, string
• L'argument offset est le d&eacute;calage &agrave; partir du d&eacute;but du fichier o&ugrave; la cha&icirc;ne doit &ecirc;treins&eacute;r&eacute;e.
• L'argument string est la cha&icirc;ne &agrave; ins&eacute;rer.
Derni&egrave;re mise &agrave; jour le 22/6/2011
488
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
dom.source.nextWord()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;place le point d'insertion au d&eacute;but du mot suivant (ou des mots suivants, si sp&eacute;cifi&eacute;) en mode Code. Si le contenu
est d&eacute;j&agrave; s&eacute;lectionn&eacute;, cette fonction &eacute;tend la s&eacute;lection vers la droite.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de mots que le point d'insertion doit d&eacute;placer. Si nTimes n'est pas d&eacute;fini,
il prend par d&eacute;faut la valeur1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si
bShiftIsDown a la valeur true, le contenu est s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
dom.source.outdentTextview()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;place le texte s&eacute;lectionn&eacute; en mode Code d'une marque de tabulation vers la gauche.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.source.pageDown()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;place le point d'insertion vers le bas du document affich&eacute; en mode Code, page par page. Si le contenu est d&eacute;j&agrave;
s&eacute;lectionn&eacute;, cette fonction &eacute;tend la s&eacute;lection page par page.
Derni&egrave;re mise &agrave; jour le 22/6/2011
489
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de pages que le point d'insertion doit sauter. Si nTimes n'est pas d&eacute;fini,
il prend par d&eacute;faut la valeur1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si
bShiftIsDown a la valeur true, le contenu est s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
dom.source.pageUp()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;place le point d'insertion vers le haut du document affich&eacute; en mode Code, page par page. Si le contenu est d&eacute;j&agrave;
s&eacute;lectionn&eacute;, cette fonction &eacute;tend la s&eacute;lection page par page.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de pages que le point d'insertion doit sauter. Si nTimes n'est pas d&eacute;fini,
il prend par d&eacute;faut la valeur1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si
bShiftIsDown a la valeur true, le contenu est s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
dom.source.previousWord()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;place le point d'insertion au d&eacute;but du mot pr&eacute;c&eacute;dent (ou des mots pr&eacute;c&eacute;dents, si sp&eacute;cifi&eacute;) en mode Code. Si le
contenu est d&eacute;j&agrave; s&eacute;lectionn&eacute;, cette fonction &eacute;tend la s&eacute;lection vers la gauche.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de mots que le point d'insertion doit d&eacute;placer. Si nTimes n'est pas d&eacute;fini,
il prend par d&eacute;faut la valeur1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si
bShiftIsDown a la valeur true, le contenu est s&eacute;lectionn&eacute;.
Derni&egrave;re mise &agrave; jour le 22/6/2011
490
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Valeurs renvoy&eacute;es
Aucune.
dom.source.replaceRange()
Disponibilit&eacute;
Dreamweaver 4.
Description
Remplace la plage de texte source comprise entre startOffset et endOffset par string. Si startOffset est sup&eacute;rieur &agrave;
endOffset ou si l'un des d&eacute;calages n'est pas un nombre entier positif, cette fonction n'a aucun effet et renvoie la valeur
false. Si endOffset est sup&eacute;rieur au nombre de caract&egrave;res du fichier, cette fonction remplace la plage comprise entre
startOffset et la fin du fichier. Si startOffset et endOffset sont sup&eacute;rieurs au nombre de caract&egrave;res du fichier, cette
fonction ins&egrave;re le texte &agrave; la fin du fichier.
Arguments
startOffset, endOffset, string
• L'argument startOffset est le d&eacute;calage indiquant le d&eacute;but du bloc &agrave; remplacer.
• L'argument endOffset est le d&eacute;calage indiquant la fin du bloc &agrave; remplacer.
• L'argument string est la cha&icirc;ne &agrave; ins&eacute;rer.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
dom.source.scrollEndFile()
Disponibilit&eacute;
Dreamweaver 4.
Description
Fait d&eacute;filer le mode Code vers le bas du document sans d&eacute;placer le point d'insertion.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.source.scrollLineDown()
Disponibilit&eacute;
Dreamweaver 4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
491
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Fait d&eacute;filer le mode Code vers le bas ligne par ligne sans d&eacute;placer le point d'insertion.
Arguments
nTimes
• L'argument nTimes est le nombre de lignes &agrave; faire d&eacute;filer. Si nTimes n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur1.
Valeurs renvoy&eacute;es
Aucune.
dom.source.scrollLineUp()
Disponibilit&eacute;
Dreamweaver 4.
Description
Fait d&eacute;filer le mode Code vers le haut ligne par ligne sans d&eacute;placer le point d'insertion.
Arguments
nTimes
• L'argument nTimes est le nombre de lignes &agrave; faire d&eacute;filer. Si nTimes n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur1.
Valeurs renvoy&eacute;es
Aucune.
dom.source.scrollPageDown()
Disponibilit&eacute;
Dreamweaver 4.
Description
Fait d&eacute;filer le mode Code vers le bas page par page sans d&eacute;placer le point d'insertion.
Arguments
nTimes
• L'argument nTimes est le nombre de pages &agrave; faire d&eacute;filer. Si nTimes n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur1.
Valeurs renvoy&eacute;es
Aucune.
dom.source.scrollPageUp()
Disponibilit&eacute;
Dreamweaver 4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
492
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Fait d&eacute;filer le mode Code vers le haut page par page sans d&eacute;placer le point d'insertion.
Arguments
nTimes
• L'argument nTimes est le nombre de pages &agrave; faire d&eacute;filer. Si nTimes n'est pas d&eacute;fini, il prend par d&eacute;faut la valeur1.
Valeurs renvoy&eacute;es
Aucune.
dom.source.scrollTopFile()
Disponibilit&eacute;
Dreamweaver 4.
Description
Fait d&eacute;filer le mode Code vers le haut du document sans d&eacute;placer le point d'insertion.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.source.selectParentTag()
Disponibilit&eacute;
Dreamweaver 4.
Description
Cette fonction est une extension du mode Code qui permet d'&eacute;quilibrer les balises. Vous pouvez appeler
dom.source.selectParentTag() pour &eacute;tendre la s&eacute;lection ou le point d'insertion courant de la balise d'ouverture &agrave;
la balise de fermeture. Les appels suivants &eacute;tendent la s&eacute;lection &agrave; des balises suppl&eacute;mentaires jusqu'&agrave; ce qu'il n'y ait plus
de balises de fermeture.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dom.source.setCurrentLine()
Disponibilit&eacute;
Dreamweaver 4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
493
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Place le point d'insertion au d&eacute;but de la ligne indiqu&eacute;e. Si l'argument lineNumber n'est pas un nombre entier positif, la
fonction n'a aucun effet et renvoie la valeur false. Le point d'insertion est plac&eacute; au d&eacute;but de la derni&egrave;re ligne si
lineNumber est sup&eacute;rieur au nombre de lignes de la source.
Arguments
lineNumber
• L'argument lineNumber est la ligne au d&eacute;but de laquelle le point d'insertion est plac&eacute;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true en cas de r&eacute;ussite, false dans le cas contraire.
dom.source.startOfDocument()
Disponibilit&eacute;
Dreamweaver 4.
Description
Place le point d'insertion au d&eacute;but du document affich&eacute; en mode Code. Si le contenu est d&eacute;j&agrave; s&eacute;lectionn&eacute;, cette fonction
&eacute;tend la s&eacute;lection au d&eacute;but du document.
Arguments
bShiftIsDown
• L'argument bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si bShiftIsDown a la
valeur true, le contenu est s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
dom.source.startOfLine()
Disponibilit&eacute;
Dreamweaver 4.
Description
Place le point d'insertion au d&eacute;but de la ligne courante. Si le contenu est d&eacute;j&agrave; s&eacute;lectionn&eacute;, cette fonction &eacute;tend la
s&eacute;lection au d&eacute;but de la ligne courante.
Arguments
bShiftIsDown
• L'argument bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si bShiftIsDown a la
valeur true, le contenu est s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
Derni&egrave;re mise &agrave; jour le 22/6/2011
494
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
dom.source.topPage()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;place le point d'insertion en haut de la page courante ou de la page pr&eacute;c&eacute;dente (si le point d'insertion est d&eacute;j&agrave; en
haut d'une page). Si le contenu est d&eacute;j&agrave; s&eacute;lectionn&eacute;, cette fonction &eacute;tend la s&eacute;lection page par page.
Arguments
{nTimes}, {bShiftIsDown}
• L'argument facultatif nTimes est le nombre de pages que le point d'insertion doit sauter. Si nTimes n'est pas d&eacute;fini,
il prend par d&eacute;faut la valeur1.
• L'argument facultatif bShiftIsDown est une valeur bool&eacute;enne qui indique si un contenu est s&eacute;lectionn&eacute;. Si
bShiftIsDown a la valeur true, le contenu est s&eacute;lectionn&eacute;.
Valeurs renvoy&eacute;es
Aucune.
dom.source.wrapSelection()
Disponibilit&eacute;
Dreamweaver 4.
Description
Ins&egrave;re le texte de startTag avant la s&eacute;lection en cours et le texte de endTag apr&egrave;s la s&eacute;lection en cours. La fonction
s&eacute;lectionne ensuite la plage enti&egrave;re entre les balises ins&eacute;r&eacute;es, en incluant ces balises. Si la s&eacute;lection en cours est un point
d'insertion, la fonction place le point d'insertion entre startTag et endTagstartTag et endTag ne doivent pas
n&eacute;cessairement &ecirc;tre des balises; il peut s'agir de tout segment de texte de votre choix.
Arguments
startTag, endTag
• L'argument startTag est le texte &agrave; ins&eacute;rer au d&eacute;but de la s&eacute;lection.
• L'argument endTag est le texte &agrave; ins&eacute;rer &agrave; la fin de la s&eacute;lection.
Valeurs renvoy&eacute;es
Aucune.
dom.synchronizeDocument()
Disponibilit&eacute;
Dreamweaver 4.
Derni&egrave;re mise &agrave; jour le 22/6/2011
495
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Synchronise les modes Code et Cr&eacute;ation.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Fonctions du mode Code en direct
Le code affich&eacute; en mode Code en direct est similaire &agrave; ce que vous verriez si vous consultiez la source de la page &agrave; partir
d'un navigateur. Alors que de telles sources de pages sont statiques et ne fournissent que la source de la page &agrave; partir
du navigateur, le mode Code en direct est dynamique et est mis &agrave; jour &agrave; mesure que vous interagissez avec la page en
mode Affichage en direct.
Lorsque l'utilisateur active des &eacute;l&eacute;ments interactives d'une page, le mode Code en direct affiche la source dans le nouvel
&eacute;tat et met en surbrillance le code qui a chang&eacute; entres les diff&eacute;rents &eacute;tats.
dom.getLiveCodeHighlightsChanges()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction sera &agrave; d&eacute;terminer si la fonction de mise en surbrillance du code est activ&eacute;e pour le document actif.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne qui indique si la fonction de mise en surbrillance du code est activ&eacute;e.
dom.setLiveCodeHighlightsChanges()
Disponibilit&eacute;
Dreamweaver CS5.
Description
Cette fonction permet d'activer ou de d&eacute;sactiver la mise en surbrillance du code pour le document actif.
Arguments
Valeur bool&eacute;enne qui indique si la fonction de mise en surbrillance du code est activ&eacute;e.
Derni&egrave;re mise &agrave; jour le 22/6/2011
496
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Valeurs renvoy&eacute;es
Aucune.
Fonctions de l'&eacute;diteur de balises et de la biblioth&egrave;que de
balises
Vous pouvez utiliser les &eacute;diteurs de balises pour ins&eacute;rer de nouvelles balises, pour modifier des balises existantes ou
pour acc&eacute;der &agrave; des informations de r&eacute;f&eacute;rence sur les balises. Le s&eacute;lecteur de balises permet aux utilisateurs d'organiser
leurs balises afin qu'ils puissent s&eacute;lectionner les balises les plus fr&eacute;quemment utilis&eacute;es. Les biblioth&egrave;ques de balises
fournies avec Dreamweaver stockent des informations concernant les balises utilis&eacute;es dans les langages de balisage
standard et dans les langages de script et de balise fr&eacute;quemment utilis&eacute;s. Vous pouvez utiliser les fonctions de l'&eacute;diteur
de balises JavaScript, du s&eacute;lecteur de balises, de la biblioth&egrave;que de balises lorsque vous devez utiliser les &eacute;diteurs de
balises et biblioth&egrave;ques de balises dans vos extensions.
dom.getTagSelectorTag()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction obtient le nœud DOM de la balise s&eacute;lectionn&eacute;e dans la barre du s&eacute;lecteur de balises se trouvant au bas
de la fen&ecirc;tre de document.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Noeud DOM de la balise s&eacute;lectionn&eacute;e ; null si aucune balise n'est s&eacute;lectionn&eacute;e.
dreamweaver.popupInsertTagDialog()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction v&eacute;rifie les fichiers VTM pour s'assurer qu'un &eacute;diteur de balises a &eacute;t&eacute; utilis&eacute; pour la balise. Si c'est le cas,
l'&eacute;diteur de cette balise appara&icirc;t et accepte la balise de d&eacute;but. Si ce n'est pas le cas, la balise de d&eacute;but est ins&eacute;r&eacute;e telle
quelle dans le document de l'utilisateur.
Arguments
start_tag_string
Cha&icirc;ne de balise de d&eacute;but qui comprend un des types suivants de valeurs initiales :
• une balise, comme &lt;input&gt; ;
Derni&egrave;re mise &agrave; jour le 22/6/2011
497
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
• une balise avec des attributs, comme &lt;input
• une directive, comme &lt;%=
type='text'&gt; ;
%&gt;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si un &eacute;l&eacute;ment est ins&eacute;r&eacute; dans le document et false dans le cas contraire.
dreamweaver.popupEditTagDialog()
Disponibilit&eacute;
Dreamweaver MX.
Description
Si une balise est s&eacute;lectionn&eacute;e, cette fonction ouvre l'&eacute;diteur de balises correspondant &agrave; cette balise pour vous permettre
de modifier la balise.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
Activateur
Voir &laquo; dreamweaver.canPopupEditTagDialog() &raquo; &agrave; la page 515.
dreamweaver.showTagChooser()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction affiche la bo&icirc;te de dialogue S&eacute;lecteur de balises, la fait appara&icirc;tre au premier plan et la rend active.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.showTagLibraryEditor()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction ouvre l'&eacute;diteur de la biblioth&egrave;que de balises.
Derni&egrave;re mise &agrave; jour le 22/6/2011
498
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Arguments
Aucun.
Valeurs renvoy&eacute;es
Aucune.
dreamweaver.tagLibrary.getTagLibraryDOM()
Disponibilit&eacute;
Dreamweaver MX.
Description
Associ&eacute;e &agrave; l'URL d'un fichier filename.vtm, cette fonction renvoie le DOM de ce fichier afin que son contenu soit
modifi&eacute;.Cette fonction ne doit &ecirc;tre appel&eacute;e que lorsque l'&eacute;diteur de la biblioth&egrave;que de balises est actif.
Arguments
fileURL
• L'argument fileURL est l'URL d'un fichier filename.vtm , relatif au dossier Configuration/Tag Libraries, comme le
montre l'exemple suivant : &quot;HTML/img.vtm&quot;
Valeurs renvoy&eacute;es
Un pointeur DOM d&eacute;signant un fichier nouveau ou plus ancien du dossier TagLibraries.
dreamweaver.tagLibrary.getSelectedLibrary()
Disponibilit&eacute;
Dreamweaver MX.
Description
Si un nœud de biblioth&egrave;que est s&eacute;lectionn&eacute; dans l'&eacute;diteur de la biblioth&egrave;que de balises, cette fonction obtient le nom
de la biblioth&egrave;que.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne correspondant au nom de la biblioth&egrave;que s&eacute;lectionn&eacute;e dans l'&eacute;diteur de la biblioth&egrave;que de balises ; renvoie une
cha&icirc;ne vide si aucune biblioth&egrave;que n'est s&eacute;lectionn&eacute;e.
dreamweaver.tagLibrary.getSelectedTag()
Disponibilit&eacute;
Dreamweaver MX.
Derni&egrave;re mise &agrave; jour le 22/6/2011
499
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
Description
Si un nœud d'attribut est s&eacute;lectionn&eacute;, cette fonction obtient le nom de la balise qui contient l'attribut.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Cha&icirc;ne correspondant au nom de la balise s&eacute;lectionn&eacute;e dans l'&eacute;diteur de la biblioth&egrave;que de balises ; renvoie une cha&icirc;ne
vide si aucune balise n'est s&eacute;lectionn&eacute;e.
dreamweaver.tagLibrary.importDTDOrSchema()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction importe un fichier DTD/Sch&eacute;ma &agrave; partir d'un serveur distant dans la biblioth&egrave;que de balises.
Arguments
fileURL, Pr&eacute;fixe
• L'argument fileURL est le chemin du fichier DTD ou sch&eacute;ma, au format URL local.
• L'argument Prefix est la cha&icirc;ne de pr&eacute;fixe qui doit &ecirc;tre ajout&eacute;e &agrave; toutes les balises de cette biblioth&egrave;que.
Valeurs renvoy&eacute;es
Nom de la biblioth&egrave;que de balises import&eacute;es.
dreamweaver.tagLibrary.getImportedTagList()
Disponibilit&eacute;
Dreamweaver MX.
Description
Cette fonction g&eacute;n&egrave;re une liste d'objets TagInfo &agrave; partir d'une biblioth&egrave;que de balises import&eacute;es.
Arguments
libname
• L'argument libname est le nom de la biblioth&egrave;que de balises import&eacute;es.
Valeurs renvoy&eacute;es
Tableau d'objets tagInfo.
Un objet taginfo contient des informations concernant une balise de la biblioth&egrave;que de balises. Les propri&eacute;t&eacute;s
suivantes sont d&eacute;finies dans un objet tagInfo :
• la propri&eacute;t&eacute; tagName, qui est une cha&icirc;ne ;
Derni&egrave;re mise &agrave; jour le 22/6/2011
500
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Code
• la propri&eacute;t&eacute; attributes, qui est un tableau de cha&icirc;nes. Chaque cha&icirc;ne correspond au nom d'un attribut d&eacute;fini pour
cette balise.
Exemple :
L'exemple suivant indique que l'utilisation de la fonction dw.tagLibrary.getImportedTagList() peut r&eacute;sulter en
un tableau de balises de la biblioth&egrave;que libName :
// &quot;fileURL&quot; and &quot;prefix&quot; have been entered by the user.
// tell the Tag Library to Import the DTD/Schema
var libName = dw.tagLibrary.importDTDOrSchema(fileURL, prefix);
// get the array of tags for this library
// this is the TagInfo object
var tagArray = dw.tagLibrary.getImportedTagList(libName);
// now I have an array of tagInfo objects.
// I can get info out of them. This gets info out of the first one.
// note: this assumes there is at least one TagInfo in the array.
var firstTagName = tagArray[0].name;
var firstTagAttributes = tagArray[0].attributes;
// note that firstTagAttributes is an array of attributes.
Derni&egrave;re mise &agrave; jour le 22/6/2011
501
Chapitre 19 : Activateurs
Les fonctions d'activateur d'Adobe&reg; Dreamweaver&reg; CS5 d&eacute;terminent si une autre fonction peut effectuer une op&eacute;ration
donn&eacute;e dans le contexte actuel. Les circonstances g&eacute;n&eacute;rales dans lesquelles chaque fonction renvoie la valeur true sont
d&eacute;crites dans la sp&eacute;cification de fonction correspondante. Toutefois, ces descriptions ne pr&eacute;tendent pas &ecirc;tre
exhaustives et ne couvrent pas n&eacute;cessairement tous les cas o&ugrave; la fonction renverrait la valeur false.
Fonctions d'activateur
Les fonctions d'activateur dans l'API JavaScript comprennent les fonctions suivantes.
dom.canAlign()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Aligner &agrave; gauche, Aligner &agrave; droite, Aligner en haut ou Aligner en bas.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si deux calques ou zones r&eacute;actives au minimum sont s&eacute;lectionn&eacute;s.
dom.canApplyTemplate()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Appliquer &agrave; la page. Cette fonction n'est valide que pour le
document actif.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si le document n'est pas un &eacute;l&eacute;ment de biblioth&egrave;que ni un mod&egrave;le, et si la s&eacute;lection n'est
pas encadr&eacute;e de balises NOFRAMES.
Derni&egrave;re mise &agrave; jour le 22/6/2011
502
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dom.canArrange()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Mettre au premier plan ou Mettre en arri&egrave;re-plan.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si une zone r&eacute;active est s&eacute;lectionn&eacute;e.
dom.canClipCopyText()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Copier comme texte.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les d&eacute;calages d'ouverture et de fermeture sont diff&eacute;rents ; false dans le cas contraire, pour
indiquer qu'aucune s&eacute;lection n'a &eacute;t&eacute; effectu&eacute;e.
dom.canClipPaste()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Coller.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le Presse-papiers contient des donn&eacute;es pouvant &ecirc;tre coll&eacute;es dans Dreamweaver, false dans
le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
503
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dom.canClipPasteText()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Coller comme texte.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le Presse-papiers contient des donn&eacute;es pouvant &ecirc;tre coll&eacute;es sous forme de texte dans
Dreamweaver, false dans le cas contraire.
dom.canConvertLayersToTable()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Convertir les calques en tableau.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le contenu complet de la section BODY du document est compris dans des calques, false
dans le cas contraire.
dom.canConvertTablesToLayers()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Convertir les tableaux en calques.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si tout le contenu de la section BODY du document figure dans des tableaux et si le document
n'est pas bas&eacute; sur un mod&egrave;le, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
504
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dom.canDecreaseColspan()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration R&eacute;duire l'&eacute;tendue de colonnes.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la cellule active poss&egrave;de un attribut COLSPAN et si la valeur de cet attribut est sup&eacute;rieure ou
&eacute;gale &agrave; 2 ; false dans le cas contraire.
dom.canDecreaseRowspan()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration R&eacute;duire l'&eacute;tendue de lignes.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la cellule active poss&egrave;de un attribut ROWSPAN et si la valeur de cet attribut est sup&eacute;rieure ou
&eacute;gale &agrave; 2 ; false dans le cas contraire.
dom.canDeleteTableColumn()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Supprimer la colonne.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le point d'insertion se trouve dans une cellule ou si une cellule ou une colonne est
s&eacute;lectionn&eacute;e, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
505
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dom.canDeleteTableRow()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Supprimer la ligne.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le point d'insertion se trouve dans une cellule ou si une cellule ou une ligne est s&eacute;lectionn&eacute;e,
false dans le cas contraire.
site.canEditColumns()
Description
V&eacute;rifie si un site existe.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le site existe, false dans le cas contraire.
dom.canEditNoFramesContent()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Modifier le contenu sans cadres.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le document actif est un jeu de cadres ou s'il figure dans un jeu de cadres, false dans le cas
contraire.
dom.canIncreaseColspan()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
506
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Augmenter l'&eacute;tendue de colonnes.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true s'il existe des cellules &agrave; droite de la cellule active, false dans le cas contraire.
dom.canIncreaseRowspan()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Augmenter l'&eacute;tendue de lignes.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true s'il existe des cellules au-dessous de la cellule active, false dans le cas contraire.
dom.canInsertTableColumns()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Ins&eacute;rer une colonne.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la s&eacute;lection se trouve dans un tableau, false si la s&eacute;lection constitue un tableau entier ou
si elle ne se trouve pas dans un tableau.
dom.canInsertTableRows()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Ins&eacute;rer une ligne.
Derni&egrave;re mise &agrave; jour le 22/6/2011
507
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la s&eacute;lection se trouve dans un tableau, false si la s&eacute;lection constitue un tableau entier ou
si elle ne se trouve pas dans un tableau.
dom.canMakeNewEditableRegion()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Nouvelle r&eacute;gion modifiable.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le document actif est un fichier de mod&egrave;le (DWT).
dom.canMarkSelectionAsEditable()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Marquer la s&eacute;lection comme modifiable.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true s'il y a une s&eacute;lection et si le document actif est un fichier DWT, false dans le cas contraire.
dom.canMergeTableCells()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Fusionner les cellules.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
508
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la s&eacute;lection est un regroupement adjacent de cellules de tableau, false dans le cas contraire.
dom.canPlayPlugin()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Lire. Cette fonction n'est valide que pour le document actif.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la s&eacute;lection peut &ecirc;tre ex&eacute;cut&eacute;e avec un plug-in.
dom.canRedo()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration R&eacute;tablir.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true s'il reste des op&eacute;rations &agrave; r&eacute;tablir, false dans le cas contraire.
dom.canRemoveEditableRegion()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Rendre la r&eacute;gion non modifiable.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le document est un mod&egrave;le et false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
509
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dom.canSelectTable()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration S&eacute;lectionner le tableau.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la s&eacute;lection ou le point d'insertion se trouve dans un tableau, false dans le cas contraire.
dom.canSetLinkHref()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut modifier le lien qui entoure la s&eacute;lection en cours ou en cr&eacute;er un si n&eacute;cessaire.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la s&eacute;lection est une image, du texte ou si le point d'insertion se trouve dans un lien, false
dans les autres cas. Une s&eacute;lection de texte se d&eacute;finit comme une s&eacute;lection pour laquelle l'inspecteur Propri&eacute;t&eacute;s de texte
s'ouvrirait.
dom.canShowListPropertiesDialog()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut afficher la bo&icirc;te de dialogue Propri&eacute;t&eacute;s de la liste.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la s&eacute;lection est encadr&eacute;e de balises LI, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
510
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dom.canSplitFrame()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Fractionner le cadre [&agrave; gauche | &agrave; droite | vers le haut | vers le bas].
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la s&eacute;lection se trouve dans un cadre et false dans le cas contraire.
dom.canSplitTableCell()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Fractionner la cellule.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le point d'insertion se trouve dans une cellule de tableau ou si la s&eacute;lection est une cellule de
tableau, false dans les autres cas.
dom.canStopPlugin()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Arr&ecirc;ter.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la s&eacute;lection est ex&eacute;cut&eacute;e actuellement avec un plug-in, false dans les autres cas.
Derni&egrave;re mise &agrave; jour le 22/6/2011
511
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dom.canUndo()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Annuler.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true s'il reste des op&eacute;rations &agrave; annuler, false dans le cas contraire.
dom.hasTracingImage()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si le document poss&egrave;de un trac&eacute; d'image.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le document comporte un trac&eacute; d'image, false dans le cas contraire.
dreamweaver.assetPalette.canEdit()
Disponibilit&eacute;
Dreamweaver 4.
Description
Active les options de menu du panneau Actifs pour permettre leur modification.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Renvoie une valeur bool&eacute;enne : true si l'actif peut &ecirc;tre modifi&eacute; et false dans le cas contraire. Renvoie la valeur false
pour les couleurs et les URL de la liste des sites et false pour une s&eacute;lection de plusieurs couleurs et URL dans la liste
des favoris.
Derni&egrave;re mise &agrave; jour le 22/6/2011
512
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dreamweaver.assetPalette.canInsertOrApply()
Disponibilit&eacute;
Dreamweaver 4.
Description
V&eacute;rifie si les options s&eacute;lectionn&eacute;es peuvent &ecirc;tre ins&eacute;r&eacute;es ou appliqu&eacute;es. Renvoie les valeurs true ou false pour que
l'insertion ou l'application des options de menu puissent &ecirc;tre activ&eacute;es ou d&eacute;sactiv&eacute;es.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les &eacute;l&eacute;ments s&eacute;lectionn&eacute;s peuvent &ecirc;tre ins&eacute;r&eacute;s ou appliqu&eacute;s, false si la page active est un
mod&egrave;le et que la cat&eacute;gorie en cours est Templates. La fonction renvoie &eacute;galement la valeur false si aucun document
n'est ouvert ou si un &eacute;l&eacute;ment de biblioth&egrave;que est s&eacute;lectionn&eacute; dans le document et que la cat&eacute;gorie active est
Biblioth&egrave;que.
dreamweaver.canClipCopy()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Copier.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si un contenu s&eacute;lectionn&eacute; peut &ecirc;tre copi&eacute; dans le Presse-papiers, false dans le cas contraire.
dreamweaver.canClipCut()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Couper.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si un contenu s&eacute;lectionn&eacute; peut &ecirc;tre coup&eacute; dans le Presse-papiers, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
513
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dreamweaver.canClipPaste()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Coller.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le contenu du Presse-papiers, le cas &eacute;ch&eacute;ant, peut &ecirc;tre coll&eacute; dans le document actif, dans la
fen&ecirc;tre active du panneau Site ou, sur Macintosh, dans un champ de texte d'un panneau flottant ou d'une bo&icirc;te de
dialogue ; false dans le cas contraire.
dreamweaver.canDeleteSelection()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut supprimer la s&eacute;lection en cours. Celle-ci peut se trouver, selon le cas, dans la fen&ecirc;tre
de document, dans le panneau Site ou, sur Macintosh, dans un champ de texte d'un panneau flottant ou d'une bo&icirc;te de
dialogue.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les d&eacute;calages d'ouverture et de fermeture de la s&eacute;lection sont diff&eacute;rents, ce qui indique
qu'une s&eacute;lection est effectu&eacute;e ; false s'ils sont identiques et qu'il n'y a donc qu'un point d'insertion.
dreamweaver.canExportTemplateDataAsXML()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si Dreamweaver peut exporter le document actif au format XML.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le document actif peut &ecirc;tre export&eacute; et false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
514
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Exemple
Dans l'exemple suivant, dw.canExportTemplateDataAsXML() est appel&eacute; pour d&eacute;terminer si Dreamweaver peut
exporter le document actif au format XML. S'il renvoie la valeur true, il appelle dw.ExportTemplateDataAsXML()
pour l'exporter :
if(dreamweaver.canExportTemplateDataAsXML())
{
dreamweaver.exportTemplateDataAsXML(&quot;file:///c|/dw_temps/mytemplate.txt&quot;)
}
dreamweaver.canFindNext()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Rechercher le suivant.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si un mod&egrave;le de recherche a &eacute;t&eacute; d&eacute;fini, false dans le cas contraire.
dreamweaver.canFitSelection()
Disponibilit&eacute;
Dreamweaver 8.
Description
V&eacute;rifie si un &eacute;l&eacute;ment est s&eacute;lectionn&eacute; dans un mode Cr&eacute;ation actif, ce qui signifie que fitSelection() peut &ecirc;tre
appel&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si un &eacute;l&eacute;ment est s&eacute;lectionn&eacute; dans un mode Cr&eacute;ation actif, false dans le cas contraire.
dreamweaver.canOpenInFrame()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Ouvrir dans un cadre.
Derni&egrave;re mise &agrave; jour le 22/6/2011
515
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la s&eacute;lection ou le point d'insertion se trouve dans un cadre et false dans le cas contraire.
dreamweaver.canPasteSpecial()
Disponibilit&eacute;
Dreamweaver 8.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Collage sp&eacute;cial.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le Presse-papiers contient du texte, du code HTML ou du code HTML pour Dreamweaver
et que le mode Code, Cr&eacute;ation ou Inspecteur de code est actif ; false dans le cas contraire.
dreamweaver.canPlayRecordedCommand()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Reproduire la commande enregistr&eacute;e.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true s'il existe un document actif et une commande enregistr&eacute;e pouvant &ecirc;tre ex&eacute;cut&eacute;e, false dans
le cas contraire.
dreamweaver.canPopupEditTagDialog()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si la s&eacute;lection en cours est une balise et si l'&eacute;l&eacute;ment de menu Modifier la balise est actif.
Derni&egrave;re mise &agrave; jour le 22/6/2011
516
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Arguments
Aucun.
Valeurs renvoy&eacute;es
Nom de la balise s&eacute;lectionn&eacute;e ou la valeur null si aucune balise n'est s&eacute;lectionn&eacute;e.
dreamweaver.canRedo()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration R&eacute;tablir dans le contexte en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant s'il existe des op&eacute;rations pouvant &ecirc;tre annul&eacute;es.
dreamweaver.canRevertDocument()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration R&eacute;tablir (revenir au dernier &eacute;tat enregistr&eacute;).
Arguments
documentObject.
• L'argument documentObject correspond &agrave; l'objet situ&eacute; &agrave; la racine de l'arborescence DOM d'un document (c'est-&agrave;dire la valeur renvoy&eacute;e par la fonction dreamweaver.getDocumentDOM()).
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si le document est &agrave; l'&eacute;tat non enregistr&eacute; et s'il en existe une version enregistr&eacute;e sur un
lecteur local.
dreamweaver.canSaveAll()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Enregistrer tout.
Derni&egrave;re mise &agrave; jour le 22/6/2011
517
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si deux documents non enregistr&eacute;s, ou plus, sont ouverts.
dreamweaver.canSaveDocument()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Enregistrer sur le document sp&eacute;cifi&eacute;.
Arguments
documentObject.
• L'argument documentObject est la racine d'un DOM de document (valeur identique &agrave; celle renvoy&eacute;e par
dreamweaver.getDocumentDOM()).
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si le document contient des modifications non enregistr&eacute;es.
dreamweaver.canSaveDocumentAsTemplate()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Enregistrer comme mod&egrave;le sur le document sp&eacute;cifi&eacute;.
Arguments
documentObject.
• L'argument documentObject est la racine d'un DOM de document (valeur identique &agrave; celle renvoy&eacute;e par
dreamweaver.getDocumentDOM()).
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si le document peut &ecirc;tre enregistr&eacute; comme mod&egrave;le.
dreamweaver.canSaveFrameset()
Disponibilit&eacute;
Dreamweaver 3.
Derni&egrave;re mise &agrave; jour le 22/6/2011
518
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Enregistrer le jeu de cadres sur le document sp&eacute;cifi&eacute;.
Arguments
documentObject.
• L'argument documentObject est la racine d'un DOM de document (valeur identique &agrave; celle renvoy&eacute;e par
dreamweaver.getDocumentDOM()).
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si le document est un jeu de cadres comportant des modifications non enregistr&eacute;es.
dreamweaver.canSaveFramesetAs()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Enregistrer le jeu de cadres sous sur le document sp&eacute;cifi&eacute;.
Arguments
documentObject.
• L'argument documentObject est la racine d'un DOM de document (valeur identique &agrave; celle renvoy&eacute;e par
dreamweaver.getDocumentDOM()).
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne qui indique si le document est un jeu de cadres.
dreamweaver.canSelectAll()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration S&eacute;lectionner tout.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant s'il est possible d'effectuer une op&eacute;ration S&eacute;lectionner tout.
Derni&egrave;re mise &agrave; jour le 22/6/2011
519
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dreamweaver.canShowFindDialog()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Rechercher.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Une valeur bool&eacute;enne qui est true si une fen&ecirc;tre de document ou un panneau Site est ouvert. Cette fonction renvoie
la valeur false lorsque la s&eacute;lection se trouve dans la section HEAD.
dreamweaver.canUndo()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Annuler dans le contexte en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant s'il existe des op&eacute;rations pouvant &ecirc;tre annul&eacute;es.
dreamweaver.canZoom()
Disponibilit&eacute;
Dreamweaver 8.
Description
V&eacute;rifie si un mode Cr&eacute;ation ou En direct est actif, ce qui signifie que les commandes de zoom de base peuvent &ecirc;tre
appliqu&eacute;es.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true s'il existe un mode Cr&eacute;ation actif, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
520
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dreamweaver.cssRuleTracker.canEditSelectedRule()
Disponibilit&eacute;
Dreamweaver MX 2004.
Description
V&eacute;rifie si l'&eacute;diteur de grille de propri&eacute;t&eacute; peut s'appliquer &agrave; la r&egrave;gle s&eacute;lectionn&eacute;e. La grille de propri&eacute;t&eacute; pouvant afficher
les r&egrave;gles dans les fichiers verrouill&eacute;s, la valeur de renvoi true ne garantit pas que les r&egrave;gles peuvent &ecirc;tre modifi&eacute;es.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'&eacute;diteur de grille de propri&eacute;t&eacute; peut s'appliquer &agrave; la r&egrave;gle s&eacute;lectionn&eacute;e, false dans le cas
contraire.
Exemple
Le code suivant v&eacute;rifie que la fonction de l'activateur a &eacute;t&eacute; d&eacute;finie sur la valeur true avant d'autoriser les modifications
sur la r&egrave;gle s&eacute;lectionn&eacute;e :
if(dw.cssRuleTracker.canEditSelectedRule()){
dw.cssRuleTracker.editSelectedRule();
}
dreamweaver.cssStylePalette.canApplySelectedStyle()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si le style s&eacute;lectionn&eacute; peut &ecirc;tre appliqu&eacute; au document actif.
Arguments
{pane}
• L'argument facultatif pane est une cha&icirc;ne sp&eacute;cifiant le volet du panneau Styles CSS auquel cette fonction est
appliqu&eacute;e. Les valeurs possibles sont les suivantes : &quot;stylelist&quot;, qui correspond &agrave; la liste des styles en mode
&laquo; Tout &raquo; ; &quot;cascade&quot;, qui correspond &agrave; la liste des r&egrave;gles applicables concern&eacute;es en mode &laquo; Courant &raquo; ; &quot;summary&quot;,
qui correspond &agrave; la liste des propri&eacute;t&eacute;s de la s&eacute;lection en cours en mode &laquo; Courant &raquo; et &quot;ruleInspector&quot;, qui
correspond &agrave; la liste ou grille de propri&eacute;t&eacute;s modifiable en mode &laquo; Courant &raquo;. La valeur par d&eacute;faut est &quot;stylelist&quot;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le style s&eacute;lectionn&eacute; comporte un s&eacute;lecteur de classes, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
521
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dreamweaver.cssStylePalette.canDeleteSelectedStyle()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si le style s&eacute;lectionn&eacute; peut &ecirc;tre supprim&eacute; de la s&eacute;lection en cours.
Arguments
{pane}
• L'argument facultatif pane est une cha&icirc;ne sp&eacute;cifiant le volet du panneau Styles CSS auquel cette fonction est
appliqu&eacute;e. Les valeurs possibles sont les suivantes : &quot;stylelist&quot;, qui correspond &agrave; la liste des styles en mode
&laquo; Tout &raquo; ; &quot;cascade&quot;, qui correspond &agrave; la liste des r&egrave;gles applicables concern&eacute;es en mode &laquo; Courant &raquo; ; &quot;summary&quot;,
qui correspond &agrave; la liste des propri&eacute;t&eacute;s de la s&eacute;lection en cours en mode &laquo; Courant &raquo; et &quot;ruleInspector&quot;, qui
correspond &agrave; la liste ou grille de propri&eacute;t&eacute;s modifiable en mode &laquo; Courant &raquo;. La valeur par d&eacute;faut est &quot;stylelist&quot;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si la s&eacute;lection peut &ecirc;tre supprim&eacute;e, false dans le cas contraire.
dreamweaver.cssStylePalette.canDuplicateSelectedStyle()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si le style s&eacute;lectionn&eacute; peut &ecirc;tre dupliqu&eacute; dans le document actif.
Arguments
{pane}
• L'argument facultatif pane est une cha&icirc;ne sp&eacute;cifiant le volet du panneau Styles CSS auquel cette fonction est
appliqu&eacute;e. Les valeurs possibles sont les suivantes : &quot;stylelist&quot;, qui correspond &agrave; la liste des styles en mode
&laquo; Tout &raquo; ; &quot;cascade&quot;, qui correspond &agrave; la liste des r&egrave;gles applicables concern&eacute;es en mode &laquo; Courant &raquo; ; &quot;summary&quot;,
qui correspond &agrave; la liste des propri&eacute;t&eacute;s de la s&eacute;lection en cours en mode &laquo; Courant &raquo; et &quot;ruleInspector&quot;, qui
correspond &agrave; la liste ou grille de propri&eacute;t&eacute;s modifiable en mode &laquo; Courant &raquo;. La valeur par d&eacute;faut est &quot;stylelist&quot;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le style s&eacute;lectionn&eacute; peut &ecirc;tre dupliqu&eacute;, false dans le cas contraire.
dreamweaver.cssStylePalette.canEditSelectedStyle()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si le style s&eacute;lectionn&eacute; peut &ecirc;tre modifi&eacute; dans le document actif.
Derni&egrave;re mise &agrave; jour le 22/6/2011
522
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Arguments
{pane}
• L'argument facultatif pane est une cha&icirc;ne sp&eacute;cifiant le volet du panneau Styles CSS auquel cette fonction est
appliqu&eacute;e. Les valeurs possibles sont les suivantes : &quot;stylelist&quot;, qui correspond &agrave; la liste des styles en mode
&laquo; Tout &raquo; ; &quot;cascade&quot;, qui correspond &agrave; la liste des r&egrave;gles applicables concern&eacute;es en mode &laquo; Courant &raquo; ; &quot;summary&quot;,
qui correspond &agrave; la liste des propri&eacute;t&eacute;s de la s&eacute;lection en cours en mode &laquo; Courant &raquo; et &quot;ruleInspector&quot;, qui
correspond &agrave; la liste ou grille de propri&eacute;t&eacute;s modifiable en mode &laquo; Courant &raquo;. La valeur par d&eacute;faut est &quot;stylelist&quot;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le style s&eacute;lectionn&eacute; est modifiable, false dans le cas contraire.
dreamweaver.cssStylePalette.canEditSelectedStyleInCodeview()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si le style s&eacute;lectionn&eacute; peut &ecirc;tre modifi&eacute; dans le document actif en mode Code.
Arguments
{pane}
• L'argument facultatif pane est une cha&icirc;ne sp&eacute;cifiant le volet du panneau Styles CSS auquel cette fonction est
appliqu&eacute;e. Les valeurs possibles sont les suivantes : &quot;stylelist&quot;, qui correspond &agrave; la liste des styles en mode
&laquo; Tout &raquo; ; &quot;cascade&quot;, qui correspond &agrave; la liste des r&egrave;gles applicables concern&eacute;es en mode &laquo; Courant &raquo; ; &quot;summary&quot;,
qui correspond &agrave; la liste des propri&eacute;t&eacute;s de la s&eacute;lection en cours en mode &laquo; Courant &raquo; et &quot;ruleInspector&quot;, qui
correspond &agrave; la liste ou grille de propri&eacute;t&eacute;s modifiable en mode &laquo; Courant &raquo;. La valeur par d&eacute;faut est &quot;stylelist&quot;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le style s&eacute;lectionn&eacute; est modifiable, false dans le cas contraire.
dreamweaver.cssStylePalette.canEditStyleSheet()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si la s&eacute;lection en cours contient des &eacute;l&eacute;ments de feuille de style modifiables.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si la s&eacute;lection est un nœud de feuille de style ou une d&eacute;finition de style n'est pas masqu&eacute;e et
si elle est distincte de ce document ; false si la s&eacute;lection est masqu&eacute;e ou si elle se trouve dans ce document.
Derni&egrave;re mise &agrave; jour le 22/6/2011
523
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dreamweaver.cssStylePalette.canRenameSelectedStyle()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si le style s&eacute;lectionn&eacute; peut &ecirc;tre renomm&eacute; dans le document actif.
Arguments
{pane}
• L'argument facultatif pane est une cha&icirc;ne sp&eacute;cifiant le volet du panneau Styles CSS auquel cette fonction est
appliqu&eacute;e. Les valeurs possibles sont les suivantes : &quot;stylelist&quot;, qui correspond &agrave; la liste des styles en mode
&laquo; Tout &raquo; ; &quot;cascade&quot;, qui correspond &agrave; la liste des r&egrave;gles applicables concern&eacute;es en mode &laquo; Courant &raquo; ; &quot;summary&quot;,
qui correspond &agrave; la liste des propri&eacute;t&eacute;s de la s&eacute;lection en cours en mode &laquo; Courant &raquo; et &quot;ruleInspector&quot;, qui
correspond &agrave; la liste ou grille de propri&eacute;t&eacute;s modifiable en mode &laquo; Courant &raquo;. La valeur par d&eacute;faut est &quot;stylelist&quot;.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le style s&eacute;lectionn&eacute; peut &ecirc;tre renomm&eacute;, false dans le cas contraire.
dreamweaver.isRecording()
Disponibilit&eacute;
Dreamweaver 3.
Description
Indique si Dreamweaver est en train de m&eacute;moriser une commande.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si Dreamweaver est en train d'enregistrer une commande.
dreamweaver.htmlStylePalette.canEditSelection()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut modifier, supprimer ou dupliquer la s&eacute;lection dans le panneau Styles HTML.
Arguments
Aucun.
Derni&egrave;re mise &agrave; jour le 22/6/2011
524
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si Dreamweaver peut modifier, supprimer ou dupliquer la s&eacute;lection dans le panneau Styles
HTML ; false si aucun style n'est s&eacute;lectionn&eacute; ou si l'un des styles ind&eacute;termin&eacute;s est s&eacute;lectionn&eacute;.
dreamweaver.resultsPalette.canClear()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie que vous pouvez effacer le contenu du panneau R&eacute;sultats actuellement actif.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le contenu peut &ecirc;tre effac&eacute;, false dans le cas contraire.
dreamweaver.resultsPalette.canCopy()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si la fen&ecirc;tre de r&eacute;sultats peut afficher un message copi&eacute; dans son contenu.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le contenu peut &ecirc;tre affich&eacute;, false dans le cas contraire.
dreamweaver.resultsPalette.canCut()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si la fen&ecirc;tre de r&eacute;sultats peut afficher un message coup&eacute; dans son contenu.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le contenu peut &ecirc;tre affich&eacute;, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
525
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dreamweaver.resultsPalette.canPaste()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si la fen&ecirc;tre de r&eacute;sultats peut afficher un message coll&eacute; dans son contenu.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le contenu peut &ecirc;tre affich&eacute;, false dans le cas contraire.
dreamweaver.resultsPalette.canOpenInBrowser()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si le rapport en cours peut &ecirc;tre affich&eacute; dans un navigateur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le contenu peut &ecirc;tre affich&eacute;, false dans le cas contraire.
dreamweaver.resultsPalette.canOpenInEditor()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si le rapport en cours peut &ecirc;tre affich&eacute; dans un &eacute;diteur.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne, true si le contenu peut &ecirc;tre affich&eacute;, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
526
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dreamweaver.resultsPalette.canSave()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si la bo&icirc;te de dialogue d'enregistrement peut &ecirc;tre lanc&eacute;e pour le panneau en cours. Actuellement, les panneaux
Rapports du site, V&eacute;rification du navigateur cible, Validation et V&eacute;rificateur de lien prennent en charge la bo&icirc;te de
dialogue d'enregistrement.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true, si la bo&icirc;te de dialogue d'enregistrement appara&icirc;t, false dans le cas contraire.
dreamweaver.resultsPalette.canSelectAll()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si un message S&eacute;lectionner tout peut &ecirc;tre transmis &agrave; la fen&ecirc;tre active.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le message S&eacute;lectionner tout peut &ecirc;tre transmis, false dans le cas contraire.
dreamweaver.siteSyncDialog.canCompare()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction v&eacute;rifie si le menu contextuel Comparer peut &ecirc;tre affich&eacute; dans la bo&icirc;te de dialogue Synchroniser le site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le menu contextuel Comparer peut &ecirc;tre affich&eacute; dans la bo&icirc;te de dialogue Synchroniser le
site, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
527
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dreamweaver.siteSyncDialog.canMarkDelete()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction v&eacute;rifie si le menu contextuel Modifier l'action &agrave; supprimer peut &ecirc;tre affich&eacute; dans la bo&icirc;te de dialogue
Synchroniser le site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le menu contextuel Modifier l'action &agrave; supprimer peut &ecirc;tre affich&eacute;, false dans le cas
contraire.
dreamweaver.siteSyncDialog.canMarkGet()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction v&eacute;rifie si le menu contextuel Modifier l'action &agrave; obtenir peut &ecirc;tre affich&eacute; dans la bo&icirc;te de dialogue
Synchroniser le site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le menu contextuel Modifier l'action &agrave; obtenir peut &ecirc;tre affich&eacute;, false dans le cas contraire.
dreamweaver.siteSyncDialog.canMarkIgnore()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction v&eacute;rifie si le menu contextuel Modifier l'action &agrave; ignorer peut &ecirc;tre affich&eacute; dans la bo&icirc;te de dialogue
Synchroniser le site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le menu contextuel Modifier l'action &agrave; ignorer peut &ecirc;tre affich&eacute;, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
528
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dreamweaver.siteSyncDialog.canMarkPut()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction v&eacute;rifie si le menu contextuel Modifier l'action &agrave; placer peut &ecirc;tre affich&eacute; dans la bo&icirc;te de dialogue
Synchroniser le site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le menu contextuel Modifier l'action &agrave; placer peut &ecirc;tre affich&eacute;, false dans le cas contraire.
dreamweaver.siteSyncDialog.canMarkSynced()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction v&eacute;rifie si le menu contextuel Modifier l'action &agrave; synchroniser peut &ecirc;tre affich&eacute; dans la bo&icirc;te de dialogue
Synchroniser le site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le menu contextuel Modifier l'action &agrave; synchroniser peut &ecirc;tre affich&eacute;, false dans le cas
contraire.
dreamweaver.snippetpalette.canEditSnippet()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si vous pouvez modifier l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; et renvoie la valeur true ou la valeur false pour vous permettre
d'activer ou de d&eacute;sactiver les &eacute;l&eacute;ments de menu destin&eacute;s &agrave; l'&eacute;dition.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si vous pouvez modifier l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
529
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
dreamweaver.snippetpalette.canInsert()
Disponibilit&eacute;
Dreamweaver MX.
Description
V&eacute;rifie si vous pouvez ins&eacute;rer ou appliquer l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; et renvoie la valeur true ou la valeur false pour vous
permettre d'activer ou de d&eacute;sactiver les &eacute;l&eacute;ments de menu destin&eacute;s &agrave; l'insertion ou &agrave; l'application.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si vous pouvez ins&eacute;rer ou appliquer l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;, false dans le cas contraire.
site.browseDocument()
Disponibilit&eacute;
Dreamweaver 4.
Description
Ouvre tous les documents s&eacute;lectionn&eacute;s dans une fen&ecirc;tre de navigateur. Cela revient &agrave; utiliser la commande Aper&ccedil;u
dans le navigateur.
Arguments
browserName.
• L'argument browserName est le nom du navigateur tel qu'il est d&eacute;fini dans les pr&eacute;f&eacute;rences d'aper&ccedil;u dans le
navigateur. Si cet argument n'est pas d&eacute;fini, le navigateur principal de l'utilisateur est utilis&eacute; par d&eacute;faut.
Valeurs renvoy&eacute;es
Aucune.
site.canCheckIn()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Archiver.
Arguments
siteOrURL
• L'argument siteOrURL doit &ecirc;tre soit le mot cl&eacute; site, indiquant que la fonction doit agir sur l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;
dans le panneau Site, soit l'URL d'un fichier.
Derni&egrave;re mise &agrave; jour le 22/6/2011
530
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si les conditions suivantes sont vraies, false dans le cas contraire :
• Un site distant a &eacute;t&eacute; d&eacute;fini.
• Dans le cas o&ugrave; une fen&ecirc;tre de document est active, le fichier a &eacute;t&eacute; enregistr&eacute; sur un site local ou, dans le cas o&ugrave; le
panneau Site est actif, un ou plusieurs fichiers ou dossiers sont s&eacute;lectionn&eacute;s.
• La fonction Archiver/Extraire est activ&eacute;e pour le site.
site.canCheckOut()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Extraire sur le ou les fichiers sp&eacute;cifi&eacute;s.
Arguments
siteOrURL
• L'argument siteOrURL doit &ecirc;tre soit le mot cl&eacute; site, indiquant que la fonction doit agir sur l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;
dans le panneau Site, soit l'URL d'un fichier.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si toutes les conditions suivantes sont vraies, false dans le cas contraire :
• Un site distant a &eacute;t&eacute; d&eacute;fini.
• Dans le cas o&ugrave; une fen&ecirc;tre de document est active, le fichier appartient &agrave; un site local et il n'est pas d&eacute;j&agrave; extrait ou,
dans le cas o&ugrave; le panneau Site est actif, plusieurs fichiers ou dossiers sont s&eacute;lectionn&eacute;s et au moins un des fichiers
s&eacute;lectionn&eacute;s n'a pas encore &eacute;t&eacute; extrait.
• La fonction Archiver/Extraire est activ&eacute;e pour le site.
site.canCloak()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration de voilage.
Arguments
siteOrURL
• L'argument siteOrURL doit &ecirc;tre soit le mot cl&eacute; site, indiquant que la fonction canCloak() doit agir sur l'&eacute;l&eacute;ment
s&eacute;lectionn&eacute; dans le panneau Site, soit l'URL d'un dossier donn&eacute;, indiquant que la fonction canCloak() doit agir sur
le dossier sp&eacute;cifi&eacute; et l'ensemble de son contenu.
Derni&egrave;re mise &agrave; jour le 22/6/2011
531
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si Dreamweaver peut ex&eacute;cuter l'op&eacute;ration de voilage sur le site en cours ou le dossier sp&eacute;cifi&eacute;,
false dans le cas contraire.
site.canCompareFiles()
Disponibilit&eacute;
Dreamweaver 8.
Description
Cette fonction v&eacute;rifie si Dreamweaver peut ex&eacute;cuter la fonction Comparer sur des fichiers s&eacute;lectionn&eacute;s.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si deux fichiers (un fichier local et un fichier distant, deux fichiers locaux ou deux fichiers
distants) sont s&eacute;lectionn&eacute;s ; false dans le cas contraire.
site.canConnect()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut se connecter au site distant.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le site distant en cours est un site FTP, false dans le cas contraire.
site.canDisplaySyncInfoForFile()
Disponibilit&eacute;
Dreamweaver CS3
Description
D&eacute;termine si Dreamweaver peut effectuer l'op&eacute;ration displaySyncInfoForFile.
Arguments
path, 'site'
• path est l'URL pointant vers un fichier local.
Derni&egrave;re mise &agrave; jour le 22/6/2011
532
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
• 'site' indique que la fonction utilise le fichier s&eacute;lectionn&eacute; dans le panneau Site.
Valeurs renvoy&eacute;es
Renvoie la valeur true si un fichier est s&eacute;lectionn&eacute; dans l'affichage local des fichiers (si 'site' en est le param&egrave;tre) ou
true si le chemin transmis fait partie d'un site. Renvoie false dans le cas contraire.
site.canGet()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Acqu&eacute;rir.
Arguments
siteOrURL
• L'argument siteOrURL doit &ecirc;tre soit le mot cl&eacute; site, indiquant que la fonction doit agir sur l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;
dans le panneau Site, soit l'URL d'un fichier.
Valeurs renvoy&eacute;es
Si l'argument est site, valeur bool&eacute;enne indiquant si un ou plusieurs fichiers ou dossiers sont s&eacute;lectionn&eacute;s dans le
panneau Site et si un site distant a &eacute;t&eacute; d&eacute;fini. Si l'argument est une URL, valeur bool&eacute;enne indiquant si le document
appartient &agrave; un site pour lequel un site distant a &eacute;t&eacute; d&eacute;fini.
site.canLocateInSite()
Disponibilit&eacute;
Dreamweaver 3, mise &agrave; jour dans CS4.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Retrouver sur le site local ou Retrouver sur le site distant (en
fonction de l'argument).
Arguments
localOrRemote, siteOrURL
• L'argument localOrRemote doit &ecirc;tre local ou remote.
• L'argument siteOrURL doit &ecirc;tre le mot cl&eacute; site. Ce mot cl&eacute; indique que la fonction doit agir sur l'&eacute;l&eacute;ment
s&eacute;lectionn&eacute; dans le panneau Site ou sur l'URL d'un fichier.
Valeurs renvoy&eacute;es
L'une des valeurs suivantes :
• Valeur bool&eacute;enne qui indique si le document appartient &agrave; un site. La valeur bool&eacute;enne est renvoy&eacute;e si le premier
argument est le mot cl&eacute; local et le second argument est une URL.
Derni&egrave;re mise &agrave; jour le 22/6/2011
533
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
• Valeur bool&eacute;enne. La valeur bool&eacute;enne est renvoy&eacute;e si le premier argument est le mot cl&eacute; remote et le second
argument est une URL. La valeur bool&eacute;enne indique :
• si le document appartient &agrave; un site pour lequel un site distant a &eacute;t&eacute; d&eacute;fini ;
• si le disque dur est mont&eacute;, si le type de serveur est Local/R&eacute;seau.
• Valeur bool&eacute;enne qui indique si les deux fen&ecirc;tres contiennent des fichiers du site et si la s&eacute;lection se trouve dans le
volet en face de l'argument. La valeur bool&eacute;enne est renvoy&eacute;e si le second argument est le mot cl&eacute; site.
site.canMakeEditable()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration D&eacute;sactiver le mode Lecture seule.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si Dreamweaver peut effectuer une op&eacute;ration D&eacute;sactiver le mode Lecture seule, false si un
ou plusieurs des fichiers s&eacute;lectionn&eacute;s sont verrouill&eacute;s.
site.canMakeNewFileOrFolder()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Nouveau fichier ou Nouveau dossier dans le panneau Site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si des fichiers sont visibles dans le volet s&eacute;lectionn&eacute; du panneau Site, false dans le cas
contraire.
site.canOpen()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut ouvrir les fichiers ou les dossiers actuellement s&eacute;lectionn&eacute;s dans le panneau Site.
Derni&egrave;re mise &agrave; jour le 22/6/2011
534
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si des fichiers ou des dossiers sont s&eacute;lectionn&eacute;s dans le panneau Site, false dans les autres cas.
site.canPut()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Placer.
Arguments
siteOrURL
• L'argument siteOrURL doit &ecirc;tre soit le mot cl&eacute; site, indiquant que la fonction doit agir sur l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;
dans le panneau Site, soit l'URL d'un fichier.
Valeurs renvoy&eacute;es
L'une des valeurs suivantes :
• si l'argument est le mot cl&eacute; site, renvoie la valeur true si des fichiers ou des dossiers sont s&eacute;lectionn&eacute;s dans le
panneau Site et si un site distant a &eacute;t&eacute; d&eacute;fini; renvoie la valeur false dans les autres cas ;
• si l'argument est une URL, renvoie la valeur true si le document appartient &agrave; un site pour lequel un site distant a
&eacute;t&eacute; d&eacute;fini ; renvoie la valeur false dans le cas contraire.
site.canRecreateCache()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Recr&eacute;er le cache du site.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si l'option Utiliser le cache pour acc&eacute;l&eacute;rer les mises &agrave; jour des liens est activ&eacute;e pour le site en
cours.
Derni&egrave;re mise &agrave; jour le 22/6/2011
535
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
site.canRefresh()
Disponibilit&eacute;
Dreamweaver 3.
Description
V&eacute;rifie si Dreamweaver peut effectuer une op&eacute;ration Actualiser [local | distant].
Arguments
localOrRemote.
• L'argument localOrRemote doit &ecirc;tre le mot cl&eacute; local ou remote.
Valeurs renvoy&eacute;es
Valeur true si l'argument localOrRemote est le mot cl&eacute; local ; sinon, une valeur bool&eacute;enne indiquant si un site distant
a &eacute;t&eacute; d&eacute;fini.
site.canSelectAllCheckedOutFiles()
Disponibilit&eacute;
Dreamweaver 4.
Description
D&eacute;termine si la fonction Archiver/Extraire est activ&eacute;e sur le site en cours.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le site autorise l'archivage et l'extraction, false dans le cas contraire.
site.canSelectNewer()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration S&eacute;lectionner [distants | locaux] plus r&eacute;cents.
Arguments
localOrRemote.
• L'argument localOrRemote doit &ecirc;tre le mot cl&eacute; local ou remote.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si le document appartient &agrave; un site pour lequel un site distant a &eacute;t&eacute; d&eacute;fini.
Derni&egrave;re mise &agrave; jour le 22/6/2011
536
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
site.canSynchronize()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Synchroniser.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne indiquant si un site distant a &eacute;t&eacute; d&eacute;fini.
site.canUncloak()
Disponibilit&eacute;
Dreamweaver MX.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration de suppression du voile.
Arguments
siteOrURL
• L'argument siteOrURL doit &ecirc;tre soit le mot-cl&eacute; site, indiquant que la fonction canUncloak() doit agir sur
l'&eacute;l&eacute;ment s&eacute;lectionn&eacute; dans le panneau Site, soit l'URL d'un dossier donn&eacute;, indiquant que la fonction canUncloak()
doit agir sur le dossier sp&eacute;cifi&eacute; et l'ensemble de son contenu.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si Dreamweaver peut ex&eacute;cuter l'op&eacute;ration de suppression du voile sur le site en cours ou le
dossier sp&eacute;cifi&eacute;, false dans le cas contraire.
site.canUndoCheckOut()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Annuler extraction.
Arguments
siteOrURL
• L'argument siteOrURL doit &ecirc;tre soit le mot cl&eacute; site, indiquant que la fonction doit agir sur l'&eacute;l&eacute;ment s&eacute;lectionn&eacute;
dans le panneau Site, soit l'URL d'un fichier.
Derni&egrave;re mise &agrave; jour le 22/6/2011
537
R&Eacute;F&Eacute;RENCE DES API DE DREAMWEAVER
Activateurs
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le fichier sp&eacute;cifi&eacute; ou l'un des fichiers s&eacute;lectionn&eacute;s, au moins, a &eacute;t&eacute; extrait.
site.canViewAsRoot()
Disponibilit&eacute;
Dreamweaver 3.
Description
D&eacute;termine si Dreamweaver peut effectuer une op&eacute;ration Afficher comme racine.
Arguments
Aucun.
Valeurs renvoy&eacute;es
Valeur bool&eacute;enne : true si le fichier sp&eacute;cifi&eacute; est un fichier HTML ou Flash, false dans le cas contraire.
Derni&egrave;re mise &agrave; jour le 22/6/2011
Manuel du propriétaire | Adobe DREAMWEAVER CS5 Manuel utilisateur

Manuels associés

Adobe

Dreamweaver CS4

Adobe

DREAMWEAVER CS3

Adobe

Dreamweaver CS5.5

Adobe

Dreamweaver CS4

Adobe

DREAMWEAVER CS3

MACROMEDIA

DREAMWEAVER MX 6

Adobe

Dreamweaver CS4

MACROMEDIA

DREAMWEAVER 8-EXTENSION DE DREAMWEAVER

MACROMEDIA

DREAMWEAVER MX 2004-UTILISATION DE DREAMWEAVER

MACROMEDIA

DREAMWEAVER MX 2004-BIEN DMARRER AVEC DREAMWEAVER

MACROMEDIA

DREAMWEAVER 8-UTILISATION DE DREAMWEAVER

Adobe

DREAMWEAVER CS5
