The enabler functions in the JavaScript API include the following functions.

dom.canAlign()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform an Align Left, Align Right, Align Top, or Align Bottom operation.

Arguments

None.

Returns

A Boolean value that indicates whether two or more layers or hotspots are selected.

dom.canApplyTemplate()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform an Apply To Page operation. This function is valid only for the active document.

Arguments

None.

Returns

A Boolean value that indicates whether the document is not a library item or a template, and that the selection is not within the NOFRAMES tag.

dom.canArrange()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Bring to Front or Move to Back operation.

Arguments

None.

Returns

A Boolean value that indicates whether a hotspot is selected.

dom.canClipCopyText()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Copy as Text operation.

Arguments

None.

Returns

A Boolean value: true if the opening and closing offsets of the selection are different; false otherwise, to indicate that nothing has been selected.

dom.canClipPaste()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Paste operation.

Arguments

None.

Returns

A Boolean value: true if the Clipboard contains any content that can be pasted into Dreamweaver; false otherwise.

dom.canClipPasteText()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Paste as Text operation.

Arguments

None.

Returns

A Boolean value: true if the Clipboard contains any content that can be pasted into Dreamweaver as text; false otherwise.

dom.canConvertLayersToTable()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Convert Layers to Table operation.

Arguments

None.

Returns

A Boolean value: true if all the content in the BODY section of the document is contained within layers; false otherwise.

dom.canConvertTablesToLayers()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Convert Tables to Layers operation.

Arguments

None.

Returns

A Boolean value: true if all the content in the BODY section of the document is contained within tables, and the document is not based on a template; false otherwise.

dom.canDecreaseColspan()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Decrease Colspan operation.

Arguments

None.

Returns

A Boolean value: true if the current cell has a COLSPAN attribute and that attribute’s value is greater than or equal to 2; false otherwise.

dom.canDecreaseRowspan()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Decrease Rowspan operation.

Arguments

None.

Returns

A Boolean value: true if the current cell has a ROWSPAN attribute and that attribute’s value is greater than or equal to 2; false otherwise.

dom.canDeleteTableColumn()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Delete Column operation.

Arguments

None.

Returns

A Boolean value: true if the insertion point is inside a cell or if a cell or column is selected; false otherwise.

dom.canDeleteTableRow()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Delete Row operation.

Arguments

None.

Returns

A Boolean value: true if the insertion point is inside a cell or if a cell or row is selected; false otherwise.

site.canEditColumns()

Description

Checks whether a site exists.

Arguments

None.

Returns

A Boolean value: true if a site exists; false otherwise.

dom.canEditNoFramesContent()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform an Edit No Frames Content operation.

Arguments

None.

Returns

A Boolean value: true if the current document is a frameset or within a frameset; false otherwise.

dom.canIncreaseColspan()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform an Increase Colspan operation.

Arguments

None.

Returns

A Boolean value: true if there are any cells to the right of the current cell; false otherwise.

dom.canIncreaseRowspan()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform an Increase Rowspan operation.

Arguments

None.

Returns

A Boolean value: true if there are any cells below the current cell; false otherwise.

dom.canInsertTableColumns()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform an Insert Column(s) operation.

Arguments

None.

Returns

A Boolean value: true if the selection is inside a table; false if the selection is an entire table or is not inside a table.

dom.canInsertTableRows()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform an Insert Row(s) operation.

Arguments

None.

Returns

A Boolean value: true if the selection is inside a table; false if the selection is an entire table or is not inside a table.

dom.canMakeNewEditableRegion()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a New Editable Region operation.

Arguments

None.

Returns

A Boolean value: true if the current document is a template (DWT) file.

dom.canMarkSelectionAsEditable()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Mark Selection as Editable operation.

Arguments

None.

Returns

A Boolean value: true if there is a selection and the current document is a DWT file; false otherwise.

dom.canMergeTableCells()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Merge Cells operation.

Arguments

None.

Returns

A Boolean value: true if the selection is an adjacent grouping of table cells; false otherwise.

dom.canPlayPlugin()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Play operation. This function is valid only for the active document.

Arguments

None.

Returns

A Boolean value: true if the selection can be played with a plug-in.

dom.canRedo()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Redo operation.

Arguments

None.

Returns

A Boolean value: true if any steps remain to redo; false otherwise.

