BitmapImage.AutoPlay 属性

定义

命名空间:

Windows.UI.Xaml.Media.Imaging

获取或设置一个值，该值指示动画图像在加载后是否应立即播放。

public:
 property bool AutoPlay { bool get(); void set(bool value); };

bool AutoPlay();

void AutoPlay(bool value);

public bool AutoPlay { get; set; }

var boolean = bitmapImage.autoPlay;
bitmapImage.autoPlay = boolean;

Public Property AutoPlay As Boolean

属性值

Boolean

bool

如果动画图像在加载后立即播放，则为 true;否则为 false。 默认值为 true。

Windows 要求

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

示例

此示例演示如何使用版本自适应代码在所有版本的 Windows 10 上运行的应用中使用此属性。 在版本 1607 之前的版本中，显示 GIF 的第一帧，但不进行动画处理。

<Image Loaded="Image_Loaded">
    <Image.Source>
        <BitmapImage x:Name="imageSource"
                     UriSource="Assets/example.gif"/>
    </Image.Source>
</Image>

// Set the AutoPlay property.
private void Image_Loaded(object sender, RoutedEventArgs e)
{
    if (ApiInformation.IsPropertyPresent("Windows.UI.Xaml.Media.Imaging.BitmapImage", "AutoPlay") == true)
    {
        imageSource.AutoPlay = false;
    }
}

注解

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

使用默认为 true 的 AutoPlay 属性指定动画位图在加载后是否立即播放。

注意

对于大多数应用，建议在 UISettings.AnimationsEnabled 为 false 时将“自动播放”设置为 false，以支持用户的辅助功能需求。 如果动态 GIF 的内容对于应用的可用性很重要，请不要这样做。

兼容性说明

如果应用在版本 1607 之前的 Windows 10 版本上运行，则必须在代码中设置此属性，并使用 ApiInformation 类检查此属性，然后再使用它。 如果在 XAML 中设置此属性，将收到 XAML 编译器错误。 有关详细信息，请参阅 版本自适应代码：在保持与以前版本的兼容性的同时使用新 API。