Table of SettingID values

The following table lists currently exposed setting IDs. For backward compatibility, these values will not change, but some may become obsolete and be removed from the set.

Setting ID  Value Description
SET_FLAG_READONLY_FILES         
0 flag read-only files in the file list
SET_WARN_READONLY_OPEN          
1 warn when opening read-only files
SET_RELOAD_TYPE                 
2 what to do when another app modifies current document
SET_STARTUP_FOLDER_TYPE         
3 start in last opened folder or specific folder
SET_DEFAULT_EXTENSION           
4 default extension for new documents
SET_DEFAULT_TEMPLATE            
5 default template to use when creating new documents
SET_SHOW_RESTAB                 
6 display the resource tab
SET_CURRENT_RESTAB              
7 page in resource tab active when closed (reset at startup)
SET_RESTAB_ALIGN                
8
SET_RESTAB_TABPOS               
9 tab position (top/bottom)
SET_RESTAB_WIDTH                
10
SET_PALETTE_FILE                
11 current palette file
SET_DYNAMIC_REFRESH             
12 dynamically refresh the file list when current directory changed
SET_FILELIST_TIMEOUT            
14 milliseconds to wait before cancelling retrieval of files in folder (internal use only)
SET_LOAD_CUSTOM_SHORTCUTS       
15 if set, loads custom command table at startup
SET_LINEAR_TAG_OUTPUT           
16 output tags from tag editors on a single line?
SET_TITLE_AS_LINK_DESC          
17 use the <title> tag as the description for dropped links
SET_INTERNAL_BROWSE_MSIE        
18 use MSIE as the internal browser
SET_MSIE_AUTO_REFRESH           
19 automatically refresh MSIE after navigating (needed for IE3.x)
SET_ANCHORDLG_NAMES             
20 show #named links in anchor dialog box
SET_USE_SHORT_TEMPFILE_NAME     
21 use short filename for tempfiles when shelling to external browser
SET_RESTORE_FILES               
22 restore files at startup (see also SET_RESTORE_PROJECT)
SET_FILE_FILTER                 
23 file filter for file list
SET_REMOTE_FILE_FILTER          
24 file filter for remote file list
SET_TAG_INSIGHT                 
26 use tag insight
SET_INSIGHT_SHOWTAGLIST         
27 use tag insight for tags (immediately after < is hit)
SET_TAG_COMPLETION              
28
SET_TAGHELP_DELAY               
29 milliseconds to delay tag insight
SET_LOWERCASE_TAGS              
30 lowercase inserted tags (see TCase)
SET_HEX_COLORS                  
31 always use hex values instead of color names
SET_DHTMLED_ALLOW_FRAMES        
32 if True, allow DHTMLEdit view to display frames (v1.0 of DHTMLEdit doesn't support frames, but later versions might)
SET_STANDARD_OPEN_DLG           
33 use TOpenDialog instead of TfFileOpenDlg (common dialog box instead of custom)
SET_OPEN_DLG_PREVIEW            
34 Enable preview in TfFileOpenDlg
SET_OPEN_DLG_DETAILS            
35 show details in TfFileOpenDlg (ViewStyle vsReport instead of vsList)
SET_USER_DICTIONARY_FILE        
37 user dictionary (for integrated spell checker)
SET_SPELLCHECK_SKIPTAGS         
38 skip tags and <script> blocks when spell checking
SET_SHOW_QUICKBAR               
39 show QuickBar
SET_TAG_VALIDATION              
40 validate when ">" is pressed
SET_USE_CSE_VALIDATOR           
41 use CSE validator for full-page validation - never change the key for this setting, since Alsoft may update it during the CSE install
SET_SHOW_EDITORTOOLBAR          
42 show editor toolbar
SET_SHOW_EDITORTAB              
43 show the tabset below the editor
SET_WARNING_BEEP                
44 beep when a warning message is shown
SET_AUTOCONVERT_SPECHAR         
45 automatically convert special characters (> #128) when typed
SET_RUNONCE_ENABLED             
46 at startup, HomeSite checks the gREG_ROOT\RunOnce key and executes any scripts. this undocumented
                                                
SET_TAGTREE_HEIGHT              
47
SET_SHELLTREE_HEIGHT            
48
SET_DISABLE_DESIGN_VIEW         
49 hide the design tab
SET_PROXY_NAME                  
50 proxy name for link verification and open from web
SET_PROXY_PORT                  
51
SET_CONNECT_TIMEOUT_MS          
52 timeout (in milliseconds) for link verification and open from web
SET_SAVE_FILE_FORMAT            
53 file format for saving (pc, unix, mac)
SET_WEB_DOCUMENT_EXTENSIONS     
54
SET_WEB_IMAGE_EXTENSIONS        
55
SET_BROWSE_MAPPINGS             
56 enable internal browser mappings
SET_SHOW_HELP_SEPARATE_PANE     
57 use main integrated browser for help
SET_HELP_BROWSER_HEIGHT         
58
SET_QUICKBAR_LEFT               
60
SET_SHOW_SKIPPED_FILES_IN_SEARCH
66 undocumented - see dxSearchResults.AddSkipItem
SET_LOWERCASE_LINKS             
67 lowercase IMG, A and other dropped links
SET_ALLOW_MULTIPLE_INSTANCES    
79 only for debugging - multiple instances use same reg settings and would conflict
SET_CLOSE_PARA_TAGS             
80 add </p> when <p> toolbutton hit
SET_PROMPT_ON_UNKNOWN_FILES     
81 show warning before opening unknown files
SET_PROMPT_BROWSE_UNSAVED_REMOTE
82 when browsing remote files, prompt user to save changes (undocumented)
SET_FILEDLG_SHOW_CURRENT        
83 when displaying the open or save dialog box, default to the current local dir
SET_STARTUP_BLANK_DOC           
84 start with a blank document (overrides default template)
SET_SHOW_SHORTCUT_IN_HINTS      
85 show keyboard shortcuts in toolbutton hints
SET_INTERNAL_BROWSE_MOZILLA     
86 use MOZILLA as the internal browser
SET_OEM_CONVERSION     
87 controls call to CharToOemBuff() - DH 01/09/99
SET_FULL_PATH_ON_SAVE    
88 put full path in filename edit box when saving - DH 02/12/99
SET_WARN_BEFORE_DESIGN_VIEW    
89 determines whether a warning should be displayed when user clicks on the Desin tab.
SET_CHECK_UPDATE_TYPE           
100 check for product updates every time app starts (HS only)
SET_CHECK_UPDATE_DATE           
101 date last check for update run
SET_CHECK_UPDATE_TIMEOUT_SHORT  
102 timeout for update check at startup (milliseconds)
SET_CHECK_UPDATE_TIMEOUT_LONG   
103 timeout for update check initiated by user
SET_CHECK_UPDATE_LAST_DATE      
104
SET_CENTER_START_TAG            
105 start tag to use when align center toolbutton hit
SET_CENTER_END_TAG              
106 end tag to use when align center toolbutton hit
SET_USE_VTM_IMAGE_DIALOG        
107
SET_USE_VTM_ANCHOR_DIALOG       
108
SET_USE_VTM_BODY_DIALOG         
109
SET_TEMPFILE_PREFIX             
110 prefix to use for tempfiles (~hs) - undocumented
SET_FILELIST_COLS_ACTIVE        
120 which local columns are active?
SET_FILELIST_COL_SIZES          
121 local FileList Column Size Settings
SET_REMOTE_FILELIST_COLS_ACTIVE 
122 which Remote columns are active?
SET_REMOTE_FILELIST_COL_SIZES   
123 remote FileList Column Size Settings
SET_REMOTE_FPTREE_HEIGHT        
125
SET_PROJECT_VERIFIER_EXCL_EXTS  
130 setting for exclusion extension list
SET_SPECIALCHAR_LAYOUT    
131 layout orientation of special character toolbar DH 02/18/99
SET_DREAMWEAVER_INTEGRATION     
140
SET_DREAMWEAVER_LAUNCH_TYPE     
149
SET_DIR_LOCAL_USER              
150
SET_DIR_SNIPPETS_PRIVATE        
151 location of private snippets
SET_DIR_SNIPPETS_SHARED         
152 location of shared snippets - blank for no shared snippets
SET_DIR_HELP                    
153 location of help files
SET_DIR_PALETTES                
154 location of palette files
SET_DIR_TOOLBARS                
155 location of toolbars
SET_DIR_TOOLBUTTON_IMAGES       
156 location of images for toolbars when no path specified in TBR file
SET_DIR_PARSERS                 
157 location of color coding parsers
SET_DIR_STARTUP                 
158 location of startup directory
SET_DIR_WIZARDS                 
159 location of wizard root dir
SET_DIR_CUSTOM_TEMPLATES        
160
SET_DIR_OLD_TEMPLATES           
161
SET_DIR_OLD_TAGEDITORS          
162
SET_DIR_EXTENSIONS              
163
SET_DIR_TAGDEFS                 
164
SET_DIR_CUSTOM_TAGDEFS          
165
SET_DIR_OUTLINEPROFILES         
166
SET_DIR_SPELLING                
167
SET_DIR_AUTOFORMATTERS          
168
SET_DIR_SAVED_SEARCHES          
169
SET_DIR_HTML_HELP               
170
SET_DIR_THUMBNAILS              
199 location to store thumbnails (deleted at close)
SET_TAGCHOOSER_FILE             
200
SET_EXPBUILDER_FILE             
201
SET_USER_SHORCUTS_FILE          
202
SET_SNIPPETS_SHORCUTS_FILE      
203
SET_SPECIAL_CHAR_FILE           
204
SET_TOOLBAR_POS_FILE            
205 file containing data about the positions of toolbars and tool windows
SET_TOOLBAR_DATA_FILE           
206 file containing data about the active toolbars
SET_QUICKBAR_DATA_FILE          
207 file containing data about what toolbars are in the QuickBar
SET_INSIGHT_TAGLIST_FILE        
208
SET_STYLE_EDIT_EXE              
209 full path to StyleEdit
SET_CODETEMPLATE_FILE           
210
SET_AUTOREPLACE_FILE            
211 undocumented
SET_TAGCOMPLETION_FILE          
212
SET_BREAKPOINTS_FILE            
213
SET_DEFAULTAUTOFORMAT_FILE      
214 default formatting used by the CodeSweeper
SET_VERITY_HELP_SEARCH_HELPFILE 
215 used to display search tips
SET_STYLE_EDIT_WND_CLASS        
216 used to dynamically invoke a Style Editor (StyleEd or TopStyle)
SET_STYLE_EDIT_OLE_OBJECT       
217 used to dynamically invoke a Style Editor (StyleEd or TopStyle)
SET_EDITOR_FONTNAME             
300
SET_EDITOR_FONTSIZE             
301
SET_EDITOR_TABWIDTH             
302
SET_EDITOR_SHOW_RMARGIN         
303
SET_EDITOR_RMARGIN              
304
SET_EDITOR_AUTOINDENT           
305
SET_EDITOR_FOREGROUND           
306
SET_EDITOR_BACKGROUND           
307
SET_EDITOR_SHOW_GUTTER          
308
SET_EDITOR_WORDWRAP             
309
SET_EDITOR_USE_TABS             
310
SET_EDITOR_AUTOREPLACE          
311
SET_EDITOR_AUTOREPLACE_TRIGGERS 
312
SET_EDITOR_AUTOQUOTE            
313 automatically close quotes
SET_EDITOR_AUTOCLOSE_ASP        
314 add %> when <% entered
SET_EDITOR_AUTOCOMMENT          
315
SET_EDITOR_HTML_DROP            
316 allow HTML to be dragged-and-dropped from compliant apps (inserted as text otherwise)
SET_EDITOR_SHOW_BROWSER         
317 show web browser below editor
SET_EDITOR_BROWSER_HEIGHT       
318
SET_EDITOR_BROWSE_UPDATE_INTERVAL 
319
SET_EDITOR_BROWSE_AUTOUPDATE    
320
SET_EDITOR_ALLOW_DRAGDROP       
321 allow drag/drop inside editor
SET_EDITOR_ALLOW_UNDO_AFTER_SAVE
322
SET_EDITOR_ADJUST_POS_FOR_WORDWRAP 
323 see fAllaireClientMain.ShowEditorPos
SET_EDITOR_LINE_NUMBERS         
324
SET_EDITOR_AUTOPOUND            
325
SET_EDITOR_CHARSET              
326
SET_EDITOR_OUTLINECURRLINE   
327 outline current line DH 02/17/99
SET_SITEVIEW_GRADIENT           
400
SET_SITEVIEW_SHOWTITLE          
401
SET_SITEVIEW_STYLE              
402 tree or chart
SET_SITEVIEW_AUTONAV_TO_LINK    
403 undocumented. navigate to the current link when user clicks on a node in SiteView
SET_PROJECT_RESTORE_AT_START    
500 restore last opened project at startup
SET_PROJECT_LAST_OPENED         
501 full path to last opened project
SET_PROJECT_CLOSE_ALL_ON_OPEN   
502 close all files when another project is opened
SET_AUTOFORMAT_AFTER_DESIGN     
600 run code formatter after returning from design view
SET_AUTOFORMAT_CURRENT_PROFILE  
601 the path to the currenrly selected AutoFormatter
SET_AUTOFORMAT_SHOW_PROMPT      
602 show prompt when user clicks toolbutton
  SET_CFS_HELP_SERVER
CFStudio only
61 server to map to in dxWebBrowser.DoMSIENewWindow when user browses snippets
  SET_CFS_ADJUST_HELP_EXAMPLES
CFStudio only
62 if False, then help examples aren't adjusted (see dxWebBrowser.DoMSIENewWindow)

Projects

AActiveProjectFile (read-only string)

Returns the filename of the active project, or the empty string if no project is open.

AddFileToProject

function AddFileToProject(const wsFilename: WideString): WordBool;

Adds the passed file to the active project. Note that the file must be contained under the main project folder or a subfolder of the main project.

CloseProject

function CloseProject(wbCloseOpenFiles: WordBool): WordBool;

Closes the active project, if any. If wbCloseOpenFiles is True, then all open files are closed.

OpenProject

function OpenProject(const wsProjectFile: WideString): WordBool;

Opens the passed project file, making it the active project. Pass an empty string to display the Open Project dialog box.

RemoveFileFromProject

function RemoveFileFromProject(const wsFilename: WideString): WordBool;

Removes the passed file from the active project.

ShowLastProjectError

function ShowLastProjectError;

Displays an error message for the last project-related error.

UploadProjectDlg

function UploadProjectDlg: WordBool;

Displays the upload project dialog box for the active project.

UploadProject

function UploadProject(const wsTargetDir: WideString; const wbForceLCase, wbUploadOnlyNewer, wbEncryptCFML: WordBool): WordBool;

Uploads a project based on the passed criteria. Note that wbEncryptCFML is specific to ColdFusion Studio.

Toolbars

Each toolbar is identified by name, which is the same as the title bar caption that appears when the toolbar is undocked. Names are unique, so two toolbars will never have the same name/caption. Toolbars are loaded from files in the toolbar directory, which can be obtained from the ToolbarDir property. Toolbars names are the same as their file names without the path or extension. For example, if the toolbar file is c:\homesite\toolbars\Custom.tbr, then the toolbar name is "Custom". Also note that toolbutton captions are limited to two characters.

AddAppToolbutton

function AddAppToolbutton(wsToolbarName, wsExeFile, wsCmdLine, wsHint: WideString): WordBool;

Adds a toolbutton for an external application to the passed toolbar. Fails if the toolbar doesn't exist or if the toolbutton could not be added. Returns True if the same toolbutton (based on wsExeFile and wsCmdLine) already exists on the toolbar, but doesn't add a duplicate button.

AddScriptToolbutton

function AddScriptToolbutton(wsToolbarName, wsScriptFile, wsHint, wsCaption, wsImageFile: WideString): WordBool;

Adds a script toolbutton (executes passed JavaScript or VBScript file when clicked) to the passed toolbar. Fails if toolbar doesn't exist. Returns true if Toolbutton already exists, but doesn't add duplicate button.

AddTagToolbutton

function AddTagToolbutton(wsToolbarName, wsTagStart, wsTagEnd, wsHint, wsCaption, wsImageFile: WideString): WordBool;

Adds a tag toolbutton (inserts tag pair when clicked) to the passed toolbar. Fails if toolbar doesn't exist. Returns true if Toolbutton already exists, but doesn't add duplicate button.

AddVTMToolbutton

function AddVTMToolbutton(wsToolbarName, wsScriptFile, wsHint, wsCaption, wsImageFile: WideString): WordBool;

Adds a VTM toolbutton (displays passed VTM dialog box when clicked) to the passed toolbar. Fails if toolbar doesn't exist. Returns true if Toolbutton already exists, but doesn't add duplicate button.

CreateToolbar

function CreateToolbar(wsToolbarName: WideString): WordBool;

Creates a new, undocked toolbar of the passed name. Fails if a toolbar of the same name already exists.

DeleteToolbar

function DeleteToolbar(wsToolbarName: WideString): WordBool;

Physically deletes the toolbar. Fails if toolbar doesn't exist or if toolbar is one of the built-in toolbars (only works on custom toolbars - built-in toolbars can be hidden, but not deleted).

HideToolbar

function HideToolbar(wsToolbarName: WideString): WordBool;

Hides a toolbar. Fails if the toolbar doesn't exist.

SetToolbarDockPos

function SetToolbarDockPos(wsToolbarName: WideString; nDockPos: Integer): WordBool;

Sets the docking position of the toolbar. Allowed values for nDockPos are:

1 = Top
2 = Bottom
3 = Left
4 = Right         

Fails if the toolbar doesn't exist.

ShowToolbar

function ShowToolbar(wsToolbarName: WideString): WordBool;

Displays a toolbar if it's not already showing. Fails if the toolbar doesn't exist.

The JavaScript example below creates a toolbar named "Apps" if one doesn't exist already, and then adds two custom toolbuttons to it. The first toolbutton launches Windows Explorer, while the second one opens Windows Explorer at the current folder in the editor:

function Main() {        
    var TB_NAME = `Apps';
    var app = Application;    

    if (!app.ToolbarExists(TB_NAME)) {
        app.CreateToolbar(TB_NAME);
    }
    app.AddAppToolbutton(TB_NAME, `c:\\windows\\explorer.exe', ",
    `Explorer');
    app.AddAppToolbutton(TB_NAME, `c:\\windows\\explorer.exe', 
        app.CurrentFolder, 'Explorer - Current Folder');    
}

Here's the same code in VBScript:

Sub Main
    const TB_NAME = "Apps"
    Dim app

    set app = Application
    if not app.ToolbarExists(TB_NAME) then
        app.CreateToolbar TB_NAME
    end if

    app.AddAppToolbutton TB_NAME, "c:\windows\explorer.exe", "",
        "Explorer"
    app.AddAppToolbutton TB_NAME, "c:\windows\explorer.exe",
        app.CurrentFolder, "Explorer - Current Folder"
End Sub

ToolbarDir (widestring, read-only property)

Returns the path where toolbar files are located.

ToolbarExists

function ToolbarExists(wsToolbarName: WideString): WordBool;

Returns True if the passed toolbar exists.