beautypg.com

Document.removerelatedfile(), Document.getdependentfiles() – Adobe Dreamweaver API Reference CS5 User Manual

Page 200

background image

195

DREAMWEAVER API REFERENCE

Workspace

Last updated 8/27/2013

If you are an extension developer, make sure that you invoke the r

efreshRelatedFiles()

function after invoking

the

addRelatedFile()

function. For more information on the

refreshRelatedFiles()

function, see

dreamweaver.refreshRelatedFiles()

” on page 192.

Arguments

uri

- A

DWUri

object representing the related file object. This argument is required.

persistent

- A Boolean value. True, if the related file object will persist when the top level document is re-

scanned. This is an optional argument.

type - A optional string specified in the document.getRelatedFiles() function. Callers who omit this parameter will
insert a related file of type

USER_DEFINED_CHILD_DOC

.

Returns
None.

document.removeRelatedFile()

Availability
Dreamweaver CS5.

Description
This function is used to remove an extension-defined related file.

Related document objects of only type

CHILD_DOC

can be removed using this function. Related document objects with

the type

SOURCE_HTML

or

GENERATED_HTML

cannot be removed using this function.

Arguments

uri

- A

DWUri

object representing the related file object. This argument is required.

Returns
None.

document.getDependentFiles()

Availability
Dreamweaver CS5.

Description
This function is used to retrieve the dependent files of the document object.

The dependent files list is the list of files that are pushed to the server if they are modified for Preview In Browser, Live
View, or when getting the document from the server or version control.

Arguments
None.

Returns
An array of

DWUri

objects representing the dependent file list.