Interface Document

  • Artigo

Representa um documento do ambiente abrir para edição.

Namespace:  EnvDTE
Assembly:  EnvDTE (em EnvDTE.dll)

Sintaxe

'Declaração
<GuidAttribute("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")> _
Public Interface Document

[GuidAttribute("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")]
public interface Document

[GuidAttribute(L"63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")]
public interface class Document

[<GuidAttribute("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")>]
type Document =  interface end

public interface Document

O tipo Document expõe os membros a seguir.

Propriedades

  Nome Descrição
Propriedade pública ActiveWindow Obtém a janela ativa no momento ou a janela superior se não há outras pessoas estiverem ativas.Retorna Nothing se não há janelas estiverem abertas.
Propriedade pública Collection Obtém a coleção que contém o Document objeto.
Propriedade pública DTE Obtém o objeto de extensibilidade de nível superior.
Propriedade pública Extender Retorna o extensor solicitado se estiver disponível para este objeto.
Propriedade pública ExtenderCATID Obtém a categoria de extensor ID CATID () para o objeto.
Propriedade pública ExtenderNames Obtém uma lista de extensores disponíveis para o objeto.
Propriedade pública FullName Obtém o caminho completo e o nome do arquivo do objeto.
Propriedade pública IndentSize Infraestrutura. Somente para uso interno da Microsoft.
Propriedade pública Kind Obtém uma seqüência de caracteres GUID indicando a espécie ou o tipo do objeto.
Propriedade pública Language Infraestrutura. Somente para uso interno da Microsoft.
Propriedade pública Name Obtém o nome da Document.
Propriedade pública Path Obtém o caminho, sem o nome do arquivo, para o diretório que contém o documento.
Propriedade pública ProjectItem Obtém o ProjectItem objeto associado com o Document objeto.
Propriedade pública ReadOnly Infraestrutura. Somente para uso interno da Microsoft.
Propriedade pública Saved Retorna true se o objeto não foi modificado desde o último sendo salvo ou aberto.
Propriedade pública Selection Obtém um objeto que representa a seleção atual sobre o Document.
Propriedade pública TabSize Infraestrutura. Somente para uso interno da Microsoft.
Propriedade pública Type Infraestrutura. Somente para uso interno da Microsoft.
Propriedade pública Windows Obtém um Windows que contém as janelas que exibem no objeto de coleção.

Superior

Métodos

  Nome Descrição
Método público Activate Move o foco para o item atual.
Método público ClearBookmarks Infraestrutura. Somente para uso interno da Microsoft.
Método público Close Fecha o documento aberto e, opcionalmente, salva-lo, ou fecha e destrói a janela.
Método público MarkText Infraestrutura. Somente para uso interno da Microsoft.
Método público NewWindow Cria uma nova janela na qual deseja exibir o documento.
Método público Object Retorna uma interface ou objeto que pode ser acessado no tempo de execução por nome.
Método público PrintOut Infraestrutura. Somente para uso interno da Microsoft.
Método público Redo Executa a última ação foi desfeita pela Undo método ou o usuário.
Método público ReplaceText Infraestrutura. Somente para uso interno da Microsoft.
Método público Save Salva o documento.
Método público Undo Reverte a última ação executada pelo usuário no documento.

Superior

Comentários

A Document objeto representa cada documento aberto ou designer no ambiente — ou seja, as janelas que não são janelas de ferramentas e tem uma área para editar o texto.O Document objeto tem membros (Propriedades, métodos e eventos) que você pode usar para manipular o documento.Se ele é um arquivo de texto editado pelo editor de Visual Studio, então ele também tem um TextDocument objeto associado a ele.

Todos os documentos abertos são referenciados na Documents coleção.Você pode encontrar um determinado documento, iterando através esta coleção.

A propriedade padrão para um Document o objeto é o Name propriedade.

Este objeto de referência usando DTE.Documents.Item(...).

Exemplos

Sub DocumentExample()
    Dim doc As Document
    Dim desc As String

    Set doc = DTE.ActiveDocument
    desc = "You are editing a "
    If (doc.ReadOnly) Then
        desc = desc & "read-only"
    Else
        desc = desc & "writable"
    End If
    desc = desc & " document called " & doc.Name & " located at " & doc.Path
    MsgBox desc
End Sub

Consulte também

Referência

Namespace EnvDTE