DocumentProperties Kelas

Referensi

Definisi

Ruang nama:: Windows.Storage.FileProperties

Penting

Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.

Edit

Menyediakan akses ke properti item terkait dokumen (seperti file atau folder).

public ref class DocumentProperties sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
class DocumentProperties final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
public sealed class DocumentProperties

Public NotInheritable Class DocumentProperties

Warisan: Object Platform::Object IInspectable DocumentProperties

Atribut: ContractVersionAttribute

Penerapan: IStorageItemExtraProperties

Persyaratan Windows

Rangkaian perangkat	Windows 10 (diperkenalkan dalam 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (diperkenalkan dalam v1.0)

Contoh

Contoh ini menunjukkan cara menggunakan kueri file yang didukung oleh indeks sistem untuk mengambil properti dokumen seperti Judul.

try
{
    // Create index backed file query and get results
    List<string> fileTypeFilter = new List<string>();
    fileTypeFilter.Add(".docx");
    QueryOptions queryOptions = new QueryOptions(Windows.Storage.Search.CommonFileQuery.OrderByName, fileTypeFilter);
    queryOptions.IndexerOption = IndexerOption.OnlyUseIndexer;
    StorageFileQueryResult queryResult = Windows.Storage.KnownFolders.DocumentsLibrary.CreateFileQueryWithOptions(queryOptions);
    var files = await queryResult.GetFilesAsync();

    // Process resulting files
    if (files.Count == 0)
    {
        // Perform tasks to handle no files found
    }
    else
    {
        // Access properties for each file
        foreach (StorageFile file in files)
        {
            var documentProperties = await file.Properties.GetDocumentPropertiesAsync();
            // Perform tasks with document properties
            String title = documentProperties.Title;
        }
    }
}
// Handle errors with catch blocks
catch (FileNotFoundException)
{
 // For example, handle a file not found error
}

Meskipun contoh menggunakan DocumentsLibrary untuk membuat kueri, Anda bisa membuat kueri seperti ini untuk folder apa pun yang dapat Anda akses sebagai StorageFolder.

Dalam contoh, file berisi StorageFile yang mewakili file untuk mengambil properti.

Keterangan

Anda dapat mengakses objek DocumentProperties secara asinkron menggunakan metode GetDocumentPropertiesAsync dari properti Properti item (seperti file folder), atau secara sinkron menggunakan properti DocumentProperties jika tersedia. Anda bisa mendapatkan objek DocumentProperties menggunakan salah satu metode dan properti berikut:

Properti FileInformation.documentProperties
Properti FolderInformation.documentProperties
Metode StorageItemContentProperties.getDocumentPropertiesAsync , yang dapat diakses menggunakan properti Properti , jika tersedia.

Catatan

Properti yang didapatkan atau diatur menggunakan handler properti yang ditentukan oleh aplikasi lain (seperti Microsoft Word) mungkin tidak dapat diakses. Sebagai gantinya, Anda bisa mencoba mendapatkan properti ini menggunakan kueri file yang didukung oleh indeks sistem. Untuk informasi selengkapnya, lihat QueryOptions.

Untuk sampel kode selengkapnya tentang mengakses properti, lihat Sampel akses file.

Properti

Author	Mendapatkan koleksi penulis dokumen.
Comment	Mendapatkan atau mengatur komentar yang terkait dengan dokumen.
Keywords	Mendapatkan kumpulan kata kunci yang terkait dengan dokumen.
Title	Mendapatkan atau mengatur judul dokumen.

Metode

RetrievePropertiesAsync(IIterable<String>)	Mengambil properti yang ditentukan yang terkait dengan item.
SavePropertiesAsync()	Menyimpan semua properti yang terkait dengan item.
SavePropertiesAsync(IIterable<KeyValuePair<String,Object>>)	Menyimpan properti dan nilai yang ditentukan yang terkait dengan item.

Berlaku untuk

Bagikan melalui