ADOBE Dreamweaver API CS5 User Manual [fr]

Référence des API

ADOBE® DREAMWEAVER® CS5 & CS5.5

d’

Mentions légales

Mentions légales

Vous trouverez des informations juridiques à l'adresse http://help.adobe.com/fr_FR/legalnotices/index.html.

Dernière mise à jour le 22/6/2011

Sommaire

Chapitre 1 : Introduction

A propos des extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Extension de Dreamweaver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Ressources supplémentaires pour les créateurs d'extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Nouvelles fonctions de Dreamweaver CS5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Conventions utilisées dans ce manuel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapitre 2 : API d'E/S des fichiers

A propos des dossiers de configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

A propos de l'API d'E/S des fichiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapitre 3 : API HTTP

Fonctionnement de l'API HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

L'API HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Chapitre 4 : API de Design Notes

Fonctionnement des Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

L'API JavaScript de Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

L'API C de Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

iii

Chapitre 5 : Intégration de Fireworks

L'API FWLaunch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Chapitre 6 : Intégration de Flash

L'API des objets Flash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Fonctions des panneaux et des boîtes de dialogue de Flash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Chapitre 7 : Intégration de Photoshop

Fonctionnement des objets dynamiques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

L'API des objets dynamiques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Chapitre 8 : API de base de données

Fonctionnement de l'API de base de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Fonctions de connexion à une base de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Fonctions d'accès à la base de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Chapitre 9 : API de connectivité à une base de données

Sélection d'un nouveau type de connexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Création d'un nouveau type de connexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

L'API de connexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Fichier inclus généré . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Fichier de définition pour votre type de connexion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

Sommaire

Chapitre 10 : API d'intégration de commande source

Fonctionnement de l'intégration des commandes source avec Dreamweaver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Ajout d'une fonctionnalité de système de commande source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Fonctions requises de l'API d'intégration de commande source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Fonctions facultatives de l'API d'intégration de commande source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Activateurs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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être de résultats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Fonctions de bascule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158

Fonctions relatives aux barres d'outils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Fonctions relatives aux fenêtres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Fonctions de la barre d'information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Fonctions des fichiers apparentés . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Fonctions du mode Fractionnement vertical . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Fonctions relatives au fractionnement des codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

Fonctions relatives aux barres d'outils du mode Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

Fonctions des couleurs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

iv

Chapitre 13 : Site

Fonctions relatives aux rapports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

Fonctions relatives aux sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Chapitre 14 : Document

Fonctions relatives aux conversions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254

Fonctions relatives aux commandes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255

Fonctions relatives aux manipulations de fichiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

Fonctions relatives à l'ensemble d'un document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271

Fonctions relatives aux chemins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279

Fonctions relatives à la sélection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297

Fonctions de manipulation de chaînes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 303

Fonctions relatives à la traduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

Fonctions XSLT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308

Chapitre 15 : Contenu de page

Fonctions du panneau Actifs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312

Fonctions relatives aux comportements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320

Presse-papiers, fonctions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330

Fonctions relatives aux éléments de bibliothèque et aux modèles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334

Dernière mise à jour le 22/6/2011

RÉFÉ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érification de la compatibilité avec les navigateurs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

Chapitre 16 : Documents dynamiques

Fonctions de composants de serveur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356

Fonctions relatives aux sources de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357

Fonctions de l'Extension Data Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358

Fonctions Live data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

Fonctions relatives au mode En direct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365

Fonctions relatives aux comportements de serveur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377

Fonctions de modèle de serveur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378

Chapitre 17 : Création

Fonctions relatives aux mises en forme CSS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385

Fonctions relatives aux cadres et aux jeux de cadres . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408

Fonctions relatives aux calques et aux cartes d'images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410

Fonctions d'environnement de mise en forme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

Fonctions relatives au mode de Mise en forme . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418

Fonctions de gestion de résolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424

Requête multimédia . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426

Fonctions relatives aux zooms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427

Propriétés et fonctions de repère . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431

Fonctions de modification des tableaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438

v

Chapitre 18 : Code

Fonctions de code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448

Fonctions relatives à la recherche et au remplacement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453

Fonctions de modifications générales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459

Fonction relative à l'impression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475

Fonctions relatives à Quick Tag Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476

Fonctions relatives au mode Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478

Fonctions du mode Code en direct . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495

Fonctions de l'éditeur de balises et de la bibliothèque de balises . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496

Chapitre 19 : Activateurs

Fonctions d'activateur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501

Dernière mise à jour le 22/6/2011

Chapitre 1 : Introduction

Le Guide des API d'Adobe Dreamweaver CS5 décrit les interfaces de programmation d'applications (API) qui vous
permettent d'effectuer diverses tâches de prise en charge lorsque vous développez des extensions Adobe®
Dreamweaver® CS5 et ajoutez des codes de programme à vos pages Web Dreamweaver. Les API comprennent l'API
JavaScript principale, qui permet d'accéder à la plupart des fonctionnalités essentielles de Dreamweaver. Les
fonctionnalités essentielles de Dreamweaver sont à peu près tout ce qui peut être effectué via un menu, et bien plus
encore. Il s'agit aussi de diverses API utilitaires destinées à des tâches aussi courantes que la lecture de fichiers et leur
écriture, le transfert d'informations à l'aide de HTTP et la communication avec Fireworks et Flash.

L'API JavaScript vous permet d'exécuter un large éventail de tâches plus réduites. L'utilisateur exécute nombre de ces
tâches lorsqu'il crée ou modifie des documents Dreamweaver. Ces fonctions d'API sont regroupées selon les parties de
l'interface utilisateur de Dreamweaver auxquelles elles se rapportent. Ainsi, l'API JavaScript comprend les fonctions
relatives à l'espace de travail, aux documents, à la conception, etc. Les fonctions de l'API permettent de réaliser
quelques-unes des tâches suivantes, et bien plus encore :

• Ouverture d'un nouveau document

