xmanual.htm

aspupload

<br><font face="Courier New,Courier"><font color="#000000"><font size=-1>Response.Write
"Response from Server: " &amp;_</font></font></font>
<br><font face="Courier New,Courier"><font color="#000000"><font size=-1>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
XUpload.MakeHttpRequest("POST", "param1=value1&amp;param2=value+2")</font></font></font>
<br><font face="Courier New,Courier"><font color="#000000"><font size=-1>%></font></font></font></td>
</tr>
</table>

<p>The following code sample pulls a JPG file from a remote server and
saves it in a local directory:
<br>&nbsp;
<table BORDER CELLSPACING=0 COLS=1 WIDTH="81%" BGCOLOR="#FFFFCC" >
<tr>
<td><font face="Courier New,Courier"><font size=-1>&lt;%</font></font>
<br><font face="Courier New,Courier"><font size=-1>Set XUpload = Server.CreateObject("Persits.XUpload")</font></font>
<br><font face="Courier New,Courier"><font size=-1>XUpload.Server = "192.168.1.1"</font></font>
<br><font face="Courier New,Courier"><font size=-1>XUpload.Script = "/somedir/somefile.jpg"</font></font>
<br><font face="Courier New,Courier"><font size=-1>XUpload.MakeHttpRequest
"GET", "", "c:\localdir\somefile.jpg"</font></font>
<br><font face="Courier New,Courier"><font size=-1>%></font></font></td>
</tr>
</table>

<p>See section <i>Object Reference</i> for the complete description of
the <b>MakeHttpRequest</b>.</blockquote>


<font color="#000099"><B>Object Reference</B></font>

<blockquote><b><u>XUpload Properties</u></b>
<table BORDER CELLSPACING=0 CELLPADDING=2 COLS=3 WIDTH="94%" >
<tr VALIGN=TOP BGCOLOR="#FFCCCC">
<td><b>Property Name</b></td>

<td><b>Type (Access, Default value)</b></td>

<td><b>Comments</b></td>
</tr>

<tr VALIGN=TOP>
<td><b>Server</b></td>

<td>String (RW)</td>

<td>Specifies the address of the server where the files are uploaded to.</td>
</tr>

<tr VALIGN=TOP>
<td><b>Script</b></td>

<td>String (RW)</td>

<td>Specifies the upload script on the <b>Server.</b></td>
</tr>

<tr VALIGN=TOP>
<td><b>SSL</b></td>

<td>Boolean (RW, False)</td>

<td>Specifies whether the server expects a SSL connection.</td>
</tr>

<tr VALIGN=TOP>
<td><b>Port</b></td>

<td>Integer (RW, 0)</td>

<td>Specifies the TCP//IP port on the server to connect to. If not specified,
ports 80 and 443 are used for regular and SSL connections, respectively.</td>
</tr>

<tr VALIGN=TOP>
<td><b>Username</b></td>

<td>String (RW)</td>

<td>Specifies the default username in case basic authentication is enabled
on the server.</td>
</tr>

<tr VALIGN=TOP>
<td><b>Password</b></td>

<td>String (RW)</td>

<td>Specifies the default password in case basic authentication is enabled
on the server.</td>
</tr>

<tr VALIGN=TOP>
<td><b>ShowLoginDialog</b></td>

<td>Boolean (RW, True)</td>

<td>Specifies whether a login dialog box should be shown by XUpload if
basic authentication is enabled on the server. If this property is set
to False, an upload may fail in case <b>Username/Password</b> are invalid.</td>
</tr>

<tr VALIGN=TOP>
<td><b>ShowProgress</b></td>

<td>Boolean (RW, True)</td>

<td>Specifies whether the progress bar should be displayed.</td>
</tr>

<tr VALIGN=TOP>
<td><b>EnablePopupMenu</b></td>

<td>Boolean (RW, True)</td>

<td>Specifies whether a popup menu should be displayed if the control is
right-clicked. If an application chooses to set this property to False,
it must provide some other means to invoke the Select, Remove and Upload
commands.</td>
</tr>

<tr VALIGN=TOP>
<td><b>ViewServerReply</b></td>

<td>Boolean (RW, True)</td>

<td>Specifies whether XUpload should display the Reply from Server message
box with the text returned by the upload script.</td>
</tr>

<tr VALIGN=TOP>
<td><b>Directory</b></td>

<td>String (RW)</td>

<td>Specifies the default directory for the Select Files and Select Folder
dialogs.</td>
</tr>

<tr VALIGN=TOP>
<td><b>Filter</b></td>

<td>String (RW)</td>

<td>Specified the file type filters for the Select Files dialog in the
form of a list of pairs separated by the pipe character ( | ). Each pair
specifies the verbal description of a filter and the filter itself as a
list of semicolon-separated wildcards. The elements in a pair are separated
by the pipe character as well. For example,
<p>"Images (.gif;.jpg)|*.gif;*.jpg|Documents (.doc)|*.doc"</td>
</tr>

