Mmnotes.getkeycount(), Mmnotes.getkeys(), Mmnotes.getsiterootforfile() – Adobe Dreamweaver API Reference CS5 User Manual

Page 28

Advertising
background image

23

DREAMWEAVER API REFERENCE

The Design Notes API

Last updated 8/27/2013

MMNotes.getKeyCount()

Description
This function gets the number of key/value pairs in the specified Design Notes file.

Arguments
fileHandle

•

The fileHandle argument is the file handle that the

MMNotes.open()

function returns.

Returns
An integer that represents the number of key/value pairs in the Design Notes file.

MMNotes.getKeys()

Description
This function gets a list of all the keys in a Design Notes file.

Arguments
fileHandle

•

The fileHandle argument is the file handle that the

MMNotes.open()

function returns.

Returns
An array of strings where each string contains the name of a key.

Example
The following code might be used in a custom floating panel to display the Design Notes information for the active
document:

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

MMNotes.getSiteRootForFile()

Description
This function determines the site root for the specified Design Notes file.

Advertising