StorageFile.GetThumbnailAsync Метод

  • Ссылка

Определение

Пространство имен:
Windows.Storage

Перегрузки

GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

Извлекает скорректированное эскизное изображение для файла, определяемое назначением эскиза, запрошенным размером и указанными параметрами.
GetThumbnailAsync(ThumbnailMode)

Извлекает скорректированное эскизное изображение для файла, определяемое назначением эскиза.
GetThumbnailAsync(ThumbnailMode, UInt32)

Извлекает скорректированное изображение эскиза для файла, определяемое назначением эскиза и запрошенным размером.

GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

Изменить

Извлекает скорректированное эскизное изображение для файла, определяемое назначением эскиза, запрошенным размером и указанными параметрами.

public:
 virtual IAsyncOperation<StorageItemThumbnail ^> ^ GetThumbnailAsync(ThumbnailMode mode, unsigned int requestedSize, ThumbnailOptions options) = GetThumbnailAsync;
/// [Windows.Foundation.Metadata.Overload("GetThumbnailAsync")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode const& mode, uint32_t const& requestedSize, ThumbnailOptions const& options);
[Windows.Foundation.Metadata.Overload("GetThumbnailAsync")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, uint requestedSize, ThumbnailOptions options);
function getThumbnailAsync(mode, requestedSize, options)
Public Function GetThumbnailAsync (mode As ThumbnailMode, requestedSize As UInteger, options As ThumbnailOptions) As IAsyncOperation(Of StorageItemThumbnail)

Параметры

mode
ThumbnailMode

Значение перечисления, которое описывает назначение эскиза и определяет способ настройки эскиза.

Рекомендации по выбору оптимального режима эскизов см. в разделе Рекомендации и контрольный список для эскизов.

requestedSize
UInt32

unsigned int

uint32_t

Запрошенный размер (в пикселях) самого длинного края эскиза. Windows использует requestedSize в качестве руководства и пытается масштабировать эскиз изображения без снижения качества изображения.

Если Windows не удается найти эскиз, масштабируемый в соответствии с требуемым размером, может быть возвращен эскиз большего размера. Если эскиз большего размера недоступен, может быть возвращено эскизное изображение, которое меньше запрошенного размера.

options
ThumbnailOptions

Значение перечисления, описывающее требуемое поведение, используемое для получения эскиза. Указанное поведение может повлиять на размер и (или) качество изображения, а также на то, как быстро извлекается эскиз.

Возвращаемое значение

IAsyncOperation<StorageItemThumbnail>

После успешного завершения этого метода он возвращает объект StorageItemThumbnail , представляющий эскизное изображение, или значение NULL , если с файлом нет эскиза.

Реализации

M:Windows.Storage.IStorageItemProperties.GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,System.UInt32,Windows.Storage.FileProperties.ThumbnailOptions) M:Windows.Storage.IStorageItemProperties.GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,unsigned int,Windows.Storage.FileProperties.ThumbnailOptions) M:Windows.Storage.IStorageItemProperties.GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,uint32_t,Windows.Storage.FileProperties.ThumbnailOptions)
Атрибуты
OverloadAttribute RemoteAsyncAttribute

Примеры

