ADOBE Dreamweaver API CS5 User Manual [de]

ADOBE® DREAMWEAVER® CS5 & CS5.5

API-Referenzhandbuch

Rechtliche Hinweise

Rechtliche Hinweise

Rechtliche Hinweise finden Sie unter http://help.adobe.com/de_DE/legalnotices/index.html.

Letzte Aktualisierung 22.6.2011

Inhalt

Kapitel 1: Einführung

Erweiterungen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Erweitern von Dreamweaver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Weitere Ressourcen für das Programmieren von Erweiterungen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Neue Funktionen in Dreamweaver CS5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

In diesem Handbuch verwendete Konventionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Kapitel 2: API für Datei-E/A

Konfigurationsordner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Funktionen der API für Datei-E/A . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Kapitel 3: HTTP-API

Funktionsweise der HTTP-API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Funktionen der HTTP-API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Kapitel 4: API für Design Notes

Funktionsweise von Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

JavaScript-API für Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

C-API für Design Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

iii

Kapitel 5: Fireworks-Integration

FWLaunch-API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Kapitel 6: Flash-Integration

API für Flash-Objekte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Funktionen für Flash-Bedienfelder und Flash-Dialogfelder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Kapitel 7: Photoshop-Integration

Funktionsweise von Smart Objekten . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

API für Smart Objekte . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Kapitel 8: API für Datenbanken

Funktionsweise der API für Datenbanken . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Funktionen für Datenbankverbindungen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Funktionen für den Datenbankzugriff . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Kapitel 9: API für Datenbankverbindungen

Auswählen eines neuen Verbindungstyps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Erstellen eines neuen Verbindungstyps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

API für Verbindungen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Generierte Include-Datei . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Definitionsdatei für den Verbindungstyp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Inhalt

Kapitel 10: API zur Integration der Quellcodeverwaltung

Funktionsweise der Integration der Quellcodeverwaltung in Dreamweaver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Hinzufügen von Quellcode-Verwaltungssystemfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Erforderliche Funktionen der API zur Integration der Quellcodeverwaltung . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Optionale Funktionen der API zur Integration der Quellcodeverwaltung . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Enabler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Kapitel 11: Anwendung

Funktionen für externe Anwendungen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111

Globale Anwendungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120

Bridge-Kommunikationsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Kapitel 12: Arbeitsbereich

Verlaufsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Funktionen zum Einfügen von Objekten . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136

Tastaturfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Menüfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Ergebnisfenster-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148

Umschaltfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

Symbolleistenfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Fensterfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Funktionen für die Informationsleiste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196

Funktionen für zugehörige Dateien . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Funktionen für die vertikal geteilte Ansicht . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

Funktionen für das Ausblenden von Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212

Symbolleistenfunktionen der Codeansicht . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

Farbfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

iv

Kapitel 13: Site

Berichtfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Site-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

Kapitel 14: Dokument

Konvertierungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

Befehlsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259

Dateibearbeitungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

Globale Dokumentfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275

Pfadfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283

Auswahlfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

Stringbearbeitungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307

Übersetzungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311

XSLT-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313

Kapitel 15: Seiteninhalt

Funktionen für das Bedienfeld „Elemente“ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316

Verhaltensfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324

Zwischenablagefunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332

Bibliotheks- und Vorlagenfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Inhalt

Funktionen für das Bedienfeld „Codefragmente“ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342

Bearbeitungsfunktionen für Spry-Widgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

Einfügen von Spry-Widget-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348

Funktionen für die Browserkompatibilitätsprüfung . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351

Kapitel 16: Dynamische Dokumente

Funktionen für Serverkomponenten . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359

Datenquellenfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360

Extension Data Manager-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361

Live Data-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364

Live-Ansichtsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368

Serververhalten-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380

Servermodell-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382

Kapitel 17: Entwurf

CSS-Layoutfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389

Funktionen für Frames und Framesets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412

Funktionen für Ebenen und Imagemaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

Funktionen für die Layout-Umgebung . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416

Funktionen für die Layoutansicht . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422

Funktionen für die Auflösungsverwaltung . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428

Medienabfrage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430

Zoom-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431

Funktionen und Eigenschaften für Hilfslinien . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435

Funktionen zum Bearbeiten von Tabellen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 442

v

Kapitel 18: Code

Codefunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452

Funktionen zum Suchen und Ersetzen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457

Allgemeine Bearbeitungsfunktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463

Druckfunktion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479

Funktionen für den Quick Tag Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480

Funktionen für die Codeansicht . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482

Funktionen für die Live-Codeansicht . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500

Funktionen für Tag-Editor und Tag-Bibliothek . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501

Kapitel 19: Enabler

Enabler-Funktionen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506

Letzte Aktualisierung 22.6.2011

Kapitel 1: Einführung

Im Adobe Dreamweaver CS5 API-Referenzhandbuch werden die Anwendungsprogrammierschnittstellen (APIs)
beschrieben. Mit APIs können Sie während der Entwicklung von Adobe® Dreamweaver® CS5-Erweiterungen und
beim Hinzufügen von Programmcode zu Dreamweaver-Webseiten verschiedene unterstützende Aufgaben ausführen.
Eine der wichtigsten APIs ist die JavaScript-API, die Zugriff auf die meisten Kernfunktionen von Dreamweaver bietet.
Unter die Kernfunktionen von Dreamweaver fallen generell alle menügesteuerten Aktionen. Hinzu kommen
verschiedene Dienstprogramm-APIs für gängige Aufgaben wie das Schreiben und Lesen von Dateien, die
Datenübertragung mit HTTP und die Kommunikation mit Fireworks und Flash.

Mit der umfangreichen JavaScript-API können Sie vielfältige kleinere Aufgaben erledigen. Dabei handelt es sich in der
Mehrzahl um Arbeitsschritte, die ein Benutzer i. d. R. beim Erstellen oder Bearbeiten von Dreamweaver-Dokumenten
ausführt. Diese API-Funktionen sind nach den betreffenden Komponenten der Dreamweaver-Benutzeroberfläche
gruppiert. So umfasst die JavaScript-API beispielsweise Arbeitsbereichfunktionen, Dokumentfunktionen,
Designfunktionen usw. Mit den API-Funktionen können Sie einige der folgenden Aufgaben und vieles mehr
ausführen:

• Öffnen neuer Dokumente

• Abrufen oder Festlegen einer Schriftgröße

• Suchen nach einem Suchstring im HTML-Code

• Sichtbarmachen von Symbolleisten

1

Erweiterungen

In diesem Buch wird davon ausgegangen, dass Sie Kenntnisse in Dreamweaver, HTML, XML, der JavaScript­Programmierung und eventuell der Programmierung in C haben. Wenn Sie Erweiterungen zum Erstellen von
Webanwendungen programmieren, sollten Sie auch mit serverbasierten Skripts auf mindestens einer Plattform
vertraut sein, z. B. Active Server Pages (ASP), ASP.NET, PHP: Hypertext Preprocessor (PHP), Adobe ColdFusion oder
Java Server Pages (JSP).

Erweitern von Dreamweaver

Weitere Informationen über das Dreamweaver-Framework und die API zur Erstellung von Dreamweaver­Erweiterungen finden Sie im Handbuch Dreamweaver erweitern. Im Handbuch Dreamweaver erweitern werden die
API-Funktionen beschrieben, die Dreamweaver zur Implementierung von Objekten, Menüs, schwebenden
Bedienfeldern, Serververhalten usw. aufruft, welche die verschiedenen Funktionen von Dreamweaver umfassen.
Mithilfe dieser APIs können Sie dem Produkt Objekte, Menüs, schwebende Bedienfelder oder andere Funktionen
hinzufügen. Im Handbuch Dreamweaver erweitern wird darüber hinaus erläutert, wie Sie Dreamweaver an Ihre
spezifischen Anforderungen anpassen. Durch das Bearbeiten und Hinzufügen von Tags zu verschiedenen HTML- und
XML-Dateien können Sie beispielsweise Menüelemente oder Dokumenttypen hinzufügen.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Einführung

Weitere Ressourcen für das Programmieren von Erweiterungen

Wenn Sie sich mit anderen Entwicklern austauschen möchten, die ebenfalls Erweiterungen erstellen, können Sie der
Dreamweaver Extensibility Newsgroup beitreten. Die Website für diese Newsgroup befindet sich unter

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

Neue Funktionen in Dreamweaver CS5

Die folgenden neuen Funktionen wurden der JavaScript-API von Dreamweaver CS5 hinzugefügt. Die Überschriften
beziehen sich auf die Kapitel und Abschnitte, die die neuen Funktionen enthalten.

Dynamische Dokumente

Die folgenden Funktionen wurden zum Kapitel „Dynamische Dokumente“ hinzugefügt.

Live-Ansichtsfunktionen

„dom.setLiveViewFollowsLinks()“ auf Seite 371

2

„dom.getLiveViewFollowsLinks()“ auf Seite 372

„dom.isLiveViewBrowsingHomeURI()“ auf Seite 372

„dreamweaver.findSiteForURI()“ auf Seite 373

„dom.browser.isPageNavigationHistoryEnabled()“ auf Seite 374

„dom.browser.enablePageNavigationHistory()“ auf Seite 375

„dom.browser.getPageNavigationHistoryLength()“ auf Seite 375

„dom.browser.getPageNavigationHistoryPosition()“ auf Seite 375

„dom.browser.goToPageNavigationHistoryPosition()“ auf Seite 376

„dom.browser.getPageNavigationHistoryItem()“ auf Seite 376

„dom.browser.setHomePage()“ auf Seite 377

„dom.browser.getHomePage()“ auf Seite 377

Arbeitsbereich

Die folgenden neuen Funktionen wurden zum Kapitel „Arbeitsbereich“ hinzugefügt.

Funktionen für zugehörige Dateien

„dreamweaver.getRelatedFilesFilter()“ auf Seite 198

„dreamweaver.setRelatedFilesFilter()“ auf Seite 198

„dreamweaver.getQuickRelatedFilesFilterStrings()“ auf Seite 198

„dreamweaver.invokeRelatedFilesCustomFilterDialog()“ auf Seite 199

„dreamweaver.getDynamicRelatedFilesDiscoverySetting()“ auf Seite 199

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Einführung

„dreamweaver.setDynamicRelatedFilesDiscoverySetting()“ auf Seite 200

„dreamweaver.refreshRelatedFiles()“ auf Seite 200

„dreamweaver.saveAllRelatedFiles()“ auf Seite 201

„dreamweaver.canSaveAllRelatedFiles()“ auf Seite 201

„document.isRelatedFileViewOpen()“ auf Seite 201

„document.getRelatedFiles()“ auf Seite 202

„document.addRelatedFile()“ auf Seite 203

„document.removeRelatedFile()“ auf Seite 203

„document.getDependentFiles()“ auf Seite 204

... und weitere.

Dokument

Die folgenden neuen Funktionen wurden zum Kapitel „Dokument“ hinzugefügt.

„DWUri.isValidURI()“ auf Seite 286

3

„DWUri.isAbsolute()“ auf Seite 287

„DWUri.isRelative()“ auf Seite 287

„DWUri.isDirectory()“ auf Seite 287

„DWUri.isHierarchical()“ auf Seite 288

„DWUri.isOfType()“ auf Seite 288

„DWUri.isOfFileType()“ auf Seite 288

... und weitere.

Code

Die folgenden neuen Funktionen wurden zum Kapitel „Code“ hinzugefügt.

„dom.getLiveCodeHighlightsChanges()“ auf Seite 500

„dom.setLiveCodeHighlightsChanges()“ auf Seite 500

... und weitere.

In diesem Handbuch verwendete Konventionen

Typografische Konventionen

In diesem Handbuch werden die folgenden typografischen Konventionen verwendet:

• Codeschrift kennzeichnet Codefragmente und API-Literale, z. B. Klassennamen, Methodennamen,

Funktionsnamen, Typnamen, Skripts, SQL-Anweisungen, HTML- und XML-Tag-Namen sowie Attributnamen.

• Kursive Codeschrift kennzeichnet Platzhalterelemente im Code.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Einführung

• Das Fortsetzungssymbol (¬) weist darauf hin, dass ein langer Code über mehrere Zeilen umbrochen wurde. Da die

Zeilenlänge in diesem Handbuch durch die im Format festgelegten Ränder begrenzt ist, muss Code, der eigentlich
fortlaufend ist, auf mehrere Zeilen verteilt werden. Löschen Sie beim Kopieren der Codezeilen das
Fortsetzungssymbol und geben Sie die Zeilen ohne Umbruch ein.

• Geschweifte Klammern ({ }), die ein Argument einschließen, weisen darauf hin, dass es sich um ein optionales

Argument handelt.

• Funktionsnamen mit dem Präfix dreamweaver.Funktionsname können beim Programmieren von Code als

dw.Funktionsname abgekürzt werden. In diesem Handbuch wird das ausführliche Präfix dreamweaver. bei der

Definition der Funktion und im Index verwendet. In vielen Beispielen wird jedoch das kürzere Präfix

dw.

verwendet.

Namengebungskonventionen

Folgende Namengebungskonventionen werden in diesem Handbuch verwendet:

• Sie – die Person, die für das Programmieren von Erweiterungen verantwortlich ist (also der Entwickler).

• Der Benutzer – die Person, die Dreamweaver verwendet.

4

Letzte Aktualisierung 22.6.2011

Kapitel 2: API für Datei-E/A

Adobe® Dreamweaver® CS5 enthält eine gemeinsam genutzte C-Bibliothek mit dem Namen „DWfile“. Mithilfe von
DWfile können Autoren von Objekten, Befehlen, Verhalten, Datenübersetzern, schwebenden Bedienfeldern und
Eigenschafteninspektoren im lokalen Dateisystem Dateien lesen und schreiben. In diesem Kapitel werden die API für
Datei-E/A und deren Verwendung erläutert.

Allgemeine Informationen über das Zusammenwirken von C-Bibliotheken mit dem JavaScript-Interpreter in
Dreamweaver finden Sie in Dreamweaver erweitern unter „C-Level-Erweiterbarkeit“.

Konfigurationsordner

Unter Microsoft Windows 2000, Windows XP und Mac OS X verfügen die Benutzer über eigene Kopien der
Konfigurationsdateien. Wenn Dreamweaver in eine Konfigurationsdatei schreibt, übernimmt Dreamweaver diese
Änderung in den Ordner „Configuration“ des Benutzers. Auch beim Lesen einer Konfigurationsdatei sucht
Dreamweaver zunächst im Ordner „Configuration“ des Benutzers und erst dann im Ordner „Configuration“ von
Dreamweaver. DWfile-Funktionen arbeiten nach dem gleichen Prinzip. Wenn also Ihre Erweiterung eine Datei im
Dreamweaver-Ordner „Configuration“ schreibt oder liest, greift sie dabei auch auf den Ordner „Configuration“ des
Benutzers zu. Weitere Informationen zu Konfigurationsordnern in Mehrbenutzersystemen finden Sie im Handbuch
Dreamweaver erweitern.

5

Funktionen der API für Datei-E/A

Alle Funktionen der API für Datei-E/A sind Methoden des Objekts DWfile.

DWfile.copy()

Verfügbarkeit

Dreamweaver 3.

Beschreibung

Diese Funktion kopiert die angegebene Datei an einen neuen Ort.

Argumente

originalURL, copyURL

• Das Argument originalURL ist die Datei, die Sie kopieren möchten, im URL-Format „file://“.

• Das Argument copyURL ist der Speicherort, an dem Sie die kopierte Datei speichern möchten, im URL-Format

„file://“.

Rückgabewerte

Ein boolescher Wert:

true, wenn der Kopiervorgang erfolgreich ist, andernfalls false.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datei-E/A

Beispiel

Der folgende Code kopiert die Datei „myconfig.cfg“ nach „myconfig_backup.cfg“:

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

DWfile.createFolder()

Verfügbarkeit

Dreamweaver 2.

Beschreibung

Diese Funktion erstellt einen Ordner am angegebenen Ort.

Argumente

folderURL

• Das Argument folderURL ist der Speicherort des Ordners, den Sie erstellen möchten, im URL-Format „file://“.

6

Rückgabewerte

Ein boolescher Wert:

true, wenn der Ordner erfolgreich erstellt wurde, andernfalls false.

Beispiel

Der folgende Code erstellt den Ordner „tempFolder“ im Stammverzeichnis von Laufwerk C: und teilt in einem
Dialogfeld mit, ob der Vorgang erfolgreich ausgeführt wurde:

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

alert("Created " + folderURL);

}else{

alert("Unable to create " + folderURL);

}

DWfile.exists()

Verfügbarkeit

Dreamweaver 2.

Beschreibung

Diese Funktion prüft das Vorhandensein einer bestimmten Datei.

Argumente

fileURL

• Das Argument fileURL ist die angeforderte Datei im URL-Format „file://“.

Rückgabewerte

Ein boolescher Wert:

true, wenn die Datei vorhanden ist, andernfalls false.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datei-E/A

Beispiel

Der folgende Code sucht die Datei „mydata.txt“ und teilt in einer Meldung mit, ob sie vorhanden ist:

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

alert(fileURL + " exists!");

}else{

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

}

DWfile.getAttributes()

Verfügbarkeit

Dreamweaver 2.

Beschreibung

Diese Funktion ruft die Attribute der angegebenen Datei bzw. des angegebenen Ordners ab.

Argumente

fileURL

7

• Das Argument fileURL ist die Datei oder der Ordner, für die bzw. den Sie Attribute abrufen möchten, im URL-

Format „file://“.

Rückgabewerte

Ein String, der die Attribute der angegebenen Datei bzw. des angegebenen Ordners darstellt. Existiert die Datei oder
der Ordner nicht, gibt die Funktion den Wert

null zurück. Die Attribute werden durch folgende Zeichen im String

dargestellt:

• R (schreibgeschützt)

• D (Ordner)

• H (verborgen)

• S (Systemdatei oder Ordner)

Beispiel

Der folgende Code fragt die Attribute der Datei „mydata.txt“ ab und zeigt eine Warnmeldung an, falls die Datei
schreibgeschützt ist:

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()

Verfügbarkeit

Dreamweaver 2.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datei-E/A

Beschreibung

Diese Funktion fragt den Zeitpunkt der letzten Änderung einer Datei ab.

Argumente

fileURL

• Das Argument fileURL ist die Datei, deren Zeitpunkt der letzten Änderung Sie überprüfen, im URL-Format

„file://“.

Rückgabewerte

Ein String mit einer hexadezimalen Zahl, die die Anzahl der seit dem Ausgangszeitpunkt verstrichenen Zeiteinheiten
angibt. Die jeweilige Bedeutung der Zeiteinheiten und des Ausgangszeitpunkts hängt von der verwendeten Plattform
ab. So beträgt in Windows eine Zeiteinheit 100 ns und als Ausgangszeitpunkt wird der 1. Januar 1600 verwendet.

Beispiel

Sie sollten die Funktion zweimal aufrufen und die Rückgabewerte vergleichen, da der Rückgabewert dieser Funktion
plattformabhängig ist und keine direkt lesbaren Datums- und Uhrzeitwerte darstellt. Der folgende Code fragt das
Änderungsdatum von „file1.txt“ und „file2.txt“ ab und zeigt eine Meldung an, in der angegeben wird, welche der
beiden Dateien aktueller ist:

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()

Verfügbarkeit

Dreamweaver 4.

Beschreibung

Diese Funktion fragt den Zeitpunkt ab, zu der die Datei erstellt wurde.

Argumente

fileURL

• Das Argument fileURL ist die Datei, deren Zeitpunkt der Erstellung Sie überprüfen, im URL-Format „file://“.

Rückgabewerte

Ein String mit einer hexadezimalen Zahl, die die Anzahl der seit dem Ausgangszeitpunkt verstrichenen Zeiteinheiten
angibt. Die jeweilige Bedeutung der Zeiteinheiten und des Ausgangszeitpunkts hängt von der verwendeten Plattform
ab. So beträgt in Windows eine Zeiteinheit 100 ns und als Ausgangszeitpunkt wird der 1. Januar 1600 verwendet.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datei-E/A

Beispiel

Sie können diese Funktion und die Funktion

DWfile.getModificationDate() aufrufen, um das Änderungsdatum

einer Datei mit ihrem Erstelldatum zu vergleichen:

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()

Verfügbarkeit

Dreamweaver MX.

Beschreibung

Diese Funktion ruft das JavaScript-Objekt für den Zeitpunkt ab, zu dem die Datei erstellt wurde.

9

Argumente

fileURL

• Das Argument fileURL ist die Datei, deren Zeitpunkt der Erstellung Sie überprüfen, im URL-Format „file://“.

Rückgabewerte

Ein JavaScript

Date-Objekt für Datum und Uhrzeit der Erstellung einer Datei.

DWfile.getModificationDateObj()

Verfügbarkeit

Dreamweaver MX.

Beschreibung

Diese Funktion ruft das JavaScript

Argumente

fileURL

• Das Argument fileURL ist die Datei, deren Zeitpunkt der letzten Änderung Sie überprüfen, im URL-Format

„file://“.

Rückgabewerte

Ein JavaScript

Date-Objekt für Datum und Uhrzeit der letzten Änderung an einer Datei.

Date-Objekt für den Zeitpunkt der letzten Änderung an einer Datei ab.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datei-E/A

DWfile.getSize()

Verfügbarkeit

Dreamweaver MX.

Beschreibung

Diese Funktion ruft die Größe einer Datei ab.

Argumente

fileURL

• Das Argument fileURL ist die Datei, deren Größe Sie überprüfen, im URL-Format „file://“.

Rückgabewerte

Eine Ganzzahl für die tatsächliche Größe (in Byte) einer Datei.

DWfile.listFolder()

10

Verfügbarkeit

Dreamweaver 2.

Beschreibung

Diese Funktion erstellt eine Liste mit dem Inhalt des angegebenen Ordners.

Argumente

folderURL, {constraint}

• Das Argument folderURL ist der Ordner, für den Sie eine Inhaltsliste erstellen möchten, im URL-Format „file://“

gefolgt von einem optionalen Dateimasken-Platzhalter. Gültige Platzhalter sind Sternchen (*) für ein oder mehrere
Zeichen und Fragezeichen (?) für ein Zeichen.

• Das Argument constraint, falls angegeben, muss entweder "files" (nur Dateien zurückgeben) oder

"directories" (nur Ordner zurückgeben) lauten. Falls das Argument nicht angegeben wird, werden sowohl

Dateien als auch Ordner berücksichtigt.

Rückgabewerte

Ein String-Array mit den einzelnen Elementen des Ordners.

Beispiel

Der folgende Code erstellt eine Liste aller Textdateien (TXT) im Ordner „C:/temp“. Die Liste wird in einer Meldung
angezeigt:

var folderURL = "file:///c|/temp";
var fileMask = "*.txt";
var list = DWfile.listFolder(folderURL + "/" + fileMask, "files");
if (list){

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

}

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datei-E/A

DWfile.read()

Verfügbarkeit

Dreamweaver 2.

Beschreibung

Diese Funktion liest den Inhalt der angegebenen Datei und schreibt ihn in einen String.

Argumente

fileURL

• Das Argument fileURL ist die Datei, die Sie lesen möchten, im URL-Format „file://“.

Rückgabewerte

Ein String, in dem sich der Inhalt der Datei befindet, oder der Wert

Beispiel

Der folgende Code liest die Datei „mydata.txt“ und zeigt bei einem erfolgreichen Lesevorgang eine Meldung mit dem
Inhalt der Datei an:

null, wenn der Lesevorgang fehlgeschlagen ist.

11

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

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

}

DWfile.remove()

Verfügbarkeit

Dreamweaver 3.

Beschreibung

Diese Funktion löscht die angegebene Datei.

Argumente

fileURL

• Das Argument fileURL ist die Datei, die Sie entfernen möchten, im URL-Format „file://“.

Rückgabewerte

Ein boolescher Wert:

Beispiel

Im folgenden Beispiel wird mit

confirm() ein Ja/Nein-Dialogfeld in der Benutzeroberfläche angezeigt:

true, wenn der Vorgang erfolgreich ist, andernfalls false.

