download Behavior

Downloads a file and notifies a specified callback function when the download is complete.

Syntax

XML <Prefix: CustomTag ID=sID STYLE="behavior:url('#default#download')" />
HTML <ELEMENT STYLE="behavior:url('#default#download')" ID=sID>
Scripting object.style.behavior = "url('#default#download')"
object.addBehavior ("#default#download")

Possible Values

Prefix Prefix that associates the CustomTag with an XML namespace. This prefix is set using the XMLNS attribute of the HTML tag.
CustomTag User-defined tag.
sID String that specifies a unique identifier for the object.

Members Table

The following table lists the members exposed by the download object. Click a tab on the left to choose the type of member you want to view.
Methods
Method Description
startDownload Downloads the specified file.

Remarks

The members listed in the preceding table might not be accessible through scripting until the window.onload event fires. Waiting for this event to fire ensures that the page is completely loaded, that all behaviors have been applied to corresponding elements on the page, and that all the behavior's properties, methods, and events are available for scripting. To prevent a scripting error—which would indicate that the object does not support a particular member—do not use any of the behavior-defined members before the window.onload event fires.
The download behavior and the file specified in the startDownload method must exist on the same domain.
The download behavior is available as of Microsoft® Internet Explorer 5, in the Microsoft Win32® and Unix platforms.

Examples

This example uses the download behavior to download a page.
<HTML XMLNS:IE>
<SCRIPT>
function onDownloadDone(s) { alert (s); }
</SCRIPT>
<IE:Download ID="oDownload" STYLE="behavior:url(#default#download)" />
<P>Click <A HREF="javascript:oDownload.startDownload('download.htm',
onDownloadDone)">here</A> to begin downloading this page.
This feature requires Microsoft® Internet Explorer 5 or later. Click the following icon to install the latest version. Then reload this page to view the sample.
This example demonstrates using the download behavior with Microsoft Visual Basic® Scripting Edition (VBScript).
<HTML XMLNS:IE>
<SCRIPT LANGUAGE="VBScript">
Function onDownloadDone(s)
MsgBox s
End Function
</SCRIPT>
<IE:DOWNLOAD ID="oDownload" STYLE="behavior:url(#default#download)" />
<button
onclick="vbscript:oDownload.startDownload 'downloadvb.htm', GetRef('onDownloadDone')">
Download File</button>

Applies To

A, ACRONYM, ADDRESS, APPLET, AREA, B, BASE, BASEFONT, BDO, BGSOUND, BIG, BLOCKQUOTE, BODY, BR, BUTTON, CAPTION, CENTER, CITE, CODE, COL, COLGROUP, COMMENT, DD, DEL, DFN, DIR, DIV, DL, DT, EM, EMBED, FIELDSET, FONT, FORM, FRAME, FRAMESET, HEAD, hn, HR, HTML, I, IFRAME, IMG, INPUT type=button, INPUT type=checkbox, INPUT type=file, INPUT type=hidden, INPUT type=image, INPUT type=password, INPUT type=radio, INPUT type=reset, INPUT type=submit, INPUT type=text, INS, ISINDEX, KBD, LABEL, LEGEND, LI, LINK, LISTING, MAP, MARQUEE, MENU, nextID, NOBR, NOFRAMES, NOSCRIPT, OBJECT, OL, OPTION, P, PLAINTEXT, PRE, Q, RT, RUBY, S, SAMP, SCRIPT, SELECT, SMALL, SPAN, STRIKE, STRONG, SUB, SUP, TABLE, TBODY, TD, TEXTAREA, TFOOT, TH, THEAD, TITLE, TR, TT, U, UL, VAR, WBR, XML, XMP