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

Используйте свойство IsPlaying вместе с методами Play и Stop для управления воспроизведением анимированного растрового изображения.

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

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