BitmapImage.Stop Méthode

Définition

Espace de noms:

Windows.UI.Xaml.Media.Imaging

Termine l’animation d’une image animée.

public:
 virtual void Stop() = Stop;

void Stop();

public void Stop();

function stop()

Public Sub Stop ()

Configuration requise pour Windows

Famille d’appareils	Windows 10 Anniversary Edition (introduit dans 10.0.14393.0)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v3.0)

Exemples

Voici comment utiliser ApiInformation.IsMethodPresent pour case activée la présence de la méthode Stop avant de l’appeler.

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

Cet exemple montre comment utiliser un GIF animé. Un bouton permet à l’utilisateur de démarrer ou d’arrêter l’animation. La propriété IsPlaying est vérifiée pour déterminer si la méthode Play ou Stop est appelée pour désactiver la lecture.

L’exemple utilise du code adaptatif de version pour qu’il puisse s’exécuter sur toutes les versions de Windows 10. Dans ce cas, la présence de la propriété IsPlaying indique que les méthodes Play et Stop sont également présentes, de sorte qu’une case activée API supplémentaire n’est pas nécessaire.

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

Remarques

À compter de Windows 10 version 1607, l’élément Image XAML prend en charge les images GIF animées. Lorsque vous utilisez bitmapImage comme source d’image, vous pouvez accéder à l’API BitmapImage pour contrôler la lecture de l’image GIF animée. Pour plus d’informations, consultez la section « Images animées » de la classe BitmapImage Remarks et l’exemple de lecture GIF animée.

Utilisez la propriété IsPlaying avec les méthodes Play et Stop pour contrôler la lecture d’une image bitmap animée.

Notes de compatibilité

Si votre application s’exécute sur des versions de Windows 10 antérieures à la version 1607, vous devez utiliser la classe ApiInformation pour case activée la présence de cette méthode avant de l’utiliser. Pour plus d’informations, consultez Code adaptatif de version : utiliser de nouvelles API tout en conservant la compatibilité avec les versions précédentes.