UserProfilePersonalizationSettings.TrySetWallpaperImageAsync(StorageFile) UserProfilePersonalizationSettings.TrySetWallpaperImageAsync(StorageFile) UserProfilePersonalizationSettings.TrySetWallpaperImageAsync(StorageFile) UserProfilePersonalizationSettings.TrySetWallpaperImageAsync(StorageFile) UserProfilePersonalizationSettings.TrySetWallpaperImageAsync(StorageFile) Method

Definition

Attempts to set the specified image file as the desktop wallpaper image.

public : IAsyncOperation<Platform::Boolean> TrySetWallpaperImageAsync(StorageFile imageFile)
IAsyncOperation<bool> TrySetWallpaperImageAsync(StorageFile imageFile) const;
public IAsyncOperation<bool> TrySetWallpaperImageAsync(StorageFile imageFile)
Public Function TrySetWallpaperImageAsync(imageFile As StorageFile) As IAsyncOperation(Of bool)
Windows.System.UserProfile.UserProfilePersonalizationSettings.trySetWallpaperImageAsync(imageFile).done( /* Your success and error handlers */ );

Parameters

imageFile
StorageFile StorageFile StorageFile

The image to set as the desktop background.

Returns

The result of the async operation. true if the background image was set successfully; otherwise, false.

Examples

using Windows.System.UserProfile; 

// Pass in a relative path to a file inside the local appdata folder 
async Task<bool> SetWallpaperAsync(string localAppDataFileName) 
{ 
   bool success = false; 
   if (UserProfilePersonalizationSettings.IsSupported())       
   {
       var uri = new Uri("ms-appx:///Local/" + localAppDataFileName);
       StorageFile file = await StorageFile.GetFileFromApplicationUriAsync(uri);
       UserProfilePersonalizationSettings profileSettings = UserProfilePersonalizationSettings.Current;
       success = await profileSettings.TrySetWallpaperImageAsync(file);
   }
}

Remarks

Note

When you set an image more than once, the new image file must have a different name than the previously set image. If you set a new image using a file with the same name as the previous image, it will fail.