• Obtention ou définition d'une taille de police

• Recherche de l'occurrence d'une chaîne de recherche dans le code HTML

• Activation de la visibilité d'une barre d'outils

1

A propos des extensions

Ce manuel suppose une bonne maîtrise de Dreamweaver, HTML, XML, de la programmation JavaScript et, le cas
échéant, de la programmation C. Pour rédiger vos propres extensions afin de créer des applications Web, vous devez
connaître les langages de script côté 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évelopper des extensions de
Dreamweaver, voir Extension de Dreamweaver. Le manuel Extension de Dreamweaver décrit les fonctions des API que
Dreamweaver appelle pour implémenter les objets, menus, panneaux flottants, comportements de serveur, etc., qui
composent les diverses fonctionnalité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 également comment
personnaliser Dreamweaver en modifiant et en ajoutant des balises à différents fichiers HTML et XML, de façon à
ajouter des éléments de menus ou des types de documents, etc.

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

Introduction

Ressources supplémentaires pour les créateurs d'extensions

Pour entrer en contact avec d'autres développeurs d'extensions, rejoignez le forum de discussion consacré à
l'extensibilité de Dreamweaver. Vous trouverez ce forum à l'adresse

http://www.adobe.com/cfusion/webforums/forum/categories.cfm?forumid=12&catid=190&entercat=y.

Nouvelles fonctions de Dreamweaver CS5

Les nouvelles fonctions suivantes ont été ajoutées à l'API JavaScript de Dreamweaver CS5. Les en-têtes désignent les
chapitres et les sections qui contiennent les nouvelles fonctions :

Documents dynamiques

Les fonctions suivantes ont été ajoutées au chapitre Documents dynamiques.

Fonctions relatives au mode En direct

« dom.setLiveViewFollowsLinks() » à la page 368

2

« dom.getLiveViewFollowsLinks() » à la page 368

« dom.isLiveViewBrowsingHomeURI() » à la page 369

« dreamweaver.findSiteForURI() » à la page 369

« dom.browser.isPageNavigationHistoryEnabled() » à la page 371

« dom.browser.enablePageNavigationHistory() » à la page 371

« dom.browser.getPageNavigationHistoryLength() » à la page 372

« dom.browser.getPageNavigationHistoryPosition() » à la page 372

« dom.browser.goToPageNavigationHistoryPosition() » à la page 372

« dom.browser.getPageNavigationHistoryItem() » à la page 373

« dom.browser.setHomePage() » à la page 373

« dom.browser.getHomePage() » à la page 374

Espace de travail

Les fonctions suivantes ont été ajoutées au chapitre Espace de travail.

Fonctions des fichiers apparentés

« dreamweaver.getRelatedFilesFilter() » à la page 195

« dreamweaver.setRelatedFilesFilter() » à la page 196

« dreamweaver.getQuickRelatedFilesFilterStrings() » à la page 196

« dreamweaver.invokeRelatedFilesCustomFilterDialog() » à la page 196

« dreamweaver.getDynamicRelatedFilesDiscoverySetting() » à la page 197

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

Introduction

« dreamweaver.setDynamicRelatedFilesDiscoverySetting() » à la page 197

« dreamweaver.refreshRelatedFiles() » à la page 198

« dreamweaver.saveAllRelatedFiles() » à la page 198

« dreamweaver.canSaveAllRelatedFiles() » à la page 198

« document.isRelatedFileViewOpen() » à la page 199

« document.getRelatedFiles() » à la page 199

« document.addRelatedFile() » à la page 200

« document.removeRelatedFile() » à la page 201

« document.getDependentFiles() » à la page 201

...et bien d'autres encore.

Document

Les fonctions suivantes ont été ajoutées au chapitre Document.

« DWUri.isValidURI() » à la page 282

3

« DWUri.isAbsolute() » à la page 283

« DWUri.isRelative() » à la page 283

« DWUri.isDirectory() » à la page 283

« DWUri.isHierarchical() » à la page 284

« DWUri.isOfType() » à la page 284

« DWUri.isOfFileType() » à la page 284

...et bien d'autres encore.

Code

Les fonctions suivantes ont été ajoutées au chapitre Code.

« dom.getLiveCodeHighlightsChanges() » à la page 495

« dom.setLiveCodeHighlightsChanges() » à la page 495

...et bien d'autres encore.

Conventions utilisé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é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 éléments remplaçables dans le code.

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

Introduction

• Le symbole de continuation (¬) indique qu'une longue ligne de code a été fractionnée sur deux lignes ou plus. En

raison des limites de marge du format de ce manuel,une ligne de code continue doit ici être coupée. Lorsque vous
copiez les lignes de code, supprimez le symbole de continuation et entrez-les comme une seule ligne.

• Les accolades ({ }) placées avant et après un argument de fonction indiquent que cet argument est facultatif.

• Le nom des fonctions ayant le préfixe dreamweaver.nomfonc peut être abrégé en dw.nomfonc lorsque vous écrivez

le code. Ce manuel utilise le préfixe
Toutefois, dans de nombreux exemples, le préfixe

dreamweaver. complet dans les définitions de fonctions et dans l'index.

dw. est utilisé.

Conventions de dénomination

Ce manuel utilise les conventions de dénomination suivantes :

• Vous — le développeur responsable de la rédaction des extensions

• L'utilisateur — la personne utilisant Dreamweaver

4

Dernière mise à jour le 22/6/2011

Chapitre 2 : API d'E/S des fichiers

Adobe® Dreamweaver® CS5 comprend une bibliothèque partagée C, appelée DWfile, qui donne aux auteurs d'objets,
de commandes, de comportements, de traducteurs de données, de panneaux flottants et d'inspecteurs Propriétés la
possibilité de lire et d'écrire des fichiers sur le système de fichiers local. Ce chapitre décrit l'API d'entrée/sortie des
fichiers et son utilisation.