DWfile.getAttributes() ermittelt, ob eine Datei schreibgeschützt ist, und mit

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datei-E/A

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()

Verfügbarkeit

Dreamweaver MX.

Beschreibung

Diese Funktion legt die Attribute auf Systemebene für eine bestimmte Datei fest.

12

Argumente

fileURL, strAttrs

• Das Argument fileURL identifiziert die Datei, für die Sie die Attribute festlegen, im URL-Format „file://“.

• Das Argument strAttrs legt die Attribute auf Systemebene für die von fileURL bezeichnete Datei fest. In der

folgenden Tabelle sind gültige Attributwerte und ihre Bedeutungen aufgeführt:

Attributwert Beschreibung

R

W

H

V

Gültige Werte für den

R und W schließen sich gegenseitig aus und sollten daher nicht gemeinsam verwendet werden. Werden sie in der

Kombination eingesetzt, wird

H und V schließen sich gegenseitig aus. Wenn Sie sie kombinieren, wird H außer Kraft gesetzt und die Datei wird

auf sichtbar (

Legen Sie

V) gesetzt.

H oder V ohne das Lese-/Schreibattribut R oder W fest, bleibt das aktuelle Lese-/Schreibattribut der Datei

unverändert. Wenn Sie

strAttrs-String sind R, W, H, V, RH, RV, WH und WV.

R außer Kraft gesetzt und der Schreibschutz für die Datei wird aufgehoben (W). Auch

R oder W festlegen, ohne das Attribut H oder V anzugeben, wird das aktuelle

Schreibgeschützt

Kein Schreibschutz (überschreibt R)

Verborgen

Sichtbar (überschreibt H)

Sichtbarkeitsattribut der Datei nicht geändert.

Rückgabewerte

Keine.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datei-E/A

DWfile.write()

Verfügbarkeit

Dreamweaver 2.

Beschreibung

Diese Funktion schreibt den festgelegten String in die angegebene Datei. Wenn die angegebene Datei noch nicht
vorhanden ist, wird sie erstellt.

Argumente

fileURL, text, {mode}

• Das Argument fileURL ist die Datei, in die Sie schreiben, im URL-Format „file://“.

Hinweis: Wenn der Pfad Leerzeichen enthält, werden mit dieser Funktion keine Dateien geschrieben.

• Das Argument text gibt den zu schreibenden String an.

• Als mode-Argument (falls angegeben) muss append verwendet werden. Falls dieses Argument nicht angegeben

wird, überschreibt der String den Dateiinhalt.

13

Rückgabewerte

Ein boolescher Wert:

true bei erfolgreichem Schreibvorgang, andernfalls false.

Beispiel

Der folgende Code schreibt den String
Schreibvorgang eine Meldung aus. Anschließend wird der String

xxx in die Datei „mydata.txt“ und gibt nach einem erfolgreichen

aaa an den Dateiinhalt angehängt. Wenn dieser

Vorgang erfolgreich verläuft, wird eine zweite Meldung ausgegeben. Nach Ausführung des Skripts enthält die Datei
„mydata.txt“ lediglich den Text

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);
}

xxxaaa.

Letzte Aktualisierung 22.6.2011

Kapitel 3: HTTP-API

Die Einsatzmöglichkeiten der Erweiterungen beschränken sich nicht auf das lokale Dateisystem. Adobe®
Dreamweaver® bietet einen Mechanismus, mit dem über HTTP (Hypertext Transfer Protocol) Informationen von
einem Webserver abgerufen bzw. an diesen gesendet werden können. In diesem Kapitel werden die HTTP-API und
deren Verwendung erläutert.

Funktionsweise der HTTP-API

Alle Funktionen der HTTP-API sind Methoden des Objekts MMHttp. Bei den meisten dieser Funktionen wird als
Argument eine URL verwendet und die meisten geben ein Objekt zurück. Als Standardanschluss für URL-Argumente
wird Anschluss 80 verwendet. Wenn Sie einen anderen Anschluss verwenden möchten, fügen Sie einen Doppelpunkt
und die Nummer des Anschlusses an die URL an, wie im folgenden Beispiel gezeigt:

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

Bei Funktionen, die ein Objekt zurückgeben, verfügt das Objekt über zwei Eigenschaften: statusCode und data.

14

Die Eigenschaft

• 200: Status OK

• 400: Unverständliche Anforderung

• 404: Angeforderte URL nicht gefunden

• 405: Server unterstützt angeforderte Methode nicht

• 500: Unbekannter Serverfehler

• 503: Serverkapazität erreicht

Eine umfassende Liste der Statuscodes für Ihren Server erhalten Sie bei Ihrem Internetdienstanbieter oder
Systemadministrator.

Der Wert der Eigenschaft
Funktionsbeschreibungen angegeben.

Funktionen, die ein Objekt zurückgeben, sind jeweils auch in einer sogenannten Callback-Version vorhanden. Bei
Callback-Funktionen können andere Funktionen ausgeführt werden, während der Webserver eine HTTP­Anforderung bearbeitet. Dies ist dann nützlich, wenn Sie in Dreamweaver mehrere HTTP-Anforderungen ausgeben.
Die Callback-Version einer Funktion übergibt ihre ID und ihren Rückgabewert direkt an die als ihr erstes Argument
definierte Funktion.

statusCode gibt den Status der Operation an. Mögliche Werte sind unter anderem:

data ist von der jeweiligen Funktion abhängig. Die möglichen Werte sind bei den einzelnen

Funktionen der HTTP-API

In diesem Abschnitt werden die Funktionen, bei denen es sich um Methoden des Objekts MMHttp handelt, ausführlich
erläutert.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

HTTP-API

MMHttp.clearServerScriptsFolder()

Verfügbarkeit

Dreamweaver MX.

Beschreibung

Löscht den Ordner „_mmServerScripts“ und alle darin enthaltenen Dateien im Stammordner der aktuellen lokalen
Site oder Remote-Site. Der Ordner „_mmServerScripts“ befindet sich im Ordner
„Configuration/Connections/Scripts/Servermodell/_mmDBScripts“.

Argumente

serverScriptsfolder

• serverScriptsfolder ist ein String, der einen bestimmten Ordner relativ zum Ordner „Configuration“ auf dem

Anwendungsserver bezeichnet, von dem Sie Serverskripts abrufen und löschen möchten.

Rückgabewerte

Ein Objekt, das die Antwort vom Server repräsentiert. Die Eigenschaft
Inhalt der gelöschten Skripts. Wenn ein Fehler auftritt, zeigt Dreamweaver diesen in der Eigenschaft
zurückgegebenen Objekts an.

data dieses Objekts ist ein String mit dem

statusCode des

15

Beispiel

Wenn der folgende Code in einer Menübefehlsdatei im Ordner „Configuration/Menus“ steht, entfernt er beim Aufruf
über ein Menü alle Dateien aus dem Ordner „_mmServerScripts“:

<!-- 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>

MMHttp.clearTemp()

Beschreibung

Diese Funktion löscht alle Dateien aus dem Ordner „Configuration/Temp“, der sich im Anwendungsordner von
Dreamweaver befindet.

Argumente

Keine.

Rückgabewerte

Keine.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

HTTP-API

Beispiel

Wenn der folgende Code als Datei im Ordner „Configuration/Shutdown“ gespeichert wird, werden beim Beenden von
Dreamweaver alle Dateien aus dem Ordner „Configuration/Temp“ gelöscht:

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

MMHttp.getFile()

Beschreibung

Diese Funktion ruft die Datei unter der angegebenen URL ab und speichert sie im Ordner „Configuration/Temp“, der
sich im Anwendungsordner von Dreamweaver befindet. Dreamweaver erstellt automatisch Unterordner, durch die
die Ordnerstruktur des Servers nachgeahmt wird. Lautet der angegebene Pfad beispielsweise
„www.dreamcentral.com/people/index.html“, speichert Dreamweaver die Datei „index.html“ im Unterordner
„People“ des Ordners „www.dreamcentral.com“.

16

Argumente

URL, {prompt}, {saveURL}, {titleBarLabel}

• Das Argument URL ist eine absolute URL auf einem Webserver. Wenn http:// in der URL nicht angegeben wird,

geht Dreamweaver davon aus, dass HTTP verwendet wird.

• Das optionale Argument prompt ist ein boolescher Wert, der angibt, ob der Benutzer zum Speichern der Datei

aufgefordert wird. Wenn sich saveURL auf einen Speicherort außerhalb des Ordners „Configuration/Temp“
bezieht, wird beim Argument prompt der Wert

false aus Sicherheitsgründen ignoriert.

• Das optionale Argument saveURL ist der Speicherort auf der Festplatte des Benutzers, an dem die Datei gespeichert

