How to create a converter that use async and await in Windows 10?

Question

I am migrating my Windows Phone 8 ImageConverter to Windows 10 but I am facing issue while using Storage APIs as it uses async and await. Can someone suggest what can be used to achieve my requirement?

My Windows Phone 8 image converter class is below

public class ImageConverter : IValueConverter
{

    public object Convert(object value, Type targetType, object parameter, CultureInfo culture)
    {
        if (value != null)
        {
            string imageUrl = value.ToString();

            if (imageUrl.Contains("NoImageIcon"))
                return value;

            if (imageUrl.Contains(Constants.IMAGES_FOLDER_PATH))
            {
                BitmapImage image = new BitmapImage();
                image.CreateOptions = BitmapCreateOptions.BackgroundCreation;

                IsolatedStorageFile myIsolatedStorage = IsolatedStorageFile.GetUserStoreForApplication();

                if (!myIsolatedStorage.FileExists(imageUrl)) return null;

                using (myIsolatedStorage)
                {
                    using (IsolatedStorageFileStream fileStream = myIsolatedStorage.OpenFile(imageUrl, FileMode.Open, FileAccess.Read))
                    {
                       image.SetSource(fileStream);
                    }
                }
                return image;
            }

            if (imageUrl.Contains("mp4"))
            {
                BitmapImage image = new BitmapImage(new Uri("/Images/video.png", UriKind.Relative));
                image.CreateOptions = BitmapCreateOptions.BackgroundCreation;
                return image;
            }

            if (MCSManager.Instance.isInternetConnectionAvailable)
                return value;
            else
            {
                BitmapImage image = new BitmapImage(new Uri("/Images/defaultImage.png", UriKind.Relative));
                image.CreateOptions = BitmapCreateOptions.BackgroundCreation;
                return image;
            }


        }
        return new Uri("/Images/defaultImage.png", UriKind.Relative);

    }

    public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)
    {
        return null;
    }

}

Windows 10 Code

public class ImageConverter:IValueConverter
{
    StorageFolder localFolder = ApplicationData.Current.LocalFolder;
    public object Convert(object value, Type targetType, object parameter, string culture)
    {
        if (value != null)
        {
            string imageUrl = value.ToString();

            if (imageUrl.Contains("NoImageIcon"))
                return value;

            if (imageUrl.Contains(Constants.IMAGES_FOLDER_PATH))
            {
                BitmapImage image = new BitmapImage();
                image.CreateOptions = BitmapCreateOptions.IgnoreImageCache;
                System.Threading.Tasks.Task.Factory.StartNew(async()=>
                    {
                        StorageFile imagefile = await localFolder.GetFileAsync(imageUrl);
                        using (IRandomAccessStream fileStream=await imagefile.OpenAsync(FileAccessMode.ReadWrite))
                        {

                            image.SetSource(fileStream);
                            return image;
                        }
                    });
            }

            if (imageUrl.Contains("mp4"))
            {
                BitmapImage image = new BitmapImage(new Uri("ms-appx:///Images/video.png", UriKind.RelativeOrAbsolute));
                image.CreateOptions = BitmapCreateOptions.IgnoreImageCache;
                return image;
            }

            if (MCSManager.Instance.isInternetConnectionAvailable)
                return value;
            else
            {
                BitmapImage image = new BitmapImage(new Uri("ms-appx:///Images/defaultImage.png", UriKind.RelativeOrAbsolute));
                image.CreateOptions = BitmapCreateOptions.IgnoreImageCache;
                return image;
            }


        }
        return new Uri("ms-appx:///Images/defaultImage.png", UriKind.RelativeOrAbsolute);

    }
    public object ConvertBack(object value, Type targetType, object parameter, string culture)
    {
        return null;
    }


    private async Task<bool> FileExists(string fileName)
    {
        try
        {
            StorageFile file =await localFolder.GetFileAsync(fileName);
            return true;
        }
        catch(FileNotFoundException ex)
        {
            return false;
        }
    }
}

I want to use this converter in my ListView DataTemplate. My DataTemplate is

