Toggle functions

Toggle functions get and set various options either on or off.

dom.getEditNoFramesContent()

Availability

Dreamweaver 3.

Description

This function gets the current state of the Modify > Frameset > Edit NoFrames Content option.

Arguments

None.

Returns

A Boolean value: true indicates the NOFRAMES content is the active view; false otherwise.

dom.getHideAllVisualAids()

Availability

Dreamweaver 4.

Description

This function determines whether visual aids are set as hidden.

Arguments

None.

Returns

A Boolean value: true sets Hide All Visual Aids to hidden; false otherwise.

dom.getPreventLayerOverlaps()

Availability

Dreamweaver 3.

Description

This function gets the current state of the Prevent Layer Overlaps option.

Arguments

None.

Returns

A Boolean value: TRue turns on the Prevent Layer Overlaps option; false otherwise.

dom.getShowAutoIndent()

Availability

Dreamweaver 4.

Description

This function determines whether auto-indenting is on in the Code view of the document window.

Arguments

None.

Returns

A Boolean value: true if auto-indenting is on; false otherwise.

dom.getShowFrameBorders()

Availability

Dreamweaver 3.

Description

This function gets the current state of the View > Frame Borders option.

Arguments

None.

Returns

A Boolean value: true indicates frame borders are visible; false otherwise.

dom.getShowGrid()

Availability

Dreamweaver 3.

Description

This function gets the current state of the View > Grid > Show option.

Arguments

None.

Returns

A Boolean value: true indicates the grid is visible; false otherwise.

dom.getShowHeadView()

Availability

Dreamweaver 3.

Description

This function gets the current state of the View > Head Content option.

Arguments

None.

Returns

A Boolean value: true indicates the head content is visible; false otherwise.

dom.getShowInvalidHTML()

Availability

Dreamweaver 4.

Description

This function determines whether invalid HTML code is currently highlighted in the Code view of the document window.

Arguments

None.

Returns

A Boolean value: true if invalid HTML code is highlighted; false otherwise.

dom.getShowImageMaps()

Availability

Dreamweaver 3.

Description

This function gets the current state of the View > Image Maps option.

Arguments

None.

Returns

A Boolean value: true indicates the image maps are visible; false otherwise.

dom.getShowInvisibleElements()

Availability

Dreamweaver 3.

Description

This function gets the current state of the View > Invisible Elements option.

Arguments

None.

Returns

A Boolean value: TRue indicates the invisible element markers are visible; false otherwise.

dom.getShowLayerBorders()

Availability

Dreamweaver 3.

Description

This function gets the current state of the View > Layer Borders option.

Arguments

None.

Returns

A Boolean value: true indicates the layer borders are visible; false otherwise.

dom.getShowLineNumbers()

Availability

Dreamweaver 4.

Description

This function determines whether line numbers are shown in the Code view.

Arguments

None.

Returns

A Boolean value: true indicates the line numbers are shown; false otherwise.

dom.getShowRulers()

Availability

Dreamweaver 3.

Description

This function gets the current state of the View > Rulers > Show option.

Arguments

None.

Returns

A Boolean value: true indicates the rulers are visible; false otherwise.

dom.getShowSyntaxColoring()

Availability

Dreamweaver 4.

Description

This function determines whether syntax coloring is on in the Code view of the document window.

Arguments

None.

Returns

A Boolean value: TRue if syntax coloring is on; false otherwise.

dom.getShowTableBorders()

Availability

Dreamweaver 3.

Description

This function gets the current state of the View > Table Borders option.

Arguments

None.

Returns

A Boolean value: TRue indicates the table borders are visible; false otherwise.

dom.getShowToolbar()

Availability

Dreamweaver 4.

Description

This function determines whether the toolbar appears.

Arguments

None.

Returns

A Boolean value: TRue if the toolbar appears; false otherwise.

dom.getShowTracingImage()

Availability

Dreamweaver 3.

Description

This function gets the current state of the View > Tracing Image > Show option.

Arguments

None.

Returns

A Boolean value: true indicates the option is on; false otherwise.

dom.getShowWordWrap()

Availability

Dreamweaver 4.

