Поделиться через

StorageFolder.GetThumbnailAsync Метод

  • Ссылка

Определение

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

Перегрузки

GetThumbnailAsync(ThumbnailMode, UInt32, ThumbnailOptions)

Возвращает эскиз для текущей папки, размер для указанного назначения эскиза, скорректированный в соответствии с запрошенным размером с указанными параметрами.
GetThumbnailAsync(ThumbnailMode, UInt32)

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

Получает эскиз для текущей папки размером для указанного назначения эскиза.

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

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

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

options
ThumbnailOptions

Значение из перечисления , указывающее способ извлечения и размера изображения. Значение по умолчанию UseCurrentScale подходит для большинства приложений.

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

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

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

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

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

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

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

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

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(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

Примеры

В следующем примере получается эскиз для папки "Изображения" пользователя и отображается эскиз в элементе управления Изображение . В этом примере также запрашивается изображение, самая длинная сторона которого составляет 64 пикселя, и запрашивает изображение только в том случае, если оно уже кэшировано на устройстве. В примере предполагается, что на текущей странице есть элемент управления ImageControl.

Перед выполнением следующего примера включите возможность "Библиотека рисунков" в файле манифеста приложения.

using Windows.Storage;
using Windows.Storage.FileProperties;
using System.Threading.Tasks;
using Windows.UI.Xaml.Media.Imaging; // For the Bitmap object.

// Get the user's Pictures folder.
// Enable the corresponding capability in the app manifest file.
StorageFolder picturesFolder = KnownFolders.PicturesLibrary;

// Get a thumbnail for the current folder.
StorageItemThumbnail thumb =
    await picturesFolder.GetThumbnailAsync(ThumbnailMode.SingleItem,
    64, ThumbnailOptions.ReturnOnlyIfCached);

// Display the thumbnail in an Image control
// named ImageControl on the current page.
BitmapImage bitmapImage = new BitmapImage();
bitmapImage.SetSource(thumb);
ImageControl.Source = bitmapImage;

Комментарии

Пример, демонстрирующий метод GetThumbnailAsync , см. в разделе Пример эскиза файлов и папок.

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

Метод StorageFolder.GetThumbnailAsync иногда возвращает изображение папки по умолчанию. Для приложения Windows Phone версии 8.x этот метод игнорирует текущую тему при возврате этого изображения по умолчанию. Возвращаемое изображение всегда является изображением для темной темы; то есть папка прозрачна с белой границей. Если вы хотите вернуть изображение для светлой темы, необходимо создать собственное изображение, видимое на светлом фоне. Затем необходимо использовать условную логику для проверка активной темы. Если активная тема является светлой, используйте метод, отличный от GetThumbnailAsync , чтобы получить пользовательское изображение.

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

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