Pour obtenir des informations générales sur la façon dont les bibliothèques C interagissent avec l'interpréteur
JavaScript dans Dreamweaver, voir « Extensibilité de niveau C » 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 écrit dans un fichier de configuration, il le fait dans le
dossier Configuration de l'utilisateur. De mê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èdent de la même manière. En d'autres termes, si une extension lit ou é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.

5

A propos de l'API d'E/S des fichiers

Toutes les fonctions de l'API d'E/S des fichiers sont des méthodes associées à l'objet DWfile.

DWfile.copy()

Disponibilité

Dreamweaver 3.

Description

Cette fonction copie le fichier spécifié vers un nouvel emplacement.

Arguments

originalURL, copyURL

• L'argument originalURL, exprimé sous la forme d'une URL de type file://, représente le fichier que vous souhaitez

copier.

• L'argument copyURL, exprimé sous la forme d'une URL de type file://, représente l'emplacement où vous souhaitez

enregistrer le fichier copié.

Valeurs renvoyées

Valeur booléenne,

true si la copie réussit, false dans le cas contraire.

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

API d'E/S des fichiers

Exemple

Le code suivant copie un fichier appelé myconfig.cfg vers myconfig_backup.cfg :

var fileURL = "file:///c|/Config/myconfig.cfg";
var newURL ="file:///c|/Config/myconfig_backup.cfg";
DWfile.copy(fileURL, newURL);

DWfile.createFolder()

Disponibilité

Dreamweaver 2.

Description

Cette fonction crée un dossier à l'emplacement spécifié.

Arguments

folderURL

• L'argument folderURL, exprimé sous la forme d'une URL de type file://, représente l'emplacement dans lequel vous

souhaitez créer le dossier.

6

Valeurs renvoyées

Valeur booléenne :

true si le dossier est bien créé, false en cas d'échec.

Exemple

Le code suivant tente de créer un dossier nommé tempFolder à la racine du lecteur C et affiche un message
d'avertissement indiquant si l'opération a réussi.

var folderURL = "file:///c|/tempFolder";
if (DWfile.createFolder(folderURL)){

alert("Created " + folderURL);

}else{

alert("Unable to create " + folderURL);

}

DWfile.exists()

Disponibilité

Dreamweaver 2.

Description

Cette fonction vérifie l'existence du fichier spécifié.

Arguments

fileURL

• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier requis.

Valeurs renvoyées

Valeur booléenne :

true si le fichier existe, false dans le cas contraire.

Dernière mise à jour le 22/6/2011

RÉFÉ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 à l'utilisateur si le
fichier existe :

var fileURL = "file:///c|/temp/mydata.txt";
if (DWfile.exists(fileURL)){

alert(fileURL + " exists!");

}else{

alert(fileURL + " does not exist.");

}

DWfile.getAttributes()

Disponibilité

Dreamweaver 2.

Description

Cette fonction obtient les attributs du fichier ou dossier spécifié.

Arguments

fileURL

7

• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier ou dossier dont vous

souhaitez obtenir les attributs.

Valeurs renvoyées

Chaîne représentant les attributs du fichier ou du dossier spécifié. Si le fichier ou le dossier n'existe pas, cette fonction
renvoie la valeur

null. Les caractères suivants de la chaîne représentent les attributs :

• R signifie lecture seule.

• D signifie dossier.

• H signifie masqué.

• S indique un fichier ou dossier systè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 = "file:///c|/temp/mydata.txt";
var str = DWfile.getAttributes(fileURL);
if (str && (str.indexOf("R") != -1)){

alert(fileURL + " is read only!");

}

DWfile.getModificationDate()

Disponibilité

Dreamweaver 2.

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

API d'E/S des fichiers

Description

Cette fonction renvoie l'heure à laquelle le fichier a été modifié pour la dernière fois.

Arguments

fileURL

• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dont vous vérifiez l'heure

de la dernière modification.

Valeurs renvoyées

Chaîne qui contient un nombre hexadécimal représentant le nombre d'unités de temps écoulées depuis une base de
temps donnée. La signification exacte des unités de temps et de la base de temps dépend de la plate-forme ; sous
Windows, par exemple, une unité de temps est égale à 100 ns et la base de temps est le 1 janvier 1600.

Exemple

Comme la valeur renvoyée par cette fonction n'est pas une date et une heure identifiables et qu'elle dépend de la plate­forme employée, il est utile d'appeler la fonction deux fois pour comparer les valeurs renvoyé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écent :

8

var file1 = "file:///c|/temp/file1.txt";
var file2 = "file:///c|/temp/file2.txt";
var time1 = DWfile.getModificationDate(file1);
var time2 = DWfile.getModificationDate(file2);
if (time1 == time2){

alert("file1 and file2 were saved at the same time");

}else if (time1 < time2){

alert("file1 older that file2");

}else{

alert("file1 is newer than file2");

}

DWfile.getCreationDate()

Disponibilité

Dreamweaver 4.

Description

Cette fonction renvoie l'heure à laquelle le fichier a été créé.

Arguments

fileURL

• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dont vous vérifiez l'heure

de création.

Valeurs renvoyées

Chaîne qui contient un nombre hexadécimal représentant le nombre d'unités de temps écoulées depuis une base de
temps donnée. La signification exacte des unités de temps et de la base de temps dépend de la plate-forme ; sous
Windows, par exemple, une unité de temps est égale à 100 ns et la base de temps est le 1 janvier 1600.

Dernière mise à jour le 22/6/2011

RÉFÉ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éation :

var file1 = "file:///c|/temp/file1.txt";
var time1 = DWfile.getCreationDate(file1);
var time2 = DWfile.getModificationDate(file1);
if (time1 == time2){

alert("file1 has not been modified since it was created");

}else if (time1 < time2){

alert("file1 was last modified on " + time2);

}

DWfile.getCreationDateObj()

Disponibilité

Dreamweaver MX.

Description

Cette fonction obtient l'objet JavaScript représentant l'heure de création du fichier.

