DocumentProperties Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Fornece acesso às propriedades relacionadas ao documento de um item (como um arquivo ou pasta).
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 DocumentPropertiesPublic NotInheritable Class DocumentProperties- Herança
- Atributos
- Implementações
Requisitos do Windows
| Família de dispositivos |
Windows 10 (introduzida na 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduzida na v1.0)
|
Exemplos
Este exemplo demonstra como usar uma consulta de arquivo que é apoiada pelo índice do sistema para recuperar propriedades de documento como Title.
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
}
Embora o exemplo use a DocumentsLibrary para criar a consulta, você pode criar uma consulta como esta para qualquer pasta à qual você tenha acesso que possa obter como uma StorageFolder.
No exemplo, file contém um StorageFile que representa o arquivo para o qual recuperar as propriedades.
Comentários
Você pode acessar um objeto DocumentProperties de forma assíncrona usando o método GetDocumentPropertiesAsync da propriedade Properties de um item (como um arquivo de pasta) ou de forma síncrona usando a propriedade DocumentProperties se ela estiver disponível. Você pode obter um objeto DocumentProperties usando qualquer um dos seguintes métodos e propriedades:
- Propriedade FileInformation.documentProperties
- Propriedade FolderInformation.documentProperties
- Método StorageItemContentProperties.getDocumentPropertiesAsync , que pode ser acessado usando a propriedade Properties , se estiver disponível.
Observação
As propriedades que são get ou set usando um manipulador de propriedades definido por outro aplicativo (como o Microsoft Word) podem não estar acessíveis. Em vez disso, você pode tentar obter essas propriedades usando uma consulta de arquivo que é apoiada pelo índice do sistema. Para obter mais informações, consulte QueryOptions.
Para obter mais exemplos de código sobre como acessar propriedades, consulte o Exemplo de acesso a arquivos.
Propriedades
| Author |
Obtém a coleção dos autores do documento. |
| Comment |
Obtém ou define os comentários associados ao documento. |
| Keywords |
Obtém a coleção de palavras-chave associadas ao documento. |
| Title |
Obtém ou define o título do documento. |
Métodos
| RetrievePropertiesAsync(IIterable<String>) |
Recupera as propriedades especificadas associadas ao item. |
| SavePropertiesAsync() |
Salva todas as propriedades associadas ao item. |
| SavePropertiesAsync(IIterable<KeyValuePair<String,Object>>) |
Salva as propriedades e os valores especificados associados ao item. |