Document Interface

Definição

Representa um documento no ambiente aberto para edição.

public interface class Document
public interface class Document
__interface Document
[System.Runtime.InteropServices.Guid("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")]
[System.Runtime.InteropServices.TypeLibType(4160)]
public interface Document
[<System.Runtime.InteropServices.Guid("63EB5C39-CA8F-498E-9A66-6DD4A27AC95B")>]
[<System.Runtime.InteropServices.TypeLibType(4160)>]
type Document = interface
Public Interface Document
Atributos

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  

Comentários

Um Document objeto representa cada documento aberto ou designer no ambiente, ou seja, janelas que não são janelas de ferramentas e têm 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 for um arquivo de texto editado pelo editor do Visual Studio, ele também terá um TextDocument objeto associado a ele.

Todos os documentos abertos são referenciados na Documents coleção. Você pode encontrar um documento específico Iterando por meio desta coleção.

A propriedade padrão de um Document objeto é a Name propriedade.

Referencie esse objeto usando DTE.Documents.Item(...) .

Propriedades

ActiveWindow

Obtém a janela ativa no momento ou a janela superior se nenhuma outra estiver ativa. Retorna Nothing se nenhuma janela do Windows estiver aberta.

Collection

Obtém a coleção que contém o Document objeto.

DTE

Obtém o objeto de extensibilidade de nível superior.

Extender[String]

Retorna o extensor solicitado se ele estiver disponível para esse objeto.

ExtenderCATID

Obtém o ID da categoria do extensor (CATID) para o objeto.

ExtenderNames

Obtém uma lista de extensores disponíveis para o objeto.

FullName

Obtém o caminho completo e o nome do arquivo do objeto.

IndentSize

Somente para uso interno da Microsoft.

Kind

Obtém uma cadeia de caracteres GUID que indica o tipo ou tipo do objeto.

Language

Somente para uso interno da Microsoft.

Name

Obtém o nome do Document.

Path

Obtém o caminho, sem o nome do arquivo, para o diretório que contém o documento.

ProjectItem

Obtém o objeto ProjectItem associado ao objeto Document.

ReadOnly

Somente para uso interno da Microsoft.

Saved

Retorna true se o objeto não foi modificado desde a última vez que foi salvo ou aberto.

Selection

Obtém um objeto que representa a seleção atual no Document .

TabSize

Somente para uso interno da Microsoft.

Type

Somente para uso interno da Microsoft.

Windows

Obtém uma Windows coleção que contém as janelas que são exibidas no objeto.

Métodos

Activate()

Move o foco para o item atual.

ClearBookmarks()

Somente para uso interno da Microsoft.

Close(vsSaveChanges)

Fecha o documento aberto e, opcionalmente, salva-o ou fecha e destrói a janela.

MarkText(String, Int32)

Somente para uso interno da Microsoft.

NewWindow()

Cria uma nova janela na qual exibir o documento.

Object(String)

Retorna uma interface ou um objeto que pode ser acessado em tempo de execução por nome.

PrintOut()

Somente para uso interno da Microsoft.

Redo()

Executa novamente a última ação que foi desfeita pelo Undo() método ou pelo usuário.

ReplaceText(String, String, Int32)

Somente para uso interno da Microsoft.

Save(String)

Salva o documento.

Undo()

Reverte a ação executada pela última vez pelo usuário no documento.

Aplica-se a