werden soll (im URL-Format „file://“). Wenn für „prompt“ der Wert

true definiert wurde oder sich saveURL auf

einen Speicherort außerhalb des Ordners „Configuration/Temp“ bezieht, kann der Benutzer saveURL im
Dialogfeld „Speichern“ überschreiben.

• Das optionale Argument titleBarLabel ist die Bezeichnung, die in der Titelleiste des Dialogfelds „Speichern“

angezeigt werden soll.

Rückgabewerte

Ein Objekt, das die Antwort vom Server repräsentiert. Die Eigenschaft
Speicherort der Datei enthält (im URL-Format „file://“). Normalerweise enthält die Eigenschaft

data dieses Objekts ist ein String, der den

statusCode des

Objekts den vom Server empfangenen Statuscode. Wenn jedoch beim Speichern auf dem lokalen Laufwerk ein
Datenträgerfehler aufgetreten ist und der Vorgang nicht erfolgreich ausgeführt werden kann, enthält die Eigenschaft

statusCode einen Fehlercode in Form eines der folgenden ganzzahligen Werte:

• 1: Unbekannter Fehler

• 2: Datei nicht gefunden

• 3: Ungültiger Pfad

• 4: Zu viele Dateien geöffnet

• 5: Zugriff verweigert

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

HTTP-API

• 6: Ungültiges Datei-Handle

• 7: Aktueller Arbeitsordner kann nicht entfernt werden

• 8: Keine weiteren Ordnereinträge

• 9: Fehler beim Setzen des Dateizeigers

• 10: Hardwarefehler

• 11: Zugriffsverletzung

• 12: Sperrverletzung

• 13: Festplatte voll

• 14: Dateiende erreicht

Beispiel

Mit dem folgenden Code wird zunächst eine HTML-Datei abgerufen. Dann werden alle Dateien im Ordner
„Configuration/Temp“ gespeichert und die lokale Kopie der HTML-Datei wird in einem Browser geöffnet:

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()

Beschreibung

Diese Funktion ruft die Datei unter der angegebenen URL ab, speichert die Datei im Ordner „Configuration/Temp“
innerhalb des Anwendungsordners von Dreamweaver und ruft anschließend die angegebene Funktion mit der
Anforderungs-ID und dem Antwortergebnis auf. Wenn die Datei lokal gespeichert wird, erstellt Dreamweaver
automatisch Unterordner, durch die die Ordnerstruktur des Servers nachgeahmt wird. Lautet der angegebene Pfad
beispielsweise „www.dreamcentral.com/people/index.html“, speichert Dreamweaver die Datei „index.html“ im
Unterordner „People“ des Ordners „www.dreamcentral.com“.

Argumente

callbackFunction, URL, {prompt}, {saveURL}, {titleBarLabel}

• Das Argument callbackFunction ist der Name der JavaScript-Funktion, die nach erfolgter HTTP-Anfrage

aufgerufen werden soll.

• Das Argument URL ist eine absolute URL auf einem Webserver. Wenn http:// in der URL nicht angegeben wird,

geht Dreamweaver davon aus, dass HTTP verwendet wird.

• Das optionale Argument prompt ist ein boolescher Wert, der angibt, ob der Benutzer zum Speichern der Datei

aufgefordert wird. Wenn sich saveURL auf einen Speicherort außerhalb des Ordners „Configuration/Temp“
bezieht, wird beim Argument prompt der Wert

• Das optionale Argument saveURL ist der Speicherort auf der Festplatte des Benutzers, an dem die Datei gespeichert

werden soll (im URL-Format „file://“). Wenn für „prompt“ der Wert
einen Speicherort außerhalb des Ordners „Configuration/Temp“ bezieht, kann der Benutzer saveURL im
Dialogfeld „Speichern“ überschreiben.

false aus Sicherheitsgründen ignoriert.

true definiert wurde oder sich saveURL auf

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

HTTP-API

• Das optionale Argument titleBarLabel ist die Bezeichnung, die in der Titelleiste des Dialogfelds „Speichern“

angezeigt werden soll.

Rückgabewerte

Ein Objekt, das die Antwort vom Server repräsentiert. Die Eigenschaft
Speicherort der Datei enthält (im URL-Format „file://“). Normalerweise enthält die Eigenschaft

data dieses Objekts ist ein String, der den

statusCode des

Objekts den vom Server empfangenen Statuscode. Wenn jedoch beim Speichern auf dem lokalen Laufwerk ein
Datenträgerfehler aufgetreten ist, enthält die Eigenschaft

statusCode einen ganzzahligen Fehlercode. Eine Liste der

möglichen Fehlercodes finden Sie unter „MMHttp.getFile()“ auf Seite 16.

MMHttp.getText()

Verfügbarkeit

Dreamweaver UltraDev 4, verbessert in Dreamweaver MX.

Beschreibung

Ruft den Inhalt des Dokuments unter der angegebenen URL ab.

18

Argumente

URL, {serverScriptsFolder}

• Das Argument URL ist eine absolute URL auf einem Webserver. Wenn http:// in der URL nicht angegeben wird,

geht Dreamweaver davon aus, dass HTTP verwendet wird.

• Das Argument serverScriptsFolder ist ein optionaler String, der einen bestimmten Ordner relativ zum Ordner

„Configuration“ auf dem Anwendungsserver bezeichnet, von dem Sie Serverskripts abrufen möchten. Zum
Abrufen der Skripts verwendet Dreamweaver das entsprechende Übertragungsprotokoll (z. B. FTP, WebDAV oder
Remote-Dateisystem). Dreamweaver kopiert diese Dateien in den Unterordner „_mmServerScripts“ im
Stammordner der aktuellen Site.

Wenn ein Fehler auftritt, zeigt Dreamweaver diesen in der Eigenschaft

statusCode des zurückgegebenen Objekts an.

MMHttp.getTextCallback()

Verfügbarkeit

Dreamweaver UltraDev 4, verbessert in Dreamweaver MX.

Beschreibung

Ruft den Inhalt des Dokuments unter der angegebenen URL ab und übergibt ihn an die angegebene Funktion.

Argumente

callbackFunc, URL, {serverScriptsFolder}

• Das Argument callbackFunc ist die JavaScript-Funktion, die nach erfolgter HTTP-Anfrage aufgerufen werden soll.

• Das Argument URL ist eine absolute URL auf einem Webserver. Wenn http:// in der URL nicht angegeben wird,

geht Dreamweaver davon aus, dass HTTP verwendet wird.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

HTTP-API

• Das Argument serverScriptsFolder ist ein optionaler String, der einen bestimmten Ordner relativ zum Ordner

„Configuration“ auf dem Anwendungsserver bezeichnet, von dem Sie Serverskripts abrufen möchten. Zum
Abrufen der Skripts verwendet Dreamweaver das entsprechende Übertragungsprotokoll (z. B. FTP, WebDAV oder
Remote-Dateisystem). Dreamweaver ruft diese Dateien ab und übergibt sie an die Funktion, die durch
callbackFunc angegeben wird.

Wenn ein Fehler auftritt, zeigt Dreamweaver MX diesen in der Eigenschaft

statusCode

des zurückgegebenen Objekts an.

MMHttp.postText()

Verfügbarkeit

Dreamweaver UltraDev 4, verbessert in Dreamweaver MX.

Beschreibung

Führt einen HTTP-Sendevorgang durch, um die angegebenen Daten an die angegebene URL zu übertragen. In der
Regel handelt es sich dabei um formularkodierten Text, doch kann mit der Funktion jeder beliebige Datentyp
übertragen werden, den der Server erwartet.

Argumente

URL, dataToPost, {contentType}, {serverScriptsFolder}

19

• Das Argument URL ist eine absolute URL auf einem Webserver. Wenn http:// in der URL nicht angegeben wird,

geht Dreamweaver davon aus, dass HTTP verwendet wird.

• Das Argument dataToPost gibt die zu sendenden Daten an. Wenn das dritte Argument "application/x-www-

form-urlencoded" lautet oder weggelassen wird, muss das Argument dataToPost gemäß Abschnitt 8.2.1 der

Spezifikation RFC 1866 (zu finden unter www.faqs.org/rfcs/rfc1866.html) formularkodiert sein.

• Das optionale Argument contentType bezeichnet den Inhaltstyp der Daten, die durch das post-Verfahren

übertragen werden sollen. Bei fehlendem Argument wird als Standardwert

urlencoded" verwendet.

"application/x-www-form-

• Das Argument serverScriptsFolder ist ein optionaler String, der einen bestimmten Ordner relativ zum Ordner

„Configuration“ auf dem Anwendungsserver bezeichnet, auf den Sie Daten übertragen möchten. Zum Senden der
Daten verwendet Dreamweaver das entsprechende Übertragungsprotokoll (z. B. FTP, WebDAV oder Remote­Dateisystem).

Wenn ein Fehler auftritt, zeigt Dreamweaver diesen in der Eigenschaft

statusCode des zurückgegebenen Objekts an.

Beispiel

Im folgenden Beispiel für einen

MMHttp.postText()-Funktionsaufruf wird davon ausgegangen, dass ein Entwickler

die Datei „myScripts.cfm“ im Ordner „DeployScripts“ abgelegt hat, der sich im Ordner „Configuration“ des lokalen
Computers befindet:

MMHttp.postText(

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

"arg1=Foo",

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

"Configuration/DeployScripts/"
)

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

HTTP-API

Sobald Dreamweaver diesen Funktionsaufruf ausführt, läuft Folgendes ab:

1 Die Datei „myScripts.cfm“ im Ordner „Configuration/DeployScripts“ des lokalen Computers wird in einen

anderen Ordner „DeployScripts“ kopiert, der ein Unterordner des Stammordners der Website „ultraqa8“ ist. Zum
Bereitstellen der Dateien verwendet Dreamweaver das bei der Konfiguration der Site angegebene Protokoll.

2 Dreamweaver verwendet das HTTP-Protokoll, um die arg1=Foo-Daten an den Webserver zu übertragen.

3 Das Ergebnis der Übertragungsanfrage ist, dass der Webserver von „ultraqa8“ das Skript „myScripts.cfm“ unter

Verwendung der

arg1-Daten ausführt.

MMHttp.postTextCallback()

Verfügbarkeit

Dreamweaver UltraDev 4, verbessert in Dreamweaver MX.

Beschreibung

Führt einen HTTP-Sendevorgang durch, um den Text an die angegebene URL zu übertragen, und übergibt die
Antwort vom Server an die angegebene Funktion. In der Regel handelt es sich dabei um formularkodierten Text, doch
kann mit der Funktion jeder beliebige Datentyp übertragen werden, den der Server erwartet.

20

Argumente

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

• Das Argument callbackFunc ist der Name der JavaScript-Funktion, die nach erfolgter HTTP-Anfrage aufgerufen

werden soll.

• Das Argument URL ist eine absolute URL auf einem Webserver. Wenn http:// in der URL nicht angegeben wird,

geht Dreamweaver davon aus, dass HTTP verwendet wird.

• Das Argument dataToPost gibt die zu sendenden Daten an. Wenn das dritte Argument "application/x-www-

form-urlencoded" lautet oder weggelassen wird, muss das Argument data gemäß Abschnitt 8.2.1 der

Spezifikation RFC 1866 (zu finden unter www.faqs.org/rfcs/rfc1866.html) formularkodiert sein.

• Das optionale Argument contentType bezeichnet den Inhaltstyp der Daten, die durch das post-Verfahren

übertragen werden sollen. Bei fehlendem Argument wird als Standardwert

urlencoded" verwendet.

"application/x-www-form-

• serverScriptsFolder ist ein optionaler String. Er bezeichnet einen bestimmten Ordner relativ zum Ordner

„Configuration“ auf dem Anwendungsserver, an den Sie Daten senden möchten. Zum Senden der Daten
verwendet Dreamweaver das entsprechende Übertragungsprotokoll (z. B. FTP, WebDAV oder Remote­Dateisystem). Dreamweaver ruft diese Daten ab und übergibt sie an die Funktion, die durch callbackFunc
angegeben wird.

Wenn ein Fehler auftritt, zeigt Dreamweaver diesen in der Eigenschaft

statusCode des zurückgegebenen Objekts an.

Letzte Aktualisierung 22.6.2011

Kapitel 4: API für Design Notes

Mit Adobe® Dreamweaver®, Adobe® Fireworks® und Adobe® Flash® haben Webdesigner und Webentwickler die
Möglichkeit, zusätzliche Informationen über Dokumente zu speichern und abzurufen. Diese Informationen sind in
Dateien gespeichert, die als „Design Notes“ bezeichnet werden. Zu diesen Informationen zählen
Revisionskommentare, Änderungshinweise oder die Quelldateien für GIF- oder JPEG-Dateien.

Weitere Informationen zur Verwendung von Design Notes in Dreamweaver finden Sie in der Dokumentation
Dreamweaver verwenden.

Funktionsweise von Design Notes

In jeder Design Notes-Datei sind Informationen zu einem einzigen Dokument gespeichert. Wenn mit einem oder
mehreren Dokumenten in einem Ordner eine Design Notes-Datei verknüpft ist, erstellt Dreamweaver einen
Unterordner mit dem Namen „_notes“, in dem Design Notes-Dateien gespeichert werden können. Der Ordner
„_notes“ und die darin enthaltenen Design Notes-Dateien werden im Bedienfeld „Dateien“ nicht angezeigt, jedoch im
Finder (Macintosh) bzw. in Windows Explorer. Design Notes-Dateinamen bestehen aus dem Hauptdateinamen und
der Erweiterung „.mno“. Die Design Notes-Datei für die Datei „avocado8.gif“ trägt beispielsweise den Namen
„avocado8.gif.mno“.

21

Design Notes-Dateien sind XML-Dateien, in denen Informationen in einer Folge von Schlüssel-Wert-Paaren
gespeichert sind. Der Schlüssel beschreibt den gespeicherten Informationstyp und der Wert stellt die eigentlichen
Informationen dar. Schlüssel können höchstens 64 Zeichen lang sein.

Im folgenden Beispiel ist die Design Notes-Datei für die Datei „foghorn.gif.mno“ dargestellt:

<?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>

JavaScript-API für Design Notes

Alle Funktionen der JavaScript-API für Design Notes sind Methoden des MMNotes-Objekts. MMNotes ist eine
gemeinsam genutzte C-Bibliothek, mit deren Hilfe die Autoren von Erweiterungen Design Notes-Dateien lesen und
schreiben können. Wie die gemeinsam genutzte Bibliothek DWfile verfügt auch MMNotes über eine JavaScript-API,
über die Sie die Funktionen aufrufen können. Die Funktionen werden über Objekte, Befehle, Verhalten, schwebende
Bedienfelder, Eigenschafteninspektoren und Datenübersetzer der Bibliothek aufgerufen. Die gemeinsam genutzte
Bibliothek MMNotes kann unabhängig von Dreamweaver verwendet werden, selbst wenn Dreamweaver nicht
installiert ist.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Design Notes

MMNotes.close()

Beschreibung

Diese Funktion schließt die angegebene Design Notes-Datei und speichert alle Änderungen. Wenn alle Schlüssel­Wert-Paare entfernt wurden, löscht Dreamweaver die Design Notes-Datei. Wenn es sich um die letzte Design Notes­Datei im Ordner „_notes“ handelt, wird auch der Ordner gelöscht.

22

Hinweis: Rufen Sie nach Verwendung von Design Notes immer die Funktion
Dreamweaver das Schreiben in die Datei abschließt.

Argumente

fileHandle

MMNotes.close() auf, damit

• Das Argument fileHandle ist das von der Funktion MMNotes.open() zurückgegebene Datei-Handle.

Rückgabewerte

Keine.

Beispiel

Siehe „MMNotes.set()“ auf Seite 26.

MMNotes.filePathToLocalURL()

Beschreibung

Diese Funktion wandelt den angegebenen lokalen Laufwerkspfad in das URL-Format „file://“ um.

Argumente

drivePath

• Das Argument drivePath ist ein String, der den vollständigen Laufwerkspfad enthält.

Rückgabewerte

Ein String mit der URL der angegebenen Datei im URL-Format „file://“.

Beispiel

Beim Aufruf von

"file:///c|/sites/webdev/index.htm" zurückgegeben.

MMNotes.filePathToLocalURL('C:\sites\webdev\index.htm') wird der String

MMNotes.get()

Beschreibung

Diese Funktion ruft den Wert des angegebenen Schlüssels in einer Design Notes-Datei ab.

Argumente

fileHandle, keyName

• Das Argument fileHandle ist das von MMNotes.open() zurückgegebene Datei-Handle.

• Das Argument keyName ist ein String, der den Namen des Schlüssels enthält.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Design Notes

Rückgabewerte

Ein String mit dem Wert des Schlüssels.

Beispiel

Siehe „MMNotes.getKeys()“ auf Seite 23.

MMNotes.getKeyCount()

Beschreibung

Diese Funktion ruft die Anzahl der Schlüssel-Wert-Paare in der angegebenen Design Notes-Datei ab.

Argumente

fileHandle

• Das Argument fileHandle ist das von der Funktion MMNotes.open() zurückgegebene Datei-Handle.

Rückgabewerte

Eine Ganzzahl, die die Anzahl der Schlüssel-Wert-Paare in der Design Notes-Datei angibt.

23

MMNotes.getKeys()

Beschreibung

Diese Funktion ruft eine Liste sämtlicher Schlüssel in einer Design Notes-Datei ab.

Argumente

fileHandle

• Das Argument fileHandle ist das von der Funktion MMNotes.open() zurückgegebene Datei-Handle.

Rückgabewerte

Ein String-Array, in dem jeder String den Namen eines Schlüssels enthält.

Beispiel

Der folgende Code kann in einem benutzerdefinierten schwebenden Bedienfeld verwendet werden, um die
Design Notes-Informationen für das aktive Dokument anzuzeigen.

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);

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Design Notes

MMNotes.getSiteRootForFile()

Beschreibung

Diese Funktion ermittelt den Stammordner für die angegebene Design Notes-Datei.

Argumente

fileURL

• Das Argument fileURL im URL-Format „file://“ ist der Pfad zu einer lokalen Datei.

Rückgabewerte

Ein String, der den Pfad des lokalen Stammordners der Site enthält (im URL-Format „file://“) oder der leer ist, wenn
Dreamweaver nicht installiert ist oder die Design Notes-Datei sich außerhalb einer mit Dreamweaver definierten Site
befindet. Diese Funktion sucht nach allen Sites, die in Dreamweaver definiert sind.

MMNotes.getVersionName()

Beschreibung

Diese Funktion ruft den Versionsnamen der gemeinsam genutzten Bibliothek MMNotes ab, der gleichzeitig die
implementierende Anwendung angibt.

24

Argumente

Keine.

Rückgabewerte

Ein String mit dem Namen der Anwendung, von der die gemeinsam genutzte Bibliothek MMNotes implementiert
wurde.

Beispiel

Wenn die Funktion
Eigenschafteninspektor, ein schwebendes Bedienfeld oder einen Datenübersetzer in Dreamweaver aufgerufen wurde,
wird der String
Fireworks wird ebenfalls
vom Dreamweaver-Entwicklungsteam erstellt wurde.

MMNotes.getVersionName() über einen Befehl, ein Objekt, ein Verhalten, einen

"Dreamweaver" zurückgegeben. Durch Aufrufen der Funktion MMNotes.getVersionName() über

"Dreamweaver" zurückgegeben, da Fireworks dieselbe Bibliotheksversion verwendet, die

MMNotes.getVersionNum()

Beschreibung

Diese Funktion ruft die Versionsnummer der gemeinsam genutzten Bibliothek MMNotes ab.

Argumente

Keine.

Rückgabewerte

Ein String, der die Versionsnummer enthält.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Design Notes

MMNotes.localURLToFilePath()

Beschreibung

Diese Funktion wandelt den im URL-Format „file://“ angegebenen Pfad in einen lokalen Laufwerkspfad um.

Argumente

fileURL

• Das Argument fileURL im URL-Format „file://“ ist der Pfad zu einer lokalen Datei.

Rückgabewerte

Ein String, der den lokalen Laufwerkspfad für die angegebene Datei enthält.

Beispiel

Beim Aufruf von

"MacintoshHD:images:moon.gif" zurückgegeben.

MMNotes.localURLToFilePath('file:///MacintoshHD/images/moon.gif') wird der String

MMNotes.open()

25

Beschreibung

Diese Funktion öffnet die der angegebenen Datei zugeordnete Design Notes-Datei oder erstellt sie gegebenenfalls.

Argumente

filePath, {bForceCreate}

• Das Argument filePath im URL-Format „file://“ ist der Pfad zur Hauptdatei, mit der die Design Notes-Datei

verknüpft ist.

• Das Argument bForceCreate ist ein boolescher Wert, der angibt, ob die Design Notes-Datei auch dann erstellt

werden soll, wenn Design Notes für die Site deaktiviert ist oder wenn filePath mit keiner Site verknüpft ist.

Rückgabewerte

Das Datei-Handle für die Design Notes-Datei oder Null (0), wenn die Datei nicht geöffnet oder erstellt wurde.

Beispiel

Siehe „MMNotes.set()“ auf Seite 26.

MMNotes.remove()

Beschreibung

Diese Funktion entfernt den angegebenen Schlüssel (und seinen Wert) aus einer Design Notes-Datei.

Argumente

fileHandle, keyName

• Das Argument fileHandle ist das von der Funktion MMNotes.open() zurückgegebene Datei-Handle.

• Das Argument keyName ist ein String, der den Namen des zu entfernenden Schlüssels enthält.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Design Notes

Rückgabewerte

Ein boolescher Wert:

true, wenn der Vorgang erfolgreich war, andernfalls false.

MMNotes.set()

Beschreibung

Diese Funktion erstellt oder aktualisiert ein Schlüssel-Wert-Paar in einer Design Notes-Datei.

Argumente

fileHandle, keyName, valueString

• Das Argument fileHandle ist das von der Funktion MMNotes.open() zurückgegebene Datei-Handle.

• Das Argument keyName ist ein String, der den Namen des Schlüssels enthält.

• Das Argument valueString ist ein String, der den Wert enthält.

Rückgabewerte

Ein boolescher Wert:

true, wenn der Vorgang erfolgreich war, andernfalls false.

26

Beispiel

Mit dem folgenden Beispielcode wird die mit der Site „dreamcentral“ verknüpfte Design Notes-Datei
„peakhike99/index.html“ geöffnet, dieser Datei ein neues Schlüssel-Wert-Paar hinzugefügt, der Wert eines
vorhandenen Schlüssels geändert und dann die Design Notes-Datei geschlossen.

var noteHandle = MMNotes.open('file:///c|/sites/dreamcentral/peakhike99/

index.html',true);

if(noteHandle > 0){

MMNotes.set(noteHandle,"Author","M. G. Miller");
MMNotes.set(noteHandle,"Last Changed","August 28, 1999");
MMNotes.close(noteHandle);

}

C-API für Design Notes

Neben der JavaScript-API enthält die gemeinsam genutzte Bibliothek MMNotes auch eine C-API, über die andere
Anwendungen Design Notes-Dateien erstellen können. Wenn Sie die Bibliothek MMNotes in Dreamweaver
verwenden, müssen Sie diese C-Funktionen nicht direkt aufrufen, da sie von den entsprechenden JavaScript­Versionen der Funktionen aufgerufen werden.

In diesem Abschnitt werden die Funktionen sowie deren Argumente und Rückgabewerte beschrieben. Sie finden die
Definition der Funktionen und Datentypen in der Datei „MMInfo.h“ im Ordner „Extending/c_files“ des
Anwendungsordners von Dreamweaver.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Design Notes

void CloseNotesFile()

Beschreibung

Diese Funktion schließt die angegebene Design Notes-Datei und speichert alle Änderungen. Wenn alle Schlüssel­Wert-Paare aus der Design Notes-Datei entfernt wurden, wird die Datei in Dreamweaver gelöscht. Dreamweaver
löscht den Ordner „_notes“, nachdem die letzte Design Notes-Datei gelöscht wurde.

Argumente

noteHandle

• Das Argument noteHandle ist das von der Funktion OpenNotesFile() zurückgegebene Datei-Handle.

Rückgabewerte

Keine.

BOOL FilePathToLocalURL()

Beschreibung

Diese Funktion wandelt den angegebenen lokalen Laufwerkspfad in das URL-Format „file://“ um.

27

Argumente

const char* drivePath, char* localURLBuf, int localURLMaxLen

• Das Argument drivePath ist ein String, der den vollständigen Laufwerkspfad enthält.

• Das Argument localURLBuf ist der Puffer, in dem der URL-String „file://“ gespeichert wird.

• Das Argument localURLMaxLen ist die maximale Größe von localURLBuf.

Rückgabewerte

Ein boolescher Wert:
den Wert des URL-Strings „file://“.

true, wenn der Vorgang erfolgreich war, andernfalls false. Das Argument localURLBuf erhält

BOOL GetNote()

Beschreibung

Diese Funktion ruft den Wert des angegebenen Schlüssels in einer Design Notes-Datei ab.

Argumente

FileHandle noteHandle, const char keyName[64], char* valueBuf, int valueBufLength

• Das Argument noteHandle ist das von der Funktion OpenNotesFile() zurückgegebene Datei-Handle.

• Das Argument keyName[64] ist ein String, der den Namen des Schlüssels enthält.

• Das Argument valueBuf ist der Puffer, in dem der Wert gespeichert wird.

• Das Argument valueBufLength ist die Ganzzahl, die von GetNoteLength(noteHandle, keyName) zurückgegeben

wird und die maximale Länge des Wertepuffers angibt.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Design Notes

Rückgabewerte

Ein boolescher Wert:

true, wenn der Vorgang erfolgreich war, andernfalls false. Das Argument valueBuf erhält den

Wert des Schlüssels.

Beispiel

Mit dem folgenden Code wird der Wert des Schlüssels

comments in der mit der Datei „welcome.html“ verknüpften

Design Notes-Datei abgerufen.

FileHandle noteHandle = OpenNotesFile("file:///c|/sites/avocado8/iwjs/welcome.html");
if(noteHandle > 0){

int valueLength = GetNoteLength( noteHandle, "comments");
char* valueBuffer = new char[valueLength + 1];
GetNote(noteHandle, "comments", valueBuffer, valueLength + 1);
printf("Comments: %s",valueBuffer);
CloseNotesFile(noteHandle);

}

int GetNoteLength()

Beschreibung

Diese Funktion ruft die Länge des Werts für den angegebenen Schlüssel ab.

28

Argumente

FileHandle noteHandle, const char keyName[64]

• Das Argument noteHandle ist das von der Funktion OpenNotesFile() zurückgegebene Datei-Handle.

• Das Argument keyName[64] ist ein String, der den Namen des Schlüssels enthält.

Rückgabewerte

Eine Ganzzahl, die die Länge des Werts angibt.

Beispiel

Siehe „BOOL GetNote()“ auf Seite 27.

int GetNotesKeyCount()

Beschreibung

Diese Funktion ruft die Anzahl der Schlüssel-Wert-Paare in der angegebenen Design Notes-Datei ab.

Argumente

FileHandle noteHandle

• Das Argument noteHandle ist das von der Funktion OpenNotesFile() zurückgegebene Datei-Handle.

Rückgabewerte

Eine Ganzzahl, die die Anzahl der Schlüssel-Wert-Paare in der Design Notes-Datei angibt.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Design Notes

BOOL GetNotesKeys()

Beschreibung

Diese Funktion ruft eine Liste sämtlicher Schlüssel in einer Design Notes-Datei ab.

Argumente

FileHandle noteHandle, char* keyBufArray[64], int keyArrayMaxLen

• Das Argument noteHandle ist das von OpenNotesFile() zurückgegebene Datei-Handle.

• Das Argument keyBufArray[64] ist das Puffer-Array, in dem die Schlüssel gespeichert werden.

• Das Argument keyArrayMaxLen ist die von GetNotesKeyCount(noteHandle) zurückgegebene Ganzzahl, die die

maximale Anzahl von Elementen im Schlüsselpuffer-Array angibt.

Rückgabewerte

Ein boolescher Wert:
die Schlüsselnamen.

Beispiel

Mit dem folgenden Code werden die Schlüsselnamen und -werte sämtlicher Schlüssel in der Design Notes-Datei
ausgegeben, die mit der Datei „welcome.html“ verknüpft ist.

true, wenn der Vorgang erfolgreich war, andernfalls false. Das Argument keyBufArray erhält

29

typedef char[64] InfoKey;
FileHandle noteHandle = OpenNotesFile("file:///c|/sites/avocado8/iwjs/welcome.html");
if (noteHandle > 0){

int keyCount = GetNotesKeyCount(noteHandle);
if (keyCount <= 0)

return;
InfoKey* keys = new InfoKey[keyCount];
BOOL succeeded = GetNotesKeys(noteHandle, keys, keyCount);

if (succeeded){

for (int i=0; i < keyCount; i++){

printf("Key is: %s\n", keys[i]);
printf("Value is: %s\n\n", GetNote(noteHandle, keys[i]);

}
}
delete []keys;

}
CloseNotesFile(noteHandle);

BOOL GetSiteRootForFile()

Beschreibung

Diese Funktion ermittelt den Stammordner für die angegebene Design Notes-Datei.

Argumente

const char*filePath, char*siteRootBuf, intsiteRootBufMaxLen, {InfoPrefs* infoPrefs}

• Das Argument filePath im URL-Format „file://“ ist die Datei, deren Stammordner ermittelt werden soll.

• Das Argument siteRootBuf ist der Puffer, in dem der Stammordner gespeichert wird.

• Das Argument siteRootBufMaxLen ist die maximale Größe des Puffers, auf den siteRootBuf verweist.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Design Notes

• Das optionale Argument infoPrefs ist ein Verweis auf eine struct, in der die Voreinstellungen für die Site

gespeichert werden.

Rückgabewerte

Ein boolescher Wert:

true, wenn der Vorgang erfolgreich war, andernfalls false. Das Argument siteRootBuf erhält

die Adresse des Puffers, in dem der Stammordner gespeichert wird. Wenn Sie das Argument infoPrefs angeben,
werden auch die Design Notes-Voreinstellungen für die Site zurückgegeben.

bUseDesignNotes und bUploadDesignNotes, beide vom Typ BOOL.

InfoPrefs verfügt über zwei Variablen:

BOOL GetVersionName()

Beschreibung

Diese Funktion ruft den Versionsnamen der gemeinsam genutzten Bibliothek MMNotes ab, der gleichzeitig die
implementierende Anwendung angibt.

Argumente

char* versionNameBuf, intversionNameBufMaxLen

• Das Argument versionNameBuf ist der Puffer, in dem der Versionsname gespeichert wird.

• Das Argument versionNameBufMaxLen ist die maximale Größe des Puffers, auf den das Argument

versionNameBuf verweist.

30

Rückgabewerte

Ein boolescher Wert:

"Dreamweaver" im Argument versionNameBuf.

true, wenn der Vorgang erfolgreich war, andernfalls false. Dreamweaver speichert

BOOL GetVersionNum()

Beschreibung

Diese Funktion ruft die Versionsnummer der gemeinsam genutzten Bibliothek MMNotes ab, sodass Sie ermitteln
können, ob bestimmte Funktionen verfügbar sind.

Argumente

char* versionNumBuf, intversionNumBufMaxLen

• Das Argument versionNumBuf ist der Puffer, in dem die Versionsnummer gespeichert wird.

• Das Argument versionNumBufMaxLen ist die maximale Größe des Puffers, auf den versionNumBuf verweist.

Rückgabewerte

Ein boolescher Wert:

true, wenn der Vorgang erfolgreich war, andernfalls false. Das Argument versionNumBuf

speichert die Versionsnummer.

BOOL LocalURLToFilePath()

Beschreibung

Diese Funktion wandelt den im URL-Format „file://“ angegebenen Pfad in einen lokalen Laufwerkspfad um.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Design Notes

Argumente

const char* localURL, char* drivePathBuf, int drivePathMaxLen

• Das Argument localURL im URL-Format „file://“ ist der Pfad zu einer lokalen Datei.

• Das Argument drivePathBuf ist der Puffer, in dem der lokale Laufwerkspfad gespeichert wird.

• Das Argument drivePathMaxLen ist die maximale Größe des Puffers, auf den das Argument drivePathBuf verweist.

Rückgabewerte

Ein boolescher Wert:

true, wenn der Vorgang erfolgreich war, andernfalls false. Das Argument drivePathBuf erhält

den lokalen Laufwerkspfad.

FileHandle OpenNotesFile()

Beschreibung

Diese Funktion öffnet die der angegebenen Datei zugeordnete Design Notes-Datei oder erstellt sie gegebenenfalls.

Argumente

const char* localFileURL, {BOOL bForceCreate}

31

• Das Argument localFileURL im URL-Format „file://“ ist ein String, der den Pfad zur Hauptdatei enthält, mit der

die Design Notes-Datei verknüpft ist.

• Das Argument bForceCreate ist ein boolescher Wert, der angibt, ob die Design Notes-Datei auch dann erstellt

werden soll, wenn Design Notes für die Site deaktiviert ist oder der für localFileURL angegebene Pfad mit keiner
Site verknüpft ist.

FileHandle OpenNotesFilewithOpenFlags()

Beschreibung

Diese Funktion öffnet die der angegebenen Datei zugeordnete Design Notes-Datei oder erstellt sie gegebenenfalls. Die
Datei kann im schreibgeschützten Modus geöffnet werden.

Argumente

const char* localFileURL, {BOOL bForceCreate}, {BOOL bReadOnly}

• Das Argument localFileURL im URL-Format „file://“ ist ein String, der den Pfad zur Hauptdatei enthält, mit der

die Design Notes-Datei verknüpft ist.

• Das Argument bForceCreate ist ein boolescher Wert, der angibt, ob die Design Notes-Datei auch dann erstellt

werden soll, wenn Design Notes für die Site deaktiviert ist oder der Pfad mit keiner Site verknüpft ist. Der
Standardwert ist
Argument angeben.

• Das optionale Argument bReadOnly ist ein boolescher Wert, der angibt, ob die Datei im schreibgeschützten Modus

geöffnet werden soll. Der Standardwert ist
„MMNotes.dll“ verfügbar.

false. Dieses Argument ist optional. Es muss jedoch angegeben werden, wenn Sie das dritte

false. Das Argument bReadOnly ist ab Version 2 der Datei

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Design Notes

BOOL RemoveNote()

Beschreibung

Diese Funktion entfernt den angegebenen Schlüssel (und seinen Wert) aus einer Design Notes-Datei.

Argumente

FileHandlenoteHandle, const char keyName[64]

• Das Argument noteHandle ist das von der Funktion OpenNotesFile() zurückgegebene Datei-Handle.

• Das Argument keyName[64] ist ein String, der den Namen des zu entfernenden Schlüssels enthält.

Rückgabewerte

Ein boolescher Wert:

true, wenn der Vorgang erfolgreich war, andernfalls false.

BOOL SetNote()

Beschreibung

Diese Funktion erstellt oder aktualisiert ein Schlüssel-Wert-Paar in einer Design Notes-Datei.

32

Argumente

FileHandle noteHandle, const char keyName[64], const char* value

• Das Argument noteHandle ist das von der Funktion OpenNotesFile() zurückgegebene Datei-Handle.

• Das Argument keyName[64] ist ein String, der den Namen des Schlüssels enthält.

• Das Argument value ist ein String, der den Wert enthält.

Rückgabewerte

Ein boolescher Wert:

true, wenn der Vorgang erfolgreich war, andernfalls false.

Letzte Aktualisierung 22.6.2011

Kapitel 5: Fireworks-Integration

FWLaunch ist eine gemeinsam genutzte C-Bibliothek, durch die Autoren von Objekten, Befehlen, Verhalten und
Eigenschafteninspektoren mit Adobe® Fireworks® kommunizieren können. Mithilfe von FWLaunch können Sie
JavaScript-Code programmieren, um die Fireworks-Benutzeroberfläche zu öffnen und Befehle an Fireworks über die
zugehörige JavaScript-API zu senden. Informationen dazu finden Sie im Handbuch Extending Fireworks. Allgemeine
Informationen über das Zusammenwirken von C-Bibliotheken mit dem JavaScript-Interpreter in Adobe®
Dreamweaver® CS5 sowie Details zur C-Level-Erweiterbarkeit finden Sie im Handbuch Erweitern von Dreamweaver.

FWLaunch-API

Mit dem FWLaunch-Objekt können Sie Fireworks öffnen, Fireworks-Operationen über die JavaScript-API von
Fireworks durchführen und anschließend Werte an Dreamweaver zurückgeben. In diesem Kapitel werden die
FWLaunch-Kommunikations-API und deren Verwendung erläutert.

33

FWLaunch.bringDWToFront()

Verfügbarkeit

Dreamweaver 3, Fireworks 3.

Beschreibung

Diese Funktion stellt Dreamweaver in den Vordergrund.

Argumente

Keine.

Rückgabewerte

Keine.

FWLaunch.bringFWToFront()

Verfügbarkeit

Dreamweaver 3, Fireworks 3.

Beschreibung

Diese Funktion stellt Fireworks in den Vordergrund, falls es ausgeführt wird.

Argumente

Keine.

Rückgabewerte

Keine.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Fireworks-Integration

FWLaunch.execJsInFireworks()

Verfügbarkeit

Dreamweaver 3, Fireworks 3.

Beschreibung

Diese Funktion übergibt das angegebene JavaScript oder einen Verweis auf eine JavaScript-Datei zur Ausführung an
Fireworks.

Argumente

javascriptOrFileURL

• Das Argument javascriptOrFileURL im URL-Format „file://“ ist entweder ein String mit explizitem JavaScript-

Code oder der Pfad zu einer JavaScript-Datei.

Rückgabewerte

Ein Cookie-Objekt, falls die JavaScript-Daten erfolgreich übergeben wurden, oder ein Fehlercode ungleich null, falls
einer der folgenden Fehler aufgetreten ist:

• Ungültige Verwendung: javascriptOrFileURL wurde als null-Wert oder als leerer String definiert oder der

Pfad zu der JS- bzw. JSF-Datei ist ungültig.

• I/O-Dateifehler: Fireworks konnte keine Antwortdatei erstellen, da die Festplatte voll ist.

• Fehlermeldung an Dreamweaver: Benutzer führt keine gültige Version von Dreamweaver (Version 3 oder höher) aus.

• Fehler beim Starten des Fireworks-Prozesses: Die Funktion startet keine gültige Version von Fireworks (Version 3

oder höher erforderlich).

• Die Aktion wurde vom Benutzer abgebrochen.

34

FWLaunch.getJsResponse()

Verfügbarkeit

Dreamweaver 3, Fireworks 3.

Beschreibung

Diese Funktion bestimmt, ob Fireworks noch immer den von
JavaScript-Code ausführt, ob das Skript erfolgreich beendet wurde oder ob ein Fehler aufgetreten ist.

Argumente

progressTrackerCookie

• Das Argument progressTrackerCookie ist das von der Funktion FWLaunch.execJsInFireworks()

zurückgegebene Cookie-Objekt.

Rückgabewerte

Ein String mit dem Ergebnis des an die Funktion
Vorgang erfolgreich beendet wurde. Der Wert ist

FWLaunch.execJsInFireworks()·übergebenen·Skripts, wenn der

null, wenn Fireworks den JavaScript-Code noch ausführt. Ein

Fehlercode ungleich Null wird zurückgegeben, wenn einer der folgenden Fehler aufgetreten ist:

• Ungültige Verwendung: Beim Ausführen des Skripts ist ein JavaScript-Fehler aufgetreten.

Letzte Aktualisierung 22.6.2011

FWLaunch.execJsInFireworks() übergebenen

DREAMWEAVER API-REFERENZHANDBUCH

Fireworks-Integration

• I/O-Dateifehler: Fireworks konnte keine Antwortdatei erstellen, da die Festplatte voll ist.

• Fehlermeldung an Dreamweaver: Benutzer führt keine gültige Version von Dreamweaver (Version 3 oder höher) aus.

• Fehler beim Starten des Fireworks-Prozesses: Die Funktion startet keine gültige Version von Fireworks (Version 3

oder höher erforderlich).

• Die Aktion wurde vom Benutzer abgebrochen.

Beispiel

Der folgende Code übergibt den String

FWLaunch.execJsInFireworks() und überprüft das Ergebnis:

var progressCookie = FWLaunch.execJsInFireworks("prompt('Please enter your name:')");
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) == "number") {

// error or user-cancel, time to close the window
// and let the user know we got an error
window.close();
alert("An error occurred.");

}else{

// got a valid response!
alert("Nice to meet you, " + response);
window.close();

}

doneFlag = true;

}
}

}

"prompt('Please enter your name:')" an

35

FWLaunch.mayLaunchFireworks()

Verfügbarkeit

Dreamweaver 2, Fireworks 2.

Beschreibung

Diese Funktion bestimmt, ob der Start einer Fireworks-Optimierungssitzung möglich ist.

Argumente

Keine.

Rückgabewerte

Ein boolescher Wert, der angibt, ob Windows oder Macintosh als Plattform verwendet wird. Bei Macintosh wird
angezeigt, ob bereits eine andere Fireworks-Optimierungssitzung ausgeführt wird.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Fireworks-Integration

FWLaunch.optimizeInFireworks()

Verfügbarkeit

Dreamweaver 2, Fireworks 2.

Beschreibung

Diese Funktion startet für das angegebene Bild eine Fireworks-Optimierungssitzung.

Argumente

docURL, imageURL, {targetWidth}, {targetHeight}

• Das Argument docURL ist der Pfad zum aktiven Dokument im URL-Format „file://“.

• imageURL ist der Pfad zum ausgewählten Bild. Wenn der Pfad relativ ausgedrückt ist, ist er relativ zu dem in

docURL angegebenen Pfad.

• Das optionale Argument targetWidth ist die Breite, an die das Bild angepasst werden soll.

• Das optionale Argument targetHeight ist die Höhe, an die das Bild angepasst werden soll.

Rückgabewerte

Null, wenn für das ausgewählte Bild eine Fireworks-Optimierungssitzung erfolgreich gestartet wurde. Ein Fehlercode
ungleich Null wird zurückgegeben, wenn einer der folgenden Fehler aufgetreten ist:

36

• Ungültige Verwendung: docURL, imageURL oder beide wurden als Wert null bzw. als leerer String definiert.

• I/O-Dateifehler: Fireworks konnte keine Antwortdatei erstellen, da die Festplatte voll ist.

• Fehlermeldung an Dreamweaver: Benutzer führt keine gültige Version von Dreamweaver (Version 2 oder höher) aus.

• Fehler beim Starten des Fireworks-Prozesses: Die Funktion startet keine gültige Version von Fireworks (Version 2

oder höher erforderlich).

• Die Aktion wurde vom Benutzer abgebrochen.

FWLaunch.validateFireworks()

Verfügbarkeit

Dreamweaver 2, Fireworks 2.

Beschreibung

Diese Funktion sucht auf der Festplatte des Benutzers nach der angegebenen Version von Fireworks.

Argumente

{versionNumber}

• Das Argument versionNumber ist ein optionaler Gleitkommawert, der mindestens 2 beträgt. Er stellt die

erforderliche Fireworks-Version dar. Bei fehlendem Argument wird der Wert 2 als Standard verwendet.

Rückgabewerte

Ein boolescher Wert, der angibt, ob die betreffende Version von Fireworks gefunden wurde.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Fireworks-Integration

Beispiel

Mit dem folgenden Code wird überprüft, ob Fireworks installiert ist:

if (FWLaunch.validateFireworks(6.0)){

alert("Fireworks 6.0 or later is installed.");

}else{

alert("Fireworks 6.0 is not installed.");

}

Einfaches FWLaunch-Kommunikationsbeispiel

Mit dem folgenden Befehl wird Fireworks angewiesen, den Benutzer nach seinem Namen zu fragen und diesen Namen
an Dreamweaver zu übergeben:

<html>
<head>
<title>Prompt in Fireworks</title>
<meta http-equiv="Content-Type" content="text/html; ¬
charset=iso-8859-1">
<script>

function commandButtons(){

return new Array("Prompt", "promptInFireworks()", "Cancel", ¬
"readyToCancel()", "Close","window.close()");

}

var gCancelClicked = false;
var gProgressTrackerCookie = null;

function readyToCancel() {

gCancelClicked = true;

}

function promptInFireworks() {

var isFireworks3 = FWLaunch.validateFireworks(3.0);
if (!isFireworks3) {

alert("You must have Fireworks 3.0 or later to use this ¬

command");
return;

}

// Tell Fireworks to execute the prompt() method.
gProgressTrackerCookie = FWLaunch.execJsInFireworks¬
("prompt('Please enter your name:')");

// null means it wasn't launched, a number means an error code
if (gProgressTrackerCookie == null || ¬
typeof(gProgressTrackerCookie) == "number") {

window.close();

alert("an error occurred");

gProgressTrackerCookie = null;
} else {

// bring Fireworks to the front

FWLaunch.bringFWToFront();

// start the checking to see if Fireworks is done yet

checkOneMoreTime();
}

37

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Fireworks-Integration

}
function checkOneMoreTime() {

// Call checkJsResponse() every 1/2 second to see if Fireworks
// is done yet
window.setTimeout("checkJsResponse();", 500);

}

function checkJsResponse() {

var response = null;

// The user clicked the cancel button, close the window
if (gCancelClicked) {

window.close();

alert("cancel clicked");
} 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) == "number") {

// if the response was a number, it means an error occurred
// the user cancelled in Fireworks
window.close();
alert("an error occurred.");

} 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
alert("Nice to meet you, " + response + "!");

}
}

}
</script>
</head>
<body>
<form>
<table width="313" nowrap>
<tr>
<td>This command asks Fireworks to execute the prompt() ¬
function. When you click Prompt, Fireworks comes forward and ¬
asks you to enter a value into a dialog box. That value is then ¬
returned to Dreamweaver and displayed in an alert.</td>
</tr>
</table>
</form>
</body>
</html>

