Partager via

DocumentTask, classe

  • Article

Représente un élément pour un service de langage dans la fenêtre de Options de liste d'erreurs.

Cette API n'est pas conforme CLS. 

Hiérarchie d'héritage

System.Object
  Microsoft.VisualStudio.Shell.Task
    Microsoft.VisualStudio.Shell.ErrorTask
      Microsoft.VisualStudio.Package.DocumentTask

Espace de noms :  Microsoft.VisualStudio.Package
Assemblys :   Microsoft.VisualStudio.Package.LanguageService.11.0 (dans Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (dans Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (dans Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (dans Microsoft.VisualStudio.Package.LanguageService.10.0.dll)

Syntaxe

'Déclaration
<CLSCompliantAttribute(False)> _
<ComVisibleAttribute(True)> _
Public Class DocumentTask _
    Inherits ErrorTask _
    Implements IVsTextMarkerClient, IDisposable

[CLSCompliantAttribute(false)]
[ComVisibleAttribute(true)]
public class DocumentTask : ErrorTask, 
    IVsTextMarkerClient, IDisposable

Le type DocumentTask expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique DocumentTask Initialise une nouvelle instance d'DocumentTask pour la mémoire tampon de texte, l'étendue de texte, et le nom de fichier spécifiés.

Début

Propriétés

  Nom Description
Propriété publique CanDelete Obtient ou définit si la tâche peut être supprimée. (Hérité de Task.)
Propriété publique Category Obtient ou définit la catégorie de la tâche. (Hérité de Task.)
Propriété publique Checked Obtient ou définit pas si la case à cocher de la tâche n'est actuellement sélectionnée ou est désactivée. (Hérité de Task.)
Propriété publique Column Obtient ou définit le numéro de colonne dans le fichier associé à la tâche. (Hérité de Task.)
Propriété publique Document Obtient ou définit le fichier associé à la tâche. (Hérité de Task.)
Propriété publique ErrorCategory Obtient ou définit la catégorie d'erreur de cette tâche. (Hérité de ErrorTask.)
Propriété publique HelpKeyword Obtient ou définit le mot clé d'aide associé à la tâche. (Hérité de Task.)
Propriété publique HierarchyItem Obtient ou définit l'élément de hiérarchie associé à cette tâche. (Hérité de ErrorTask.)
Propriété publique ImageIndex Obtient ou définit l'index de l'image associée à la tâche. (Hérité de Task.)
Propriété publique IsCheckedEditable Obtient ou définit s'il est possible de modifier l'état activé de la tâche. (Hérité de Task.)
Propriété publique IsMarkerValid Obtient une valeur indiquant si la marque a été définie à valide.
Propriété publique IsPriorityEditable Obtient ou définit s'il est possible de modifier la priorité d'une tâche. (Hérité de Task.)
Propriété publique IsTextEditable Obtient ou définit s'il est possible de modifier la description d'une tâche. (Hérité de Task.)
Propriété publique Line Obtient ou définit le numéro de ligne du fichier associé à la tâche. (Hérité de Task.)
Propriété publique Priority Obtient ou définit la priorité d'une tâche. (Hérité de Task.)
Propriété publique Site Obtient le fournisseur de services.
Propriété publique Span Obtient l'étendue où l'erreur s'est produite.
Propriété publique SubcategoryIndex Obtient ou définit l'index du sous-catégorie de la tâche. (Hérité de Task.)
Propriété publique Text Obtient ou définit la description d'une tâche. (Hérité de Task.)
Propriété publique TextLineMarker Retourne l'objet de marque de ligne de texte qui décrit l'emplacement de l'erreur.

Début

Méthodes

  Nom Description
Méthode publique Dispose() Récupère des ressources juste avant que l'objet d'DocumentTask soit détruit.
Méthode protégée Dispose(Boolean) Récupère des ressources juste avant que l'objet d'DocumentTask soit détruit.
Méthode publique Equals Détermine si l'objet Object spécifié est égal à l'objet Object actuel. (Hérité de Object.)
Méthode publique ExecMarkerCommand Exécute une commande sur une marque spécifique dans la mémoire tampon de texte.
Méthode protégée Finalize Récupère des ressources juste avant que l'objet d'DocumentTask soit détruit. (Substitue Object.Finalize().)
Méthode publique GetHashCode Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
Méthode publique GetMarkerCommandInfo Interroge la marque pour les informations de commande.
Méthode publique GetTipText Obtient le texte de conseil pour le marqueur de texte qui est affiché lorsque la souris pointe sur de la marque.
Méthode publique GetType Obtient le Type de l'instance actuelle. (Hérité de Object.)
Méthode publique GetUserContext Crée un nouveau contexte d'utilisateur. (Hérité de Task.)
Méthode publique MarkerInvalidated Appelé lorsque le texte qui est associé à une marque est supprimé par une action utilisateur.
Méthode protégée MemberwiseClone Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
Méthode publique OnAfterMarkerChange Signaux que la position de marque a changé.
Méthode publique OnAfterSpanReload Des signaux que le texte sous la marque a été modifié mais la marque n'a pas été supprimés.
Méthode publique OnBeforeBufferClose Envoie la notification que la mémoire tampon de texte est sur le point de se fermer.
Méthode publique OnBufferSave Appelé lorsque la mémoire tampon a été enregistrée.
Méthode protégée OnDeleted Déclenché lorsque la tâche a été supprimée. (Hérité de Task.)
Méthode protégée OnHelp Déclenché lorsque les demandes de l'utilisateur aident ; par exemple en cliquant avec le bouton droit et en sélectionnant Afficher l'aide sur l'erreur. (Hérité de Task.)
Méthode protégée OnNavigate Charge le document qui est associé à l'erreur et accède à l'emplacement de l'erreur. (Substitue Task.OnNavigate(EventArgs).)
Méthode protégée OnRemoved Appelé lorsque cet objet d'DocumentTask est supprimé de la fenêtre de Options de liste d'erreurs. (Substitue Task.OnRemoved(EventArgs).)
Méthode publique ToString Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)

Début

Événements

  Nom Description
Événement public Deleted Gère des événements OnDeleted. (Hérité de Task.)
Événement public Help Gère des événements OnHelp. (Hérité de Task.)
Événement public Navigate Gère des événements OnNavigate. (Hérité de Task.)
Événement public Removed Gère des événements OnRemoved. (Hérité de Task.)

Début

Implémentations d'interface explicite

  Nom Description
Implémentation d'interface expliciteMéthode privée IVsErrorItem.GetCategory Obtient la catégorie de l'erreur. (Hérité de ErrorTask.)
Implémentation d'interface expliciteMéthode privée IVsErrorItem.GetHierarchy Obtient le nœud de la hiérarchie associé à la tâche. (Hérité de ErrorTask.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.CanDelete Obtient une valeur indiquant s'il est possible de supprimer la tâche. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.Category Définit la catégorie de tâche. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.Column Obtient le numéro de colonne du fichier associé à la tâche. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.Document Obtient le nom du fichier associé à la tâche. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.get_Checked Détermine si la case à cocher de la tâche est actuellement sélectionnée ou désactivée. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.get_Priority Obtient la priorité de la tâche. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.get_Text Obtient la description de la tâche. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.HasHelp Détermine si la tâche a associé l'aide. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.ImageListIndex Obtient l'index de l'image associée à la tâche. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.IsReadOnly Détermine si le champ spécifié de tâche est en lecture seule. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.Line Obtient le numéro de ligne du fichier associé à la tâche. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.NavigateTo Ouvre un fichier associé avec une tâche et déplace à la position appropriée dans le fichier. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.NavigateToHelp Ouvre la ressource d'aide associée à une tâche. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.OnDeleteTask Déclenché lorsqu'une tâche a été supprimée. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.OnFilterTask Déclenché lorsqu'une tâche a été filtrée dans ou hors d'une vue. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.put_Checked Définit si la case à cocher d'une tâche est sélectionnée ou désactivée. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.put_Priority Définit le niveau de priorité d'une tâche. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.put_Text Définit la description de la tâche. (Hérité de Task.)
Implémentation d'interface expliciteMéthode privée IVsTaskItem.SubcategoryIndex Obtient l'index de la tâche dans la liste de sous-catégorie. (Hérité de Task.)

Début

Remarques

Cette classe est une version spécialisée de la classe d'ErrorTask et représente un élément qui signale un problème dans l'analyse du fichier source actuel.En outre, elle prend en charge la fonctionnalité d'accéder à la ligne qui a provoqué l'erreur.Cette classe substitue les classes de base d'ErrorTask et d'Task et crée un objet d'IVsTextLineMarker qui gère une étendue dans une mémoire tampon et fournit la navigation personnalisée à la source de l'erreur.

Remarques à l'attention des implémenteurs

Cette classe contient toute la fonctionnalité qui est requise pour gérer un élément dans la fenêtre de Options de liste d'erreurs.Vous pouvez dériver de cette classe aux comportements d'ordre de marque de modification.Au delà de cela, vous ne devez pas dériver de cette classe.

Remarques à l'attention des appelants

Une instance de cette classe est créée dans la méthode d'CreateErrorTaskItem dans la classe d'Source.La classe d'Source utilise la classe d'DocumentTask pour montrer tous les avertissements et les erreurs qui sont produites par l'analyseur de service de langage.En général, la classe d'Source gère toutes les instances de la classe d'DocumentTask en interne.

Sécurité des threads

Tous les membres static (Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.

Voir aussi

Référence

Microsoft.VisualStudio.Package, espace de noms