Class CoreWebView2DownloadStartingEventArgs

Namespace

Microsoft.Web.WebView2.Core

Assembly

Microsoft.Web.WebView2.Core.dll

Event args for the DownloadStarting event.

public class CoreWebView2DownloadStartingEventArgs : EventArgs

Inheritance

object

EventArgs

CoreWebView2DownloadStartingEventArgs

Inherited Members

EventArgs.Empty

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Cancel

Indicates whether to cancel the download.

public bool Cancel { get; set; }

Property Value

bool

Remarks

If canceled, the download save dialog is not displayed regardless of the Handled value and the state is changed to Interrupted with interrupt reason UserCanceled.

DownloadOperation

Returns the CoreWebView2DownloadOperation for the download that has started.

public CoreWebView2DownloadOperation DownloadOperation { get; }

Property Value

CoreWebView2DownloadOperation

Handled

Indicates whether to hide the default download dialog.

public bool Handled { get; set; }

Property Value

bool

Remarks

If set to true, the default download dialog is hidden for this download. The download progresses normally if it is not canceled, there will just be no default UI shown. By default the value is false and the default download dialog is shown.

ResultFilePath

The path to the file.

public string ResultFilePath { get; set; }

Property Value

string

Remarks

If setting the path, the host should ensure that it is an absolute path, including the file name, and that the path does not point to an existing file. If the path points to an existing file, the file will be overwritten. If the directory does not exist, it is created.

Methods

GetDeferral()

Gets a CoreWebView2Deferral object.

public CoreWebView2Deferral GetDeferral()

Returns

CoreWebView2Deferral

Remarks

Use this to Complete() the event at a later time.