Trabalhar com propriedades do documento

As propriedades do documento permitem armazenar algumas informações úteis sobre o seu documento. Essas propriedades podem ser divididas em dois grupos:

  • Sistema ou integrado que contém valores como título do documento, nome do autor, estatísticas do documento e outros.
  • Definido pelo usuário ou personalizado, fornecido como pares nome-valor onde o usuário pode definir o nome e o valor.

É útil saber que as informações sobre API e número de versão são gravadas diretamente nos documentos de saída. Por exemplo, ao converter um documento para PDF, o Aspose.Words preenche o campo “Aplicativo” com “Aspose.Words”, e o campo “PDF Producer” com “Aspose.Words para .NET YY.MN”, onde YY.M.N é a versão do Aspose.Words utilizada para conversão. Para obter mais detalhes, consulte Nome do Gerador ou Produtor Incluído nos Documentos de Saída.

Acessar propriedades do documento

Para acessar as propriedades do documento em Aspose.Words, use:

built_in_document_properties e custom_document_properties são coleções de objetos DocumentProperty. Esses objetos podem ser obtidos através da propriedade do indexador por nome ou por índice.

Além disso, built_in_document_properties fornece acesso às propriedades do documento por meio de um conjunto de propriedades inseridas que retornam valores do tipo apropriado. custom_document_properties permite adicionar ou remover propriedades de um documento.

A classe DocumentProperty permite obter o nome, valor e tipo de propriedade de um documento. value retorna um objeto, mas há um conjunto de métodos que permitem converter o valor da propriedade em um tipo específico. Depois de saber qual é o tipo da propriedade, você pode usar um dos métodos DocumentProperty.to_XXX, como PropriedadeDoDocumento.__str__ e DocumentProperty.to_int, para obter o valor do tipo apropriado.

O exemplo de código a seguir mostra como enumerar todas as propriedades internas e personalizadas em um documento:

No Microsoft Word, você pode acessar as propriedades do documento usando o menu “Arquivo → Propriedades”.

trabalhar com propriedades do documento-1.png

Adicionar ou remover propriedades do documento

Você não pode adicionar ou remover propriedades internas do documento usando Aspose.Words. Você só pode alterar ou atualizar seus valores.

Para adicionar propriedades personalizadas do documento com Aspose.Words, utilize o método add, passando o nome da nova propriedade e o valor do tipo apropriado. O método retorna o objeto DocumentProperty recém-criado.

Para remover propriedades customizadas, utilize o método remove, passando o nome da propriedade a ser removida, ou o método remove_at para remover a propriedade por índice. Você também pode remover todas as propriedades usando o método clear.

O exemplo de código a seguir verifica se uma propriedade personalizada com um determinado nome existe em um documento e adiciona mais algumas propriedades personalizadas do documento:

O exemplo de código a seguir mostra como remover uma propriedade de documento personalizada:

Atualizar propriedades integradas do documento

Aspose.Words não atualiza automaticamente as propriedades do documento, como o Microsoft Word faz com algumas propriedades, mas fornece um método para atualizar algumas propriedades estatísticas internas do documento. Chame o método update_word_count para recalcular e atualizar as seguintes propriedades:

Crie uma nova propriedade personalizada vinculada ao conteúdo

Aspose.Words fornece o método add_link_to_content para criar uma nova propriedade de documento personalizada vinculada ao conteúdo. Esta propriedade retorna o objeto de propriedade recém-criado ou nulo se o link_source for inválido.

O exemplo de código a seguir mostra como configurar um link para uma propriedade customizada:

Obtenha variáveis de documento

Você pode obter uma coleção de variáveis de documento usando a propriedade variables. Nomes e valores de variáveis são strings.

O exemplo de código a seguir mostra como adicionar e acessar variáveis de documento:

Remover informações pessoais do documento

Se quiser compartilhar um documento do Word com outras pessoas, você pode remover informações pessoais, como nome do autor e empresa. Para fazer isso, use a propriedade remove_personal_information para definir o sinalizador que indica que o Microsoft Word removerá todas as informações do usuário dos comentários, revisões e propriedades do documento ao salvar o documento.

O exemplo de código a seguir mostra como remover informações pessoais:

Converter entre unidades de medida