BitmapImage.Stop 方法

定义

命名空间:

Windows.UI.Xaml.Media.Imaging

结束动画图像的动画。

public:
 virtual void Stop() = Stop;

void Stop();

public void Stop();

function stop()

Public Sub Stop ()

Windows 要求

设备系列	Windows 10 Anniversary Edition (在 10.0.14393.0 中引入)
API contract	Windows.Foundation.UniversalApiContract (在 v3.0 中引入)

示例

下面介绍如何使用 ApiInformation.IsMethodPresent 在调用 Stop 方法之前检查。

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

此示例演示如何使用动画 GIF。 按钮允许用户启动或停止动画。 选中 IsPlaying 属性以确定是否调用 Play 或 Stop 方法来切换播放。

该示例使用版本自适应代码，因此它可以在所有版本的 Windows 10 上运行。 在这种情况下，IsPlaying 属性的存在指示也存在 Play 和 Stop 方法，因此不需要额外的 API 检查。

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

注解

从 Windows 10 版本 1607 开始，XAML Image 元素支持动态 GIF 图像。 使用 BitmapImage 作为图像 源时，可以访问 BitmapImage API 来控制动画 GIF 图像的播放。 有关详细信息，请参阅 BitmapImage 类“备注”和 动画 GIF 播放示例的“动画图像”部分。

使用 IsPlaying 属性以及 Play 和 Stop 方法来控制动画位图的播放。

兼容性说明

如果应用在版本 1607 之前的 Windows 10 版本上运行，则必须使用 ApiInformation 类来检查此方法是否存在。 有关详细信息，请参阅 版本自适应代码：在保持与以前版本的兼容性的同时使用新 API。