Compartir a través de

DocumentProperties Clase

  • Referencia

Definición

Espacio de nombres:
Windows.Storage.FileProperties
Editar

Proporciona acceso a las propiedades relacionadas con el documento de un elemento (como un archivo o carpeta).

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
Herencia
Object Platform::Object IInspectable DocumentProperties
Atributos
ContractVersionAttribute
Implementaciones
IStorageItemExtraProperties

Requisitos de Windows

Familia de dispositivos
Windows 10 (se introdujo en la versión 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (se introdujo en la versión v1.0)

Ejemplos

En este ejemplo se muestra cómo usar una consulta de archivo respaldada por el índice del sistema para recuperar propiedades 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
}

Aunque en el ejemplo se usa DocumentsLibrary para crear la consulta, puede crear una consulta como esta para cualquier carpeta a la que tenga acceso que puede obtener como storageFolder.

En el ejemplo, file contiene un storageFile que representa el archivo para el que se van a recuperar las propiedades.

Comentarios

Puede obtener acceso a un objeto DocumentProperties de forma asincrónica mediante el método GetDocumentPropertiesAsync desde la propiedad Properties de un elemento (como un archivo de carpeta) o mediante la propiedad DocumentProperties de forma sincrónica si está disponible. Puede obtener un objeto DocumentProperties mediante cualquiera de los métodos y propiedades siguientes:

Nota:

Es posible que no se pueda acceder a las propiedades que se obtienen o establecen mediante un controlador de propiedades definido por otra aplicación (como Microsoft Word). En su lugar, puede intentar obtener estas propiedades mediante una consulta de archivo respaldada por el índice del sistema. Para obtener más información, vea QueryOptions.

Para obtener más ejemplos de código sobre el acceso a propiedades, consulte el ejemplo de acceso a archivos.

Propiedades

Author

Obtiene la colección de autores del documento.
Comment

Obtiene o establece los comentarios asociados al documento.
Keywords

Obtiene la colección de palabras clave asociadas al documento.
Title

Obtiene o establece el título del documento.

Métodos

RetrievePropertiesAsync(IIterable<String>)

Recupera las propiedades especificadas asociadas al elemento.
SavePropertiesAsync()

Guarda todas las propiedades asociadas al elemento.
SavePropertiesAsync(IIterable<KeyValuePair<String,Object>>)

Guarda las propiedades y valores especificados asociados al elemento.

Se aplica a

Consulte también