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

示例

以下示例获取用户的“图片”文件夹的缩略图，并在 Image 控件中显示缩略图。 此示例还请求一个最长边为 64 像素的图像，并且仅当图像已缓存在设备上时才请求该图像。 该示例假定当前页上有一个名为 ImageControl 的 Image 控件。

在运行以下示例之前，请在应用清单文件中启用 图片库 功能。

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 以外的方法检索自定义图像。

另请参阅

适用于