dom.canRemoveEditableRegion()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform an Unmark Editable Region operation.

Arguments

None.

Returns

A Boolean value: true if the current document is a template; false otherwise.

dom.canSelectTable()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Select Table operation.

Arguments

None.

Returns

A Boolean value: true if the insertion point or selection is within a table; false otherwise.

dom.canSetLinkHref()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can change the link around the current selection or create one if necessary.

Arguments

None.

Returns

A Boolean value: true if the selection is an image, text, or if the insertion point is inside a link; false otherwise. A text selection is defined as a selection for which the text Property inspector would appear.

dom.canShowListPropertiesDialog()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can show the List Properties dialog box.

Arguments

None.

Returns

A Boolean value: true if the selection is within an LI tag; false otherwise.

dom.canSplitFrame()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Split Frame [Left | Right | Up | Down] operation.

Arguments

None.

Returns

A Boolean value: true if the selection is within a frame; false otherwise.

dom.canSplitTableCell()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Split Cell operation.

Arguments

None.

Returns

A Boolean value: true if the insertion point is inside a table cell or the selection is a table cell; false otherwise.

dom.canStopPlugin()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Stop operation.

Arguments

None.

Returns

A Boolean value: true if the selection is currently being played with a plug-in; false otherwise.

dom.canUndo()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform an Undo operation.

Arguments

None.

Returns

A Boolean value: true if any steps remain to undo; false otherwise.

dom.hasTracingImage()

Availability

Dreamweaver 3.

Description

Checks whether the document has a tracing image.

Arguments

None.

Returns

A Boolean value: true if the document has a tracing image; false otherwise.

dreamweaver.assetPalette.canEdit()

Availability

Dreamweaver 4.

Description

Enables menu items in the Assets panel for editing.

Arguments

None.

Returns

Returns a Boolean value: true if the asset can be edited; false otherwise. Returns a false value for colors and URLs in the Site list, and returns a false value for a multiple selection of colors and URLs in the Favorites list.

dreamweaver.assetPalette.canInsertOrApply()

Availability

Dreamweaver 4.

Description

Checks if the selected elements can be inserted or applied. Returns either a true or false value so the menu items can be enabled or disabled for insertion or application.

Arguments

None.

Returns

Returns a Boolean value: true if the selected elements can be inserted or applied; false if the current page is a template and the current category is Templates. The function also returns a false value if no document is open or if a library item is selected in the document and the current category is Library.

dreamweaver.canClipCopy()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Copy operation.

Arguments

None.

Returns

A Boolean value: true if there is any content selected that can be copied to the Clipboard; false otherwise.

dreamweaver.canClipCut()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Cut operation.

Arguments

None.

Returns

A Boolean value: true if there is any selected content that can be cut to the Clipboard; false otherwise.

dreamweaver.canClipPaste()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Paste operation.

Arguments

None.

Returns

A Boolean value: true if the Clipboard contains any content that can be pasted into the current document or the active window in the Site panel (on the Macintosh, a text field in a floating panel or dialog box); false otherwise.

dreamweaver.canDeleteSelection()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can delete the current selection. Depending on the window that has focus, the deletion might occur in the Document window or the Site panel (on the Macintosh, in a text field in a dialog box or floating panel).

Arguments

None.

Returns

A Boolean value: true if the opening and closing offsets for the selection are different, which indicates that there is a selection; false if the offsets are the same, indicating that there is only an insertion point.

dreamweaver.canExportTemplateDataAsXML()

Availability

Dreamweaver MX.

Description

Checks whether Dreamweaver can export the current document as XML.

Arguments

None.

Returns

A Boolean value: true if you can perform an export on the current document; false otherwise.

Example

The following example calls dw.canExportTemplateDataAsXML() to determine whether Dreamweaver can export the current document as XML and if it returns true, calls dw.ExportTemplateDataAsXML() to export it:

 if(dreamweaver.canExportTemplateDataAsXML()) 
{ 
    dreamweaver.exportTemplateDataAsXML("file:///c|/dw_temps/mytemplate.txt") 
}

dreamweaver.canFindNext()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Find Next operation.

Arguments

None.

Returns

A Boolean value: true if a search pattern has already been established; false otherwise.

dreamweaver.canFitSelection()

Availability

Dreamweaver 8.

Description

Checks whether there is a selection in an active Design view, which means that fitSelection() can be called.