38

Letzte Aktualisierung 22.6.2011

Kapitel 6: Flash-Integration

Adobe® Dreamweaver® unterstützt die API für Flash-Objekte, die mithilfe der Flash Generator-Vorlagendatei neue
Flash-Objekte erstellt. Im Folgenden wird unter „API für Flash-Objekte“ ausführlich erläutert, wie Sie aus Flash
Generator-Vorlagen (SWT-Dateien) Flash-Objekte (SWF-Dateien) erstellen.

Informationen zum Hinzufügen von Flash-Inhalt zu Dreamweaver-Objekten oder -Befehlen finden Sie im Handbuch
Dreamweaver erweitern.

API für Flash-Objekte

Die API für Flash-Objekte dient Entwicklern von Erweiterungen zum Erzeugen von Objekten, die mithilfe von Flash
Generator einfache SWF-Dateien erstellen. Mit dieser API können Sie Parameter in einer Flash Generator-Vorlage
festlegen und als SWF- bzw. Bilddatei ausgeben. Des Weiteren können Sie mit der API neue Flash-Objekte erstellen
sowie vorhandene Flash-Objekte lesen und bearbeiten.

Die SWT-Datei ist eine Flash Generator-Vorlagendatei, in der sich alle erforderlichen Daten für das Erstellen einer
Flash-Objektdatei befinden. Mit diesen API-Funktionen können Sie eine SWF-Datei (oder Bilddatei) aus einer SWT­Datei erstellen. Die SWF-Datei entsteht durch Ersetzen der Parameter der SWT-Datei durch echte Werte. Weitere
Informationen über Flash finden Sie in der Flash-Dokumentation. Die folgenden Funktionen stellen Methoden des

SWFFile-Objekts dar.

39

SWFFile.createFile()

Beschreibung

Diese Funktion generiert eine neue Flash-Objektdatei mit der angegebenen Vorlage und einem Parameter-Array.
Außerdem erstellt sie GIF-, PNG-, JPEG- und MOV-Versionen des Titels, sofern für diese Formate Dateinamen
angegeben wurden.

Wenn Sie einen optionalen Parameter angeben möchten, der auf andere optionale Parameter folgt, die Sie jedoch nicht
verwenden möchten, müssen Sie für die nicht zu verwendenden Parameter leere Strings angeben. Angenommen, Sie
möchten eine PNG-Datei erstellen, jedoch keine GIF-Datei. In diesem Fall muss vor dem PNG-Dateinamen ein leerer
String stehen.

Argumente

templateFile, templateParams, swfFileName, {gifFileName}, {pngFileName}, {jpgFileName}, {movFileName},
{generatorParams}

• Das Argument templateFile ist ein Pfad zu einer Vorlagendatei im URL-Format „file:// “. Hierbei kann es sich um

eine SWT-Datei handeln.

• Das Argument templateParams ist ein Array aus Name-Wert-Paaren. Die Namen stehen hierbei für die

Parameternamen in der SWT-Datei und die Werte für die gewünschten Werte dieser Parameter. Damit
Dreamweaver eine SWF-Datei als Flash-Objekt erkennt, muss der erste Parameter
muss ein String sein, der den Namen des Objekttyps repräsentiert, beispielsweise

• Das Argument swfFileName ist der Name einer SWF-Ausgabedatei im URL-Format „file://“ bzw. ein leerer String,

der ignoriert wird.

"dwType" lauten. Der Wert

"Flash Text".

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Flash-Integration

• Das Argument gifFileName ist der Name einer GIF-Ausgabedatei im URL-Format „file://“. Dieses Argument ist

optional.

• Das Argument pngFileName ist der Name einer PNG-Ausgabedatei im URL-Format „file://“. Dieses Argument ist

optional.

• Das Argument jpgFileName ist der Name einer JPEG-Ausgabedatei im URL-Format „file://“. Dieses Argument ist

optional.

• Das Argument movFileName ist der Name einer QuickTime-Ausgabedatei im URL-Format „file://“. Dieses

Argument ist optional.

• Das Argument generatorParams ist ein String-Array, das optionale Befehlszeilen-Flags für Flash Generator angibt.

Dieses Argument ist optional. Die Datenelemente für jedes Flag müssen auf dieses Argument folgen. Die folgende
Tabelle enthält eine Beschreibung der gängigsten Flags.

Options-Flag Daten Beschreibung Beispiel

40

-defaultsize

-exactFit

Breite, Höhe Stellt die Größe des Ausgabebilds auf die

angegebene Breite und Höhe ein.

Keine. Streckt den Inhalt des Ausgabebilds, um es genau

an die festgelegte Ausgabegröße anzupassen.

"-defaultsize",
"640", "480"

"-exactFit"

Rückgabewerte

Ein String, der einen der folgenden Werte enthält:

• "noError" bedeutet, dass der Aufruf erfolgreich war.

• "invalidTemplateFile" bedeutet, dass die angegebene Vorlagendatei ungültig war oder nicht gefunden wurde.

• "invalidOutputFile" bedeutet, dass mindestens einer der angegebenen Ausgabedateinamen ungültig ist.

• "invalidData" bedeutet, dass mindestens eines der Name-Wert-Paare des Arguments templateParams ungültig ist.

• "initGeneratorFailed" bedeutet, dass Flash Generator nicht initialisiert werden konnte.

• "outOfMemory" bedeutet, dass für den Vorgang nicht genügend Speicher zur Verfügung stand.

• "unknownError" bedeutet, dass ein unbekannter Fehler aufgetreten ist.

Beispiel

Mit dem folgenden JavaScript wird eine Flash-Objektdatei vom Typ
Vorlagendatei durch den String

var params = new Array;
params[0] = "dwType";
params[1] = "myType";
params[2] = "text";
params[3] = "Hello World";
errorString = SWFFile.createFile( "file:///MyMac/test.swt", ¬
params, "file:///MyMac/test.swf", "file:///MyMac/test.gif");

"Hello World" ersetzt. Dabei werden eine GIF- und eine SWF-Datei erstellt.

"myType" erstellt, die jeden "text"-String in der

SWFFile.getNaturalSize()

Beschreibung

Diese Funktion gibt die natürliche Größe eines unkomprimierten Flash-Inhalts zurück.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Flash-Integration

Argumente

fileName

• Das Argument fileName ist der Pfad zum Flash-Inhalt im URL-Format „file://“.

Rückgabewerte

Ein Array mit zwei Elementen, die die Breite und Höhe einer unkomprimierten SWF-Datei angeben bzw. den Wert

null, wenn die Datei keine unkomprimierte SWF-Datei ist.

SWFFile.getObjectType()

Beschreibung

Diese Funktion gibt den Flash-Objekttyp zurück, d. h. den Wert, der im Parameter
Datei durch die Funktion

SWFFile.createFile() erstellt wurde.

Argumente

fileName

• Das Argument fileName ist der Pfad zu einer Flash-Objektdatei im URL-Format „file://“. Hierbei handelt es sich

normalerweise um eine SWF-Datei.

dwType übergeben wurde, als die

41

Rückgabewerte

Ein String, der den Objekttyp repräsentiert, oder

null, wenn die Datei kein Flash-Objekt ist oder nicht gefunden

werden konnte.

Beispiel

Mit dem folgenden Code wird geprüft, ob die Datei „test.swf“ ein Flash-Objekt des Typs

if ( SWFFile.getObjectType("file:///MyMac/test.swf") == "myType" ){

alert ("This is a myType object.");

}else{

alert ("This is not a myType object.");

}

myType ist:

SWFFile.readFile()

Beschreibung

Mit dieser Funktion wird eine Flash-Objektdatei gelesen.

Argumente

fileName

• Das Argument fileName ist der Pfad zu einer Flash-Objektdatei im URL-Format „file://“.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Flash-Integration

Rückgabewerte

Ein String-Array, bei dem das erste Array-Element den vollständigen Pfad zur SWT-Vorlagendatei angibt. Die
folgenden Strings geben die Parameter (Name-Wert-Paare) für das Objekt an. Im Array befindet sich hinter jedem
Namen der entsprechende Wert. Das erste Name-Wert-Paar ist
Die Funktion gibt den Wert

null zurück, wenn die Datei nicht gefunden werden kann oder wenn sie keine Flash-

"dwType" und dahinter steht der zugehörige Wert.

Objektdatei ist.

Beispiel

Durch Aufrufen von

var params = SWFFile.readFile("file:///MyMac/test.swf") werden die folgenden

Werte im Parameter-Array zurückgegeben:

"file:///MyMac/test.swt" // template file used to create this .swf file
"dwType" // first parameter
"myType" // first parameter value
"text" // second parameter
"Hello World" // second parameter value

Funktionen für Flash-Bedienfelder und Flash-

42

Dialogfelder

Mit den folgenden API-Funktionen können Sie Bedienfeldern und Dialogfeldern SWF-Dateien hinzufügen.

dreamweaver.flash.newControl()

Verfügbarkeit

Dreamweaver CS4.

Beschreibung

Mit dieser Funktion können Sie ein Flash-Steuerelement erstellen. Später wird darauf mithilfe des Parameters

controlID Bezug genommen. Das Steuerelement zeigt die mit dem SWF-Pfad angegebene Flash-Datei (.swf) an. Die

Position und Größe des Steuerelements ist im Parameter

Hinweis: Dreamweaver zeigt Flash-Steuerelemente an, wenn Sie
zeigt Steuerelemente von Dialogfeldern an, wenn Sie

flash.requestStateChange aufrufen.

Argumente

controlID, controlType, controlData

• Das Argument controlID ist ein String.

• Das Argument controlType gibt an, ob das Bedienfeld eine Standarderweiterung ("standard"), eine

vertrauenswürdige Standarderweiterung ("trusted") oder eine zusätzliche Erweiterung (jeder andere Wert) ist.
Wenn es sich um eine zusätzliche Erweiterung handelt, ist der Wert eine spezielle ID für die Hostanwendung, die
den Typ der erforderlichen benutzerdefinierten Integration angibt. Wenn der Anwendung dieser
benutzerdefinierte Integrationstyp unbekannt ist, wird ein Fehler zurückgegeben.

• Das Argument controlData ist ein Objekt. Es folgen einige der wichtigsten Eigenschaften dieses Arguments:

defaultGeometry angegeben.

flash.requestStateChange aufrufen. Dreamweaver

newControl aufrufen. Sie müssen dazu nicht

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Flash-Integration

Eigenschaft Beschreibung Werte

43

controlData.swfUTF8Path Speicherort der SWF-Datei. Diese Eigenschaft ist

{controlData.scriptPath} Pfad zu der JS-Datei mit den Funktionen, die per

controlData.defaultGeometry Die Werte von defaultGeometry sind als

erforderlich und wird als Unicode-String
übergeben, da in JavaScript alle Zeichen das
Unicode-Format verwenden.

Aufruf der External-Schnittstelle aus der SWF­Datei ausgeführt werden. Diese Eigenschaft ist
optional. Wenn Sie über die External­Schnittstelle einen Rückruf aus der SWF-Datei in
JavaScript-Code von Dreamweaver durchführen
möchten, können Sie eine JS-Datei mit
Funktionen angeben, die dann aus der SWF­Datei aufgerufen werden können. Weitere
Informationen finden Sie im Abschnitt zum
Aufruf von

Bildschirmkoordinaten mit
Koordinatenursprung in der linken oberen Ecke
des Bildschirms angegeben. Diese Eigenschaft
ist erforderlich.

Object /*!< default creation
geometry, including positioning */
{ topleftx: Number, toplefty:
Number, width: Number, height:
Number }

dw.flash.executeScript.

Mögliche Werte für

controlData.windowType:

• PanelWindow. In der auf diese

Tabelle folgenden Tabelle sind die
Spezifikationen für diesen Wert
aufgeführt.

• ModalDialogWindow

In der folgenden Tabelle sind die Spezifikationen für PanelWindow aufgeführt:

Optionen Typ Beschreibung

name String Der auf der Registerkarte angezeigte Name des Bedienfelds. Wenn kein

controlData.minSize} Objekt minSize gilt nur für Steuerelemente des Typs PanelWindow. Mit dieser

{

{controlData.maxSize} Objekt Die maxSize-Eigenschaft gibt es nur für Steuerelemente

Name angegeben ist, wird „NICHT DEFINIERT“ zugewiesen. Alle
Bedienfeldnamen werden in Großbuchstaben dargestellt. Sie können sie
nicht in Kleinbuchstaben angeben.

Option wird die Mindestgröße des Bedienfelds festgelegt, die bei
Größenänderungen nicht unterschritten werden kann. Diese Option ist
optional. Wenn

defaultGeometry angegebenen Standardwerte für Höhe und Breite

und die Größe des Bedienfelds kann nicht geändert werden.

{ width: Number, height: Number }

des Typs „PanelWindow".

Option wird die Höchstgröße des Bedienfelds festgelegt, die bei
Größenänderungen nicht überschritten werden kann. Wenn „maxSize“
nicht angegeben ist, gelten die in
Standardwerte für Höhe und Breite und die Größe des Bedienfelds kann
nicht geändert werden.

{ width: Number, height: Number }

minSize nicht angegeben ist, gelten die in

Diese Option ist optional. Mit dieser

defaultGeometry angegebenen

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Flash-Integration

Optionen Typ Beschreibung

44

{iconPathNormal} String Pfad zu dem Symbol, das im schwebenden Bedienfeld verwendet wird,

iconPathRollOver} String Pfad zu dem Symbol, das im schwebenden Bedienfeld verwendet wird,

{

iconPathDisable} String Pfad zu dem Symbol, das im schwebenden Bedienfeld verwendet wird,

