BitmapImage.Stop Método

Definición

Espacio de nombres:

Windows.UI.Xaml.Media.Imaging

Finaliza la animación de una imagen animada.

public:
 virtual void Stop() = Stop;

void Stop();

public void Stop();

function stop()

Public Sub Stop ()

Requisitos de Windows

Familia de dispositivos	Windows 10 Anniversary Edition (se introdujo en la versión 10.0.14393.0)
API contract	Windows.Foundation.UniversalApiContract (se introdujo en la versión v3.0)

Ejemplos

Aquí se muestra cómo usar ApiInformation.IsMethodPresent para comprobar la presencia del método Stop antes de llamarlo.

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

En este ejemplo se muestra cómo usar un GIF animado. Un botón permite al usuario iniciar o detener la animación. La propiedad IsPlaying está activada para determinar si se llama al método Play o Stop para alternar la reproducción.

En el ejemplo se usa código adaptable de versión para que se pueda ejecutar en todas las versiones de Windows 10. En este caso, la presencia de la propiedad IsPlaying indica que los métodos Play y Stop también están presentes, por lo que no se necesita una comprobación de API adicional.

<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();
    }   
}

Comentarios

A partir de Windows 10, versión 1607, el elemento Imagen XAML admite imágenes GIF animadas. Al usar bitmapImagecomo origen de la imagen, puede acceder a BitmapImage API para controlar la reproducción de la imagen GIF animada. Para obtener más información, consulta la sección "Imágenes animadas" de la clase BitmapImage Comentarios y el ejemplo de reproducción gif animado.

Use la propiedad IsPlaying junto con los métodos Play y Stop para controlar la reproducción de un mapa de bits animado.

Notas de compatibilidad

Si la aplicación se ejecuta en versiones de Windows 10 anteriores a la versión 1607, debes usar la clase ApiInformation para comprobar la presencia de este método antes de usarla. Para obtener más información, consulta Código adaptable de versiones: Usar nuevas API al tiempo que mantiene la compatibilidad con versiones anteriores.