В этом примере показано, как записать эскиз файла с помощью метода [storageFile.getThumbnailAsync(mode, requestedSize, options).

storageFile.getThumbnailAsync(
    Windows.Storage.FileProperties.ThumbnailMode.musicView,
    100,
    Windows.Storage.FileProperties.ThumbnailOptions.useCurrentScale).then(
        function (storageItemThumbnail) {
            // Add code to process thumbnail
        }
    );

Чтобы использовать один из методов StorageFile.GetThumbnailAsync, необходимо иметь объект StorageFile (storageFile в примере), представляющий ваш файл.

Комментарии

Хотя GetThumbnailAsync соответствует максимальному размеру, поддерживаемому кэшем диска эскизов, GetScaledImageAsThumbnailAsync может извлекать эскизы, размер которых больше, чем поддерживает кэш диска эскизов. GetScaledImageAsThumbnailAsync обеспечивает оптимальное качество, но может повлиять на производительность, не используя кэш диска, если размер эскиза слишком велик.

См. также раздел

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

GetThumbnailAsync(ThumbnailMode)

Изменить

Извлекает скорректированное эскизное изображение для файла, определяемое назначением эскиза.

public:
 virtual IAsyncOperation<StorageItemThumbnail ^> ^ GetThumbnailAsync(ThumbnailMode mode) = GetThumbnailAsync;
/// [Windows.Foundation.Metadata.Overload("GetThumbnailAsyncOverloadDefaultSizeDefaultOptions")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode const& mode);
[Windows.Foundation.Metadata.Overload("GetThumbnailAsyncOverloadDefaultSizeDefaultOptions")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode);
function getThumbnailAsync(mode)
Public Function GetThumbnailAsync (mode As ThumbnailMode) As IAsyncOperation(Of StorageItemThumbnail)

Параметры

mode
ThumbnailMode

Значение перечисления, которое описывает назначение эскиза и определяет способ настройки эскиза.

Рекомендации по выбору оптимального режима эскизов см. в разделе Рекомендации и контрольный список для эскизов.

Возвращаемое значение

IAsyncOperation<StorageItemThumbnail>

После успешного завершения этого метода он возвращает объект StorageItemThumbnail , представляющий эскизное изображение, или значение NULL , если с файлом нет эскиза.

Реализации

GetThumbnailAsync(ThumbnailMode)
Атрибуты
OverloadAttribute RemoteAsyncAttribute

Комментарии

Хотя GetThumbnailAsync соответствует максимальному размеру, поддерживаемому кэшем диска эскизов, GetScaledImageAsThumbnailAsync может извлекать эскизы, размер которых больше, чем поддерживает кэш диска эскизов. GetScaledImageAsThumbnailAsync обеспечивает оптимальное качество, но может повлиять на производительность, не используя кэш диска, если размер эскиза слишком велик.

См. также раздел

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

GetThumbnailAsync(ThumbnailMode, UInt32)

Изменить

Извлекает скорректированное изображение эскиза для файла, определяемое назначением эскиза и запрошенным размером.

public:
 virtual IAsyncOperation<StorageItemThumbnail ^> ^ GetThumbnailAsync(ThumbnailMode mode, unsigned int requestedSize) = GetThumbnailAsync;
/// [Windows.Foundation.Metadata.Overload("GetThumbnailAsyncOverloadDefaultOptions")]
/// [Windows.Foundation.Metadata.RemoteAsync]
IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode const& mode, uint32_t const& requestedSize);
[Windows.Foundation.Metadata.Overload("GetThumbnailAsyncOverloadDefaultOptions")]
[Windows.Foundation.Metadata.RemoteAsync]
public IAsyncOperation<StorageItemThumbnail> GetThumbnailAsync(ThumbnailMode mode, uint requestedSize);
function getThumbnailAsync(mode, requestedSize)
Public Function GetThumbnailAsync (mode As ThumbnailMode, requestedSize As UInteger) As IAsyncOperation(Of StorageItemThumbnail)

Параметры

mode
ThumbnailMode

Значение перечисления, которое описывает назначение эскиза и определяет способ настройки эскиза.

Рекомендации по выбору оптимального режима эскизов см. в разделе Рекомендации и контрольный список для эскизов.

requestedSize
UInt32

unsigned int

uint32_t

Запрошенный размер (в пикселях) самого длинного края эскиза. Windows использует requestedSize в качестве руководства и пытается масштабировать эскиз изображения без снижения качества изображения.

Если Windows не удается найти эскиз, масштабируемый в соответствии с требуемым размером, может быть возвращен эскиз большего размера. Если эскиз большего размера недоступен, может быть возвращено эскизное изображение, которое меньше запрошенного размера.

Возвращаемое значение

IAsyncOperation<StorageItemThumbnail>

После успешного завершения этого метода он возвращает объект StorageItemThumbnail , представляющий эскизное изображение, или значение NULL , если с файлом нет эскиза.

Реализации

M:Windows.Storage.IStorageItemProperties.GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,System.UInt32) M:Windows.Storage.IStorageItemProperties.GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,unsigned int) M:Windows.Storage.IStorageItemProperties.GetThumbnailAsync(Windows.Storage.FileProperties.ThumbnailMode,uint32_t)
Атрибуты
OverloadAttribute RemoteAsyncAttribute

Комментарии

Хотя GetThumbnailAsync соответствует максимальному размеру, поддерживаемому кэшем диска эскизов, GetScaledImageAsThumbnailAsync может извлекать эскизы, размер которых больше, чем поддерживает кэш диска эскизов. GetScaledImageAsThumbnailAsync обеспечивает оптимальное качество, но может повлиять на производительность, не используя кэш диска, если размер эскиза слишком велик.

См. также раздел

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