Site.getsiteurlprefix(), Site.importsite(), Site.iscloaked() – Adobe Dreamweaver API Reference CS5 User Manual

Page 241

Advertising
background image

236

DREAMWEAVER API REFERENCE

Site

Last updated 8/27/2013

site.getSiteURLPrefix()

Availability
Dreamweaver 8.

Description
Gets the site URL prefix that is extracted from the HTTP Address defined in Local Info section.

Arguments
None.

Returns
A string that contains the site URL prefix.

Example

sitePrefix = getSiteURLPrefix();

site.importSite()

Availability
Dreamweaver MX.

Description
Creates a Dreamweaver site from an XML file. Dreamweaver uses the

localroot

attribute of the

<localinfo>

element to identify the local root folder for the site. During import, if this folder does not exist on the local computer,
Dreamweaver prompts for a different local root folder. Dreamweaver behaves the same way when it tries to locate the
default images folder that the

imagefolder

attribute of the

<localinfo>

element specifies.

Arguments

pathToSteFile

The

pathToSteFile

argument is a string that contains the URL for the STE file. Dreamweaver uses this file to

create a site. If

pathToSteFile

is an empty string, Dreamweaver prompts the user to select a STE file to import.

Returns
A Boolean value:

true

if the named STE file exists and if the site is created successfully;

false

otherwise.

site.isCloaked()

Availability
Dreamweaver MX.

Description
Determines whether the current selection in the Files panel or the specified folder is cloaked.

Advertising