9

Arguments

fileURL

• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dont vous vérifiez l'heure

de création.

Valeurs renvoyées

Obtient un objet

Date JavaScript représentant la date et l'heure de création du fichier spécifié.

DWfile.getModificationDateObj()

Disponibilité

Dreamweaver MX.

Description

Cette fonction obtient l'objet

Arguments

fileURL

• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dont vous vérifiez l'heure

de modification la plus récente.

Date JavaScript représentant l'heure de la dernière modification du fichier.

Valeurs renvoyées

Obtient un objet

Date JavaScript représentant la date et l'heure de la dernière modification du fichier spécifié.

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

API d'E/S des fichiers

DWfile.getSize()

Disponibilité

Dreamweaver MX.

Description

Cette fonction obtient la taille du fichier spécifié.

Arguments

fileURL

• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dont vous vérifiez la taille.

Valeurs renvoyées

Nombre entier qui représente la taille réelle du fichier spécifié, exprimée en octets.

DWfile.listFolder()

10

Disponibilité

Dreamweaver 2.

Description

Cette fonction obtient une liste du contenu du dossier spécifié.

Arguments

folderURL, {constraint}

• L'argument folderURL est le dossier dont vous souhaitez obtenir le contenu, exprimé sous la forme d'une URL de

type file:// et d'un masque de fichier facultatif composé de caractères génériques. Les caractères génériques valides
sont les astérisques (*), qui représentent un ou plusieurs caractères, et les points d'interrogation (?), qui
représentent un seul caractère.

• L'argument constraint, s'il est fourni, doit être soit "files" (renvoyer uniquement les fichiers), soit

"directories" (renvoyer uniquement les dossiers). Si cet argument n'est pas spécifié, la fonction renvoie aussi

bien des fichiers que des dossiers.

Valeurs renvoyées

Tableau de chaînes repré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 = "file:///c|/temp";
var fileMask = "*.txt";
var list = DWfile.listFolder(folderURL + "/" + fileMask, "files");
if (list){

alert(folderURL + " contains: " + list.join("\n"));

}

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

API d'E/S des fichiers

DWfile.read()

Disponibilité

Dreamweaver 2.

Description

Cette fonction lit le contenu du fichier spécifié dans une chaîne.

Arguments

fileURL

• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier que vous souhaitez lire.

Valeurs renvoyées

Soit une chaîne indiquant le contenu du fichier, soit la valeur

Exemple

Le code suivant lit le fichier mydata.txt et, s'il réussit, affiche un message d'avertissement renfermant le contenu du
fichier :

null si la lecture échoue.

11

var fileURL = "file:///c|/temp/mydata.txt";
var str = DWfile.read(fileURL);
if (str){

alert(fileURL + " contains: " + str);

}

DWfile.remove()

Disponibilité

Dreamweaver 3.

Description

Cette fonction permet de supprimer le fichier spécifié.

Arguments

fileURL

• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier que vous souhaitez

supprimer.

Valeurs renvoyées

Valeur booléenne,

true si l'opération réussit, false dans le cas contraire.

Exemple

L'exemple suivant utilise la fonction
seule et la fonction

confirm() pour afficher à l'utilisateur une boîte de dialogue de type Oui/Non :

DWfile.getAttributes() pour déterminer si le fichier est accessible en lecture

Dernière mise à jour le 22/6/2011

RÉFÉ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é

Dreamweaver MX.

Description

Cette fonction définit les attributs système d'un fichier donné.

12

Arguments

fileURL, strAttrs

• L'argument fileURL, exprimé sous la forme d'une URL de type file://, identifie le fichier dont vous définissez les

attributs.

• L'argument strAttrs spécifie les attributs système du fichier identifié par l'argument fileURL. Le tableau suivant

décrit les valeurs d'attribut valides et leur signification :

Valeur d'attribut Description

R

W

H

V

Les valeurs acceptables pour la chaîne

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éfini comme étant accessible en écriture (
aussi l'un l'autre. Si vous les associez,

Si vous spécifiez l'attribut

H ou V sans indiquer d'attribut de lecture/écriture R ou W, l'attribut de lecture/écriture

existant pour le fichier reste inchangé. De même, si vous spécifiez l'attribut
visibilité

H ou V, l'attribut de visibilité existant pour le fichier reste inchangé.

Lecture seule

Accessible en écriture (annule R)

Masqué

Visible (annule H)

strAttrs sont R, W, H, V, RH, RV, WH ou WV.

W). N'utilisez pas H et V conjointement, car ils s'excluent

H perd tout son sens et le fichier est défini comme étant visible (V).

R ou W sans spécifier un attribut de

Valeurs renvoyées

Aucune.

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

API d'E/S des fichiers

DWfile.write()

Disponibilité

Dreamweaver 2.

Description

Cette fonction écrit la chaîne spécifiée dans le fichier spécifié. Si le fichier spécifié n'existe pas, il est créé.

Arguments

fileURL, text, {mode}

• L'argument fileURL, exprimé sous la forme d'une URL de type file://, représente le fichier dans lequel vous écrivez

une chaîne.

Remarque : Si le chemin d'accès contient des espaces, cette fonction n'écrira pas les fichiers.

• L'argument text indique la chaîne que la fonction doit écrire.

• L'argument mode, s'il est fourni, doit être append. Si cet argument est omis, la chaîne écrase le contenu du fichier.

Valeurs renvoyées

Valeur booléenne :

true si l'écriture de la chaîne dans le fichier a réussi et false dans le cas contraire.

13

Exemple

Le code suivant tente d'écrire la chaîne
l'opération d'écriture réussit. Il essaie ensuite d'annexer la chaîne

xxx dans le fichier mydata.txt et affiche un message d'avertissement si

aaa au fichier et affiche un deuxième message

d'avertissement si cette opération réussit. Après l'exécution de ce script, le fichier mydata.txt contient uniquement le

xxxaaa.