Description

This function determines whether word wrap is on in the Code view of the document window.

Arguments

None.

Returns

A Boolean value: TRue if word wrap is on; false otherwise.

dom.getSnapToGrid()

Availability

Dreamweaver 3.

Description

This function gets the current state of the View > Grid > Snap To option.

Arguments

None.

Returns

A Boolean value: TRue indicates that the snap-to-grid option is on; false otherwise.

dom.setEditNoFramesContent()

Availability

Dreamweaver 3.

Description

This function toggles the Modify > Frameset > Edit NoFrames Content option on and off.

Arguments

 bEditNoFrames 

• The bEditNoFrames argument is a Boolean value: true turns on the Edit NoFrames Content option; false turns it off.

Returns

Nothing.

Enabler

See "dom.canEditNoFramesContent()" on page 1060.

dom.setHideAllVisualAids()

Availability

Dreamweaver 4.

Description

This function turns off the display of all borders, image maps, and invisible elements, regardless of their individual settings in the View menu.

Arguments

 bSet 

• The bSet argument is a Boolean value: true hides visual aids; false otherwise.

Returns

Nothing.

dom.setPreventLayerOverlaps()

Availability

Dreamweaver 3.

Description

This function toggles the Prevent Layer Overlaps option on and off.

Arguments

 bPreventLayerOverlaps 

• The bPreventLayerOverlaps argument is a Boolean value: TRue turns on the Prevent Layer Overlaps option; false turns it off.

Returns

Nothing.

dom.setShowFrameBorders()

Availability

Dreamweaver 3.

Description

This function toggles the View > Frame Borders option on and off.

Arguments

 bShowFrameBorders 

• The bShowFrameBorders argument is a Boolean value: TRue turns the Frame Borders on; false otherwise.

Returns

Nothing.

dom.setShowGrid()

Availability

Dreamweaver 3.

Description

This function toggles the View > Grid > Show option on and off.

Arguments

 bShowGrid 

• The bShowGrid argument is a Boolean value: true turns on the View > Grid > Show option; false turns it off.

Returns

Nothing.

dom.setShowHeadView()

Availability

Dreamweaver 3.

Description

This function toggles the View > Head Content option on and off.

Arguments

 bShowHead 

• The bShowHead argument is a Boolean value: TRue turns on the Head Content option; false turns it off.

Returns

Nothing.

dom.setShowInvalidHTML()

Availability

Dreamweaver 4.

Description

This function turns highlighting of invalid HTML code on or off in the Code view of the document window.

This function determines whether invalid HTML code is currently highlighted.

Arguments

 bShow 

• The bShow argument is a Boolean value: TRue indicates that highlighting invalid HTML code is visible; false otherwise.

Returns

Nothing.

dom.setShowImageMaps()

Availability

Dreamweaver 3.

Description

This function toggles the View > Image Maps option on and off.

Arguments

 bShowImageMaps 

• The bShowImageMaps argument is a Boolean value, TRue turns on the Image Maps option; false turns it off.

Returns

Nothing.

dom.setShowInvisibleElements()

Availability

Dreamweaver 3.

Description

This function toggles the View > Invisible Elements option on and off.

Arguments

 bViewInvisibleElements 

• The bViewInvisibleElements argument is a Boolean value: TRue turns on the Invisible Elements option; false turns it off.

Returns

Nothing.

dom.setShowLayerBorders()

Availability

Dreamweaver 3.

Description

This function toggles the View > Layer Borders option on and off.

Arguments

 bShowLayerBorders 

• The bShowLayerBorders argument is a Boolean value, TRue turns on the Layer Borders option; false turns it off.

Returns

Nothing.

dom.setShowLineNumbers()

Availability

Dreamweaver 4.

Description

This function shows or hides the line numbers in the Code view of the document window.

Arguments

 bShow 

• The bShow argument is a Boolean value: TRue indicates the line numbers should be visible; false hides them.

Returns

Nothing.

dom.setShowRulers()

Availability

Dreamweaver 3.

Description

This function toggles the View >Rulers > Show option on and off.

Arguments

 bShowRulers 

