BitmapImage.AutoPlay Свойство

Определение

Возвращает или задает значение, указывающее, должно ли воспроизводиться анимированное изображение сразу после загрузки.

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 в качестве источника изображения вы можете получить доступ к API BitmapImage для управления воспроизведением анимированного GIF-изображения. Дополнительные сведения см. в разделе "Анимированные изображения" класса BitmapImage Примечания и в примере воспроизведения анимированного GIF-файла.

Используйте свойство Автозапуск, которое по умолчанию имеет значение true, чтобы указать, воспроизводится ли анимированное растровое изображение сразу после загрузки.

Примечание

Для большинства приложений рекомендуется задать для параметра AutoPlay значение false , если uiSettings.AnimationsEnabled имеет значение false, чтобы обеспечить поддержку специальных возможностей пользователей. Не делайте этого, если содержимое анимированного GIF-файла важно для удобства использования приложения.

Заметки о совместимости

Если приложение выполняется в выпусках Windows 10 до версии 1607, необходимо задать это свойство в коде и использовать класс ApiInformation для проверка наличия этого свойства перед его использованием. Если задать это свойство в XAML, вы получите ошибку компилятора XAML. Дополнительные сведения см. в статье Версия адаптивного кода: использование новых API при сохранении совместимости с предыдущими версиями.

Применяется к