Adobe Dreamweaver API Reference CS5 - Manual (Page 275)

270 DREAMWEAVER API REFERENCE
Document
Last updated 8/27/2013
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 value to retrieve.
• The default_value argument is the default string value that Dreamweaver returns if it cannot find the entry.
Returns
The requested preference string, or if the string cannot be found, the default value.
Example
The following example returns the String value of the Text Editor setting in the My Extension section of Preferences.
If there is no MyExtension section or no Text Editor entry, the function returns the default value specified by the
variable
txtEditor .
var txtEditor = getExternalTextEditor(); //set default text Editor value
txtEditor = dreamweaver.getPreferenceString("My Extension", "Text Editor", txtEditor);
dreamweaver.setPreferenceInt()
Availability
Dreamweaver MX.
Description
Lets you set an integer preference setting for an extension. This setting is stored with Dreamweaver preferences when
Dreamweaver is not running.
Arguments
section, key, new_value
• The section argument is a string that specifies the preferences category in which the option is set. If the category
does not exist, Dreamweaver creates it.
• The key argument is a string that specifies the category option that the function sets. If the option does not exist,
Dreamweaver creates it.
• The new_value argument is an integer that specifies the value of the category option.
Returns
A
true value if successful; false otherwise.
Example
The following example sets the Snap Distance entry to the value of the variable
snapDist in the My Extension category
of Preferences:
var snapDist = getSnapDistance();
if(snapDist > 0)
{
dreamweaver.setPreferenceInt("My Extension", "Snap Distance", snapDist);
}