Arguments

None.

Returns

A Boolean value: true if there is a selection in an active Design view; false otherwise.

dreamweaver.canOpenInFrame()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform an Open in Frame operation.

Arguments

None.

Returns

A Boolean value: true if the selection or insertion point is within a frame; false otherwise.

dreamweaver.canPasteSpecial()

Availability

Dreamweaver 8.

Description

Checks whether Dreamweaver can perform a Paste Special operation.

Arguments

None.

Returns

A Boolean value: true if there is text, HTML, or Dreamweaver HTML on the Clipboard and focus is in Code View, Design View, or Code Inspector; false otherwise.

dreamweaver.canPlayRecordedCommand()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Play Recorded Command operation.

Arguments

None.

Returns

A Boolean value: true if there is an active document and a previously recorded command that can be played; false otherwise.

dreamweaver.canPopupEditTagDialog()

Availability

Dreamweaver MX.

Description

Checks whether the current selection is a tag and whether the Edit Tag menu item is active.

Arguments

None.

Returns

The name of the currently selected tag or a null value if no tag is selected.

dreamweaver.canRedo()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Redo operation in the current context.

Arguments

None.

Returns

A Boolean value that indicates whether any operations can be undone.

dreamweaver.canRevertDocument()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Revert (to the last-saved version) operation.

Arguments

documentObject

  • The documentObject argument is the object at the root of a document’s DOM tree (the value that the dreamweaver.getDocumentDOM() function returns).

Returns

A Boolean value that indicates whether the document is in an unsaved state and a saved version of the document exists on a local drive.

dreamweaver.canSaveAll()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Save All operation.

Arguments

None.

Returns

A Boolean value that indicates whether one or more unsaved documents are open.

dreamweaver.canSaveDocument()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Save operation on the specified document.

Arguments

documentObject

  • The documentObject argument is the root of a document’s DOM (the same value that the dreamweaver.getDocumentDOM() function returns).

Returns

A Boolean value that indicates whether the document has any unsaved changes.

dreamweaver.canSaveDocumentAsTemplate()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Save As Template operation on the specified document.

Arguments

documentObject

  • The documentObject argument is the root of a document’s DOM (the same value that the dreamweaver.getDocumentDOM() function returns).

Returns

A Boolean value that indicates whether the document can be saved as a template.

dreamweaver.canSaveFrameset()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Save Frameset operation on the specified document.

Arguments

documentObject

  • The documentObject argument is the root of a document’s DOM (the same value that the dreamweaver.getDocumentDOM() function returns).

Returns

A Boolean value that indicates whether the document is a frameset with unsaved changes.

dreamweaver.canSaveFramesetAs()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Save Frameset As operation on the specified document.

Arguments

documentObject

  • The documentObject argument is the root of a document’s DOM (the same value that the dreamweaver.getDocumentDOM() function returns).

Returns

A Boolean value that indicates whether the document is a frameset.

dreamweaver.canSelectAll()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Select All operation.

Arguments

None.

Returns

A Boolean value that indicates whether a Select All operation can be performed.

dreamweaver.canShowFindDialog()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Find operation.

Arguments

None.

Returns

A Boolean value that is true if a Site panel or a Document window is open. This function returns the value false when the selection is in the HEAD section.

dreamweaver.canUndo()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform an Undo operation in the current context.

Arguments

None.

Returns

A Boolean value that indicates whether any operations can be undone.

dreamweaver.canZoom()

Availability

Dreamweaver 8.

Description

Checks to see if there is an active Design view or Live view, which means that basic zoom commands can be applied.

Arguments

None.

Returns

A Boolean value: true if there is an active Design view; false otherwise.

dreamweaver.cssRuleTracker.canEditSelectedRule()

Availability

Dreamweaver MX 2004.

Description

Checks whether the Property Grid editor can be applied to the selected rule. Because the Property Grid can display rules in locked files, a return value of true does not guarantee that the rule can be modified.

Arguments

None.

Returns

A Boolean value: true if the Property Grid editor can be applied to the selected rule; false otherwise.

Example

The following code checks whether the enabler function has been set to the value true before allowing edits to the selected rule:

 if(dw.cssRuleTracker.canEditSelectedRule()){ 
     dw.cssRuleTracker.editSelectedRule(); 
 }

dreamweaver.cssStylePalette.canApplySelectedStyle()

