DotNetBrowser.DownloadItem Interface Reference

Provides different information such as file URL, its mime type, percent complete, received bytes etc. Also it allows registering the DownloadEvent to receive download update events for this particular download item. More...

Public Member Functions
void	Pause ()
	Pauses this download. Will have no effect when the download is already paused. More...
void	Resume ()
	Resumes this download. Will have no effect when the download is not paused. More...
void	Cancel ()
	Cancels this download. Will have no effect when the download is already cancelled. More...

Properties
string	URL [get]
	Gets URL of this download. More...
bool	Paused [get]
	Indicates whether this download is paused. Use this method in the download event to find out whether download is paused or not. Return true when this download is paused. More...
bool	Canceled [get]
	Indicates whether this download is canceled. Use this method in the download event to find out whether download is canceled or not. Return true when this download is canceled. More...
bool	Completed [get]
	Indicates whether this download is completed. Use this method in the DownloadEvent event to find out whether download is completed or not. More...
string	MimeType [get]
	Gets the MIME type of this download. More...
int	ID [get]
	Gets unique identifier of this download. More...
long	CurrentSpeed [get]
	Gets simple speed estimate in bytes/s. More...
int	PercentComplete [get]
	Gets rough percent complete. -1 means we don't know it, because we didn't receive a total size. More...
long	TotalBytes [get]
	Gets the total size of a file in bytes. More...
long	ReceivedBytes [get]
	Gets the number or received (downloaded) bytes. The received bytes must be always less that total bytes. More...
string	DestinationFile [get, set]
	Gets or sets destination file that indicates where the file will be downloaded. More...
DownloadInterruptReason	DownloadInterruptReason [get]
	Gets the possible download interrupt reason. More...

Events
DownloadEventHandler	DownloadEvent
	An event that indicates that download update for this download instance. More...

Detailed Description

Provides different information such as file URL, its mime type, percent complete, received bytes etc. Also it allows registering the DownloadEvent to receive download update events for this particular download item.

Member Function Documentation

void DotNetBrowser.DownloadItem.Cancel

(

)

Cancels this download. Will have no effect when the download is already cancelled.

void DotNetBrowser.DownloadItem.Pause

(

)

Pauses this download. Will have no effect when the download is already paused.

void DotNetBrowser.DownloadItem.Resume

(

)

Resumes this download. Will have no effect when the download is not paused.

Property Documentation

bool DotNetBrowser.DownloadItem.Canceled

get

Indicates whether this download is canceled. Use this method in the download event to find out whether download is canceled or not. Return true when this download is canceled.

bool DotNetBrowser.DownloadItem.Completed

get

Indicates whether this download is completed. Use this method in the DownloadEvent event to find out whether download is completed or not.

TRUE when this download is completed.

long DotNetBrowser.DownloadItem.CurrentSpeed

get

Gets simple speed estimate in bytes/s.

string DotNetBrowser.DownloadItem.DestinationFile

getset

Gets or sets destination file that indicates where the file will be downloaded.

DownloadInterruptReason DotNetBrowser.DownloadItem.DownloadInterruptReason

get

Gets the possible download interrupt reason.

int DotNetBrowser.DownloadItem.ID

get

Gets unique identifier of this download.

string DotNetBrowser.DownloadItem.MimeType

get

Gets the MIME type of this download.

bool DotNetBrowser.DownloadItem.Paused

get

Indicates whether this download is paused. Use this method in the download event to find out whether download is paused or not. Return true when this download is paused.

int DotNetBrowser.DownloadItem.PercentComplete

get

Gets rough percent complete. -1 means we don't know it, because we didn't receive a total size.

long DotNetBrowser.DownloadItem.ReceivedBytes

get

Gets the number or received (downloaded) bytes. The received bytes must be always less that total bytes.

long DotNetBrowser.DownloadItem.TotalBytes

get

Gets the total size of a file in bytes.

string DotNetBrowser.DownloadItem.URL

get

Gets URL of this download.

Event Documentation

DownloadEventHandler DotNetBrowser.DownloadItem.DownloadEvent

An event that indicates that download update for this download instance.