texte

var fileURL = "file:///c|/temp/mydata.txt";
if (DWfile.write(fileURL, "xxx")){

alert("Wrote xxx to " + fileURL);
}
if (DWfile.write(fileURL, "aaa", "append")){

alert("Appended aaa to " + fileURL);
}

Dernière mise à jour le 22/6/2011

Chapitre 3 : API HTTP

Les extensions ne fonctionnent pas uniquement dans le système de fichiers local. Adobe® Dreamweaver® permet
d'échanger des informations avec un serveur Web via le protocole HTTP (Hypertext Transfer Protocol). Ce chapitre
décrit l'API HTTP et son utilisation.

Fonctionnement de l'API HTTP

Toutes les fonctions de l'API HTTP sont des méthodes associées à 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éfaut pour les arguments URL est 80.
Pour spécifier un port différent, ajoutez deux points (:) et le numéro de port à la suite de l'URL, comme dans l'exemple
suivant :

MMHttp.getText("http://www.myserver.com:8025");

Pour les fonctions qui renvoient un objet, cet objet possède deux propriétés : statusCode et data.

14

La propriété

• 200 : Etat OK

• 400 : Demande inintelligible

• 404 : URL demandée introuvable

• 405 : Le serveur ne prend pas en charge la méthode demandée

• 500 : Erreur de serveur inconnue

• 503 : Capacité du serveur atteinte

Pour obtenir une liste complète des codes d'état pour votre serveur, consultez votre fournisseur d'accès Internet ou
votre administrateur système.

La valeur de la propriété
individuelles.

Les fonctions qui renvoient un objet ont également une version de rappel (« callback »). Les fonctions de rappel
permettent aux autres fonctions de s'exécuter pendant que le serveur Web traite une requête HTTP. Ceci est utile si
vous effectuez plusieurs requêtes HTTP à partir de Dreamweaver. La version de rappel d'une fonction transmet
directement son ID et sa valeur de renvoi à la fonction spécifiée sous forme de premier argument.

statusCode indique l'état de l'opération ; les valeurs possibles sont notamment :

data varie selon la fonction ; les valeurs possibles sont spécifiées dans les listes des fonctions

L'API HTTP

Cette section présente en détail les fonctions qui sont des méthodes de l'objet MMHttp.

MMHttp.clearServerScriptsFolder()

Disponibilité

Dreamweaver MX.

Dernière mise à jour le 22/6/2011

RÉFÉ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/server-
model/_mmDBScripts.

Arguments

serverScriptsfolder

• L'argument serverScriptsfolder est une chaîne qui nomme un dossier donné, en liaison avec le dossier Configuration

du serveur d'application, à partir duquel vous pouvez extraire et supprimer les scripts de serveur.

Valeurs renvoyées

Un objet représentant la réponse du serveur. La propriété
scripts supprimés. Si une erreur se produit, Dreamweaver la consigne dans la propriété

data de cet objet est une chaîne englobant le contenu des

statusCode de l'objet renvoyé.

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ée depuis un menu :

<!-- MENU-LOCATION=NONE -->
<html>
<head>
<TITLE>Clear Server Scripts</TITLE>
<SCRIPT SRC="ClearServerScripts.js"></SCRIPT>
<SCRIPT LANGUAGE="javascript">
</SCRIPT>
<body onLoad="MMHttp.clearServerScriptsFolder()">
</body>
</html>

15

MMHttp.clearTemp()

Description

Cette fonction supprime tous les fichiers du dossier Configuration/Temp situé dans le dossier de l'application
Dreamweaver.

Arguments

Aucun.

Valeurs renvoyées

Aucune.

Exemple

Le code suivant, lorsqu'il est enregistré dans un fichier du dossier Configuration/Shutdown, supprime tous les fichiers
du dossier Configuration/Temp lorsque l'utilisateur quitte Dreamweaver :

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

API HTTP

<html>
<head>
<title>Clean Up Temp Files on Shutdown</title>
</head>
<body onLoad="MMHttp.clearTemp()">
</body>
</html>

MMHttp.getFile()

Description

Cette fonction obtient le fichier situé à l'URL spécifiée et l'enregistre dans le dossier Configuration/Temp situé dans le
dossier de l'application Dreamweaver. Dreamweaver crée automatiquement des sous-dossiers qui reproduisent la
structure de dossiers du serveur ; par exemple, si le fichier spécifié 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}

16

• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqué dans l'URL, Dreamweaver

considère qu'il s'agit du protocole HTTP.

• L'argument facultatif prompt est une valeur booléenne spécifiant s'il faut inviter l'utilisateur à enregistrer le fichier.

Si saveURL est en dehors du dossier Configuration/Temp, une valeur de prompt égale à

false n'est pas prise en

compte pour des raisons de sécurité.

• L'argument facultatif saveURL est l'emplacement sur le disque dur de l'utilisateur où le fichier doit être enregistré,

exprimé 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îte de dialogue
d'enregistrement.

• L'argument facultatif titleBarLabel est le libellé qui doit figurer dans la barre de titre de la boîte de dialogue

d'enregistrement.

Valeurs renvoyées

Un objet représentant la réponse du serveur. La propriété
où le fichier a été enregistré, exprimé sous la forme d'une URL de type file://. Normalement, la propriété

data de cet objet est une chaîne contenant l'emplacement

statusCode

de l'objet contient le code d'état envoyé par le serveur. Toutefois, si une erreur de disque se produit lors de
l'enregistrement du fichier sur le lecteur local, la propriété

statusCode contient un entier représentant l'un des codes

d'erreur suivants en cas d'échec de l'opération :

• 1 : Erreur inconnue

• 2 : Fichier introuvable

• 3 : Chemin non valide

• 4 : La limite du nombre de fichiers ouverts est atteinte

• 5 : Accès refusé

• 6 : Identificateur de fichier non valide

• 7 : Impossible de supprimer le répertoire de travail en cours