Availability

Dreamweaver MX.

Description

Checks the current active document to see whether the selected style can be applied.

Arguments

{pane}

  • The pane argument, which is optional, is a string that specifies the pane of the Styles panel to which this function applies. Possible values are "stylelist", which is the list of styles in “All” mode; "cascade", which is the list of applicable, relevant rules in “Current” mode; "summary", which is the list of properties for the current selection in “Current” mode; and "ruleInspector", which is the editable list or grid of properties in “Current” mode. The default value is "stylelist".

Returns

A Boolean value: true if the selected style has a class selector; false otherwise.

dreamweaver.cssStylePalette.canDeleteSelectedStyle()

Availability

Dreamweaver MX.

Description

Checks the current selection to determine whether the selected style can be deleted.

Arguments

{pane}

  • The pane argument, which is optional, is a string that specifies the pane of the Styles panel to which this function applies. Possible values are "stylelist", which is the list of styles in “All” mode; "cascade", which is the list of applicable, relevant rules in “Current” mode; "summary", which is the list of properties for the current selection in “Current” mode; and "ruleInspector", which is the editable list or grid of properties in “Current” mode. The default value is "stylelist".

Returns

A Boolean value: true if the selection can be deleted; false otherwise.

dreamweaver.cssStylePalette.canDuplicateSelectedStyle()

Availability

Dreamweaver MX.

Description

Checks the current active document to see whether the selected style can be duplicated.

Arguments

{pane}

  • The pane argument, which is optional, is a string that specifies the pane of the Styles panel to which this function applies. Possible values are "stylelist", which is the list of styles in “All” mode; "cascade", which is the list of applicable, relevant rules in “Current” mode; "summary", which is the list of properties for the current selection in “Current” mode; and "ruleInspector", which is the editable list or grid of properties in “Current” mode. The default value is "stylelist".

Returns

A Boolean value: true if the selected style can be duplicated; false otherwise.

dreamweaver.cssStylePalette.canEditSelectedStyle()

Availability

Dreamweaver MX.

Description

Checks the current active document to see whether the selected style can be edited.

Arguments

{pane}

  • The pane argument, which is optional, is a string that specifies the pane of the Styles panel to which this function applies. Possible values are "stylelist", which is the list of styles in “All” mode; "cascade", which is the list of applicable, relevant rules in “Current” mode; "summary", which is the list of properties for the current selection in “Current” mode; and "ruleInspector", which is the editable list or grid of properties in “Current” mode. The default value is "stylelist".

Returns

A Boolean value: true if the selected style is editable; false otherwise.

dreamweaver.cssStylePalette.canEditSelectedStyleInCodeview()

Availability

Dreamweaver MX.

Description

Checks the current active document to see whether the selected style can be edited in Code view.

Arguments

{pane}

  • The pane argument, which is optional, is a string that specifies the pane of the Styles panel to which this function applies. Possible values are "stylelist", which is the list of styles in “All” mode; "cascade", which is the list of applicable, relevant rules in “Current” mode; "summary", which is the list of properties for the current selection in “Current” mode; and "ruleInspector", which is the editable list or grid of properties in “Current” mode. The default value is "stylelist".

Returns

A Boolean value: true if the selected style is editable; false otherwise.

dreamweaver.cssStylePalette.canEditStyleSheet()

Availability

Dreamweaver MX.

Description

Checks the current selection to see whether it contains style sheet elements that can be edited.

Arguments

None.

Returns

A Boolean value: true if the selection is a style sheet node or a style definition within a style sheet node and the style sheet is neither hidden nor this document; false if the selection is hidden or in this document.

dreamweaver.cssStylePalette.canRenameSelectedStyle()

Availability

Dreamweaver MX.

Description

Checks the current active document to see whether the selected style can be renamed.

Arguments

{pane}

  • The pane argument, which is optional, is a string that specifies the pane of the Styles panel to which this function applies. Possible values are "stylelist", which is the list of styles in “All” mode; "cascade", which is the list of applicable, relevant rules in “Current” mode; "summary", which is the list of properties for the current selection in “Current” mode; and "ruleInspector", which is the editable list or grid of properties in “Current” mode. The default value is "stylelist".

Returns

A Boolean value: true if the selected style can be renames; false otherwise.

dreamweaver.isRecording()

Availability

Dreamweaver 3.

Description

