Partager via


Document, interface

Représente un document dans l'environnement ouvert pour la modification.

Espace de noms :  EnvDTE
Assembly :  EnvDTE (dans EnvDTE.dll)

Syntaxe

'Déclaration
<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

Le type Document expose les membres suivants.

Propriétés

  Nom Description
Propriété publique ActiveWindow Obtient la fenêtre actuellement active ou la fenêtre située au premier plan si aucune autre fenêtre n'est active.Retourne Nothing si aucune fenêtre n'est ouverte.
Propriété publique Collection Obtient la collection contenant l'objet Document.
Propriété publique DTE Obtient l'objet d'extensibilité de niveau supérieur.
Propriété publique Extender Retourne l'objet Extender demandé s'il est disponible pour cet objet.
Propriété publique ExtenderCATID Obtient l'identificateur de catégorie d'extendeur (CATID) de l'objet.
Propriété publique ExtenderNames Obtient la liste des extendeurs disponibles pour l'objet.
Propriété publique FullName Obtient le chemin d'accès complet et le nom du fichier de l'objet.
Propriété publique IndentSize Infrastructure. Réservé à un usage interne Microsoft.
Propriété publique Kind Obtient une chaîne GUID indiquant le genre ou le type de l'objet.
Propriété publique Language Infrastructure. Réservé à un usage interne Microsoft.
Propriété publique Name Obtient le nom de Document.
Propriété publique Path Obtient le chemin d'accès, sans le nom de fichier, du répertoire contenant le document.
Propriété publique ProjectItem Obtient l'objet ProjectItem associé à l'objet Document.
Propriété publique ReadOnly Infrastructure. Réservé à un usage interne Microsoft.
Propriété publique Saved Retourne la valeur true si l'objet n'a pas été modifié depuis son dernier enregistrement ou sa dernière ouverture.
Propriété publique Selection Obtient un objet représentant la sélection actuelle sur l'objet Document.
Propriété publique TabSize Infrastructure. Réservé à un usage interne Microsoft.
Propriété publique Type Infrastructure. Réservé à un usage interne Microsoft.
Propriété publique Windows Obtient une collection Windows contenant les fenêtres qui s'affichent dans l'objet.

Début

Méthodes

  Nom Description
Méthode publique Activate Place le focus sur l'élément actuel.
Méthode publique ClearBookmarks Infrastructure. Réservé à un usage interne Microsoft.
Méthode publique Close Ferme le document ouvert et l'enregistre éventuellement, ou ferme et détruit la fenêtre.
Méthode publique MarkText Infrastructure. Réservé à un usage interne Microsoft.
Méthode publique NewWindow Crée une nouvelle fenêtre dans laquelle afficher le document.
Méthode publique Object Retourne une interface ou un objet accessible par son nom au moment de l'exécution.
Méthode publique PrintOut Infrastructure. Réservé à un usage interne Microsoft.
Méthode publique Redo Réexécute la dernière action annulée à l'aide de la méthode Undo ou par l'utilisateur.
Méthode publique ReplaceText Infrastructure. Réservé à un usage interne Microsoft.
Méthode publique Save Enregistre le document.
Méthode publique Undo Annule la dernière action effectuée par l'utilisateur dans le document.

Début

Notes

Un objet Document représente chaque document ou concepteur ouvert dans l'environnement, c'est-à-dire les fenêtres qui ne sont pas des fenêtres Outil et qui disposent d'une zone pour modifier le texte. L'objet Document dispose de membres (propriétés, méthodes et événements) que vous pouvez utiliser pour manipuler le document. S'il s'agit d'un fichier texte modifié par l'éditeur Visual Studio, un objet TextDocument lui est également associé.

Tous les documents ouverts sont référencés dans la collection Documents. Vous pouvez trouver un document particulier en itérant au sein de cette collection.

La propriété par défaut pour un objet Document est la propriété Name.

Référencez cet objet à l'aide de DTE.Documents.Item(...).

Exemples

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

Voir aussi

Référence

EnvDTE, espace de noms