Compartilhar via


Ler e gravar nas propriedades do documento

Você pode armazenar propriedades de documento junto com um documento. Os aplicativos do Office fornecem várias propriedades internas, como autor, título e assunto. Este tópico mostra como definir propriedades de documento no Microsoft Office Excel e no Microsoft Office Word.

Aplica-se a: As informações neste tópico se aplicam a projetos de nível de documento e projetos de suplemento VSTO para os seguintes aplicativos: Excel; PowerPoint; Projeto; Palavra. Para obter mais informações, consulte Recursos disponíveis por aplicativo e tipo de projeto do Office.

Definir propriedades do documento no Excel

Para trabalhar com propriedades internas no Excel, use as seguintes propriedades:

  • Em um projeto de nível de documento, use a BuiltinDocumentProperties ThisWorkbook propriedade da classe.

  • Em um projeto de suplemento VSTO, use a BuiltinDocumentProperties propriedade de um Workbook objeto.

    Essas propriedades retornam um DocumentProperties objeto, que é uma coleção de DocumentProperty objetos. Você pode usar a Item propriedade da coleção para recuperar uma propriedade específica, por nome ou por índice dentro da coleção.

    O exemplo de código a seguir mostra como alterar a propriedade interna Revision Number em um projeto de nível de documento.

Para alterar a propriedade Número da Revisão no Excel

  1. Atribua as propriedades internas do documento a uma variável.

    Microsoft.Office.Core.DocumentProperties properties;
    
    properties = (Microsoft.Office.Core.DocumentProperties)
        Globals.ThisWorkbook.BuiltinDocumentProperties; 
    
    Microsoft.Office.Core.DocumentProperty prop;
    prop = properties["Revision Number"];
    
  2. Incremente a Revision Number propriedade em um.

    if (prop.Value == null)
    {
        prop.Value = 1;
    }
    else
    {
        int revision;
        if (int.TryParse((string)prop.Value, out revision))
        {
            prop.Value = revision + 1;
            MessageBox.Show("Revision Number = " + revision);
        }
        else
        {
            MessageBox.Show("Revision Number = invalid value");
        }
    }
    

Definir propriedades do documento no Word

Para trabalhar com propriedades internas no Word, use as seguintes propriedades:

  • Em um projeto de nível de documento, use a BuiltInDocumentProperties ThisDocument propriedade da classe.

  • Em um projeto de suplemento VSTO, use a BuiltInDocumentProperties propriedade de um Document objeto.

    Essas propriedades retornam um DocumentProperties objeto, que é uma coleção de DocumentProperty objetos. Você pode usar a Item propriedade da coleção para recuperar uma propriedade específica, por nome ou por índice dentro da coleção.

    O exemplo de código a seguir mostra como alterar a propriedade interna Subject em um projeto de nível de documento.

Para alterar a propriedade Subject

  1. Atribua as propriedades internas do documento a uma variável.

    Microsoft.Office.Core.DocumentProperties properties;
    
    properties = (Microsoft.Office.Core.DocumentProperties)
        Globals.ThisDocument.BuiltInDocumentProperties;
    
  2. Altere a Subject propriedade para "Whitepaper".

    // Set the Subject property. 
    properties["Subject"].Value = "Whitepaper";
    

Programação robusta

Os exemplos pressupõem que você tenha escrito o código na ThisWorkbook classe em um projeto de nível de documento para Excel e a ThisDocument classe em um projeto de nível de documento para Word.

Embora você esteja trabalhando com o Word e o Excel e seus objetos, o Microsoft Office fornece a lista de propriedades de documento internas disponíveis. A tentativa de acessar uma propriedade indefinida gera uma exceção.