Reports whether Dreamweaver is currently recording a command.

Arguments

None.

Returns

A Boolean value that indicates whether Dreamweaver is recording a command.

dreamweaver.htmlStylePalette.canEditSelection()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can edit, delete, or duplicate the selection in the HTML Styles panel.

Arguments

None.

Returns

A Boolean value: true if Dreamweaver can edit, delete, or duplicate the selection in the HTML Styles panel; false if no style is selected or if one of the clear styles is selected.

dreamweaver.resultsPalette.canClear()

Availability

Dreamweaver MX.

Description

Checks whether you can clear the contents of the Results panel that is currently in focus.

Arguments

None.

Returns

A Boolean value: true if the contents can clear; false otherwise.

dreamweaver.resultsPalette.canCopy()

Availability

Dreamweaver MX.

Description

Checks whether the current Results window can display a copied message in its contents.

Arguments

None.

Returns

A Boolean value: true if the contents can display; false otherwise.

dreamweaver.resultsPalette.canCut()

Availability

Dreamweaver MX.

Description

Checks whether the current Results window can display a Cut message in its contents.

Arguments

None.

Returns

A Boolean value: true if the contents can display; false otherwise.

dreamweaver.resultsPalette.canPaste()

Availability

Dreamweaver MX.

Description

Checks whether the current Results window can display a Paste message in its contents.

Arguments

None.

Returns

A Boolean value: true if the contents can display; false otherwise.

dreamweaver.resultsPalette.canOpenInBrowser()

Availability

Dreamweaver MX.

Description

Checks whether the current report can display in a browser.

Arguments

None.

Returns

A Boolean value: true if the contents can display; false otherwise.

dreamweaver.resultsPalette.canOpenInEditor()

Availability

Dreamweaver MX.

Description

Checks whether the current report can display in an editor.

Arguments

None.

Returns

A Boolean value: true if the contents can display; false otherwise.

dreamweaver.resultsPalette.canSave()

Availability

Dreamweaver MX.

Description

Checks whether the Save dialog box can open for the current panel. Currently, the Site Reports, Target Browser Check, Validation, and Link Checker panels support the Save dialog box.

Arguments

None.

Returns

A Boolean value: true if the Save dialog box can appear; false otherwise.

dreamweaver.resultsPalette.canSelectAll()

Availability

Dreamweaver MX.

Description

Checks whether a Select All message can be sent to the window that is currently in focus.

Arguments

None.

Returns

A Boolean value: true if the Select All message can be sent; false otherwise.

dreamweaver.siteSyncDialog.canCompare()

Availability

Dreamweaver 8.

Description

This function checks whether the Compare context menu in the Site Synchronize dialog box can be displayed.

Arguments

None.

Returns

A Boolean value: true if the Compare context menu in the Site Synchronize dialog box can be displayed; false otherwise.

dreamweaver.siteSyncDialog.canMarkDelete()

Availability

Dreamweaver 8.

Description

This function checks whether the Change Action to Delete context menu in the Site Synchronize dialog box can be displayed.

Arguments

None.

Returns

A Boolean value: true if the Change Action to Delete context menu can be displayed; false otherwise.

dreamweaver.siteSyncDialog.canMarkGet()

Availability

Dreamweaver 8.

Description

This function checks whether the Change Action to Get context menu in the Site Synchronize dialog box can be displayed.

Arguments

None.

Returns

A Boolean value: true if the Change Action to Get context menu can be displayed; false otherwise.

dreamweaver.siteSyncDialog.canMarkIgnore()

Availability

Dreamweaver 8.

Description

This function checks whether the Change Action to Ignore context menu in the Site Synchronize dialog box can be displayed.

Arguments

None.

Returns

A Boolean value: true if the Change Action to Ignore context menu can be displayed; false otherwise.

dreamweaver.siteSyncDialog.canMarkPut()

Availability

Dreamweaver 8.

Description

This function checks whether the Change Action to Put context menu in the Site Synchronize dialog box can be displayed.

Arguments

None.

Returns

A Boolean value: true if the Change Action to Put context menu can be displayed; false otherwise.

dreamweaver.siteSyncDialog.canMarkSynced()

Availability

Dreamweaver 8.

Description

This function checks whether the Change Action to Synced context menu in the Site Synchronize dialog box can be displayed.

Arguments

None.

Returns