{

wenn das Bedienfeld in den Symbolmodus minimiert wurde. Diese Option
ist optional.

wenn das Bedienfeld in den Symbolmodus minimiert wurde und der
Benutzer mit dem Mauszeiger darauf zeigt. Diese Option ist optional.

wenn das Bedienfeld in den Symbolmodus minimiert wurde und
deaktiviert ist. Diese Option ist optional.

Rückgabewerte

Einer der folgenden Erfolgs- oder Fehlercodes:

• Der Code PlugPlugErrorCode_success gibt an, dass das Steuerelement erfolgreich erstellt wurde.

• Der Code PlugPlugErrorCode_extensionRegistrationFailed gibt an, dass das Steuerelement nicht

registriert werden konnte.

dreamweaver.flash.requestStateChange()

Verfügbarkeit

Dreamweaver CS4.

Beschreibung

Mit dieser Funktion wird der Status des mit

extensionID geändert.

mit

uniqueID identifizierten schwebenden Bedienfelds für die Erweiterung

Argumente

controlID, stateChange, stateData

• Das Argument controlID ist ein String.

• Das Argument stateChange ist ein String mit den folgenden möglichen Werten:

Wert Beschreibung

Move Änderung des Ursprungs, jedoch nicht der Größe

Resize Neue Größe und ggf. neuer Ursprung

Show Nur Sichtbarkeit, jedoch keine Änderung der Geometrie

Hide Nur Sichtbarkeit, jedoch keine Änderung der Geometrie

Minimize Wie „Hide“, jedoch mit Angabe eines Grunds

Restore Wie „Show“, jedoch mit Angabe eines Grunds

Open Fenster wird erstellt und die entsprechende Erweiterung geladen

Close Enthaltende Erweiterung wird entladen

• Die Werte des Arguments stateData sind Strings wie in der folgenden Tabelle aufgeführt:

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Flash-Integration

Wert von stateChange Wert von stateData

45

Move

Resize

eventData = { topleftx: Number, toplefty: Number }

eventData = { width: Number, height: Number }

Rückgabewerte

Die folgende Tabelle enthält die Rückgabewerte (Strings):

Wert Beschreibung

RequestPosted Ein Ereignis oder Befehl zum Ausführen der Anforderung wurde in die Warteschlange der Hostanwendung

RequestComplete Die Hostanwendung hat die Anforderung erfolgreich beendet.

RequestFailed Die Hostanwendung hat versucht, die Anforderung auszuführen, dies ist jedoch fehlgeschlagen.

RequestDenied Die Hostanwendung hat die Anforderung abgelehnt, in der Regel weil die angeforderte Aktion nicht

eingefügt.

unterstützt wird.

Beispiel

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("com.adobe.extension.foo","Open",controlData.defaultGeometry);

dreamweaver.flash.controlEvent()

Verfügbarkeit

Dreamweaver CS4.

Beschreibung

Diese Funktion dient zum Übergeben von Ereignissen an ein Flash-Steuerelement. Ereignisaufrufe werden als XML­String übergeben, der die Funktion und die benötigten Parameter enthält. Der XML-String enthält die in der SWF­Datei zu startende Funktion.

Argumente

inControlID, inXMLString

• Das Argument inControlID ist ein String.

• Das Argument inXMLString ist ein String. Übergeben Sie den folgenden inXMLString, um die Funktion in der

Flash-Datei „flashCallback“ aufzurufen und als Argument den einzelnen String „Hello“ zu übergeben.

<invoke name="flashCallback" returntype="xml">

<arguments>

<string>Hello</string>

</arguments>

</invoke>

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Flash-Integration

Rückgabewerte

Gibt einen XML-String zurück.

Beispiel

Im folgenden Beispiel wird die Funktion

flashCallback aus JavaScript aufgerufen. In diesem Beispiel übergeben Sie

den Namen der Callback-Funktion und die entsprechenden Argumente als XML-String.

var xmlString = '<invoke name="flashCallback" returntype="xml">
<arguments>
<string>Hello</string>
</arguments>
</invoke>';

In diesem Beispiel verwenden Sie dw.flash.controlEvent, um einen Callback-Aufruf in die Flash-Datei (.swf)
durchzuführen:

dw.flash.controlEvent('Flickr', xmlString);

In dieser Funktion werden folgende Argumente verwendet:

• Flickr – ID der Erweiterung, die beim Erstellen des SWF-Steuerelements mit dw.flash.newControl übergeben

wurde.

• XML-String mit der Callback-Funktion und den Argumenten.

Das folgende Beispiel ist die Implementierung der Funktion
Beispiel fügen Sie die Funktion

flashcallback hinzu. Diese Funktion muss von externen Anwendungen aufgerufen

flashcallback in „flashcallback.mxml“. In diesem

werden.

46

public function initApp():void {
ExternalInterface.addCallback("flashCallback",flashCallback);
}

Diese Funktion wird per Callback von außerhalb der Flash-Datei (.swf) aufgerufen.

Hinweis: Stellen Sie sicher, dass diese Funktion erst aufgerufen wird, nachdem

ExternalInterface.addCallback

("flashCallback",flashCallback) aufgerufen wurde.

public function flashCallback(inputStr:String):String
{

out.text += inputStr + " got flashCallback!\n";
return "it worked!";

}

dreamweaver.flash.setMenu()

Verfügbarkeit

Dreamweaver CS4.

Beschreibung

Mit dieser Funktion können Sie Ausklappbefehle für Erweiterungen des Typs „PanelWindow“ erstellen.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Flash-Integration

Argumente

inControlID, inMenuPosition, inMenu

• inControlID ist eine Erweiterungs-ID. Der Aufruf der Funktion wirkt sich auf das Ausklappmenü eines

geöffneten Bedienfelds aus, das die Erweiterung enthält. Wenn dieses Argument nicht definiert ist, werden durch
den Aufruf die Hauptmenüs der Anwendung beeinflusst.

• inMenuPosition ist ein String, der angibt, an welcher Position die angegebenen Befehle eingefügt werden sollen.

• Wenn dieser String nicht definiert ist, wird ein ganzes Menü ersetzt.

• Wenn dieser String für ein Bedienfeld bestimmt ist, wird der gesamte benutzerdefinierbare Bereich des

Ausklappmenüs ersetzt. (Für die Anwendung sind einige Ausklappmenüeinträge fest reserviert.)

• Wenn dieser String für eine Anwendung bestimmt ist, wird das gesamte Untermenü „Steuerelemente“ des

Menüs „Fenster“ ersetzt.

• Für den Fall, dass dieser String ein XML-String in einem noch zu bezeichnenden Schema zum Festlegen von

Menübereichen ist, steht für zukünftige Kompatibilität das folgende Formular zur Verfügung.

• inMenu entspricht MenuItem. Dieses Argument gibt eine Liste von Befehlen an, die an der bezeichneten

Menüposition eingefügt werden. Dabei werden alle bei einem früheren Aufruf an dieser Position eingefügten
Elemente entfernt.

47

Rückgabewerte

Einer der folgenden Erfolgs- oder Fehlercodes:

• Der Code PlugPlugErrorCode_success gibt einen erfolgreichen Abschluss an.

• Der Code PlugPlugErrorCode_extensionMenuCreationFailed gibt an, dass die Erstellung des

Erweiterungsmenüs fehlgeschlagen ist.

• Der Code PlugPlugErrorCode_unknown gibt an, dass die Funktion aus unbekannten Gründen fehlgeschlagen ist.

Beispiel

Das folgende Beispiel wird zum Einrichten des Menüs verwendet:

function initializeMenuItem(menuID, menuName,extensionID, submenu)
{

var menuItem = {};
menuItem.menuId = menuID; //!< unique menu ID, if NULL menu is disabled
menuItem.nameUtf8 = menuName; //!< Item title, if "---" item is a separator
menuItem.extensionId = extensionID; //!< optional extension ID, used for panels only
menuItem.submenu = submenu; //!< 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);

}

Hinweis: Geben Sie eine Funktion mit dem Namen „onSelectMenuItem“ in der JavaScript-Datei an, die in der
Eigenschaft

scriptPath des Objekts festgelegt ist, das an „newControl“ übergeben wurde.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Flash-Integration

Bei onSelectMenuItem handelt es sich um eine Menüelementprozedur. Sie wird mit der zugehörigen Menü-ID
aufgerufen, wenn im Ausklappmenü des schwebenden Bedienfelds ein Befehl ausgewählt wurde.

Im folgenden Beispiel wird die Definition der Callback-Prozedur in „Configuration/flash/Flickr.js“ beschrieben:

function onSelectMenuItem(menuID)
{

if (menuID == 'id1') {

var flashCallbackString = '<invoke name= " flash Callback"
returntype="xml">
<arguments><string>Hello</string></arguments></invoke>';
dw.flash.control Event('Flickr', flashCallbackString);
return("PlugPlugRequestCompleted");

} else {

alert ( ' You selected: menuID = ' + menuID);
return ( " PlugPlugRequestCompleted");
}

}

dreamweaver.flash.evalScript()

Verfügbarkeit

Dreamweaver CS4.

48

Beschreibung

Mit dieser Funktion wird eine JavaScript-Funktion für einen der folgenden Zwecke aufgerufen:

• Ausführen einer JavaScript-Funktion, die in der dieser Erweiterung (für CSXS-Erweiterungen) zugeordneten

Skriptdatei definiert ist.

• Für nicht CSXS-basierte Erweiterungen die im Parameter scriptPath definierte JS-Datei.

Argumente

controlID, javascript function call

• Das Argument controlID ist die ID der Erweiterung, die den Skriptcode ausführen soll. Diese ID muss mit der ID

übereinstimmen, die als erster Parameter für

dw.flash.newControl() angegeben ist.

• Das Argument für den JavaScript-Funktionsaufruf ermöglicht das Aufrufen von Funktionen mit einer beliebigen

Anzahl von Parametern.

Rückgabewerte

Ein boolescher Wert:

true, wenn die Funktion erfolgreich ausgeführt wurde, andernfalls false.

dreamweaver.flash.executeScript()

Verfügbarkeit

Dreamweaver CS4.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Flash-Integration

Beschreibung

Die Funktion dient zum Ausführen von Funktionen in JS-Dateien. Der ActionScript-Code in der SWF-Datei startet
die Funktion

dreamweaver.flash.executeScript().

Argumente

javascript function call

Hinweis: Geben Sie einen Pfad zur JS-Datei an, die die aufzurufenden Funktionen enthält.

Rückgabewerte

Ein XML-String, der in ein ActionScript-Objekt serialisiert wird.

Beispiel

Das folgende Beispiel enthält eine Beispieldatei („Sample.mxml“) und eine JavaScript-Funktion in einer JavaScript­Datei („Sample.js“).

private function executeScript():void

{

if(ExternalInterface.available)
{

out.text += "SwfCalledHost\n";
var scriptText:String = "helloWorld('scott');\n";
var resultStr:Object =

ExternalInterface.call("dw.flash.executeScript",scriptText);

out.text += "Result: " + resultStr.strResult + '\n';

}

}

49

Die folgende JavaScript-Datei enthält die JavaScript-Funktion helloWorld(), die aus der SWF-Datei aufgerufen wird.
Diese Funktion verwendet den Aufruf von

dw.getAppLanguage(), um einen fünfbuchstabigen Sprachcode

zurückzugeben, der in „Sample.js“ eingesetzt wird.

function helloWorld(nameStr)
{

alert('hello ' + nameStr);
var appLanguage = dw.getAppLanguage();
var returnStr = '<object><property id="strResult"><string>Language: ' + appLanguage

+ '</string></property></object>'
alert(returnStr);
return (returnStr);

}

Verwandte Themen

„dreamweaver.flash.newControl()“ auf Seite 42

dreamweaver.flash.controlExists

Verfügbarkeit

Dreamweaver CS4.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Flash-Integration

Beschreibung

Mit dieser Funktion wird überprüft, ob die Steuerelemente vorhanden sind.

zwischen den Starts von Dreamweaver gespeichert.

Argumente

controlID

Rückgabewerte

Ein boolescher Wert:

true, wenn das Steuerelement bereits erstellt wurde, andernfalls false.

50

PanelWindow-Steuerelemente werden

Letzte Aktualisierung 22.6.2011

Kapitel 7: Photoshop-Integration

Adobe® Dreamweaver CS5® ermöglicht eine enge Integration in Adobe® Photoshop®. Benutzer können Photoshop­Bilder in Dreamweaver als Smart Objekte einfügen. Mit Smart Objekten werden Bilder in Dreamweaver automatisch
aktualisiert, wenn mit Photoshop Änderungen an den Originalbildern vorgenommen werden.

Funktionsweise von Smart Objekten

Photoshop-Bilder werden als Smart Objekte in Dreamweaver eingefügt. Die Smart Objekte bleiben mit den
Photoshop-Originalbildern verknüpft. Wenn Benutzer ein Bild in Photoshop bearbeiten, wird in Dreamweaver ein
aktualisiertes Bild angezeigt. Ein Smart Objekt hat einen spezifischen Status, der hauptsächlich auf der Verbindung
des Webbilds mit der ursprünglichen Bilddatei beruht. Benutzern wird der Status eines Smart Objekts grafisch
dargestellt. Der synchronisierte Zustand des Smart Objekts wird durch ein entsprechendes Symbol angezeigt.

51

API für Smart Objekte

Mit den Funktionen für Smart Objekte werden Vorgänge der Dreamweaver- und Photoshop-Integration
durchgeführt. Mit den Funktionen können Sie folgende Aufgaben ausführen:

• Ermitteln des aktuellen Bildstatus

• Abrufen der Höhe und Breite von Bildern

dreamweaver.assetPalette.canUpdateSmartObjectFromOriginal()

Verfügbarkeit

Dreamweaver CS4.

Beschreibung

Enabler: Mit dieser Funktion wird überprüft, ob im Bedienfeld „Elemente“ ein Smart Objekt ausgewählt ist, auf das
der Befehl „Von Original aktualisieren“ angewendet werden kann.

Argumente

Keine.

Rückgabewerte

Ein boolescher Wert:
Andernfalls

false.

true, wenn „Von Original aktualisieren“ auf die aktuelle Auswahl angewendet werden kann.

dreamweaver.assetPalette.updateSmartObjectFromOriginal()

Verfügbarkeit

Dreamweaver CS4.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Photoshop-Integration

Beschreibung

Diese Funktion erstellt das ausgewählte Webbild anhand des aktuellen Inhalts der verknüpften ursprünglichen
Quelldatei neu.

Argumente

Keine.

Rückgabewerte

Keine.

dreamweaver.getSmartObjectState()

Verfügbarkeit

Dreamweaver CS4.

Beschreibung

Diese Funktion gibt den Status eines Webbilds hinsichtlich der Funktionalität von Smart Objekten zurück.

52

Argumente

Absolute lokale URL eines Webbilds.

Rückgabewerte

Der Status des Smart Objekts als Zahlenwert:

Zahlenwert Beschreibung

-10 Unbekannter Fehler

0 Kein Smart Objekt

1 Mit dem Inhalt der ursprünglichen Bilddatei synchronisiert

100 Webbild wurde nach letzter Synchronisierung bearbeitet

200 Originalbild wurde nach letzter Synchronisierung bearbeitet

+2 Abmessungen des Originalbilds unterscheiden sich von den Attributen für Höhe und Breite im HTML-Code

+4 Abmessungen des Webbilds unterscheiden sich von den Attributen für Höhe und Breite im HTML-Code

10 Zugriff auf die ursprüngliche Bilddatei nicht möglich

20 Zugriff auf die Webbilddatei nicht möglich

dreamweaver.getSmartObjectOriginalWidth()

Verfügbarkeit

Dreamweaver CS4.

Beschreibung

Diese Funktion ermittelt die Breite der ursprünglichen Bilddatei eines Smart Objekts in Pixel und gibt diesen Wert
zurück.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Photoshop-Integration

Argumente

Absolute lokale URL des Webbilds.

Rückgabewerte

Breite der ursprünglichen Bilddatei in Pixel.

dreamweaver.getImageWidth()

Verfügbarkeit

Dreamweaver CS4.

Beschreibung

Diese Funktion ermittelt die Breite eines Bilds in Pixel und gibt diesen Wert zurück.

Argumente

Absolute lokale URL eines Webbilds.

Rückgabewerte

Breite des Bilds in Pixel.

53

dreamweaver.getImageHeight()

Verfügbarkeit

Dreamweaver CS4.

Beschreibung

Diese Funktion ermittelt die Höhe eines Bilds in Pixel und gibt diesen Wert zurück.

Argumente

Absolute lokale URL eines Webbilds.

Rückgabewerte

Höhe des Bilds in Pixel.

dreamweaver.resolveOriginalAssetFileURLToAbsoluteLocalFilePath()

Verfügbarkeit

Dreamweaver CS4.

Beschreibung

Diese Funktion löst den Dateipfad zu einer ursprünglichen Bilddatei auf (wie in den Design Notes gespeichert). Die
Pfadangabe kann leer, relativ zur Site oder absolut sein.

Argumente

Absolute lokale URL oder zur Site relative URL für das Webbild. Diese URL ist erforderlich, um die Site aufzulösen.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

Photoshop-Integration

Rückgabewerte

Absoluter lokaler Dateipfad.

dreamweaver.canUpdateSmartObjectFromOriginal()

Verfügbarkeit

Dreamweaver CS4.

Beschreibung

Diese Funktion dient zum Beantworten der Frage, ob ein Smart Objekt unter Verwendung der ursprünglichen
Bilddatei aktualisiert werden kann.

Argumente

Status des Smart Objekts als Zahlenwert.
Status zurück.

Rückgabewerte

Ein boolescher Wert:

true, wenn für den angegebenen Status eine Aktualisierung auf Grundlage des Originalbilds

durchgeführt werden kann, andernfalls

ImageManipulatorSettings:GetSmartObjectStatus() gibt diesen

false.

54

dreamweaver.updateSmartObjectFromOriginal()

Verfügbarkeit

Dreamweaver CS4.

Beschreibung

Diese Funktion aktualisiert ein Webbild auf Grundlage des Inhalts der ursprünglichen Bilddatei.

Argumente

Absolute lokale URL eines Webbilds.

Rückgabewerte

Keine.

Letzte Aktualisierung 22.6.2011

Kapitel 8: API für Datenbanken

Mit den Funktionen der API für Datenbanken können Sie Datenbankverbindungen verwalten und auf Informationen
zugreifen, die in Datenbanken gespeichert sind. Mit der API für Datenbanken können folgende Aufgaben ausgeführt
werden: Verwalten von Datenbankverbindungen und Zugreifen auf Datenbankverbindungen.

Die Funktionen der API für Datenbanken werden während der Entwurfsphase ausgeführt, in der Benutzer ihre
Webanwendungen entwerfen, und nicht zur Laufzeit, nachdem die Webanwendungen bereitgestellt wurden.

Sie können diese Funktionen in allen Erweiterungen verwenden. Auch die APIs für Serververhalten, Datenformate
und Datenquellen in Adobe® Dreamweaver® CS5 verwenden diese Datenbankfunktionen.

Funktionsweise der API für Datenbanken

Im folgenden Beispiel wird die Serververhaltensfunktion getDynamicBindings() für „Recordset.js“ definiert. Dabei
wird die Funktion

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, " ");
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 < ss.ParamArray.length; i++) {

}
}

var statement = replaceParamsWithVals(statement, pa, serverModel);

}

bindingsAndTypeArray = MMDB.getColumnAndTypeList(connName, statement);
return bindingsAndTypeArray;

}

MMDB.getColumnAndTypeList() verwendet.

pa[i] = new Array();

pa[i][0] = ss.ParamArray[i].name;

pa[i][1] = ss.ParamArray[i].value;

55

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Funktionen für Datenbankverbindungen

Mithilfe von Datenbankverbindungsfunktionen können Sie Verbindungen herstellen und verwalten, z. B. ADO-,
ColdFusion- und JDBC-Verbindungen in Dreamweaver.

Diese Funktionen bilden lediglich eine Schnittstelle mit dem Connection Manager. Über diese Funktionen wird nicht
direkt auf die Datenbanken zugegriffen. Informationen zu Funktionen, mit denen auf Datenbanken zugegriffen wird,
finden Sie unter „Funktionen für den Datenbankzugriff“ auf Seite 68.

Beim Verwalten der Datenbankverbindungen können Sie den Benutzernamen und das Kennwort abfragen, um
verschiedene Aktionen auszuführen, beispielsweise:

• Herstellen einer Verbindung mit einer Datenbank

• Öffnen eines Dialogfelds für die Datenbankverbindung

MMDB.deleteConnection()

Verfügbarkeit

Dreamweaver MX.

56

Beschreibung

Diese Funktion löscht die angegebene Datenbankverbindung.

Argumente

connName

• Das Argument connName ist der Name der Datenbankverbindung, wie im Connection Manager angegeben. Dieses

Argument gibt den Namen der zu löschenden Datenbankverbindung an.

Rückgabewerte

Keine.

Beispiel

Im folgenden Beispiel wird eine Datenbankverbindung gelöscht:

function clickedDelete()
{

var selectedObj = dw.serverComponents.getSelectedNode();
if (selectedObj && selectedObj.objectType=="Connection")
{

var connRec = MMDB.getConnection(selectedObj.name);
if (connRec)
{

MMDB.deleteConnection(selectedObj.name);

dw.serverComponents.refresh();

}

}

}

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

MMDB.getColdFusionDsnList()

Verfügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion ruft mithilfe der Funktionen

getRDSUserName() und getRDSPassword() die ColdFusion-DSNs

(Data Source Names, Datenquellennamen) vom Server der Site ab.

Argumente

Keine.

Rückgabewerte

Ein Array mit den ColdFusion-DSNs, die auf dem Server der aktuellen Site gespeichert sind.

MMDB.getConnection()

Verfügbarkeit

Dreamweaver UltraDev 4, verbessert in Dreamweaver MX.

57

Beschreibung

Diese Funktion ruft ein benanntes Verbindungsobjekt ab.

Argumente

name

• Das Argument name ist eine Stringvariable, die den Namen der Verbindung angibt, auf die Sie verweisen möchten.

Rückgabewerte

Ein Verweis auf ein benanntes Verbindungsobjekt. Verbindungsobjekte enthalten die folgenden Eigenschaften.

Eigenschaft Beschreibung

name Verbindungsname

type Wenn useHTTP den Wert false hat, gibt diese Eigenschaft an, welche DLL-Datei zur Laufzeit für

string Laufzeit-ADO-Verbindungsstring oder JDBC-URL

dsn ColdFusion-DSN

driver Laufzeit-JDBC-Treiber

username Laufzeit-Benutzername

password Laufzeit-Kennwort

useHTTP Ein String, der entweder den Wert true oder false enthält und dadurch angibt, ob in der

den Aufbau der Verbindung mit einer Datenbank verwendet werden soll.

Entwurfsphase ein Remote-Treiber (HTTP-Verbindung) verwendet werden soll. Andernfalls wird ein
lokaler Treiber (DLL) verwendet.

includePattern Ein regulärer Ausdruck, mit dem die include-Anweisung auf der Seite in der Ansicht „Live Data“ und

„Vorschau in Browser“ gesucht wird.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Eigenschaft Beschreibung

58

variables Ein Array der Seitenvariablennamen und ihrer Werte, die in der Ansicht „Live Data“ und „Vorschau in

catalog Wird zur Einschränkung der angezeigten Metadaten verwendet (weitere Informationen unter

schema Wird zur Einschränkung der angezeigten Metadaten verwendet (weitere Informationen unter

filename Dateiname des Dialogfelds, das zur Erstellung der Verbindung verwendet wurde.

Browser“ verwendet werden.

„MMDB.getProcedures()“ auf Seite 72).

„MMDB.getProcedures()“ auf Seite 72).

Hinweis: Bei diesen Eigenschaften handelt es sich um die in Dreamweaver implementierten Standardeigenschaften.
Entwickler können eigene Verbindungstypen definieren und diese Standardeigenschaften durch neue Eigenschaften
ergänzen oder völlig andere Eigenschaften verwenden.

MMDB.getConnectionList()

Verfügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft eine Liste aller im Connection Manager definierten Verbindungsstrings ab.

Argumente

Keine.

Rückgabewerte

Ein String-Array, in dem jeder String der Name einer Verbindung entsprechend der Anzeige im Connection Manager ist.

Beispiel

Ein Aufruf von

MMDB.getConnectionList() kann die Strings ["EmpDB", "Test", "TestEmp"] zurückgeben.

MMDB.getConnectionName()

Verfügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft den Verbindungsnamen ab, der dem angegebenen Verbindungsstring entspricht. Diese Funktion
ist nützlich, wenn Sie aus Daten auf der Seite einen Verbindungsnamen in der Benutzeroberfläche neu auswählen
möchten.

Wenn ein Verbindungsstring auf zwei verschiedene Treiber verweist, können Sie sowohl den Verbindungsstring als
auch den Treiber angeben, der dem zurückzugebenden Verbindungsnamen entspricht. Es können beispielsweise zwei
Verbindungen vorliegen.

• Verbindung 1 hat folgende Eigenschaften:

ConnectionString="jdbc:inetdae:velcro-qa-5:1433?database=pubs"
DriverName="com.inet.tds.TdsDriver"

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

• Verbindung 2 hat folgende Eigenschaften:

ConnectionString="jdbc:inetdae:velcro-qa-5:1433?database=pubs"
DriverName="com.inet.tds.TdsDriver2"

Die Verbindungsstrings für Verbindung 1 und Verbindung 2 sind identisch. Verbindung 2 stellt eine Verbindung mit
einer neueren Version des Treibers

TdsDriver her. Sie sollten den Treibernamen an diese Funktion übergeben, um

den zurückzugebenden Verbindungsnamen vollständig zu bestimmen.

Argumente

connString, {driverName}

• Das Argument connString ist der Verbindungsstring, der den Verbindungsnamen abruft.

• Das optionale Argument driverName bestimmt das Argument connString näher.

Rückgabewerte

Ein Verbindungsnamensstring, der dem Verbindungsstring entspricht.

Beispiel

Mit dem folgenden Code wird der String

"EmpDB" zurückgegeben.

59

var connectionName = MMDB.getConnectionName ¬
("dsn=EmpDB;uid=;pwd=");

MMDB.getConnectionString()

Verfügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft den Verbindungsstring ab, der mit der benannten Verbindung verknüpft ist.

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

Rückgabewerte

Ein Verbindungsstring, der der benannten Verbindung entspricht.

Beispiel

Mit dem Code
für eine ADO- oder JDBC-Verbindung zurückgegeben.

var connectionString = MMDB.getConnectionString ("EmpDB") werden verschiedene Strings

• Bei einer ADO-Verbindung kann folgender String zurückgegeben werden:

"dsn=EmpDB;uid=;pwd=";

• Bei einer JDBC-Verbindung kann folgender String zurückgegeben werden:

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

"jdbc:inetdae:192.168.64.49:1433?database=pubs&user=JoeUser&¬
password=joesSecret"

MMDB.getDriverName()

Verfügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft den Treibernamen ab, der mit der angegebenen Verbindung verknüpft ist. Nur eine JDBC­Verbindung hat einen Treibernamen.

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

60

Rückgabewerte

Ein String, der den Treibernamen enthält.

Beispiel

Die Anweisung

"jdbc/oracle/driver/JdbcOracle"

MMDB.getDriverName ("EmpDB"); kann den folgenden String zurückgeben:

MMDB.getLocalDsnList()

Verfügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion ruft ODBC-DSNs ab, die im System des Benutzers definiert sind.

Argumente

Keine.

Rückgabewerte

Ein Array, das die im System des Benutzers definierten ODBC-DSNs enthält.

MMDB.getPassword()

Verfügbarkeit

Dreamweaver UltraDev 1.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Beschreibung

Diese Funktion ruft das Kennwort für die angegebene Verbindung ab.

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

Rückgabewerte

Ein mit dem Verbindungsnamen verknüpfter Kennwortstring.

Beispiel

Die Anweisung

MMDB.getPassword ("EmpDB"); kann beispielsweise "joessecret" zurückgeben.

MMDB.getRDSPassword()

Verfügbarkeit

Dreamweaver UltraDev 4.

61

Beschreibung

