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

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

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