A Boolean value: true if the Change Action to Synced context menu can be displayed; false otherwise.

dreamweaver.snippetpalette.canEditSnippet()

Availability

Dreamweaver MX.

Description

Checks whether you can edit the currently selected item and returns either a true or false value so you can enable or disable menu items for editing.

Arguments

None.

Returns

A Boolean value: true if you can edit the currently selected item; false otherwise.

dreamweaver.snippetpalette.canInsert()

Availability

Dreamweaver MX.

Description

Checks whether you can insert or apply the selected element and returns either a true or false value so you can enable or disable menu items for inserting or applying.

Arguments

None.

Returns

A Boolean value: true if you can insert or apply the selected element; false otherwise.

site.browseDocument()

Availability

Dreamweaver 4.

Description

Opens all selected documents in a browser window. It is the same as using the Preview in Browser command.

Arguments

browserName

  • The browserName argument is the name of a browser as defined in the Preview in Browser preferences. If omitted, this argument defaults to the user’s primary browser.

Returns

Nothing.

site.canCheckIn()

Availability

Dreamweaver 3.

Description

Determines whether Dreamweaver can perform a Check In operation.

Arguments

siteOrURL

  • The siteOrURL argument must be the site keyword, which indicates that the function should act on the selection in the Site panel or the URL for a single file.

Returns

A Boolean value: true if the following conditions are true; false otherwise:

  • A remote site has been defined.

  • If a document window has focus, the file has been saved in a local site; or, if the Site panel has focus, one or more files or folders are selected.

  • The Check In/Check Out feature is turned on for the site.

site.canCheckOut()

Availability

Dreamweaver 3.

Description

Determines whether Dreamweaver can perform a Check Out operation on the specified file or files.

Arguments

siteOrURL

  • The siteOrURL argument must be the site keyword, which indicates that the function should act on the selection in the Site panel or the URL for a single file.

Returns

A Boolean value: true if all the following conditions are true; false otherwise:

  • A remote site has been defined.

  • If a document window has focus, the file is part of a local site and is not already checked out; or, if the Site panel has focus, one or more files or folders are selected and at least one of the selected files is not already checked out.

  • The Check In/Check Out feature is turned on for the site.

site.canCloak()

Availability

Dreamweaver MX.

Description

Determines whether Dreamweaver can perform a Cloaking operation.

Arguments

siteOrURL

  • The siteOrURL argument must be the site keyword, which indicates that the canCloak() function should act on the selection in the Site panel or the URL of a particular folder, which indicates that the canCloak() function should act on the specified folder and all its contents.

Returns

A Boolean value: true if Dreamweaver can perform the Cloaking operation on the current site or the specified folder; false otherwise.

site.canCompareFiles()

Availability

Dreamweaver 8.

Description

This function checks whether Dreamweaver can perform the Compare function on selected files.

Arguments

None.

Returns

A Boolean value: true if two files (one local file and one remote file, two local files, or two remote files) are selected; false otherwise.

site.canConnect()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can connect to the remote site.

Arguments

None.

Returns

A Boolean value: true if the current remote site is an FTP site; false otherwise.

site.canDisplaySyncInfoForFile()

Availability

Dreamweaver CS3

Description

Determines whether Dreamweaver can perform the displaySyncInfoForFile operation.

Arguments

path, 'site'

  • path is the URL to a local file.

  • 'site' indicates that the function uses the file selected in the Site panel.

Returns

Returns true if one selected file is in the local file view (if 'site' is the parameter) or true if the path passed in is part of a site. Returns false otherwise.

site.canGet()

Availability

Dreamweaver 3.

Description

Determines whether Dreamweaver can perform a Get operation.

Arguments

siteOrURL

  • The siteOrURL argument must be the site keyword, which indicates that the function should act on the selection in the Site panel or the URL for a single file.

Returns

If the argument is site, a Boolean value that indicates whether one or more files or folders is selected in the Site panel and a remote site has been defined. If the argument is a URL, a Boolean value that indicates whether the document belongs to a site for which a remote site has been defined.

site.canLocateInSite()

Availability

Dreamweaver 3, and updated in CS4.

Description

Determines whether Dreamweaver can perform a Locate in Local Site or Locate in Remote Site operation (depending on the argument).

Arguments

