FileSavePickerUI.TargetFileRequested Event
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Fires when the user commits a file to be saved in the file picker.
// Register
event_token TargetFileRequested(TypedEventHandler<FileSavePickerUI, TargetFileRequestedEventArgs const&> const& handler) const;
// Revoke with event_token
void TargetFileRequested(event_token const* cookie) const;
// Revoke with event_revoker
FileSavePickerUI::TargetFileRequested_revoker TargetFileRequested(auto_revoke_t, TypedEventHandler<FileSavePickerUI, TargetFileRequestedEventArgs const&> const& handler) const;
public event TypedEventHandler<FileSavePickerUI,TargetFileRequestedEventArgs> TargetFileRequested;
function onTargetFileRequested(eventArgs) { /* Your code */ }
fileSavePickerUI.addEventListener("targetfilerequested", onTargetFileRequested);
fileSavePickerUI.removeEventListener("targetfilerequested", onTargetFileRequested);
- or -
fileSavePickerUI.ontargetfilerequested = onTargetFileRequested;
Public Custom Event TargetFileRequested As TypedEventHandler(Of FileSavePickerUI, TargetFileRequestedEventArgs)
Event Type
Examples
The File picker sample demonstrates how to respond to a TargetFileRequested event handler.
// Event handler
private async void OnTargetFileRequested(FileSavePickerUI sender, TargetFileRequestedEventArgs e)
{
// Respond to TargetFileRequested event on the background thread on which it was raised
// Requesting a deferral allows the app to call another asynchronous method and complete the request at a later time
var deferral = e.Request.GetDeferral();
// Create file and assign to TargetFile property
e.Request.TargetFile = await ApplicationData.Current.LocalFolder.CreateFileAsync(sender.FileName, CreationCollisionOption.GenerateUniqueName);
// Complete the deferral to let the Picker know the request is finished
deferral.Complete();
}
// Register for the event
fileSavePickerUI.TargetFileRequested += new TypedEventHandler<FileSavePickerUI, TargetFileRequestedEventArgs>(OnTargetFileRequested);
In the example, e
contains a TargetFileRequestedEventArgs object.
Remarks
If your app participates in the File Save Picker contract and a TargetFileRequested event fires, your app should create a new StorageFile that represents the file the user wants to save. The name of the StorageFile you create must match the name of the file specified by the FileName property. The StorageFile you create is returned to the app that called the file picker (the calling app) so that the calling app can write content to the file. Learn more about responding to this event in targetFileRequestedEventArgs.
Note
File picker UI is disabled until the providing app has finished responding to this event.