<DataTemplate x:Key="NEWReportEvidenceListItemTemplate">
    <UserControl>
        <Grid>
            <VisualStateManager.VisualStateGroups>
                <VisualStateGroup>
                    <VisualState>
                        <VisualState.StateTriggers>
                            <AdaptiveTrigger MinWindowWidth="0"/>
                        </VisualState.StateTriggers>
                        <VisualState.Setters>
                            <Setter Target="DFImage.Width" Value="70"/>
                            <Setter Target="DFImage.Height" Value="70"/>
                        </VisualState.Setters>
                    </VisualState>

                    <VisualState>
                        <VisualState.StateTriggers>
                            <AdaptiveTrigger MinWindowWidth="720"/>
                        </VisualState.StateTriggers>
                        <VisualState.Setters>
                            <Setter Target="DFImage.Width" Value="108"/>
                            <Setter Target="DFImage.Height" Value="108"/>
                        </VisualState.Setters>
                    </VisualState>
                </VisualStateGroup>
            </VisualStateManager.VisualStateGroups>
            <Image DataContext="{Binding EvidencePath,Converter={StaticResource ImageConverter}}"
                   Source="{Binding Result}"
                   x:Name="DFImage"
                   Margin="4,0,0,0"
                   Stretch="Uniform"/>
        </Grid>
    </UserControl>
</DataTemplate>

Posted the answer. Let me know if you have any problem. I dint test it — Archana, May 10 '16 at 05:11

score 2 · Accepted Answer · edited May 23 '17 at 11:45

Use this binding

<Image DataContext="{Binding ImageUrl, Converter={StaticResource ImageConverter}}" Stretch="Uniform" 
           Source="{Binding Result}" HorizontalAlignment="Stretch" VerticalAlignment="Stretch"/>

Converter class

public class ImageConverter : IValueConverter
{
    StorageFolder localFolder = ApplicationData.Current.LocalFolder;
    public object Convert(object value, Type targetType, object parameter, string culture)
    {
        if (value != null)
        {
            string imageUrl = value.ToString();

            if (imageUrl.Contains("NoImageIcon"))
                return value;

            if (imageUrl.Contains(Constants.IMAGES_FOLDER_PATH))
            {
                var task = Task.Run(()=>( (GetImage((String)value))));
                 return new TaskCompletionNotifier<BitmapImage>(task);

            }

            if (imageUrl.Contains("mp4"))
            {
                return new TaskCompletionNotifier<BitmapImage>(Task.Run(() => ((GetImage("ms-appx:///Images/video.png")))));


            }

            if (MCSManager.Instance.isInternetConnectionAvailable)
            {
                return new TaskCompletionNotifier<BitmapImage>(Task.Run(() => ((GetImage(value.ToString(),true)))));
            }
            else
            {
                var task = Task.Run(() => ((GetImage("ms-appx:///Images/defaultImage.png"))));
                return new TaskCompletionNotifier<BitmapImage>(task);
            }


        }
        return new Uri("ms-appx:///Images/defaultImage.png", UriKind.RelativeOrAbsolute);

    }
    private async Task<BitmapImage> GetImage(string path,bool link=false)
    {
        BitmapImage image=null;
        var dispatcher = Windows.ApplicationModel.Core.CoreApplication.MainView.CoreWindow.Dispatcher;
        try
        {

          await  dispatcher.RunAsync(CoreDispatcherPriority.Normal,async () =>
            {
                if (link)
                {
                    image = new BitmapImage();
                    image.UriSource = new Uri(path, UriKind.RelativeOrAbsolute);

                }
                else
                {
                    image = new BitmapImage();
                    image.CreateOptions = BitmapCreateOptions.IgnoreImageCache;

                    StorageFile imagefile = await localFolder.GetFileAsync(path);
                    using (IRandomAccessStream fileStream = await imagefile.OpenAsync(FileAccessMode.ReadWrite))
                    {

                        image.SetSource(fileStream);

                    }
                }
            });
            return image;
        }
        catch(Exception e)
        {
            return null;
        }


    }
    public object ConvertBack(object value, Type targetType, object parameter, string culture)
    {
        return null;
    }


