MACROMEDIA DREAMWEAVER MX 2004-DREAMWEAVER API, Reference

Page: 317 / 486

Library and template functions 317
Arguments
{bAsText}
•
The
bAsText
Boolean value, which is optional, specifies whether the Clipboard content is
retrieved as text. If
bAsText
is a value of
true
, the Clipboard content is retrieved as text. If
bAsText
is a value of
false
, the content retains formatting. This argument defaults to
false
.
Returns
A string that contains the contents of the Clipboard, if the Clipboard contains text (which can be
HTML); otherwise, it returns nothing.
Example
If
dreamweaver.getClipboardText()
returns
"text <b>bold</b> text"
, then
dreamweaver.getClipboardText(true)
returns
"text bold text"
.
Library and template functions
Library and template functions handle operations that are related to library items and templates,
such as creating, updating, and breaking links between a document and a template or library
item. Methods of the
dreamweaver.libraryPalette
object either control or act on the selection
in the Assets panel library items, not in the current document. Likewise, methods of the
dreamweaver.templatePalette
object control or act on the selection in the Assets panel
template objects.
dom.applyTemplate()
Availability
Dreamweaver 3.
Description
Applies a template to the current document. If no argument is supplied, the Select Template
dialog box appears. This function is valid only for the document that has focus.
Arguments
{templateURL}
,
bMaintainLink
•
The
templateURL
argument is the path to a template in the current site, which is expressed as
a file:// URL.
•
The
bMaintainLink
argument is a Boolean value that indicates whether to maintain the link
to the original template (
true
) or not (
false
).
Returns
Nothing.
Enabler
“dom.canApplyTemplate()” on page 432 .
000_DW_API_Print.book Page 317 Wednesday, August 20, 2003 9:14 AM