BitmapImage.Stop Método

Definição

Namespace:

Microsoft.UI.Xaml.Media.Imaging

Encerra a animação de uma imagem animada.

public:
 virtual void Stop() = Stop;

void Stop();

public void Stop();

function stop()

Public Sub Stop ()

Exemplos

Veja como usar a ApiInformation.IsMethodPresent para marcar a presença do método Stop antes de chamá-lo.

if (ApiInformation.IsMethodPresent("Windows.UI.Xaml.Media.Imaging.BitmapImage", "Stop"))
{
    imageSource.Stop();
}

Este exemplo mostra como usar um GIF animado. Um botão permite que o usuário inicie ou interrompa a animação. A propriedade IsPlaying é verificada para determinar se o método Play ou Stop é chamado para alternar a reprodução.

O exemplo usa código adaptável de versão para que possa ser executado em todas as versões do Windows 10. Nesse caso, a presença da propriedade IsPlaying indica que os métodos Play e Stop também estão presentes, portanto, uma API adicional marcar não é necessária.

<Grid Background="{ThemeResource ApplicationPageBackgroundThemeBrush}">
    <Image>
        <Image.Source>
            <BitmapImage x:Name="imageSource"
                         UriSource="Assets/example.gif"/>
        </Image.Source>
    </Image>

    <AppBarButton x:Name="playButton"
              Icon="Play"
              Click="playButton_Click"/>
</Grid>

// Play or stop the animated bitmap.
void playButton_Click(object sender, RoutedEventArgs e)
{
    if (ApiInformation.IsPropertyPresent("Windows.UI.Xaml.Media.Imaging.BitmapImage", "IsPlaying") 
        && imageSource.IsPlaying == true)
    {
        playButton.Icon = new SymbolIcon(Symbol.Play);
        imageSource.Stop();
    }
    else
    {
        playButton.Icon = new SymbolIcon(Symbol.Stop);
        imageSource.Play();
    }   
}

Comentários

A partir do Windows 10, versão 1607, o elemento Imagem XAML dá suporte a imagens GIF animadas. Ao usar um BitmapImage como a imagem Fonte, você pode acessar a API BitmapImage para controlar a reprodução da imagem GIF animada. Para obter mais informações, consulte a seção 'Imagens animadas' da classe BitmapImage Comentários e o exemplo de reprodução gif animado.

Use a propriedade IsPlaying junto com os métodos Play e Stop para controlar a reprodução de um bitmap animado.

Notas de compatibilidade

Se seu aplicativo for executado em versões do Windows 10 anteriores à versão 1607, você deverá usar a classe ApiInformation para marcar para a presença desse método antes de usá-lo. Para obter mais informações, consulte Código adaptável de versão: usar novas APIs enquanto mantém a compatibilidade com versões anteriores.