localOrRemote, siteOrURL

  • The localOrRemote argument must be either local or remote.

  • The siteOrURL argument must be the site keyword. The keyword indicates that the function must act on the selection in the Site panel or the URL for a single file.

Returns

One of the following values:

  • A Boolean value that indicates whether the document belongs to a site. The Boolean value is returned if the first argument is the keyword local and the second argument is a URL.

  • A Boolean value. The Boolean value is returned if the first argument is the keyword remote and the second argument is a URL. The Boolean value indicates:

    • Whether the document belongs to a site for which a remote site has been defined.

    • Whether the hard drive is mounted, if the server type is Local/Network.

  • A Boolean value that indicates whether both windows contain site files and whether the selection is in the opposite pane from the argument. The Boolean value is returned if the second argument is the keyword site.

site.canMakeEditable()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Turn Off Read Only operation.

Arguments

None.

Returns

A Boolean value: true if Dreamweaver can perform a Turn Off Read Only operation; false if one or more of the selected files is locked.

site.canMakeNewFileOrFolder()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a New File or New Folder operation in the Site panel.

Arguments

None.

Returns

A Boolean value: true if any files are visible in the selected pane of the Site panel; false otherwise.

site.canOpen()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can open the files or folders that are currently selected in the Site panel.

Arguments

None.

Returns

A Boolean value: true if any files or folders are selected in the Site panel; false otherwise.

site.canPut()

Availability

Dreamweaver 3.

Description

Determines whether Dreamweaver can perform a Put operation.

Arguments

siteOrURL

  • The siteOrURL argument must be the site keyword, which indicates that the function should act on the selection in the Site panel, or the URL for a single file.

Returns

One of the following values:

  • If the argument is the keyword site, returns the value true if any files or folders are selected in the Site panel and a remote site has been defined; otherwise false.

  • If the argument is a URL, returns the value true if the document belongs to a site for which a remote site has been defined; otherwise false.

site.canRecreateCache()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Recreate Site Cache operation.

Arguments

None.

Returns

A Boolean value: true if the Use Cache To Speed Link Updates option is enabled for the current site.

site.canRefresh()

Availability

Dreamweaver 3.

Description

Checks whether Dreamweaver can perform a Refresh [Local | Remote] operation.

Arguments

localOrRemote

  • The localOrRemote argument must be either the local or remote keyword.

Returns

A value of true if the localOrRemote argument is the local keyword; otherwise, a Boolean value that indicates whether a remote site has been defined.

site.canSelectAllCheckedOutFiles()

Availability

Dreamweaver 4.

Description

Determines whether the current working site has the Check In/Check Out feature enabled.

Arguments

None.

Returns

A Boolean value: true if the site allows Check In/Check Out; false otherwise.

site.canSelectNewer()

Availability

Dreamweaver 3.

Description

Determines whether Dreamweaver can perform a Select Newer [Remote | Local] operation.

Arguments

localOrRemote

  • The localOrRemote argument must be either the local or remote keyword.

Returns

A Boolean value that indicates whether the document belongs to a site for which a remote site has been defined.

site.canSynchronize()

Availability

Dreamweaver 3.

Description

Determines whether Dreamweaver can perform a Synchronize operation.

Arguments

None.

Returns

A Boolean value that indicates whether a remote site has been defined.

site.canUncloak()

Availability

Dreamweaver MX.

Description

Determines whether Dreamweaver can perform an uncloaking operation.

Arguments

siteOrURL

  • The siteOrURL argument must be the site keyword, which indicates that the canUncloak() function should act on the selection in the Site panel or the URL of a particular folder, which indicates that the canUncloak() function should act on the specified folder and all its contents.

Returns

A Boolean value: true if Dreamweaver can perform the uncloaking operation on the current site or the specified folder; false otherwise.

site.canUndoCheckOut()

Availability

Dreamweaver 3.

Description

Determines whether Dreamweaver can perform an Undo Check Out operation.

Arguments

siteOrURL

  • The siteOrURL argument must be the site keyword, which indicates that the function should act on the selection in the Site panel or the URL for a single file.

Returns

A Boolean value: true if the specified file or at least one of the selected files is checked out.

site.canViewAsRoot()

Availability

Dreamweaver 3.

Description

Determines whether Dreamweaver can perform a View as Root operation.

Arguments

None.

Returns

A Boolean value: true if the specified file is an HTML or Flash file; false otherwise.

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy