StorageFolder.GetThumbnailAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| 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 は、ほとんどのアプリに適しています。
戻り値
このメソッドが正常に完了すると、サムネイル画像を表す StorageItemThumbnail が返されます。フォルダーに関連付けられているサムネイル イメージがない場合は null を 返します。
実装
- 属性
こちらもご覧ください
適用対象
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 を ガイドとして使用し、画像の品質を低下させることなくサムネイルイメージのスケーリングを試みます。
このメソッドで、要求されたサイズにスケーリングできるサムネイル画像が見つからない場合は、より大きなサムネイルが返される可能性があります。 大きなサムネイルが使用できない場合は、要求されたサイズよりも小さいサムネイル画像が返されることがあります。
戻り値
このメソッドが正常に完了すると、サムネイル画像を表す StorageItemThumbnail が返されます。フォルダーに関連付けられているサムネイル イメージがない場合は null を 返します。
実装
- 属性
こちらもご覧ください
適用対象
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
サムネイルの目的を説明し、サムネイルイメージの調整方法を決定する列挙からの値。
最適なサムネイル モードの選択に関するガイダンスについては、「 サムネイルのガイドラインとチェックリスト」を参照してください。
戻り値
このメソッドが正常に完了すると、サムネイル画像を表す StorageItemThumbnail が返されます。フォルダーに関連付けられているサムネイル イメージがない場合は null を 返します。
実装
- 属性
例
次の例では、ユーザーの Pictures フォルダーのサムネイル画像を取得し、 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 以外のメソッドを使用してカスタム イメージを取得します。