beautypg.com

Site.canget(), Site.canlocateinsite() – Adobe Dreamweaver API Reference CS5 User Manual

Page 528

background image

523

DREAMWEAVER API REFERENCE

Enablers

Last updated 8/27/2013

'

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.