• The bShowRulers argument is a Boolean value: TRue turns on the Show option; false turns it off.

Returns

Nothing.

dom.setShowSyntaxColoring()

Availability

Dreamweaver 4.

Description

This function turns syntax coloring on or off in the Code view of the document window.

Arguments

 bShow 

• The bShow argument is a Boolean value: TRue indicates that syntax coloring should be visible; false otherwise.

Returns

Nothing.

dom.setShowTableBorders()

Availability

Dreamweaver 3.

Description

This function toggles the View > Table Borders option on and off.

Arguments

 bShowTableBorders 

• The bShowTableBorders argument is a Boolean value: TRue turns on the Table Borders option; false turns it off.

Returns

Nothing.

dom.setShowToolbar()

Availability

Dreamweaver 4.

Description

This function shows or hides the Toolbar.

Arguments

 bShow 

• The bShow argument is a Boolean value: TRue indicates the toolbar should be visible; false otherwise.

Returns

Nothing.

dom.setShowTracingImage()

Availability

Dreamweaver 3.

Description

This function toggles the View > Tracing Image > Show option on and off.

Arguments

 bShowTracingImage 

• The bShowTracingImage argument is a Boolean value: TRue turns on the Show option; false turns it off.

Returns

Nothing.

dom.setShowWordWrap()

Availability

Dreamweaver 4.

Description

This function toggles the Word Wrap option off or on in the Code view of the document window.

Arguments

 bShow 

• The bShow argument is a Boolean value: TRue indicates that the lines should wrap; false otherwise.

Returns

Nothing.

dom.setSnapToGrid()

Availability

Dreamweaver 3.

Description

This function toggles the View > Grid > Snap To option on or off.

Arguments

 bSnapToGrid 

• The bSnapToGrid argument is a Boolean value: TRue turns on the Snap To option; false turns it off.

Returns

Nothing.

dreamweaver.getHideAllFloaters()

Availability

Dreamweaver 3.

Description

This function gets the current state of the Hide Panels option.

Arguments

None.

Returns

A Boolean value: TRue indicates whether the Hide Panels option is on; false indicates the Show Panels option is on.

dreamweaver.getShowStatusBar()

Availability

Dreamweaver 3.

Description

This function gets the current state of the View > Status Bar option.

Arguments

None.

Returns

A Boolean value: true indicates the status bar is visible; false otherwise.

dreamweaver.htmlInspector.getShowAutoIndent()

Availability

Dreamweaver 4.

Description

This function determines whether the Auto Indent option is on in the Code inspector.

Arguments

None.

Returns

A Boolean value: TRue if auto-indenting is on; false otherwise.

dreamweaver.htmlInspector.getShowInvalidHTML()

Availability

Dreamweaver 4.

Description

This function determines whether invalid HTML code is currently highlighted in the Code inspector.

Arguments

None.

Returns

A Boolean value: TRue if invalid HTML code is highlighted; false otherwise.

dreamweaver.htmlInspector.getShowLineNumbers()

Availability

Dreamweaver 4.

Description

This function determines whether line numbers appear in the Code inspector.

Arguments

None.

Returns

A Boolean value: true if line numbers appear; false otherwise.

dreamweaver.htmlInspector.getShowSyntaxColoring()

Availability

Dreamweaver 4.

Description

This function determines whether syntax coloring is on in the Code inspector.

Arguments

None.

Returns

A Boolean value: true if syntax coloring is on; false otherwise.

dreamweaver.htmlInspector.getShowWordWrap()

Availability

Dreamweaver 4.

Description

This function determines whether the Word Wrap is on in the Code inspector.

Arguments

None.

Returns

A Boolean value: true if word wrap is on; false otherwise.

dreamweaver.htmlInspector.setShowAutoIndent()

Availability

Dreamweaver 4.

Description

This function turns the Auto Indent option on or off in the Code inspector.

Arguments

 bShow 

• The bShow argument is a Boolean value: true turns the auto-indenting on; false turns it off.

Returns

Nothing.

dreamweaver.htmlInspector.setShowInvalidHTML()

Availability

Dreamweaver 4.

Description