    private async Task<bool> FileExists(string fileName)
    {
        try
        {
            StorageFile file = await localFolder.GetFileAsync(fileName);
            return true;
        }
        catch (FileNotFoundException ex)
        {
            return false;
        }
    }
}
public sealed class TaskCompletionNotifier<TResult> : INotifyPropertyChanged
{
    public TaskCompletionNotifier(Task<TResult> task)
    {
        Task = task;
        if (!task.IsCompleted)
        {
            var scheduler = (SynchronizationContext.Current == null) ? TaskScheduler.Current : TaskScheduler.FromCurrentSynchronizationContext();
            task.ContinueWith(t =>
            {
                var propertyChanged = PropertyChanged;
                if (propertyChanged != null)
                {
                    propertyChanged(this, new PropertyChangedEventArgs("IsCompleted"));
                    if (t.IsCanceled)
                    {
                        propertyChanged(this, new PropertyChangedEventArgs("IsCanceled"));
                    }
                    else if (t.IsFaulted)
                    {
                        propertyChanged(this, new PropertyChangedEventArgs("IsFaulted"));
                        propertyChanged(this, new PropertyChangedEventArgs("ErrorMessage"));
                    }
                    else
                    {
                        propertyChanged(this, new PropertyChangedEventArgs("IsSuccessfullyCompleted"));
                        propertyChanged(this, new PropertyChangedEventArgs("Result"));
                    }
                }
            },
            CancellationToken.None,
            TaskContinuationOptions.ExecuteSynchronously,
            scheduler);
        }
    }

    // Gets the task being watched. This property never changes and is never <c>null</c>.
    public Task<TResult> Task { get; private set; }



    // Gets the result of the task. Returns the default value of TResult if the task has not completed successfully.
    public TResult Result { get { return (Task.Status == TaskStatus.RanToCompletion) ? Task.Result : default(TResult); } }

    // Gets whether the task has completed.
    public bool IsCompleted { get { return Task.IsCompleted; } }

    // Gets whether the task has completed successfully.
    public bool IsSuccessfullyCompleted { get { return Task.Status == TaskStatus.RanToCompletion; } }

    // Gets whether the task has been canceled.
    public bool IsCanceled { get { return Task.IsCanceled; } }

    // Gets whether the task has faulted.
    public bool IsFaulted { get { return Task.IsFaulted; } }


    public event PropertyChangedEventHandler PropertyChanged;
}

I'm returning task from converter and setting it to DataContext of image. Task has Result property,that i'm binding it to Source property

Referred from this link

`MCSManager.Instance.isInternetConnectionAvailable` has value true or false. It is require because if imageUrl is link then we require an Internet connection. — Kinjan Bhavsar, May 10 '16 at 05:13
yes. I am returning Url. And what value will come in `Result`? — Kinjan Bhavsar, May 10 '16 at 05:18
Result will be having bitmapimage,returned from GetImage method. I ll update the code for other part — Archana, May 10 '16 at 05:20
Ok. Did you try this? My app is crashing when I am using it, but it is not displaying any error. — Kinjan Bhavsar, May 10 '16 at 05:22
No i dint try,because i dont have full code. I just gave the idea. If post the link to a sample code i can try — Archana, May 10 '16 at 05:23
I resolved the crashing issue but I am getting the new error. I will add it in my question. I can't provide my code sorry. But you can add one URL and one local file having the image file in Images//evidence1234.jpeg file. and `value` in MCSManager.Instance.isInternetAvailable code is https:// URL. So I can't use `GetImage()` there — Kinjan Bhavsar, May 10 '16 at 05:33
ok I will try this. But can you suggest value part when it is http url — Kinjan Bhavsar, May 10 '16 at 05:43
Ok will try and let you know. Thanks for giving quick response. — Kinjan Bhavsar, May 10 '16 at 05:47
Not working now getting System.Exception and when I debug, in return statement it is showing `task => Id=298, Status=Waiting for Activation,Method="{null}",Result="{Not yet computed}"` — Kinjan Bhavsar, May 10 '16 at 05:53
I checked the reference link that you provided and also I made one mistake due to which it was not working. Thanks will accept your answer. — Kinjan Bhavsar, May 10 '16 at 06:10
ANd you have to add Dispatcher in getImage method.Becuase of misssing dispatcher you were getting Exception I ll update the code — Archana, May 10 '16 at 06:11

How to create a converter that use async and await in Windows 10?

1 Answers1