ImageResourceConverter

Artigo
03/13/2024

O ImageResourceConverter é um conversor que converte a ID do recurso de imagem inserida na respectiva ImageSource. Um recurso de imagem incorporada é quando uma imagem foi adicionada a um projeto com a Ação de Build definida como Recurso Incorporado. A ID dele é o nome totalmente qualificado, portanto, o namespace do projeto + o nome do recurso. No exemplo de um projeto chamado CommunityToolkit.Maui.Sample, de um conjunto de pastas aninhadas de Resources/Embedded e de uma imagem chamada dotnetbot.png, a ID será gerada com:

CommunityToolkit.Maui.Sample + Resources.Embedded + dotnetbot.png

o que resultar em:

CommunityToolkit.Maui.Sample.Resources.Embedded.dotnetbot.png

Propriedades de BaseConverter

As seguintes propriedades são implementadas na classe base public abstract class BaseConverter:

Propriedade	Descrição
`DefaultConvertReturnValue`	Valor padrão a ser retornado quando `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` gera uma `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como `true`.
`DefaultConvertBackReturnValue`	Valor padrão a ser retornado quando `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` gera uma `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como `true`.

Propriedades de ICommunityToolkitValueConverter

As seguintes propriedades são implementadas no public interface ICommunityToolkitValueConverter:

Propriedade	Type	Descrição
`DefaultConvertReturnValue`	`object?`	Valor padrão a ser retornado quando `IValueConverter.Convert(object?, Type, object?, CultureInfo?)` gera uma `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como `true`.
`DefaultConvertBackReturnValue`	`object?`	Valor padrão a ser retornado quando `IValueConverter.ConvertBack(object?, Type, object?, CultureInfo?)` gera uma `Exception`. Esse valor é usado quando CommunityToolkit.Maui.Options`.ShouldSuppressExceptionsInConverters` é definido como `true`.

Sintaxe

XAML

Incluir o namespace XAML

Para usar o kit de ferramentas no XAML, o xmlns a seguir precisa ser adicionado à sua página ou exibição:

xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"

Portanto, o seguinte:

<ContentPage
    x:Class="CommunityToolkit.Maui.Sample.Pages.MyPage"
    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml">

</ContentPage>

Seria modificado para incluir o xmlns conforme o seguinte:

<ContentPage
    x:Class="CommunityToolkit.Maui.Sample.Pages.MyPage"
    xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
    xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
    xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit">

</ContentPage>

Como usar o ImageResourceConverter

O ImageResourceConverter pode ser usado da seguinte maneira em XAML:

<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
             xmlns:toolkit="http://schemas.microsoft.com/dotnet/2022/maui/toolkit"
             x:Class="CommunityToolkit.Maui.Sample.Pages.Converters.ImageResourceConverterPage">

    <ContentPage.Resources>
        <ResourceDictionary>
            <toolkit:ImageResourceConverter x:Key="ImageResourceConverter" />
        </ResourceDictionary>
    </ContentPage.Resources>

    <Image Source="{Binding MyImageResource, Converter={StaticResource ImageResourceConverter}}" />

</ContentPage>

C#

O ImageResourceConverter pode ser usado da seguinte maneira em C#:

class ImageResourceConverterPage : ContentPage
{
    public ImageResourceConverterPage()
    {
        var image = new Image();

        image.SetBinding(
            Image.SourceProperty, 
            new Binding(
                static (ViewModel vm) => vm.MyImageResource, 
                converter: new ImageResourceConverter())); 

        Content = label;        
    }
}

Markup do C#

Nosso pacote CommunityToolkit.Maui.Markup disponibiliza uma forma muito mais concisa de usar esse conversor em C#.

using CommunityToolkit.Maui.Markup;

class ImageResourceConverterPage : ContentPage
{
    public ImageResourceConverterPage()
    {
        Content = new Image()
            .Bind(
                Label.SourceProperty, 
                static (ViewModel vm) => vm.MyImageResource,
                converter: new ImageResourceConverter()); 
    }
}

Exemplos

Encontre um exemplo desse conversor em ação no Aplicativo de exemplo do Kit de Ferramentas da Comunidade do .NET MAUI.

API

O código-fonte do ImageResourceConverter pode ser encontrado no repositório GitHub do .NET MAUI Community Toolkit.

Compartilhar via