Compartir a través de

Document (Interfaz)

  • Artículo

Representa un documento que está abierto en el entorno para su edición.

Espacio de nombres:  EnvDTE
Ensamblado:  EnvDTE (en EnvDTE.dll)

Sintaxis

'Declaración
<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

El tipo Document expone los siguientes miembros.

Propiedades

  Nombre Descripción
Propiedad pública ActiveWindow Obtiene la ventana activa actual, o la ventana de nivel superior si no hay otras ventanas activas.Devuelve Nothing si no hay ventanas abiertas.
Propiedad pública Collection Obtiene la colección que contiene el objeto Document.
Propiedad pública DTE Obtiene el objeto de extensibilidad de nivel superior.
Propiedad pública Extender Devuelve el objeto Extender solicitado si está disponible para este objeto.
Propiedad pública ExtenderCATID Obtiene el identificador de categoría (CATID) Extender del objeto.
Propiedad pública ExtenderNames Obtiene una lista de los objetos Extender disponibles para el objeto.
Propiedad pública FullName Obtiene la ruta de acceso completa y el nombre de archivo del objeto.
Propiedad pública IndentSize Infraestructura. Sólo para uso interno de Microsoft.
Propiedad pública Kind Obtiene una cadena GUID que identifica la clase o el tipo de objeto.
Propiedad pública Language Infraestructura. Sólo para uso interno de Microsoft.
Propiedad pública Name Obtiene el nombre de Document.
Propiedad pública Path Obtiene la ruta de acceso, sin nombre de archivo, correspondiente al directorio que contiene el documento.
Propiedad pública ProjectItem Obtiene el objeto ProjectItem asociado al objeto Document.
Propiedad pública ReadOnly Infraestructura. Sólo para uso interno de Microsoft.
Propiedad pública Saved Devuelve true si el objeto no se ha modificado desde que se guardó o abrió por última vez.
Propiedad pública Selection Obtiene un objeto que representa la selección actual en el Document.
Propiedad pública TabSize Infraestructura. Sólo para uso interno de Microsoft.
Propiedad pública Type Infraestructura. Sólo para uso interno de Microsoft.
Propiedad pública Windows Obtiene una colección Windows que contiene las ventanas que se muestran en el objeto.

Arriba

Métodos

  Nombre Descripción
Método público Activate Desplaza el foco al elemento actual.
Método público ClearBookmarks Infraestructura. Sólo para uso interno de Microsoft.
Método público Close Cierra el documento abierto y, opcionalmente, lo guarda o cierra y destruye la ventana.
Método público MarkText Infraestructura. Sólo para uso interno de Microsoft.
Método público NewWindow Crea una ventana nueva en la que se puede ver el documento.
Método público Object Devuelve una interfaz u objeto a los que se puede tener acceso en tiempo de ejecución por su nombre.
Método público PrintOut Infraestructura. Sólo para uso interno de Microsoft.
Método público Redo Vuelve a ejecutar la última acción que deshizo el método Undo o el usuario.
Método público ReplaceText Infraestructura. Sólo para uso interno de Microsoft.
Método público Save Guarda el documento.
Método público Undo Anula la última acción ejecutada por el usuario en el documento.

Arriba

Comentarios

Un objeto Document representa cada uno de los diseñadores o documentos abiertos en el entorno; es decir, las ventanas que no son ventanas de herramientas y tienen un área para editar texto. El objeto Document tiene miembros (propiedades, métodos y eventos) que se pueden utilizar para manipular el documento. Si se trata de un archivo de texto editado por el editor de Visual Studio, también tendrá un objeto TextDocument asociado.

Se hace referencia a todos los documentos abiertos en la colección Documents. Se puede buscar un documento concreto mediante iteraciones a través de esta colección.

La propiedad predeterminada para un objeto Document es la propiedad Name.

Se hace referencia a este objeto mediante DTE.Documents.Item(...).

Ejemplos

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

Vea también

Referencia

EnvDTE (Espacio de nombres)