Diese Funktion ruft das RDS-Kennwort (Remote Development Services) ab (zur Verwendung mit ColdFusion­Verbindungen).

Argumente

Keine.

Rückgabewerte

Ein String, der das RDS-Kennwort enthält.

MMDB.getRDSUserName()

Verfügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion ruft den RDS-Benutzernamen (zur Verwendung mit ColdFusion-Verbindungen) ab.

Argumente

Keine.

Rückgabewerte

Ein String, der den RDS-Benutzernamen enthält.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

MMDB.getRemoteDsnList()

Verfügbarkeit

Dreamweaver UltraDev 4, verbessert in Dreamweaver MX.

Beschreibung

Diese Funktion ruft die ODBC-DSNs vom Server der Site ab. Die Funktionen

getRDSPassword() werden verwendet, wenn ColdFusion das Servermodell der aktuellen Site ist. Mit dieser Funktion

haben Entwickler die Möglichkeit, einen URL-Parameterstring anzugeben, der an die von

MMDB.getRemoteDsnList() generierte URL für die Remote-Verbindung angefügt wird. Wenn der Entwickler einen

Parameterstring angibt, übergibt diese Funktion den String an die HTTP-Verbindungsskripts.

Argumente

{urlParams}

• Das optionale Argument urlParams ist ein String, der eine Liste von Ausdrücken im Format Name=Wert enthält,

die jeweils durch Und-Zeichen (&) getrennt sind. Die Werte dürfen nicht in Anführungszeichen gesetzt werden.
Einige Zeichen, z. B. das Leerzeichen im Wert
Argument, das an

MMDB.getRemoteDsnList() übergeben werden kann: a=1&b=Hello%20World

Hello World, müssen kodiert werden. Beispiel für ein gültiges

getRDSUserName() und

62

Rückgabewerte

Ein Array mit den ODBC-DSNs, die auf dem Server der aktuellen Site definiert sind.

MMDB.getRuntimeConnectionType()

Verfügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion gibt den Laufzeitverbindungstyp des angegebenen Verbindungsnamens zurück.

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

Rückgabewerte

Ein String, der dem Verbindungstyp entspricht. Diese Funktion kann einen der folgenden Werte zurückgeben:

"ADODSN", "JDBC" oder "CFDSN".

Beispiel

Mit dem folgenden Code wird bei einer ADO-Verbindung der String

"ADO" zurückgegeben.

"ADO",

var connectionType = MMDB.getRuntimeConnectionType ("EmpDB")

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

MMDB.getUserName()

Verfügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion gibt einen Benutzernamen für die angegebene Verbindung zurück.

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

Rückgabewerte

Ein mit dem Verbindungsnamen verknüpfter Benutzernamenstring.

Beispiel

Die Anweisung

MMDB.getUserName ("EmpDB"); kann beispielsweise "amit" zurückgeben.

63

MMDB.hasConnectionWithName()

Verfügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion stellt fest, ob eine Verbindung mit dem angegebenen Namen vorhanden ist.

Argumente

name

• Das Argument name ist der Verbindungsname.

Rückgabewerte

Ein boolescher Wert:

true, wenn eine Verbindung mit dem angegebenen Namen vorhanden ist, andernfalls false.

MMDB.needToPromptForRdsInfo()

Verfügbarkeit

Dreamweaver MX.

Beschreibung

Diese Funktion legt fest, ob das Dialogfeld „RDS-Anmeldeinformationen“ in Dreamweaver geöffnet werden soll.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Argumente

bForce

• Das Argument bForce ist ein boolescher Wert. Der Wert true gibt an, dass ein Benutzer, der zuvor das Dialogfeld

„RDS-Anmeldeinformationen“ über die Schaltfläche „Abbrechen“ geschlossen hat, weiterhin zur Eingabe der
RDS-Anmeldeinformationen aufgefordert werden muss.

Rückgabewerte

Ein boolescher Wert:
muss, andernfalls

true, wenn der Benutzer zur Eingabe der RDS-Anmeldeinformationen aufgefordert werden

false.

MMDB.needToRefreshColdFusionDsnList()

Verfügbarkeit

Dreamweaver MX.

Beschreibung

Diese Funktion weist den Connection Manager an, den Cache-Speicher zu löschen und die ColdFusion­Datenquellenliste vom Anwendungsserver abzurufen, wenn ein Benutzer die Liste das nächste Mal anfordert.

64

Argumente

Keine.

Rückgabewerte

Keine.

MMDB.popupConnection()

Verfügbarkeit

Dreamweaver MX.

Beschreibung

Diese Funktion zeigt ein Verbindungsdialogfeld an. Die Funktion hat die folgenden drei Signaturen:

• Wenn die Argumentliste nur aus dem Argument dialogFileName (String) besteht, bewirkt die Funktion

popupConnection(), dass das Verbindungsdialogfeld angezeigt wird, sodass Sie eine neue Verbindung definieren

können.

• Wenn die Argumentliste nur das Argument connRec (Verbindungsverweis) enthält, bewirkt die Funktion

popupConnection(), dass das Verbindungsdialogfeld im Bearbeitungsmodus angezeigt wird, sodass Sie die

benannte Verbindung bearbeiten können. In diesem Modus ist das Textfeld „Name“ abgeblendet.

• Wenn die Argumentliste aus dem Argument connRec und dem booleschen Wert bDuplicate besteht, bewirkt die

Funktion
diesem Modus ist das Textfeld „Name“ leer. Die restlichen Eigenschaften werden kopiert, um ein Duplikat der
Verbindung zu definieren.

popupConnection(), dass das Verbindungsdialogfeld im Duplizierungsmodus angezeigt wird. In

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Argumente

dialogFileName oder connRec oder connRec, bDuplicate

• Das Argument dialogFileName ist ein String, der den Namen einer HTML-Datei enthält, die im Ordner

„Configuration/Connections/Servermodell“ gespeichert ist. Mit dieser HTML-Datei wird das Dialogfeld definiert,
das zur Erstellung einer Verbindung verwendet wird. In dieser Datei müssen drei JavaScript-API-Funktionen
implementiert sein:
Sie eine JavaScript-Datei, die diese Funktionen implementiert, und anschließend fügen Sie diese Datei in die
HTML-Datei ein. (Weitere Informationen zum Herstellen von Verbindungen finden Sie unter „API für

Datenbankverbindungen“ auf Seite 81.)

findConnection(), inspectConnection() und applyConnection(). In der Regel erstellen

• Das Argument connRec ist ein Verweis auf ein vorhandenes Verbindungsobjekt.

• Das Argument bDuplicate ist ein boolescher Wert.

Rückgabewerte

Keine. Das definierte Verbindungsdialogfeld wird angezeigt.

MMDB.setRDSPassword()

Verfügbarkeit

Dreamweaver UltraDev 4.

65

Beschreibung

Diese Funktion legt das RDS-Kennwort fest.

Argumente

password

• Das Argument password ist ein String, der das RDS-Kennwort enthält.

Rückgabewerte

Keine.

MMDB.setRDSUserName()

Verfügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion legt den RDS-Benutzernamen fest.

Argumente

username

• Das Argument username ist ein gültiger RDS-Benutzername.

Rückgabewerte

Keine.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

MMDB.showColdFusionAdmin()

Verfügbarkeit

Dreamweaver MX.

Beschreibung

Diese Funktion zeigt das Dialogfeld „ColdFusion-Administrator“ an.

Argumente

Keine.

Rückgabewerte

Keine. Das Dialogfeld „ColdFusion Administrator“ wird angezeigt.

MMDB.showConnectionMgrDialog()

Verfügbarkeit

Dreamweaver UltraDev 1.

66

Beschreibung

Diese Funktion zeigt das Dialogfeld „Connection Manager“ an.

Argumente

Keine.

Rückgabewerte

Keine. Das Dialogfeld „Connection Manager“ wird angezeigt.

MMDB.showOdbcDialog()

Verfügbarkeit

Dreamweaver UltraDev 4 (nur Windows).

Beschreibung

Diese Funktion zeigt das Dialogfeld „System-ODBC-Administration“ oder „ODBC-Datenquellen-Administrator“ an.

Argumente

Keine.

Rückgabewerte

Keine. Das Dialogfeld „System-ODBC-Administration“ oder „ODBC-Datenquellen-Administrator“ wird angezeigt.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

MMDB.showRdsUserDialog()

Verfügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion zeigt das Dialogfeld zur Eingabe des RDS-Benutzernamens und Kennworts an.

Argumente

username, password

• Das Argument username ist der anfänglich verwendete Benutzername.

• Das Argument password ist das anfänglich verwendete Kennwort.

Rückgabewerte

Ein Objekt, das die neuen Werte in den Eigenschaften
Eigenschaften nicht definiert ist, hat der Benutzer das Dialogfeld über den Befehl „Abbrechen“ geschlossen.

username und password enthält. Wenn eine der beiden

67

MMDB.showRestrictDialog()

Verfügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion zeigt das Dialogfeld „Beschränken“ an.

Argumente

catalog, schema

• Das Argument catalog ist der anfänglich verwendete Katalogwert.

• Das Argument schema ist der anfänglich verwendete Schemawert.

Rückgabewerte

Ein Objekt, das die neuen Werte in den Eigenschaften
Eigenschaften nicht definiert ist, hat der Benutzer das Dialogfeld über den Befehl „Abbrechen“ geschlossen.

catalog und schema enthält. Wenn eine der beiden

MMDB.testConnection()

Verfügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion prüft die Verbindungseinstellungen. Sie zeigt ein modales Dialogfeld an, in dem die Ergebnisse
dargestellt sind.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Argumente

serverPropertiesArray

Diese Funktion erwartet ein einzelnes Argument, ein Array-Objekt, das Werte aus der folgenden Liste enthält, die auf
das aktuelle Servermodell zutreffen. Geben Sie für Eigenschaften, die auf die zu prüfende Verbindung nicht zutreffen,
einen leeren String (

"") an.

• Das Argument type gibt an, welche DLL-Datei für den Verbindungsaufbau mit einer Datenbank in der

Entwurfsphase zum Prüfen von Verbindungseinstellungen verwendet werden soll, wenn useHTTP den Wert

false hat.

• Das Argument string ist der ADO-Verbindungsstring oder die JDBC-URL.

• Das Argument dsn ist der Datenquellenname (DSN).

• Das Argument driver ist der JDBC-Treiber.

• Das Argument username ist der Benutzername.

• Das Argument password ist das Kennwort.

• Das Argument useHTTP ist ein boolescher Wert. Mit dem Wert true wird angegeben, dass in Dreamweaver

während der Entwurfsphase eine HTTP-Verbindung verwendet werden soll. Andernfalls wird eine DLL-Datei
verwendet.

68

Rückgabewerte

Ein boolescher Wert:

true, wenn der Verbindungstest erfolgreich war, andernfalls false.

Funktionen für den Datenbankzugriff

Mithilfe der Funktionen für den Datenbankzugriff können Sie Daten in Datenbanken abrufen.

Beim Zugriff auf Datenbankinformationen können Sie beispielsweise Metadaten abrufen, mit denen das Schema oder
die Struktur einer Datenbank definiert werden. Zu diesen Metadaten gehören Informationen zu Tabellen, Spalten,
gespeicherten Prozeduren und Ansichten. Sie können zudem die Ergebnisse der Ausführung einer Datenbankabfrage
oder gespeicherten Prozedur anzeigen. Für den Zugriff auf eine Datenbank über diese API werden SQL-Anweisungen
(Structured Query Language) verwendet.

Eine Sammlung der Funktionen, über die Datenbankverbindungen verwaltet werden, finden Sie unter „Funktionen

für Datenbankverbindungen“ auf Seite 56.

In der folgenden Aufstellung werden einige der Argumente beschrieben, die mit den verfügbaren Funktionen häufig
verwendet werden.

• Die meisten Funktionen für den Datenbankzugriff verwenden einen Verbindungsnamen als Argument. Eine Liste

der gültigen Verbindungsnamen finden Sie im Connection Manager. Sie können jedoch auch mit der Funktion

MMDB.getConnectionList() eine Liste aller Verbindungsnamen abrufen.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

• Für gespeicherte Prozeduren müssen häufig Parameter angegeben werden. Die Parameterwerte von

Datenbankfunktionen können auf zwei Arten festgelegt werden. Eine Möglichkeit besteht darin, ein Array von
Parameterwerten (

paramValuesArray) anzugeben. Wenn Sie nur Parameterwerte festlegen, müssen die Werte in

der Reihenfolge angegeben werden, in der die gespeicherte Prozedur sie benötigt. Zweitens können Sie
Parameterwerte definieren, um ein Array von Parameternamen (
Funktion
Sie Parameternamen festlegen, müssen die in
angegeben werden, in der auch die Parameternamen in

MMDB.getSPParamsAsString() können Sie die Parameter der gespeicherten Prozedur abrufen. Wenn

paramValuesArray angegebenen Werte in derselben Reihenfolge

paramNameArray festgelegt wurden.

paramNameArray) bereitzustellen. Mithilfe der

MMDB.getColumnAndTypeList()

Verfügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft eine Liste der Spalten und der zugehörigen Typen aus einer ausgeführten SQL-Anweisung

Argumente

connName, statement

SELECT

69

ab.

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

• Das Argument statement ist die auszuführende SQL-Anweisung SELECT.

Rückgabewerte

Ein String-Array, das eine Liste der Spalten (und der zugehörigen Typen) angibt, die der

SELECT-Anweisung

entsprechen. Andernfalls ein Fehler, wenn die SQL-Anweisung ungültig war oder die Verbindung nicht hergestellt
werden konnte.

Beispiel

Der Code

var columnArray = MMDB.getColumnAndTypeList("EmpDB","Select * from Employees") gibt das

folgende String-Array zurück:

columnArray[0] = "EmpName"
columnArray[1] = "varchar"
columnArray[2] = "EmpFirstName"
columnArray[3] = "varchar"
columnArray[4] = "Age"
columnArray[5] = "integer"

MMDB.getColumnList()

Verfügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft eine Liste der Spalten aus einer ausgeführten SQL-Anweisung

Letzte Aktualisierung 22.6.2011

SELECT ab.

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Argumente

connName, statement

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

• Das Argument statement ist die auszuführende SQL-Anweisung SELECT.

Rückgabewerte

Ein String-Array, das eine Liste der Spalten angibt, die der

SELECT-Anweisung entsprechen. Andernfalls ein Fehler,

wenn die SQL-Anweisung ungültig war oder die Verbindung nicht hergestellt werden konnte.

Beispiel

Der Code

var columnArray = MMDB.getColumnList("EmpDB","Select * from Employees") gibt das folgende

String-Array zurück:

columnArray[0] = "EmpName"
columnArray[1] = "EmpFirstName"
columnArray[2] = "Age"

70

MMDB.getColumns()

Verfügbarkeit

Dreamweaver MX, Argumente aktualisiert in Dreamweaver MX 2004.

Beschreibung

Diese Funktion gibt ein Array von Objekten zurück, die die in der Tabelle angegebenen Spalten beschreiben.

Argumente

connName, tableName

• Das Argument connName ist der Verbindungsname. Dieser Wert gibt den Verbindungsstring an, der beim

Herstellen einer Datenbankverbindung mit einer Live Data-Quelle verwendet werden soll.

• Das Argument tableName ist die abzufragende Tabelle.

Rückgabewerte

Ein Array von Objekten, wobei für jede Spalte ein Objekt verwendet wird. Jedes Objekt definiert die folgenden
Eigenschaften für die jeweils zugehörige Spalte.

Name der Eigenschaft Beschreibung

name Name der Spalte (z. B. price)

datatype Datentyp der Spalte (z. B. small money)

definedsize Definierte Größe der Spalte (z. B. 8)

nullable Gibt an, ob die Spalte null-Werte enthalten kann.

Beispiel

Im folgenden Beispiel wird mithilfe von

MMDB.getColumns() der QuickInfo-Textwert festgelegt.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