<tr VALIGN=TOP>
<td><b>ShowErrors</b></td>

<td>Boolean (RW, True)</td>

<td>Specifies whether XUpload should&nbsp; display error messages. If set
to False, no errors will be reported. In this case an application may need
to handle the <b>Error</b> event.&nbsp;</td>
</tr>

<tr VALIGN=TOP>
<td><b>MaxFileCount</b></td>

<td>Long (RW, 0)</td>

<td>Specifies the maximum allowed number of files. A zero value indicates
no limits.</td>
</tr>

<tr VALIGN=TOP>
<td><b>MaxFileSize</b></td>

<td>Long (RW, 0)</td>

<td>Specifies the maximum allowed size of individual files. A zero value
indicates no limits.</td>
</tr>

<tr VALIGN=TOP>
<td><b>MaxTotalSize</b></td>

<td>Long (RW, 0)</td>

<td>Specifies the maximum allowed total size of files. A zero value indicates
no limits.</td>
</tr>

<tr VALIGN=TOP>
<td><b>Extensions</b></td>

<td>String (RW)</td>

<td>Specifies a comma-separated list of allowed file extensions. An empty
string indicates no limitations.</td>
</tr>

<tr VALIGN=TOP>
<td><b>SelectedFiles</b></td>

<td>Files Collection (R)</td>

<td>Returns a collection of File objects. Each object represents a&nbsp;
file on the control's list. The File object supports the following read-only
properties: <b>Path</b>, <b>Size</b>, <b>Index</b> (0-based) and <b>Selected</b>
(indicates whether the file is highlighted in the list.)</td>
</tr>

<tr>
<td><b>TotalFileSize</b></td>

<td>Long (R)</td>

<td>Returns the total size of selected files.</td>
</tr>

<tr>
<td><b>FileCount</b></td>

<td>Long (R)</td>

<td>Returns the number of selected files</td>
</tr>

<tr VALIGN=TOP>
<td><b>ServerReply</b></td>

<td>String (R)</td>

<td>Returns a reply from server once an upload is complete.</td>
</tr>

<tr VALIGN=TOP>
<td><b>HtmlForm</b></td>

<td>String (RW)</td>

<td>Specifies the HTML form name hosted on the same page. XUpload will
automatically scan this form and upload all non-file items from it along
with files.</td>
</tr>

<tr VALIGN=TOP>
<td><b>Redirect</b></td>

<td>Boolean (RW, False)</td>

<td>Specifies whether XUpload should redirect the browser to the URL specified
by <i>RedirectURL</i> upon the completion of an upload. Only effective
when XUpload is hosted by IE, but not VB. If <i>Redirect</i> is True, XUpload
will POST to the specified URL the results generated by the upload script
in the format
<p><b><tt>XUPLOADREPLY=&lt;<i>results</i>></tt></b></td>
</tr>

<tr VALIGN=TOP>
<td><b>RedirectURL</b></td>

<td>String (RW)</td>

<td>See comments to <i>Redirect</i>. This URL must point to an ASP script
that, at a minimum, must contain the following code:
<p><b><tt>&lt;% Response.Write Request.Form("XUPLOADREPLY") %></tt></b></td>
</tr>

<tr VALIGN=TOP>
<td><b>Proxy</b></td>

<td>String (RW)</td>

<td>Specifies the proxy address when XUpload is used as a server component,
such as
<p><b>XUpload.Proxy = "http://myproxy:80"</b></td>
</tr>

<tr VALIGN=TOP>
<td><b>ProxyBypass</b></td>

<td>String (RW)</td>

<td>Specifies the proxy bypass parameter when XUpload is used as a server
component.</td>
</tr>

<tr VALIGN=TOP>
<td><b>ProxyUsername</b></td>

<td>String (RW)</td>

<td>Specifies the proxy username if the proxy requires authentication.&nbsp;</td>
</tr>

<tr VALIGN=TOP>
<td><b>ProxyPassword</b></td>

<td>String (RW)</td>

<td>Specifies the proxy password if the proxy requires authentication.&nbsp;</td>
</tr>

<tr VALIGN=TOP>
<td><b>IncludeDateInfo</b></td>

<td>Boolean (RW)</td>

<td>True by default. If set to False, switches the date preservation feature
off. This is useful when XUpload is used with an upload component other
than AspUpload.</td>
</tr>

<tr VALIGN=TOP>

<td><b>Expires</b></td>

<td>Date (R)</td>

<td>Returns the control's expiration date. Returns 9/9/9999 if this is
a registered copy. If the expiration date cannot be determined returns
0 (displayed as "12:00 AM".)</td>
</tr>

<tr VALIGN=TOP>

<td><b>Version</b></td>

<td>String (R)</td>