This function turns highlighting of invalid HTML code on or off in the Code inspector.

Arguments

 bShow 

• The bShow argument is a Boolean value: TRue indicates that the highlighting of invalid HTML code should be visible; false indicates it should not.

Returns

Nothing.

dreamweaver.htmlInspector.setShowLineNumbers()

Availability

Dreamweaver 4.

Description

This function shows or hides the line numbers in the Code view of the Code inspector.

Arguments

 bShow 

• The bShow argument is a Boolean value: true sets the line numbers to visible; false hides them.

Returns

Nothing.

dreamweaver.htmlInspector.setShowSyntaxColoring()

Availability

Dreamweaver 4.

Description

This function turns syntax coloring on or off in the Code view of the Code inspector.

Arguments

 bShow 

• The bShow argument is a Boolean value: TRue indicates that the syntax coloring should be visible; false turns it off.

Returns

Nothing.

dreamweaver.htmlInspector.setShowWordWrap()

Availability

Dreamweaver 4.

Description

This function turns the Word Wrap option off or on in the Code inspector.

Arguments

 bShow 

• The bShow argument is a Boolean value: TRue turns Word Wrap on; false turns it off.

Returns

Nothing.

dreamweaver.setHideAllFloaters()

Availability

Dreamweaver 3.

Description

This function sets either the Hide Panels option or the Show Panels option.

Arguments

 bShowFloatingPalettes 

• The bShowFloatingPalettes argument is a Boolean value: true turns on the Hide Panels option; false turns on the Show Panels option.

Returns

Nothing.

dreamweaver.setShowStatusBar()

Availability

Dreamweaver 3.

Description

This function toggles the View > Status Bar option on or off.

Arguments

 bShowStatusBar 

• The bShowStatusBar argument is a Boolean value: TRue turns on the Status Bar option; false turns it off.

Returns

Nothing.

site.getShowDependents()

Availability

Dreamweaver 3.

Description

This function gets the current state of the Show Dependent Files option.

Arguments

None.

Returns

A Boolean value: true indicates that dependent files are visible in the site map; false indicates dependent files are not visible.

site.getShowHiddenFiles()

Availability

Dreamweaver 3.

Description

This function gets the current state of the Show Files Marked as Hidden option.

Arguments

None.

Returns

A Boolean value: true indicates that hidden files are visible in the site map; false otherwise.

site.getShowPageTitles()

Availability

Dreamweaver 3.

Description

This function gets the current state of the Show Page Titles option.

Arguments

None.

Returns

A Boolean value: true indicates that the page titles are visible in the site map; false otherwise.

site.getShowToolTips()

Availability

Dreamweaver 3.

Description

This function gets the current state of the Tool Tips option.

Arguments

None.

Returns

A Boolean value: TRue indicates that the tool tips are visible in the Site panel; false otherwise.

site.setShowDependents()

Availability

Dreamweaver 3.

Description

This function toggles the Show Dependent Files option in the site map on or off.

Arguments

 bShowDependentFiles 

• The bShowDependentFiles argument is a Boolean value: true turns on the Show Dependent Files option; false turns it off.

Returns

Nothing.

site.setShowHiddenFiles()

Availability

Dreamweaver 3.

Description

This function toggles the Show Files Marked as Hidden option in the site map on or off.

Arguments

 bShowHiddenFiles 

• The bShowHiddenFiles argument is a Boolean value: true turns on the Show Files Marked as Hidden option; false turns it off.

Returns

Nothing.

site.setShowPageTitles()

Availability

Dreamweaver 3.

Description

This function toggles the Show Page Titles option in the site map on or off.

Arguments

 bShowPageTitles 

• The bShowPageTitles argument is a Boolean value: TRue turns on the Show Page Titles option; false turns it off.

Returns

Nothing.

Enabler

See "site.canShowPageTitles()" on page 1100.

site.setShowToolTips()

Availability

Dreamweaver 3.

Description

This function toggles the Tool Tips option on or off.

Arguments

 bShowToolTips 

• The bShowToolTips argument is a Boolean value: TRue turns on the Tool Tips option; false turns it off.

Returns

Nothing.