var columnNameObjs = MMDB.getColumns(connName,tableName);
var databaseType = MMDB.getDatabaseType(connName);
for (i = 0; i < 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()

Verfügbarkeit

Dreamweaver UltraDev 1.

71

Beschreibung

Diese Funktion ruft eine Liste aller Spalten in der angegebenen Tabelle ab.

Argumente

connName, tableName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

• Das Argument tableName ist der Name einer Tabelle in der Datenbank, die über connName angegeben wurde.

Rückgabewerte

Ein String-Array, in dem jeder String der Name einer Spalte in der Tabelle ist.

Beispiel

Die Anweisung

["EmpID", "FirstName", "LastName"]

MMDB.getColumnsOfTable ("EmpDB","Employees"); gibt die folgenden Strings zurück:

MMDB.getPrimaryKeys()

Verfügbarkeit

Dreamweaver MX.

Beschreibung

Diese Funktion gibt die Namen der Spalten zurück, die gemeinsam den Primärschlüssel der benannten Tabelle bilden.
Ein Primärschlüssel ist der eindeutige Bezeichner einer Datenbankzeile und besteht aus mindestens einer Spalte.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Argumente

connName, tableName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

• Das Argument tableName ist der Name der Tabelle, aus der Sie die Spalten abrufen möchten, die den

Primärschlüssel der Tabelle bilden.

Rückgabewerte

Ein String-Array. Das Array enthält jeweils einen String für alle Spalten, die den Primärschlüssel bilden.

Beispiel

Im folgenden Beispiel wird der Primärschlüssel für die angegebene Tabelle zurückgegeben.

var connName = componentRec.parent.parent.parent.name;
var tableName = componentRec.name;
var primaryKeys = MMDB.getPrimaryKeys(connName,tableName);

MMDB.getProcedures()

72

Verfügbarkeit

Dreamweaver MX.

Beschreibung

Diese Funktion gibt ein Array der Prozedurobjekte zurück, die mit einer benannten Verbindung verknüpft sind.

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

Rückgabewerte

Ein Array der Prozedurobjekte, in dem jedes Prozedurobjekt die folgenden drei Eigenschaften aufweist.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Name der Eigenschaft Beschreibung

schema Name des mit dem Objekt verknüpften Schemas.

Diese Eigenschaft gibt den Benutzer an, der mit der gespeicherten Prozedur in der SQL-Datenbank verknüpft
ist, auf die mit der Funktion
Datenbank hängt vom Typ der Verbindung ab.

getProcedures() zugegriffen wird. Die von dieser Funktion aufgerufene

• Bei ODBC-Verbindungen wird die Datenbank durch die ODBC-Datenquelle definiert. Der DSN wird durch

die Eigenschaft

getProcedures() übergeben.

dsn im Verbindungsobjekt (connName) angegeben, das Sie an die Funktion

• Bei OLE-Datenbankverbindungen wird die Datenbank durch den Verbindungsstring definiert.

catalog Name des mit dem Objekt verknüpften Katalogs (Eigentümerqualifizierer).

Der Wert der Eigenschaft
Treiberattribut wird die Standardeigenschaft
Verbindungsstring keine Datenbank angegeben ist.

procedure Name der Prozedur.

catalog wird durch ein Attribut des OLE-Datenbanktreibers definiert. Mit diesem

user.database definiert, die verwendet wird, wenn im OLE-

Hinweis: Wenn Sie eine Datensatzgruppe ändern, wird eine Verbindung mit der Datenbank hergestellt. Dann werden
alle Tabellen in der Datenbank abgerufen. Wenn die Datenbank viele Tabellen enthält, nimmt das Abrufen der Tabellen
auf bestimmten Systemen möglicherweise viel Zeit in Anspruch. Wenn die Datenbank ein Schema oder einen Katalog
enthält, können Sie mit dem Schema bzw. dem Katalog die Anzahl der Datenbankelemente beschränken, die in
Dreamweaver während der Entwurfsphase abgerufen werden. Zunächst müssen Sie in der Datenbankanwendung ein
Schema oder einen Katalog erstellen, bevor Sie das Schema oder den Katalog in Dreamweaver zuweisen können. Weitere
Informationen erhalten Sie in der Dokumentation zu Ihrer Datenbank oder von Ihrem Systemadministrator.

73

Beispiel

Mit folgendem Code wird eine Liste der Prozeduren abgerufen:

var procObjects = MMDB.getProcedures(connectionName);
for (i = 0; i < procObjects.length; i++)
{

var thisProcedure = procObjects[i]
thisSchema =Trim(thisProcedure.schema)
if (thisSchema.length == 0)
{
thisSchema = Trim(thisProcedure.catalog)
}
if (thisSchema.length > 0)
{
thisSchema += "."
}

var procName = String(thisSchema + thisProcedure.procedure);

}

MMDB.getSPColumnList()

Verfügbarkeit

Dreamweaver UltraDev 1.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Beschreibung

Diese Funktion ruft eine Liste der Ergebnissatzspalten ab, die durch einen Aufruf der angegebenen gespeicherten
Prozedur generiert wurden.

Argumente

connName, statement, paramValuesArray

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

• Das Argument statement ist der Name der gespeicherten Prozedur, die den Ergebnissatz zurückgibt, wenn sie

ausgeführt wird.

• Das Argument paramValuesArray ist ein Array, das eine Liste von Testwerten der Entwurfsphasenparameter

enthält. Geben Sie die Parameterwerte in der Reihenfolge an, in der sie von der gespeicherten Prozedur erwartet
werden. Mithilfe der Funktion

MMDB.getSPParamsAsString() können Sie die Parameter der gespeicherten

Prozedur abrufen.

Rückgabewerte

Ein String-Array, das die Liste der Spalten enthält. Diese Funktion gibt einen Fehler zurück, wenn die SQL-Anweisung
oder der Verbindungsstring ungültig ist.

74

Beispiel

Mit dem folgenden Code kann eine Liste der Ergebnissatzspalten zurückgegeben werden, die von der ausgeführten
gespeicherten Prozedur

var paramValueArray = new Array("2/1/2000", "50000")
var columnArray = MMDB.getSPColumnList("EmpDB", ¬
"getNewEmployeesMakingAtLeast", paramValueArray)
The following values return:
columnArray[0] = "EmpID", columnArray[1] = "LastName", ¬
columnArray[2] ="startDate", columnArray[3] = "salary"

getNewEmployeesMakingAtLeast generiert wurden.

MMDB.getSPColumnListNamedParams()

Verfügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft eine Liste der Ergebnissatzspalten ab, die durch einen Aufruf der angegebenen gespeicherten
Prozedur generiert wurden.

Argumente

connName, statement, paramNameArray, paramValuesArray

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

• Das Argument statement ist der Name der gespeicherten Prozedur, die den Ergebnissatz zurückgibt, wenn sie

ausgeführt wird.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

• Das Argument paramNameArray ist ein Array, das eine Liste mit Parameternamen enthält. Mithilfe der Funktion

MMDB.getSPParamsAsString() können Sie die Parameter der gespeicherten Prozedur abrufen.

• Das Argument paramValuesArray ist ein Array, das eine Liste von Testwerten der Entwurfsphasenparameter

enthält. Sie können angeben, ob beim Ausführen der Prozedur Parameter erforderlich sind. Wenn Sie in
paramNameArray Parameternamen festgelegt haben, geben Sie die Parameternamen in derselben Reihenfolge an,
in der sie in paramNameArray aufgeführt sind. Wenn Sie keine Parameter für paramNameArray angegeben haben,
legen Sie die Werte in der Reihenfolge fest, in der sie von der gespeicherten Prozedur erwartet werden.

Rückgabewerte

Ein String-Array, das die Liste der Spalten enthält. Diese Funktion gibt einen Fehler zurück, wenn die SQL-Anweisung
oder der Verbindungsstring ungültig ist.

Beispiel

Mit dem folgenden Code kann eine Liste der Ergebnissatzspalten zurückgegeben werden, die von der ausgeführten
gespeicherten Prozedur

var paramNameArray = new Array("startDate", "salary")
var paramValueArray = new Array("2/1/2000", "50000")
var columnArray = MMDB.getSPColumnListNamedParams("EmpDB", ¬
"getNewEmployeesMakingAtLeast", paramNameArray, paramValueArray)

getNewEmployeesMakingAtLeast generiert wurden.

75

Die folgenden Werte werden zurückgegeben:

columnArray[0] = "EmpID", columnArray[1] = "LastName",¬
columnArray[2] ="startDate", columnArray[3] = "salary"

MMDB.getSPParameters()

Verfügbarkeit

Dreamweaver MX.

Beschreibung

Diese Funktion gibt ein Array der Parameterobjekte einer benannten Prozedur zurück.

Argumente

connName, procName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

• Das Argument procName ist der Name der Prozedur.

Rückgabewerte

Ein Array von Parameterobjekten, die jeweils die folgende Gruppe von Eigenschaften angeben.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Name der Eigenschaft Beschreibung

name Name des Parameters (z. B. @@lolimit)

datatype Datentyp des Parameters (z. B. smallmoney)

direction Richtung des Parameters:

1 – Der Parameter wird nur für Eingaben verwendet.

2 – Der Parameter wird nur für Ausgaben verwendet. In diesem Fall wird der Parameter durch

Verweis übergeben. Die Methode weist dann dem Parameter einen Wert zu. Sie können den Wert
nach der Rückgabe durch die Methode verwenden.

3 – Der Parameter wird für Ein- und Ausgaben verwendet.

4 – Der Parameter enthält einen Rückgabewert.

Beispiel

Im folgenden Beispiel werden die Parameterobjekte für die angegebene Prozedur abgerufen und für jedes Objekt wird
anhand der entsprechenden Eigenschaft eine QuickInfo erstellt.

var paramNameObjs = MMDB.getSPParameters(connName,procName);
for (i = 0; i < paramNameObjs.length; i++)
{

var paramObj = paramNameObjs[i];
var tooltiptext = paramObj.datatype;
tooltiptext+=" ";
tooltiptext+=GetDirString(paramObj.directiontype);

}

76

MMDB.getSPParamsAsString()

Verfügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft einen String ab, der Kommas als Trennzeichen verwendet und die Liste der Parameter enthält, die
die gespeicherte Prozedur erwartet.

Argumente

connName, procName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

• Das Argument procName ist der Name der gespeicherten Prozedur.

Rückgabewerte

Ein String, der Kommas als Trennzeichen verwendet und die Liste der Parameter enthält, die für die gespeicherte
Prozedur erforderlich sind. Der Name, die Richtung und der Datentyp der Parameter sind enthalten und jeweils durch
einen Strichpunkt (;) getrennt.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Beispiel

Der Code
Form

MMDB.getSPParamsAsString ("EmpDB","getNewEmployeesMakingAtLeast") kann einen String der

startDate;direction:in;datatype:date, salary;direction:in;datatype:integer zurückgeben.

77

In diesem Beispiel hat die gespeicherte Prozedur

Salary. Bei startDate lautet die Richtung in und der Datentyp date. Bei salary lautet die Richtung in und der

Datentyp

integer.

getNewEmployeesMakingAtLeast zwei Parameter: startDate und

MMDB.getTables()

Verfügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion ruft eine Liste aller Tabellen ab, die für die angegebene Datenbank definiert sind. Jedes Tabellenobjekt
hat drei Eigenschaften:

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

Rückgabewerte

Ein Array von Objekten, in dem jedes Tabellenobjekt drei Eigenschaften hat:
Eigenschaft

table ist der Name der Tabelle. Der Wert für schema ist der Name des Schemas, das die Tabelle enthält.

Die Eigenschaft

table, schema und catalog.

table, schema und catalog. Die

catalog ist der Katalog, der die Tabelle enthält.

Beispiel

Die Anweisung

MMDB.getTables ("EmpDB"); kann beispielsweise ein Array mit zwei Objekten generieren. Die

Eigenschaften des ersten Objekts entsprechen möglicherweise dem folgenden Beispiel:

object1[table:"Employees", schema:"personnel", catalog:"syscat"]

Die Eigenschaften des zweiten Objekts entsprechen möglicherweise dem folgenden Beispiel:

object2[table:"Departments", schema:"demo", catalog:"syscat2"]

MMDB.getViews()

Verfügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Diese Funktion ruft eine Liste aller Ansichten ab, die für die angegebene Datenbank definiert sind. Jedes
Ansichtsobjekt hat die Eigenschaften

catalog, schema und view.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Argumente

connName

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

Rückgabewerte

Ein Array von Ansichtsobjekten, in dem jedes Objekt drei Eigenschaften hat:

catalog und schema zum Einschränken oder Filtern der Anzahl der Ansichten, die sich auf einen bestimmten

Sie

catalog, schema und view. Verwenden

Schema- oder Katalognamen beziehen, der im Rahmen der Verbindungsinformationen definiert wurde.

Beispiel

Im folgenden Beispiel werden die Ansichten für den Verbindungswert

var viewObjects = MMDB.getViews(CONN_LIST.getValue())
for (i = 0; i < viewObjects.length; i++)
{

thisView = viewObjects[i]
thisSchema = Trim(thisView.schema)
if (thisSchema.length == 0)
{

thisSchema = Trim(thisView.catalog)
}
if (thisSchema.length > 0)
{

thisSchema += "."
}
views.push(String(thisSchema + thisView.view))

}

CONN_LIST.getValue() zurückgegeben.

78

MMDB.showResultset()

Verfügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion zeigt ein Dialogfeld mit den Ergebnissen aus der Ausführung der angegebenen SQL-Anweisung an.
Im Dialogfeld wird ein tabellarisches Raster angezeigt, dessen Kopfzeile die Spalteninformationen für den
Ergebnissatz angibt. Wenn der Verbindungsstring oder die SQL-Anweisung ungültig ist, wird ein Fehler angezeigt.
Diese Funktion überprüft die SQL-Anweisung auf Gültigkeit.

Argumente

connName, SQLstatement

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

• Das Argument SQLstatement ist die SQL-Anweisung SELECT.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Rückgabewerte

Keine. Diese Funktion gibt einen Fehler zurück, wenn die SQL-Anweisung oder der Verbindungsstring ungültig ist.

Beispiel

Mit dem folgenden Code werden die Ergebnisse der ausgeführten SQL-Anweisung angezeigt.

MMDB.showResultset("EmpDB","Select EmpName,EmpFirstName,Age ¬
from Employees")

MMDB.showSPResultset()

Verfügbarkeit

Dreamweaver UltraDev 1.

Beschreibung

Diese Funktion zeigt ein Dialogfeld mit den Ergebnissen aus der Ausführung der angegebenen gespeicherten Prozedur
an. Im Dialogfeld wird ein tabellarisches Raster angezeigt, dessen Kopfzeile die Spalteninformationen für den
Ergebnissatz angibt. Wenn der Verbindungsstring oder die gespeicherte Prozedur ungültig ist, wird ein Fehler
angezeigt. Diese Funktion überprüft die gespeicherte Prozedur auf Gültigkeit.

79

Argumente

connName, procName, paramValuesArray

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

• Das Argument procName ist der Name der auszuführenden gespeicherten Prozedur.

• Das Argument paramValuesArray ist ein Array, das eine Liste von Testwerten der Entwurfsphasenparameter

enthält. Geben Sie die Parameterwerte in der Reihenfolge an, in der sie von der gespeicherten Prozedur erwartet
werden. Mithilfe der Funktion

MMDB.getSPParamsAsString() können Sie die Parameter der gespeicherten

Prozedur abrufen.

Rückgabewerte

Diese Funktion gibt einen Fehler zurück, wenn die SQL-Anweisung oder der Verbindungsstring ungültig ist.
Andernfalls wird kein Wert zurückgegeben.

Beispiel

Mit dem folgenden Code werden die Ergebnisse der ausgeführten gespeicherten Prozedur angezeigt.

var paramValueArray = new Array("2/1/2000", "50000")
MMDB.showSPResultset("EmpDB", "getNewEmployeesMakingAtLeast", ¬
paramValueArray)

MMDB.showSPResultsetNamedParams()

Verfügbarkeit

Dreamweaver UltraDev 1.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbanken

Beschreibung

Diese Funktion zeigt ein Dialogfeld mit den Ergebnissen der angegebenen gespeicherten Prozedur an. Im Dialogfeld
wird ein tabellarisches Raster angezeigt, dessen Kopfzeile die Spalteninformationen für den Ergebnissatz angibt. Wenn
der Verbindungsstring oder die gespeicherte Prozedur ungültig ist, wird ein Fehler angezeigt. Diese Funktion
überprüft die gespeicherte Prozedur auf Gültigkeit. Diese Funktion unterscheidet sich von

MMDB.showSPResultset(), da Sie Parameterwerte nach Namen festlegen können und nicht in der Reihenfolge

angeben müssen, in der sie von der gespeicherten Prozedur erwartet werden.

Argumente

connName, procName, paramNameArray, paramValuesArray

• Das Argument connName ist ein Verbindungsname, der im Connection Manager angegeben wurde. Er gibt den

Verbindungsstring an, der in Dreamweaver beim Herstellen einer Datenbankverbindung mit einer Live Data­Quelle verwendet werden soll.

• Das Argument procName ist der Name der gespeicherten Prozedur, die den Ergebnissatz zurückgibt, wenn sie

ausgeführt wird.

• Das Argument paramNameArray ist ein Array, das eine Liste mit Parameternamen enthält. Mithilfe der Funktion

MMDB.getSPParamsAsString() können Sie die Parameter der gespeicherten Prozedur abrufen.

• Das Argument paramValuesArray ist ein Array, das eine Liste von Testwerten der Entwurfsphasenparameter

enthält.

80

Rückgabewerte

Diese Funktion gibt einen Fehler zurück, wenn die SQL-Anweisung oder der Verbindungsstring ungültig ist.
Andernfalls wird kein Wert zurückgegeben.

Beispiel

Mit dem folgenden Code werden die Ergebnisse der ausgeführten gespeicherten Prozedur angezeigt.

var paramNameArray = new Array("startDate", "salary")
var paramValueArray = new Array("2/1/2000", "50000")
MMDB.showSPResultsetNamedParams("EmpDB","getNewEmployees¬
MakingAtLeast", paramNameArray, paramValueArray)

Letzte Aktualisierung 22.6.2011

Kapitel 9: API für Datenbankverbindungen

Als Entwickler können Sie neue Verbindungstypen und die entsprechenden Dialogfelder für neue oder vorhandene
Servermodelle für Adobe® Dreamweaver® erstellen. Anschließend kann ein Benutzer ein Verbindungsobjekt anlegen,
wenn er eine Site einrichtet, um Seiten zu erstellen. Zum Erstellen des Verbindungsobjekts muss der Benutzer
zunächst die spezifische Verbindung auswählen, die Sie erstellt haben.

Auswählen eines neuen Verbindungstyps

Der Benutzer kann den neuen Verbindungstyp wie folgt auswählen:

• Er kann im Bedienfeld „Anwendung“ auf die Schaltfläche mit dem Pluszeichen (+) klicken und die Option

„Datensatzgruppe“ auswählen. Im Dialogfeld „Datensatzgruppe“ kann er dann die Einträge des Popupmenüs
„Verbindung“ anzeigen.

• Er kann im Bedienfeld „Datenbanken“ auf der Registerkarte „Datenbank“ auf die Schaltfläche mit dem

Pluszeichen (+) klicken und „Data Source Name (DSN)“ auswählen.

81

Erstellen eines neuen Verbindungstyps

Mit den folgenden Schritten wird der Vorgang zum Erstellen eines neuen Verbindungstyps erläutert.

1 Erstellen Sie das Layout für das Verbindungsdialogfeld.

Erstellen Sie eine HTML-Datei, in der die Benutzeroberfläche für das Verbindungsdialogfeld festgelegt wird.
Speichern Sie die Datei unter dem Namen der Verbindung (z. B. „myConnection.htm“). Informationen zum
Erstellen von Dialogfeldern finden Sie im Handbuch Erste Schritte mit Dreamweaver.

Stellen Sie sicher, dass die HTML-Datei einen Verweis auf die JavaScript-Implementierungsdatei enthält, die Sie in
Schritt 2 definieren. Erstellen Sie eine JavaScript-Datei, die mindestens die folgenden Elemente implementiert:

<head>

<script SRC="../myConnectionImpl.js"></script>

</head>

Speichern Sie diese HTML-Datei, die das Verbindungsdialogfeld definiert, im Ordner
Configuration/Connections/Servermodell/Plattform (Plattform steht entweder für Windows oder für Macintosh).

Das standardmäßige ADO-Verbindungsdialogfeld für ein ASP-JavaScript-Dokument unter Windows wird
beispielsweise unter dem Namen „Connection_ado_conn_string.htm“ im Ordner „ASP_Js/Win“ gespeichert.

Hinweis: Zur Laufzeit erstellt Dreamweaver dynamisch eine Liste der Verbindungstypen, die dem Benutzer aus der
Auswahl der Dialogfelder im Ordner „ASP_Js/Win“ zur Verfügung stehen.

Im Ordner „Configuration/ServerModel“ befinden sich HTML-Dateien, die die einzelnen Servermodelle
definieren. Jede dieser HTML-Dateien enthält die Funktion
Ordners zurückgibt, der mit dem jeweiligen Servermodell verknüpft ist. Im folgenden Beispiel ist die Funktion für
den ASP-JavaScript-Dokumenttyp dargestellt:

getServerModelFolderName(), die den Namen des

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbankverbindungen

function getServerModelFolderName()
{

return "ASP_JS";

}

Anhand der Datei „MMDocumentTypes.xml“ im Ordner „Configuration/DocumentTypes“ können Sie die
Zuordnung der Servermodelle zu den Dokumenttypen ermitteln.

2 Erstellen Sie eine JavaScript-Datei, die mindestens die folgenden Elemente implementiert:

Element Beschreibung Beispiele

82

Eine Gruppe von Variablen Jede Variable definiert eine bestimmte

Verbindungseigenschaft.

Eine Gruppe von Schaltflächen Jede Schaltfläche wird im Verbindungsdialogfeld

angezeigt.

Verbindungsfunktionen Alle diese Funktionen definieren die API für

Datenbankverbindungen.

Verbindungstyp, DSN (Data Source
Name) usw.

„Testen“, „Hilfe“ usw. („OK“ und
„Abbrechen“ werden automatisch
eingefügt.)

• findConnection()

• applyConnection()

• inspectConnection()

Sie können einen beliebigen Namen für diese Implementierungsdatei auswählen, sie muss jedoch die Erweiterung
„.js“ haben (z. B. „myConnectionImpl.js“). Sie können die Datei lokal oder auf einem Remote-Computer
speichern. Sie können die Datei auch in einem Unterordner im Ordner „Configuration/Connections“ speichern.

Hinweis: Die in Schritt 1 („Erstellen Sie das Layout für das Verbindungsdialogfeld“) definierte HTML-Datei muss
diese Implementierungsdatei für den Verbindungstyp enthalten.

Wenn Sie die in der Standarddatei „connection_includefile.edml“ festgelegten Verbindungsparameter nicht anpassen
möchten, kann mit diesen beiden Schritten ein neues Verbindungsdialogfeld erstellt werden.

Hinweis: Der Titel des Dialogfelds in der Benutzeroberfläche steht im Tag

title

, das im HTML-Dokument angegeben wird.

Mithilfe der im nächsten Abschnitt aufgeführten Funktionen können Sie ein Verbindungsdialogfeld erstellen. Neben
der Implementierung der Aufrufe zum Generieren von Include-Dateien für den Benutzer können Sie Ihren
Verbindungstyp im Abschnitt für die Servermodelle in der XML-Verbindungsdatei registrieren.

Informationen zur API für Datenbankverbindungen im Zusammenhang mit dem Erstellen einer neuen Verbindung
finden Sie unter „Funktionen für Datenbankverbindungen“ auf Seite 56.

API für Verbindungen

Um einen neuen Verbindungstyp zu erstellen, einschließlich des Dialogfelds für die Benutzeroberfläche, müssen Sie
die folgenden drei Funktionen implementieren:

applyConnection(). Sie programmieren die drei Funktionen und fügen sie in die JavaScript-Implementierungsdatei

ein, die mit dem neuen Verbindungstyp verknüpft ist (siehe Schritt 2, „Erstellen Sie eine JavaScript-Datei, die
mindestens die folgenden Elemente implementiert“).

Letzte Aktualisierung 22.6.2011

findConnection(), inspectConnection() und

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbankverbindungen

Die Funktion applyConnection() gibt eine HTML-Quelle in einer Include-Datei zurück. Beispiele für die HTML-
Quelle finden Sie unter „Generierte Include-Datei“ auf Seite 85. Die Funktion
Eigenschaften der HTML-Quelle. Sie können die Funktion
Suchmuster aus XML-Dateien Informationen zu extrahieren, die von

findConnection() implementieren, um mithilfe der

applyConnection() zurückgegeben werden.

findConnection() extrahiert die

Beispiele für diese Implementierung finden Sie in den folgenden beiden JavaScript-Dateien:

• Die Datei „connection_ado_conn_string.js“ befindet sich im Ordner „Configuration/Connections/ASP_Js“.

• Die Datei „connection_common.js“ befindet sich im Ordner „Configuration/Connections/Shared“.

Wenn der Benutzer eine Site aufruft, öffnet Dreamweaver jede Datei im Ordner „Connections“ und übergibt deren
Inhalt an die Funktion
entspricht, gibt die Funktion

findConnection(). Wenn der Inhalt einer Datei den Kriterien für eine gültige Verbindung

findConnection() ein Verbindungsobjekt zurück. Alle Verbindungsobjekte werden

dann in Dreamweaver im Bedienfeld „Database Explorer“ angezeigt.

Wenn der Benutzer ein Verbindungsdialogfeld öffnet, um eine neue Verbindung zu erstellen oder eine bestehende zu
kopieren bzw. zu bearbeiten, ruft Dreamweaver die Funktion
Verbindungsobjekt zurück, das von

findConnection() erstellt wurde. Auf diese Weise kann das Dialogfeld mit

inspectConnection() auf und gibt das gleiche

Verbindungsinformationen gefüllt werden.

Wenn der Benutzer in einem Verbindungsdialogfeld auf „OK“ klickt, ruft Dreamweaver die Funktion

applyConnection() auf, um die HTML-Datei zu erstellen, die dann in die Include-Datei im Ordner

„Configuration/Connections“ eingefügt wird. Die Funktion

applyConnection() gibt einen leeren String zurück, der

angibt, dass eines der Felder einen Fehler enthält und das Dialogfeld noch nicht geschlossen werden sollte. Die
Dateinamenerweiterung der Include-Datei entspricht dem aktuellen Servermodell.

83

Wenn der Benutzer einer Seite ein Serververhalten hinzufügt, das die Verbindung verwendet (z. B. eine
Datensatzgruppe oder eine gespeicherte Prozedur), wird eine Anweisung in die Seite eingefügt, die die Include-Datei
der Verbindung enthält.

findConnection()

Verfügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Dreamweaver ruft diese Funktion auf, um eine Verbindung in der ausgewählten HTML-Quelldatei zu erkennen und
die Verbindungsparameter zu analysieren. Wenn der Inhalt dieser Quelldatei mit den Kriterien für eine gültige
Verbindung übereinstimmt, gibt
zurückgegeben.

Argumente

htmlSource

Das Argument htmlSource ist die HTML-Quelldatei für eine Verbindung.

Rückgabewerte

Ein Verbindungsobjekt, das Werte für eine bestimmte Kombination der in der folgenden Tabelle aufgeführten
Eigenschaften enthält. Die Eigenschaften, für die diese Funktion einen Wert zurückgibt, hängen vom jeweiligen
Dokumenttyp ab.

findConnection() ein Verbindungsobjekt zurück. Andernfalls wird der Wert null

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbankverbindungen

Eigenschaft Beschreibung

name Name der Verbindung

84

type Wenn useHTTP den Wert false hat, gibt diese Eigenschaft an, welche DLL für die Verbindung mit

string Verbindungsstring zur Laufzeit. Für ADO handelt es sich um einen String mit

dsn Data Source Name, der für ODBC- oder ColdFusion-Verbindungen zur Laufzeit verwendet wird.

driver Name eines zur Laufzeit verwendeten JDBC-Treibers

username Name des Benutzers für die Laufzeitverbindung

password Kennwort für die Laufzeitverbindung

designtimeString Entwurfsphasen-Verbindungsstring (siehe string)

designtimeDsn Entwurfsphasen-Data Source Name (siehe dsn)

designtimeDriver Name eines während der Entwurfsphase verwendeten JDBC-Treibers

designtimeUsername Name des Benutzers für die Entwurfsphasenverbindung

designtimePassword Kennwort für die Entwurfsphasenverbindung

designtimeType Entwurfsphasen-Verbindungstyp

usesDesigntimeInfo Wenn false, werden in der Entwurfsphase Laufzeiteigenschaften verwendet, andernfalls werden

useHTTP String mit dem Wert true oder false.true gibt an, dass in der Entwurfsphase die HTTP-

includePattern Ein regulärer Ausdruck, mit dem die include-Anweisung auf der Seite in der Ansicht „Live Data“ und

der Datenbank zur Laufzeit verwendet werden soll.

Verbindungsparametern, für JDBC um eine Verbindungs-URL.

Entwurfsphaseneigenschaften verwendet.

Verbindung verwendet werden soll.

„Vorschau in Browser“ gesucht wird.

false gibt an, dass die DLL verwendet werden soll.

variables Objekt mit einer Eigenschaft für jede Seitenvariable, die auf den entsprechenden Wert gesetzt wird.

catalog String mit einem Datenbankbezeichner, der den Umfang der angezeigten Metadaten einschränkt.

schema String mit einem Datenbankbezeichner, der den Umfang der angezeigten Metadaten einschränkt.

filename Name des Dialogfelds, über das die Verbindung erstellt wird.

Dieses Objekt wird in den Ansichten „Live Data“ und „Vorschau in Browser“ verwendet.

Wenn keine Verbindung in htmlSource gefunden wurde, wird der Wert null zurückgegeben.

Hinweis: Entwickler können benutzerdefinierte Eigenschaften (z. B. Metadaten) in die HTML-Quelle einfügen, die von

applyConnection() zusammen mit den Standardeigenschaften zurückgeben werden.

inspectConnection()

Verfügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Dreamweaver ruft diese Funktion auf, um die Dialogfelddaten zum Definieren der Verbindung zu initialisieren, wenn
der Benutzer eine vorhandene Verbindung bearbeitet. Auf diese Weise können im Dialogfeld die richtigen
Verbindungsinformationen angezeigt werden.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbankverbindungen

Argumente

parameters

85

Beim Argument parameters handelt es sich um das gleiche Objekt, das die Funktion

Rückgabewerte

Keine.

findConnection() zurückgibt.

applyConnection()

Verfügbarkeit

Dreamweaver UltraDev 4.

Beschreibung

Dreamweaver ruft diese Funktion auf, wenn der Benutzer im Verbindungsdialogfeld auf „OK“ klickt. Die Funktion

applyConnection() generiert den HTML-Quellcode für eine Verbindung. Dreamweaver schreibt den HTML-Code

in die Include-Datei Verbindungsname.erw im Ordner „Configuration/Connections“, wobei Verbindungsname der
Name Ihrer Verbindung (siehe „Erstellen eines neuen Verbindungstyps“ auf Seite 81) und „.erw“ die
Standarderweiterung für das Servermodell ist.

Argumente

Keine.

Rückgabewerte

Der HTML-Quellcode für eine Verbindung. Dreamweaver schließt auch das Verbindungsdialogfeld. Wenn eine
Feldüberprüfung einen Fehler ergibt, zeigt
zurück, um anzugeben, dass das Dialogfeld nicht geschlossen werden soll.

applyConnection() eine Fehlermeldung an und gibt einen leeren String

Generierte Include-Datei

In der von applyConnection() generierten Include-Datei werden alle Eigenschaften einer Verbindung deklariert.
Der Dateiname der Include-Datei ist der Verbindungsname. Die Datei hat die Dateinamenerweiterung, die für das mit
der aktuellen Site verknüpfte Servermodell definiert ist.

Hinweis: Verbindungen werden gemeinsam verwendet. Setzen Sie daher den Wert für
Dadurch wird sichergestellt, dass die Verbindungsdatei nur einmal in das Dokument eingefügt wird. Zudem wird
gewährleistet, dass das Serverskript auch in der Seite bleibt, wenn andere Serververhalten es verwenden.

In den folgenden Abschnitten finden Sie einige Beispiele für Include-Dateien, die von
verschiedene Standardservermodelle generiert werden.

Hinweis: Um ein Dateiformat für eine Include-Datei zu erstellen, definieren Sie eine neue EDML-Zuordnungsdatei, z. B.
„connection_includefile.edml“ (siehe dazu „Definitionsdatei für den Verbindungstyp“ auf Seite 86).

ASP JavaScript

Die ASP- und JavaScript-Include-Datei sollte den Namen „myConnection1.asp“ haben, wobei „myConnection1“ der
Name der Verbindung ist. Das folgende Beispiel ist eine Include-Datei für einen ADO-Verbindungsstring:

Letzte Aktualisierung 22.6.2011

allowMultiple auf false.

applyConnection() für

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbankverbindungen

<%

// Filename="Connection_ado_conn_string.htm"
// Type="ADO"
// HTTP="true"
// Catalog=""
// Schema=""
var MM_MyConnection1_STRING = "dsn=pubs";

%>

Die Serververhaltendatei schließt diese Verbindung mit ein, indem sie die relative Include-Anweisung verwendet
(siehe folgendes Beispiel).

<!--#include file="../Connections/MyConnection1.asp"-->

ColdFusion

Bei Verwendung von UltraDev 4 ColdFusion ruft Dreamweaver mithilfe einer ColdFusion Include-Datei eine Liste
von Datenquellen ab.

Hinweis: Bei Dreamweaver-ColdFusion ignoriert Dreamweaver normalerweise alle Include-Dateien und ruft die Liste
der Datenquellen stattdessen über RDS von ColdFusion ab.

Die Include-Datei für UltraDev 4 ColdFusion sollte den Namen „myConnection1.cfm“ haben, wobei
„myConnection1“ der Name der Verbindung ist. Im folgenden Beispiel ist die Include-Datei für eine ColdFusion­Verbindung mit einer Produkttabelle dargestellt:

86

<!-- FileName="Connection_cf_dsn.htm" "dsn=products" -->
<!-- Type="ADO" -->
<!-- Catalog="" -->
<!-- Schema="" -->
<!-- HTTP="false" -->
<CFSET MM_MyConnection1_DSN = "products">
<CFSET MM_MyConnection1_USERNAME = "">
<CFSET MM_Product_USERNAME = "">
<CFSET MM_MyConnection1_PASSWORD = "">

Die Serververhaltendatei schließt diese Verbindung mit ein, indem sie die Anweisung cfinclude verwendet (siehe
folgendes Beispiel).

<cfinclude template="Connections/MyConnection1.cfm">

Definitionsdatei für den Verbindungstyp

Für jedes Servermodell gibt es eine Datei „connection_includefile.edml“, die den Verbindungstyp definiert und die in
der Include-Datei definierten Eigenschaften den entsprechenden Elementen in der Benutzeroberfläche von
Dreamweaver zuordnet.

Dreamweaver enthält Standarddefinitionsdateien, d. h. eine Datei für jedes der vordefinierten Servermodelle, die in
der folgenden Tabelle aufgeführt sind.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbankverbindungen

Servermodell Unterordner im Ordner „Configuration/Connections“

ASP JavaScript ASP_Js

ASP.NET CSharp ASP.NET_Csharp

ASP.NET VBScript ASP.NET_VB

ASP VBScript ASP_Vbs

ColdFusion ColdFusion

Java Server Pages JSP

PHP MySql PHP_MySql

Dreamweaver ermittelt Verbindungsblöcke mit den Parametern quickSearch und searchPattern und erstellt
Verbindungsblöcke mit dem Parameter

insertText. Weitere Informationen zu EDML-Tags und EDML-Attributen

sowie zu Suchmustern für reguläre Ausdrücke finden Sie unter „Serververhalten“ im Handbuch Dreamweaver
erweitern.

Hinweis: Wenn Sie das Format Ihrer Include-Datei ändern oder eine Include-Datei für ein neues Servermodell
definieren, müssen Sie die Verbindungsparameter der Dreamweaver-Benutzeroberfläche sowie den Ansichten „Live
Data“ und „Vorschau in Browser“ zuordnen. Im folgenden Beispiel für eine EDML-Datei, die mit dem ASP-JS­Standardservermodell verknüpft ist, wurden alle Variablen der Verbindungsseite den entsprechenden Werten
zugeordnet, bevor die Seite an den Server gesendet wurde. Weitere Informationen über EDML und Suchmuster für
reguläre Ausdrücke finden Sie unter „Serververhalten“ im Handbuch „Dreamweaver erweitern“.

87

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API für Datenbankverbindungen

<participant name="connection_includefile" version="5.0">

<quickSearch>

<![CDATA[// HTTP=]]></quickSearch>
<insertText location="">

<![CDATA[<%
// FileName="@@filename@@"
// Type="@@type@@" @@designtimeString@@
// DesigntimeType="@@designtimeType@@"
// HTTP="@@http@@"
// Catalog="@@catalog@@"
// Schema="@@schema@@"
var MM_@@cname@@_STRING = @@string@@
%>
]]>

</insertText>
<searchPatterns whereToSearch="directive">

<searchPattern paramNames="filename">

<![CDATA[/\/\/\s*FileName="([^"]*)"/]]></searchPattern>

<searchPattern paramNames="type,designtimeString">

<![CDATA[/\/\/\s+Type="(\w*)"([^\r\n]*)/]]></searchPattern>

<searchPattern paramNames="designtimeType" isOptional="true">

<![CDATA[/\/\/\s*DesigntimeType="(\w*)"/]]></searchPattern>

<searchPattern paramNames="http">

<![CDATA[/\/\/\s*HTTP="(\w+)"/]]></searchPattern>

<searchPattern paramNames="catalog">

<![CDATA[/\/\/\s*Catalog="(\w*)"/]]></searchPattern>

<searchPattern paramNames="schema">

<![CDATA[/\/\/\s*Schema="(\w*)"/]]></searchPattern>

<searchPattern paramNames="cname,string">

<![CDATA[/var\s+MM_(\w*)_STRING\s*=\s*([^\r\n]+)/]]></searchPattern>

</searchPatterns>

</participant>

88

Token in einer EDML-Datei (z. B. @@filename@@ in diesem Beispiel) ordnen Werte in der Include-Datei den
jeweiligen Eigenschaften eines Verbindungsobjekts zu. Die Eigenschaften von Verbindungsobjekten legen Sie in der
JavaScript-Implementierungsdatei fest.

Alle im Lieferumfang von Dreamweaver enthaltenen Dialogfelder verwenden die Zuordnungsdatei
„connection_includefile.edml“. Damit Dreamweaver diese Datei finden kann, wird der Dateiname in der JavaScript­Implementierungsdatei festgelegt, wie im folgenden Beispiel dargestellt ist.

var PARTICIPANT_FILE = "connection_includefile";

Beim Erstellen eines benutzerdefinierten Verbindungstyps können Sie in Ihren Dialogfeldern eine beliebige
Zuordnungsdatei angeben. Wenn Sie eine Zuordnungsdatei erstellen, können Sie für Ihre EDML-Datei einen von
„connection_includefile“ abweichenden Namen verwenden. Wenn Sie einen anderen Namen verwenden, müssen Sie
diesen auch in der JavaScript-Implementierungsdatei definieren, wenn Sie den Wert für die Variable

PARTICIPANT_FILE angeben, wie im folgenden Beispiel dargestellt ist.

var PARTICIPANT_FILE = "myConnection_mappingfile";

Letzte Aktualisierung 22.6.2011

Kapitel 10: API zur Integration der Quellcodeverwaltung

Mit der API zur Integration der Quellcodeverwaltung können Sie gemeinsam genutzte Bibliotheken programmieren.
Mit diesen API-Funktionen können Sie das Ein- und Auschecken in Adobe® Dreamweaver® unter Verwendung von
Quellcode-Verwaltungssystemen (z. B. Sourcesafe oder CVS) erweitern.

Ihre Bibliotheken müssen eine Mindestanzahl erforderlicher API-Funktionen unterstützen, damit Dreamweaver in
ein Quellcode-Verwaltungssystem integriert werden kann. Außerdem müssen sich Ihre Bibliotheken im Ordner
„Programme/Adobe/Adobe Dreamweaver CS5/Configuration/SourceControl“ befinden.

89

Beim Start von Dreamweaver werden die einzelnen Bibliotheken geladen. Dreamweaver ruft
jede API-Funktion auf, um zu ermitteln, welche Funktionen die Bibliothek unterstützt. Wenn keine Adresse
vorhanden ist, nimmt Dreamweaver an, dass die API nicht von dieser Bibliothek unterstützt wird. Wenn die Adresse
vorhanden ist, verwendet Dreamweaver die Bibliothek-Version der Funktion, um die Funktionalität zu unterstützen.
Wenn ein Dreamweaver-Benutzer eine Site definiert oder bearbeitet und anschließend die Registerkarte „Web Server
SCS“ auswählt, werden die Auswahlmöglichkeiten angezeigt, die den DLLs entsprechen. Diese Auswahlmöglichkeiten
werden zusätzlich zu den Standardelementen auf der Registerkarte angezeigt. Die DLLs werden aus dem Ordner
„Programme/Adobe/Adobe Dreamweaver CS5/Configuration/SourceControl“ geladen.

Wenn Sie ein Menü „Site“ > „Source Control“ (Quellcodeverwaltung) erstellen möchten, dem Sie benutzerdefinierte
Elemente hinzufügen können, verwenden Sie den folgenden Code. Fügen Sie den Code dem Menü „Site“ in der Datei
„menus.xml“ hinzu:

<menu name="Source Control" id="DWMenu_MainSite_Site_Source¬
Control"><menuitem dynamic name="None"file="Menus/MM/¬
File_SCSItems.htm" id="DWMenu_MainSite_Site_NewFeatures_¬
Default" />
</menu>

GetProcAddress() für

Funktionsweise der Integration der Quellcodeverwaltung in Dreamweaver

Wenn ein Dreamweaver-Benutzer eine Serververbindungs-, Dateiübertragungs- oder Design Notes-Funktion
auswählt, ruft Dreamweaver die DLL-Version der entsprechenden API-Funktion auf (

Get(), Put(), Checkin(), Checkout(), Undocheckout() und Synchronize()). Die Anforderung wird von der DLL

abgewickelt; dazu gehören beispielsweise auch die Anzeige von Dialogfeldern, in denen Informationen erfasst werden,
sowie Benutzerinteraktionen mit der DLL. Die DLL zeigt außerdem Informationen und Fehlermeldungen an.

Connect(), Disconnect(),

Das Quellcodeverwaltungssystem kann optional Design Notes und das Ein- und Auschecken unterstützen. In
Dreamweaver aktiviert der Benutzer Design Notes für Quellcode-Verwaltungssysteme, indem er im Dialogfeld „Site­Definition“ auf der Registerkarte „Erweitert“ die Kategorie „Design Notes“ auswählt und dann das entsprechende
Kontrollkästchen aktiviert. So werden Design Notes auch über FTP und LANs aktiviert. Wenn Design Notes vom
Quellcode-Verwaltungssystem nicht unterstützt werden und der Benutzer diese Funktion dennoch verwenden
möchte, werden Design Notes-Dateien (MNO-Dateien) von Dreamweaver übertragen, damit die Design Notes
erhalten bleiben (wie auch über FTP und LANs).

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API zur Integration der Quellcodeverwaltung

Das Ein- und Auschecken wird anders behandelt als die Design Notes-Funktion: Wenn das Quellcode­Verwaltungssystem Ein- und Auschecken unterstützt, kann der Benutzer die Verwendung nicht vom Dialogfeld „Site­Definition“ aus außer Kraft setzen. Wenn der Benutzer versucht, das Quellcode-Verwaltungssystem außer Kraft zu
setzen, wird eine Fehlermeldung angezeigt.

Hinzufügen von Quellcode­Verwaltungssystemfunktionen

Sie können Dreamweaver Quellcode-Verwaltungssystemfunktionen hinzufügen, indem Sie einen GetNewFeatures­Handler programmieren, der eine Gruppe von Menüelementen und entsprechenden C-Funktionen zurückgibt. Wenn
Sie beispielsweise eine Sourcesafe-Bibliothek programmieren und Dreamweaver-Benutzern ermöglichen möchten,
den Verlauf einer Datei anzuzeigen, können Sie einen Handler
„Verlauf“ und den C-Funktionsnamen
Maustaste auf eine Datei klickt, wird das Menüelement „Verlauf“ im Kontextmenü aufgeführt. Wenn ein Benutzer das
Menüobjekt „Verlauf“ auswählt, ruft Dreamweaver die entsprechende Funktion auf und die ausgewählten Dateien
werden an die DLL übergeben. Die DLL zeigt das Dialogfeld „Verlauf“ an, damit der Benutzer damit genauso arbeiten
kann wie bei Sourcesafe.

history zurückgibt. Wenn der Benutzer dann in Windows mit der rechten

GetNewFeatures schreiben, der das Menüelement

90

Erforderliche Funktionen der API zur Integration der Quellcodeverwaltung

Die API zur Integration der Quellcodeverwaltung verfügt über erforderliche und optionale Funktionen. Bei den hier
aufgeführten Funktionen handelt es sich um erforderliche Funktionen.

bool SCS_GetAgentInfo()

Beschreibung

Diese Funktion fordert die DLL auf, ihren Namen und eine Beschreibung zurückzugeben. Diese Informationen
werden im Dialogfeld „Site-Definition“ angezeigt. Der Name wird im Popupmenü „Zugriff“ angezeigt (z. B.
Sourcesafe, WebDav, Perforce) und die Beschreibung direkt unter dem Popupmenü.

Argumente

char name[32], char version[32], char description[256], const char *dwAppVersion

• Das Argument name ist der Name des Quellcode-Verwaltungssystems. Der Name wird im Dialogfeld „Site-

Definition“ auf der Registerkarte „Erweitert“ in der Kategorie „Remote-Informationen“ im Popupmenü zum
Auswählen eines Quellcode-Verwaltungssystems angezeigt. Der Name kann aus maximal 32 Zeichen bestehen.

• Das Argument version ist ein String, der die Version der DLL angibt. Die Version wird im Dialogfeld „Site-

Definition“ auf der Registerkarte „Erweitert“ in der Kategorie „Remote-Informationen“ angezeigt. Die Version
kann aus maximal 32 Zeichen bestehen.

• Das Argument description ist ein String, der die Beschreibung des Quellcode-Verwaltungssystems enthält. Die

Beschreibung wird im Dialogfeld „Site-Definition“ auf der Registerkarte „Erweitert“ in der Kategorie „Remote­Informationen“ angezeigt. Die Beschreibung kann aus maximal 256 Zeichen bestehen.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API zur Integration der Quellcodeverwaltung

• Das Argument dwAppVersion ist ein String, der die Dreamweaver-Version angibt, die die DLL aufruft. Die DLL

kann anhand dieses Strings die Version und Sprache von Dreamweaver bestimmen.

Rückgabewerte

Ein boolescher Wert:

true, wenn erfolgreich, andernfalls false.

bool SCS_Connect()

Beschreibung

Diese Funktion verbindet den Benutzer mit dem Quellcode-Verwaltungssystem. Wenn die DLL nicht über
Anmeldungsinformationen verfügt, muss die DLL ein Dialogfeld anzeigen, in dem der Benutzer aufgefordert wird, die
Informationen einzugeben. Sie muss außerdem die Daten für die spätere Verwendung speichern.

Argumente

void **connectionData, const char siteName[64]

• Das Argument connectionData ist ein Handle zu den Daten, die beim Aufrufen anderer API-Funktionen von

Dreamweaver an den Agenten übergeben werden sollen.

• Das Argument siteName ist ein String, der auf den Namen der Site verweist. Der Sitename kann aus maximal 64

Zeichen bestehen.

91

Rückgabewerte

Ein boolescher Wert:

true, wenn erfolgreich, andernfalls false.

bool SCS_Disconnect()

Beschreibung

Diese Funktion trennt die Verbindung des Benutzers zum Quellcode-Verwaltungssystem.

Argumente

void *connectionData

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect()

an Dreamweaver übergeben wurden.

Rückgabewerte

Ein boolescher Wert:

true, wenn erfolgreich, andernfalls false.

bool SCS_IsConnected()

Beschreibung

Diese Funktion bestimmt den Status der Verbindung.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API zur Integration der Quellcodeverwaltung

Argumente

void *connectionData

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect()

an Dreamweaver übergeben wurden.

Rückgabewerte

Ein boolescher Wert:

true, wenn erfolgreich, andernfalls false.

int SCS_GetRootFolderLength()

Beschreibung

Diese Funktion gibt die Länge des Stammordnernamens zurück.

Argumente

void *connectionData

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect()

an Dreamweaver übergeben wurden.

92

Rückgabewerte

Eine Ganzzahl, die die Länge des Stammordnernamens angibt. Ist der Rückgabewert der Funktion
Dreamweaver als Fehler interpretiert, und das Programm versucht, die Fehlermeldung von der DLL abzurufen, sofern
dies unterstützt wird.

< 0, wird dies von

bool SCS_GetRootFolder()

Beschreibung

Diese Funktion gibt den Namen des Stammordners zurück.

Argumente

void *connectionData, char remotePath[], const int folderLen

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect()

an Dreamweaver übergeben wurden.

• remotePath ist ein Puffer, in dem der vollständige Remote-Pfad des Stammordners gespeichert wird.

• Das Argument folderLen ist eine Ganzzahl, die die Länge von remotePath angibt. Dies ist der von

GetRootFolderLength zurückgegebene Wert.

Rückgabewerte

Ein boolescher Wert:

true, wenn erfolgreich, andernfalls false.

int SCS_GetFolderListLength()

Beschreibung

Diese Funktion gibt die Anzahl der Elemente im übergebenen Ordner zurück.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API zur Integration der Quellcodeverwaltung

Argumente

void *connectionData, const char *remotePath

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect()

an Dreamweaver übergeben wurden.

• Das Argument remotePath ist der vollständige Pfad und Name des Remote-Ordners, den die DLL auf die Anzahl

der Elemente prüft.

Rückgabewerte

Eine Ganzzahl, die die Anzahl der Elemente im aktuellen Ordner angibt. Ist der Rückgabewert der Funktion

< 0, wird

dies von Dreamweaver als Fehler interpretiert, und das Programm versucht, die Fehlermeldung von der DLL
abzurufen, sofern dies unterstützt wird.

bool SCS_GetFolderList()

Beschreibung

Diese Funktion gibt eine Liste der Dateien und Ordner im übergebenen Ordner zurück, einschließlich zugehöriger
Informationen wie Größe, Datum der letzten Änderung und der Angabe, ob es sich um einen Ordner oder eine Datei
handelt.

93

Argumente

void *connectionData, const char *remotePath, itemInfo itemList[ ], const int numItems

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect()

an Dreamweaver übergeben wurden.

• Das Argument remotePath ist der Pfadname des Remote-Ordners, den die DLL auf die Anzahl der Elemente prüft.

• Das Argument itemList ist eine bereits zugewiesene Liste mit itemInfo-Strukturen:

name char[256] Name der Datei oder des Ordners

isFolder

month

day

year

hour

minutes

seconds

type

size

bool true, wenn Ordner; false, wenn Datei

int Komponente Monat von Änderungsdatum 1–12

int Komponente Tag von Änderungsdatum 1–31

int Komponente Jahr von Änderungsdatum 1900+

int Komponente Stunde von Änderungsdatum 0–23

int Komponente Minute von Änderungsdatum 0–59

int Komponente Sekunde von Änderungsdatum 0–59

char[256] Dateityp (falls nicht durch die DLL festgelegt, bestimmt Dreamweaver den Typ wie

bisher anhand der Dateierweiterung)

int In Byte

• Das Argument numItems ist die Anzahl der für itemList zugewiesenen Elemente (zurückgegeben von

GetFolderListLength).

Rückgabewerte

Ein boolescher Wert:

true, wenn erfolgreich, andernfalls false.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API zur Integration der Quellcodeverwaltung

bool SCS_Get()

Beschreibung

Diese Funktion ruft eine Liste mit Dateien oder Ordnern ab und speichert sie lokal.

Argumente

void *connectionData, const char *remotePathList[], const char *localPathList[], const int numItems

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect()

an Dreamweaver übergeben wurden.

• Das Argument remotePathList ist eine Liste der abzurufenden Remote-Dateien oder Remote-Ordner. Die Liste

enthält die vollständigen Pfade und Namen.

• Das Argument localPathList ist eine gespiegelte Liste der Namen lokaler Dateien oder Ordnerpfade.

• Das Argument numItems ist die Anzahl der Elemente in jeder Liste.

Rückgabewerte

Ein boolescher Wert:

true, wenn erfolgreich, andernfalls false.

94

bool SCS_Put()

Beschreibung

Diese Funktion stellt eine Liste mit lokalen Dateien oder Ordnern im Quellcode-Verwaltungssystem bereit.

Argumente

void *connectionData, const char *localPathList[], const char *remotePathList[], const int numItems

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect()

an Dreamweaver übergeben wurden.

• Das Argument localPathList ist die Liste mit Namen der lokalen Dateien oder Pfaden zu lokalen Ordnern, die im

Quellcode-Verwaltungssystem bereitgestellt werden sollen.

• Das Argument remotePathList ist eine gespiegelte Liste mit Namen von Remote-Dateien oder Pfaden zu Remote-

Ordnern.

• Das Argument numItems ist die Anzahl der Elemente in jeder Liste.

Rückgabewerte

Ein boolescher Wert:

true, wenn erfolgreich, andernfalls false.

bool SCS_NewFolder()

Beschreibung

Mit dieser Funktion wird ein neuer Ordner erstellt.

Letzte Aktualisierung 22.6.2011

DREAMWEAVER API-REFERENZHANDBUCH

API zur Integration der Quellcodeverwaltung

Argumente

void *connectionData, const char *remotePath

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect()

an Dreamweaver übergeben wurden.

• Das Argument remotePath ist der vollständige Pfadname des Remote-Ordners, der von der DLL erstellt wird.

Rückgabewerte

Ein boolescher Wert:

true, wenn erfolgreich, andernfalls false.

bool SCS_Delete()

Beschreibung

Diese Funktion löscht eine Liste mit Dateien oder Ordnern aus dem Quellcode-Verwaltungssystem.

Argumente

void *connectionData, const char *remotePathList[], const int numItems

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect()

an Dreamweaver übergeben wurden.

• Das Argument remotePathList ist eine Liste der Namen zu löschender Remote-Dateien bzw. der Pfade zu

löschender Remote-Ordner.

• Das Argument numItems ist die Anzahl der Elemente in remotePathList.

95

Rückgabewerte

Ein boolescher Wert:

true, wenn erfolgreich, andernfalls false.

bool SCS_Rename()

Beschreibung

Diese Funktion bewirkt, dass eine Datei oder ein Ordner umbenannt oder verschoben wird, je nach den für
oldRemotePath und newRemotePath angegebenen Werten. Ist beispielsweise oldRemotePath gleich

"$/folder1/file1" und newRemotePath gleich "$/folder1/renamefile1", wird „file1“ in „renamefile1“

umbenannt und im gleichen Ordner wie bisher („folder1“) abgelegt.

Ist oldRemotePath gleich
„file1“ in den Ordner „subfolder1“ verschoben.

Um herauszufinden, ob es sich bei dem Aufruf dieser Funktion um eine Verschiebung oder um eine Umbenennung
handelt, überprüfen Sie die übergeordneten Pfade der beiden Eingabewerte. Wenn sie identisch sind, handelt es sich
bei dem Vorgang um eine Umbenennung.

Argumente

void *connectionData, const char *oldRemotePath, const char *newRemotePath

• Das Argument connectionData ist ein Zeiger auf die Daten des Agenten, die während des Aufrufs von Connect()

an Dreamweaver übergeben wurden.

"$/folder1/file1" und newRemotePath gleich "$/folder1/subfolder1/file1", wird

Letzte Aktualisierung 22.6.2011