beautypg.com

Dreamweaver.getpreferenceint(), Dreamweaver.getpreferencestring() – Adobe Dreamweaver API Reference CS5 User Manual

Page 274

background image

269

DREAMWEAVER API REFERENCE

Document

Last updated 8/27/2013

Dreamweaver does not return references for unnamed objects. If an object does not contain either a

NAME

or an

ID

attribute, Dreamweaver returns

"unnamed <tag>"

. If the browser does not support a reference by name,

Dreamweaver references the object by index (for example,

document.myform.applets[3]

).

Dreamweaver returns references for named objects that are contained in unnamed forms and layers (for example,

document.forms[2].myCheckbox

).

dreamweaver.getPreferenceInt()

Availability
Dreamweaver MX.

Description
Lets you retrieve an integer preference setting for an extension.

Arguments
section, key, default_value

The section argument is a string that specifies the preferences section that contains the entry.

The key argument is a string that specifies the entry of the value to retrieve.

The default_value argument is the default value that Dreamweaver returns if it cannot find the entry. This value
must be an unsigned integer in the range 0 through 65,535 or a signed integer in the range -32,768 through 32,767.

Returns
Integer value of the specified entry in the specified section or the default value if the function does not find the entry.
Returns 0 if the value of the specified entry is not an integer.

Example
The following example returns the integer value of the Snap Distance setting in the My Extension section of
Preferences. If there is no MyExtension section or no Snap Distance entry, the function returns the specified default
value of 0.

var snapDist; //default value if entry not found

snapDist = dreamweaver.getPreferenceInt("My Extension", "Snap Distance", 0);

dreamweaver.getPreferenceString()

Availability
Dreamweaver MX.

Note: To access the preferences for sites, you must have version 7.0.1. Check

dw.appVersion

for the correct version before

accessing site information.

Description
Lets you retrieve a string preference setting that you stored for an extension.