BitmapImage.IsAnimatedBitmap 属性

定义

命名空间:

Windows.UI.Xaml.Media.Imaging

获取一个值，该值指示是否对图像进行动画处理。

public:
 property bool IsAnimatedBitmap { bool get(); };

bool IsAnimatedBitmap();

public bool IsAnimatedBitmap { get; }

var boolean = bitmapImage.isAnimatedBitmap;

Public ReadOnly Property IsAnimatedBitmap As Boolean

属性值

Boolean

bool

如果对图像进行动画处理，则为 true;否则为 false。

Windows 要求

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

示例

此示例演示如何使用动态 GIF。 按钮允许用户启动或停止动画。 检查 IsAnimatedBitmap 属性以确定按钮是显示还是隐藏。

该示例使用版本自适应代码，以便它可以在所有版本的 Windows 10 上运行。 在版本 1607 之前的版本中，将显示 GIF 的第一帧，但不进行动画处理。

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

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

// Show the play/stop button if the image is animated.
private void imageSource_ImageOpened(object sender, RoutedEventArgs e)
{
    var bitmapImage = (BitmapImage)sender;
    // At this point you can query whether the image is animated or not.
    if (ApiInformation.IsPropertyPresent("Windows.UI.Xaml.Media.Imaging.BitmapImage", "IsAnimatedBitmap") 
        && bitmapImage.IsAnimatedBitmap == true)
    {
        // Enable the play button
        playButton.Visibility = Visibility.Visible;
    }
}

注解

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

兼容性说明

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