• 8 : Plus d'entrées de dossier

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

API HTTP

• 9 : Erreur lors de la définition du pointeur de fichier

• 10 : Erreur matérielle

• 11 : Violation de partage

• 12 : Violation de verrouillage

• 13 : Disque saturé

• 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("http://www.dreamcentral.com/people/profiles/scott.html",
false);
if (Boolean == 200){

var saveLoc = httpReply.data;

dw.browseDocument(saveLoc);
}

17

MMHttp.getFileCallback()

Description

Cette fonction obtient le fichier situé à l'URL spécifiée, l'enregistre dans le dossier Configuration/Temp du dossier de
l'application Dreamweaver, puis appelle la fonction spécifiée avec l'ID et le résultat de la requête. Lorsque le fichier est
enregistré localement, Dreamweaver crée automatiquement des sous-dossiers qui reproduisent la structure de dossiers
du serveur ; par exemple, si le fichier spécifié 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 à appeler lorsque la requête HTTP est terminée.

• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqué dans l'URL, Dreamweaver

considère qu'il s'agit du protocole HTTP.

• L'argument facultatif prompt est une valeur booléenne spécifiant s'il faut inviter l'utilisateur à enregistrer le fichier.

Si l'argument saveURL spécifie un emplacement en dehors du dossier Configuration/Temp, une valeur de prompt

false n'est pas prise en compte pour des raisons de sécurité.

égale à

• L'argument facultatif saveURL est l'emplacement sur le disque dur de l'utilisateur où le fichier doit être enregistré,

exprimé sous la forme d'une URL de type file://. Si l'argument prompt a pour valeur
dehors du dossier Configuration/Temp, l'utilisateur peut remplacer saveURL dans la boîte de dialogue
d'enregistrement.

• L'argument facultatif titleBarLabel est le libellé qui doit figurer dans la barre de titre de la boîte de dialogue

d'enregistrement.

true ou si saveURL est en

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

API HTTP

Valeurs renvoyées

Un objet représentant la réponse du serveur. La propriété
où le fichier a été enregistré, exprimé sous la forme d'une URL de type file://. Normalement, la propriété

data de cet objet est une chaîne contenant l'emplacement

statusCode

de l'objet contient le code d'état envoyé par le serveur. Toutefois, si une erreur disque se produit lors de
l'enregistrement du fichier sur le lecteur local, la propriété

statusCode contient un nombre entier représentant un

code d'erreur. Voir « MMHttp.getFile() » à la page 16 pour une liste des codes d'erreur possibles.

MMHttp.getText()

Disponibilité

Dreamweaver UltraDev 4, amélioré dans Dreamweaver MX.

Description

Extrait le contenu du document situé à l'URL spécifiée.

Arguments

URL, {serverScriptsFolder}

• L'argument URL est une URL absolue sur un serveur Web. Si http:// n'est pas indiqué dans l'URL, Dreamweaver

considère qu'il s'agit du protocole HTTP.

• L'argument serverScriptsFolder est une chaîne facultative qui nomme un dossier spécifique, lié au dossier

Configuration du serveur d'application, à partir duquel vous souhaitez extraire les scripts de serveur. Pour extraire
les scripts, Dreamweaver utilise le protocole de transfert approprié (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été

statusCode de l'objet renvoyé.

18

MMHttp.getTextCallback()

Disponibilité

Dreamweaver UltraDev 4, amélioré dans Dreamweaver MX.

Description

Extrait le contenu du document situé à l'URL spécifiée et le transmet à la fonction spécifiée.

Arguments

callbackFunc, URL, {serverScriptsFolder}

• L'argument callbackFunc est la fonction JavaScript à appeler lorsque la requête HTTP est terminée.

• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqué dans l'URL, Dreamweaver

considère qu'il s'agit du protocole HTTP.

• L'argument serverScriptsFolder est une chaîne facultative qui nomme un dossier spécifique, lié au dossier

Configuration du serveur d'application, à partir duquel vous souhaitez extraire les scripts de serveur. Pour extraire
les scripts, Dreamweaver utilise le protocole de transfert approprié (par exemple, FTP, WebDAV ou Remote File
System). Dreamweaver extrait ces fichiers et les transmet à la fonction identifiée par callbackFunc.

Si une erreur se produit, Dreamweaver MX la consigne dans la propriété

Dernière mise à jour le 22/6/2011

statusCode de l'objet renvoyé.

RÉFÉRENCE DES API DE DREAMWEAVER

API HTTP

MMHttp.postText()

Disponibilité

Dreamweaver UltraDev 4, amélioré dans Dreamweaver MX.

Description

Exécute un envoi HTTP des données définies à l'URL spécifiée. En règle générale, les données associées à une opération
d'envoi se présentent sous la forme de texte codé en formulaire, mais il peut s'agir de tout type de donné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é dans l'URL, Dreamweaver

considère qu'il s'agit du protocole HTTP.

• L'argument dataToPost représente les données à envoyer. Si le troisième argument est "application/x-www-

form-urlencoded" ou s'il n'est pas spécifié, dataToPost doit être codé en formulaire conformément à la section

8.2.1 de la spécification RFC 1866 (disponible à l'adresse www.faqs.org/rfcs/rfc1866.html).

• L'argument facultatif contentType est le type de contenu des données à envoyer. S'il n'est pas spécifié, il prend par

défaut la valeur

• L'argument serverScriptsFolder est une chaîne facultative qui nomme un dossier spécifique, lié au dossier

Configuration du serveur d'application, vers lequel vous souhaitez envoyer les données. Pour envoyer les données,
Dreamweaver utilise le protocole de transfert approprié (par exemple, FTP, WebDAV ou Remote File System).

Si une erreur se produit, Dreamweaver la consigne dans la propriété

"application/x-www-form-urlencoded".

statusCode de l'objet renvoyé.

19

Exemple

Dans l'exemple suivant d'appel de la fonction

MMHttp.postText(), supposons qu'un développeur a placé le fichier

myScripts.cfm dans un dossier nommé DeployScripts, qui se trouve dans le dossier Configuration sur l'ordinateur
local :

MMHttp.postText(

"http://ultraqa8/DeployScripts/myScripts.cfm",

"arg1=Foo",

"application/x-www-form-urlencoded",

"Configuration/DeployScripts/"
)

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é dans un autre

dossier nommé DeployScripts, qui constitue un sous-dossier du dossier racine du site Web ultraqa8. Pour déployer
les fichiers, Dreamweaver utilise le protocole spécifié dans les propriétés de configuration du site.

2 Dreamweaver utilise le protocole HTTP pour envoyer les données arg1=Foo vers le serveur Web.

3

En réponse à la requête d'envoi, le serveur Web sur ultraqa8 exécute le script myScripts.cfm à l'aide des données arg1.

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

API HTTP

MMHttp.postTextCallback()

Disponibilité

Dreamweaver UltraDev 4, amélioré dans Dreamweaver MX.

Description

Exécute un envoi HTTP du texte à l'URL spécifiée et transmet la réponse du serveur à la fonction spécifiée. En règle
générale, les données associées à une opération d'envoi se présentent sous la forme de texte codé en formulaire, mais
il peut s'agir de tout type de données que le serveur peut accepter.

Arguments

callbackFunc, URL, dataToPost, {contentType}, {serverScriptsFolder}

• L'argument callbackFunc est le nom de la fonction JavaScript à appeler lorsque la requête HTTP est terminée.

• L'argument URL est une URL absolue sur un serveur Web ; si http:// n'est pas indiqué dans l'URL, Dreamweaver

considère qu'il s'agit du protocole HTTP.

• L'argument dataToPost représente les données à envoyer. Si le troisième argument est "application/x-www-

form-urlencoded" ou s'il n'est pas spécifié, data doit être codé en formulaire conformément à la section 8.2.1 de

la spécification RFC 1866 (disponible à l'adresse www.faqs.org/rfcs/rfc1866.html).

• L'argument facultatif contentType correspond au type de contenu des données à envoyer. S'il n'est pas spécifié, il

prend par défaut la valeur

• L'argument serverScriptsFolder est une chaîne facultative. Il nomme un dossier donné, en liaison avec le dossier

Configuration du serveur d'application sur lequel vous voulez envoyer les données. Pour envoyer les données,
Dreamweaver utilise le protocole de transfert approprié (par exemple, FTP, WebDAV ou Remote File System).
Dreamweaver extrait ces données et les transmet à la fonction identifiée par callbackFunc.

Si une erreur se produit, Dreamweaver la consigne dans la propriété

"application/x-www-form-urlencoded".

statusCode de l'objet renvoyé.

20

Dernière mise à jour le 22/6/2011

Chapitre 4 : API de Design Notes

Adobe® Dreamweaver® , Adobe® Fireworks® et Adobe® Flash® offrent aux concepteurs et développeurs Web une méthode
permettant de stocker et de récupérer des informations supplémentaires sur les documents. Ces informations sont
stockées dans des fichiers baptisés « Design Notes ». Il peut s'agir d'informations supplé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é Design Notes dans Dreamweaver, consultez le manuel
Utilisation de Dreamweaver.

Fonctionnement des Design Notes

Chaque fichier Design Notes stocke des informations relatives à un seul document. Si un fichier Design Notes est
associé à un ou plusieurs documents dans un dossier, Dreamweaver cré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être
Site, mais ils s'affichent dans le Finder Macintosh ou dans l'Explorateur Windows. Un nom de fichier Design Notes est
composé du nom du fichier principal suivi de l'extension .mno. Par exemple, le fichier Design Notes associé à
avocado8.gif est avocado8.gif.mno.

21

Les fichiers Design Notes sont des fichiers XML stockant des informations sous la forme d'une série de paires
clé/valeur. La clé décrit le type des informations stockées et la valeur représente les informations. Les clés sont limitées
à 64 caractères.

L'exemple suivant illustre le fichier Design Notes associé au fichier foghorn.gif.mno :

<?xml version="1.0" encoding="iso-8859-1" ?>
<info>

<infoitem key="FW_source" value="file:///C|sites/dreamcentral/images/sourceFiles/¬

foghorn.png" />
<infoitem key="Author" value="Heidi B." />
<infoitem key="Status" value="Final draft, approved by Jay L." />

</info>

L'API JavaScript de Design Notes

Toutes les fonctions de l'API JavaScript de Design Notes sont des méthodes associées à l'objet MMNotes. MMNotes
est une bibliothèque C partagée qui permet aux auteurs d'extensions de lire et d'écrire dans les fichiers Design Notes.
Tout comme la bibliothèque partagée DWfile, MMNotes comprend une API JavaScript qui permet d'appeler les
fonctions. Ces fonctions sont appelées à partir d'objets, de commandes, de comportements, de panneaux flottants,
d'inspecteurs Propriétés et de traducteurs de données dans la bibliothèque. La bibliothèque partagée MMNotes peut
être utilisée indépendamment de Dreamweaver, que celui-ci soit installé ou non.

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

API de Design Notes

MMNotes.close()

Description

Cette fonction ferme le fichier Design Notes spécifié et enregistre les modifications éventuelles. Si toutes les paires
clé/valeur ont été supprimées, Dreamweaver supprime le fichier Design Notes. S'il s'agit du dernier fichier Design
Notes dans le dossier _notes, Dreamweaver supprime également le dossier.

22

Remarque : Appelez toujours la fonction
Dreamweaver écrive dans le fichier.

Arguments

fileHandle

MMNotes.close() une fois le travail sur les Design Notes terminé, afin que

• L'argument fileHandle est l'identificateur de fichier renvoyé par la fonction MMNotes.open().

Valeurs renvoyées

Aucune.

Exemple

Voir « MMNotes.set() » à la page 26.

MMNotes.filePathToLocalURL()

Description

Cette fonction convertit le chemin d'accès du lecteur local spécifié en une URL de type file://.

Arguments

drivePath

• L'argument drivePath est une chaîne contenant le chemin d'accès complet du lecteur.

Valeurs renvoyées

Une chaîne contenant l'URL de type file:// du fichier spécifié.

Exemple

Un appel à la fonction

"file:///c|sites/webdev/index.htm".

MMNotes.filePathToLocalURL('C:/sites/webdev/index.htm') renvoie

MMNotes.get()

Description

Cette fonction obtient la valeur de la clé spécifiée dans le fichier Design Notes indiqué.

Arguments

fileHandle, keyName

• L'argument fileHandle est l'identificateur de fichier renvoyé par MMNotes.open().

• L'argument keyName est une chaîne contenant le nom de la clé.

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

API de Design Notes

Valeurs renvoyées

Une chaîne contenant la valeur de la clé.

Exemple

Voir « MMNotes.getKeys() » à la page 23.

MMNotes.getKeyCount()

Description

Cette fonction obtient le nombre de paires clé/valeur du fichier Design Notes spécifié.

Arguments

fileHandle

• L'argument fileHandle est l'identificateur de fichier renvoyé par la fonction MMNotes.open().

Valeurs renvoyées

Un nombre entier représentant le nombre de paires clé/valeur du fichier Design Notes spécifié.

23

MMNotes.getKeys()

Description

Cette fonction renvoie une liste de toutes les clés d'un fichier Design Notes.

Arguments

fileHandle

• L'argument fileHandle est l'identificateur de fichier renvoyé par la fonction MMNotes.open().

Valeurs renvoyées

Un tableau de chaînes, chacune d'elles contenant le nom d'une clé.

Exemple

Le code suivant peut être utilisé dans un panneau flottant personnalisé afin d'afficher les informations Design Notes
relatives au document actif :

var noteHandle = MMNotes.open(dw.getDocumentDOM().URL);
var theKeys = MMNotes.getKeys(noteHandle);
var noteString = "";
var theValue = "";
for (var i=0; i < theKeys.length; i++){

theValue = MMNotes.get(noteHandle,theKeys[i]);
noteString +=0theKeys[i] + " = " theValue + "\n";

}
document.theForm.bigTextField.value = noteString;
// always close noteHandle
MMNotes.close(noteHandle);

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

API de Design Notes

MMNotes.getSiteRootForFile()

Description

Cette fonction détermine la racine du site pour le fichier Design Notes spécifié.

Arguments

fileURL

• L'argument fileURL, exprimé sous la forme d'une URL de type file://, est le chemin d'un fichier local.

Valeurs renvoyées

Une chaîne contenant le chemin du dossier racine local pour le site, exprimé sous la forme d'une URL de type file://,
ou une chaîne vide si Dreamweaver n'est pas installé ou si le fichier Design Notes se trouve en dehors de tout site défini
par Dreamweaver. Cette fonction recherche tous les sites définis dans Dreamweaver.

MMNotes.getVersionName()

Description

Cette fonction renvoie le nom de version de la bibliothèque partagée MMNotes indiquant l'application qui l'a
implémentée.

24

Arguments

Aucun.

Valeurs renvoyées

Une chaîne contenant le nom de l'application qui a implémenté la bibliothèque partagée MMNotes.

Exemple

L'appel de la fonction
inspecteur Propriétés, d'un panneau flottant ou d'un traducteur de données Dreamweaver renvoie
L'appel de la fonction

"Dreamweaver" étant donné que Fireworks utilise la même version de la bibliothèque (celle qui a été créée par l'équipe

technique de Dreamweaver).

MMNotes.getVersionName() à partir d'une commande, d'un objet, d'un comportement, d'un

"Dreamweaver".

MMNotes.getVersionName() à partir de Fireworks renvoie également la valeur

MMNotes.getVersionNum()

Description

Cette fonction obtient le numéro de version de la bibliothèque partagée MMNotes.

Arguments

Aucun.

Valeurs renvoyées

Une chaîne contenant le numéro de version.

Dernière mise à jour le 22/6/2011

RÉFÉRENCE DES API DE DREAMWEAVER

API de Design Notes

MMNotes.localURLToFilePath()

Description

Cette fonction convertit l'URL de type file:// spécifiée en un chemin d'accès du lecteur local.

Arguments

fileURL

• L'argument fileURL, exprimé sous la forme d'une URL de type file://, est le chemin d'un fichier local.

Valeurs renvoyées

Une chaîne contenant le chemin d'accès du lecteur local pour le fichier spécifié.

Exemple

Un appel à la fonction

"MacintoshHD:images:moon.gif".

MMNotes.localURLToFilePath('file:///MacintoshHD/images/moon.gif') renvoie

MMNotes.open()

25

Description

Cette fonction ouvre le fichier Design Notes associé au fichier spécifié ou crée un fichier Design Notes s'il n'en existe pas.

Arguments

filePath, {bForceCreate}

• L'argument filePath, exprimé sous la forme d'une URL de type file://, est le chemin du fichier principal auquel le

fichier Design Notes est associé.

• L'argument bForceCreate est une valeur booléenne indiquant si la note doit être créée même si la fonctionnalité

Design Notes est désactivée pour le site ou si l'argument filePath n'est associé à aucun site.

Valeurs renvoyées

L'identificateur du fichier Design Notes ou zéro (0) si le fichier n'a pas été ouvert ni créé.

Exemple

Voir « MMNotes.set() » à la page 26.

MMNotes.remove()

Description

Cette fonction supprime la clé spécifiée (et sa valeur) du fichier Design Notes indiqué.

Arguments

fileHandle, keyName

• L'argument fileHandle est l'identificateur de fichier renvoyé par la fonction MMNotes.open().

• L'argument keyName est une chaîne contenant le nom de la clé à supprimer.

Dernière mise à jour le 22/6/2011