Como: Criar e modificar propriedades Personalizars de documentos

Se aplica a
As informações contidas neste tópico se aplicam apenas às especificado Ferramentas do Visual Studio para o Office projetos e as versões do Microsoft Office. Tipo de Projeto Projetos de nível de documento Versão do Microsoft Office Microsoft Office Sistema de 2007 Microsoft Office 2003 For more information, see Recursos disponíveis pelo aplicativo e o tipo de projeto.

O Microsoft Office Excel e Microsoft Office Word fornecem propriedades internas que são armazenadas com pastas de trabalho e documentos.Além disso, você pode criar e modificar propriedades personalizadas do documento se há informações adicionais que você deseja armazenar com o documento em uma personalização de nível de documento.

Use a propriedade de CustomDocumentProperties para trabalhar com propriedades Personalizars.Essa propriedade retorna um objeto de DocumentProperties , que é uma coleção de objetos de DocumentProperty.Você pode usar a propriedade de Item da coleção para recuperar uma propriedade específica, por nome ou por índice dentro da coleção.

O exemplo a seguir demonstra como adicionar uma propriedade Personalizar no Excel e Atribuir é um valor.

Exemplo

Sub TestProperties()
    Dim properties As Microsoft.Office.Core.DocumentProperties
    properties = CType(Me.CustomDocumentProperties, Office.DocumentProperties)

    If ReadDocumentProperty("Project Name") <> Nothing Then
        properties("Project Name").Delete()
    End If

    properties.Add("Project Name", False, _
        Microsoft.Office.Core.MsoDocProperties.msoPropertyTypeString, _
        "White Papers")
End Sub

Private Function ReadDocumentProperty(ByVal propertyName As String) As String
    Dim properties As Office.DocumentProperties
    properties = CType(Me.CustomDocumentProperties, Office.DocumentProperties)

    Dim prop As Office.DocumentProperty

    For Each prop In properties
        If prop.Name = propertyName Then
            Return prop.Value.ToString()
        End If
    Next

    Return Nothing
End Function

void TestProperties()
{
    Microsoft.Office.Core.DocumentProperties properties;
    properties = (Office.DocumentProperties)this.CustomDocumentProperties;

    if (ReadDocumentProperty("Project Name") != null)
    {
        properties["Project Name"].Delete();
    }

    properties.Add("Project Name", false,
        Microsoft.Office.Core.MsoDocProperties.msoPropertyTypeString,
        "White Papers", missing);
}

private string ReadDocumentProperty(string propertyName)
{
    Office.DocumentProperties properties;
    properties = (Office.DocumentProperties)this.CustomDocumentProperties;

    foreach (Office.DocumentProperty prop in properties)
    {
        if (prop.Name == propertyName)
        {
            return prop.Value.ToString();
        }
    }
    return null;
}

Programação robusta

Tentativa de acessar a propriedade Value para propriedades indefinidas gera uma exceção.

Consulte também

Tarefas

Como: Ler e gravar em propriedades do documento

Conceitos

Personalizações de nível de documento de programação