Partager via

Source, classe

  • Article

Représente un fichier source dans le service de langage et contrôle des opérations d'analyse sur cette source.

Cette API n'est pas conforme CLS. 

Hiérarchie d'héritage

System.Object
  Microsoft.VisualStudio.Package.Source

Espace de noms :  Microsoft.VisualStudio.Package
Assemblys :   Microsoft.VisualStudio.Package.LanguageService.10.0 (dans Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (dans Microsoft.VisualStudio.Package.LanguageService.dll)
  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)

Syntaxe

'Déclaration
<CLSCompliantAttribute(False)> _
Public Class Source _
    Implements IDisposable, IVsTextLinesEvents, IVsHiddenTextClient, IVsUserDataEvents

[CLSCompliantAttribute(false)]
public class Source : IDisposable, IVsTextLinesEvents, 
    IVsHiddenTextClient, IVsUserDataEvents

Le type Source expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique Source Initialise une nouvelle instance de la classe Source.

Début

Propriétés

  Nom Description
Propriété publique ChangeCount Obtient le nombre de modifications apportées au fichier source comme il a été ouvert.
Propriété publique ColorState Obtient ou définit l'objet d'IVsTextColorState qui est utilisé dans différentes tâches d'analyse.
Propriété publique CompletedFirstParse Obtient une valeur indiquant si l'analyseur s'est achevé au moins une fois.
Propriété publique CompletionSet Obtient la collection d'CompletionSet utilisée pour cette instance de la classe d'Source.
Propriété publique DirtySpan Obtient une plage qui identifie les lignes modifiées dans la source.
Propriété protégée HandlesSnapshots
Propriété publique IsClosed Obtient l'état actuel du fichier source.
Propriété publique IsCompletorActive Obtient une valeur indiquant si les modes membres de conseil d'achèvement ou de méthode d'Intellisense sont actives.
Propriété publique IsDirty Obtient ou définit si les lignes l'une des de source ont changé.
Propriété publique LanguageService Obtient le service de langage associé avec le fichier source.
Propriété publique LastParseTime Obtient la durée de la dernière opération d'analyse.
Propriété publique OutliningEnabled Obtient ou définit si le mode plan est actuellement activé.

Début

Méthodes

  Nom Description
Méthode publique BeginParse() Commence une opération d'analyse complète au premier plan ou d'arrière-plan.
Méthode publique BeginParse(Int32, Int32, TokenInfo, ParseReason, IVsTextView, ParseResultHandler) Commence une opération d'analyse avec le jeton donné, affichage de texte, et analyse le gestionnaire de demande.
Méthode publique Close Détermine si le fichier source peut être fermé.
Méthode publique ColumnToVisiblePosition Obtient la position de la colonne d'écran correspondant à l'offset spécifié de personnage, en fonction de la taille des tabulations.
Méthode publique CommentBlock Commente une étendue de source à l'aide de commentaires de bloc.
Méthode publique CommentLines Commente une étendue de source à l'aide de commentaires de ligne.
Méthode publique CommentSpan Commente l'étendue spécifiée de la source.
Méthode publique Completion Commence une opération membre d'achèvement d'Intellisense.
Méthode publique CreateAuthoringSink Crée une instance d'un objet d'AuthoringSink pour une utilisation dans des opérations d'analyse.
Méthode publique CreateCompletionSet Crée une instance d'une classe CompletionSet.
Méthode publique CreateErrorTaskItem(TextSpan, MARKERTYPE, String) Crée une nouvelle tâche d'erreur pour Liste d'erreurs, pour le texte, le type de marqueur, et le nom de fichier fournis.
Méthode publique CreateErrorTaskItem(TextSpan, String, String, TaskPriority, TaskCategory, MARKERTYPE, TaskErrorCategory) Crée une nouvelle tâche d'erreur pour Liste d'erreurs, pour le texte, le nom de fichier, le message, la priorité, la catégorie, le type de marqueur, et le type d'erreur fournis.
Méthode publique CreateMethodData Crée une nouvelle instance d'un objet d'MethodData qui gère le mode de conseil de méthode d'Intellisense.
Méthode publique DismissCompletor Supprime le conseil ou la liste de saisie semi-automatique de méthode d'Intellisense de la vue, celle qui était actif.
Méthode publique Dispose Appelé en vue de détruire cet objet d'Source.
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 la commande spécifiée sur la zone spécifiée.
Méthode protégée Finalize Le destructeur de classe, appelé juste avant l'objet est détruit. (Substitue Object.Finalize().)
Méthode publique GetColorizer Obtient le coloriseur associé à cet objet d'Source.
Méthode publique GetCommentFormat Obtient les informations sur ce qui définit un commentaire dans le langage.
Méthode publique GetDocumentSpan Obtient l'étendue occupée par le fichier source entier.
Méthode publique GetExpansionProvider Obtient un fournisseur de l'à expansion appui des extraits de code.
Méthode publique GetFilePath Obtient le nom de fichier du fichier source.
Méthode publique GetHashCode Sert de fonction de hachage pour un type particulier. (Hérité de Object.)
Méthode publique GetHiddenTextSession Obtient le gestionnaire masqué de zone si disponible.
Méthode publique GetLine Obtient le texte sur la ligne spécifiée.
Méthode publique GetLineCount Obtient le nombre d'entrées ligne le fichier source.
Méthode publique GetLineIndexOfPosition Obtient la ligne et la colonne pour la position spécifiée.
Méthode publique GetLineLength Obtient la longueur de la ligne spécifiée.
Méthode publique GetMarkerCommandInfo Détermine que les commandes de marque peuvent être montré dans un menu contextuel pour la zone masquée spécifiée.
Méthode publique GetNewLine Obtient le caractère de saut de ligne utilisé à la fin de la ligne spécifiée.
Méthode publique GetPairExtents(IVsTextView, Int32, Int32, TextSpan%) Obtient l'étendue par une paire correspondante d'éléments de langage.
Méthode publique GetPairExtents(IVsTextView, Int32, Int32, TextSpan%, TextSpan%) Obtient les étendues de texte pour une paire correspondante (ou le triplet) des éléments de langage.
Méthode publique GetPositionOfLineIndex Obtient la position correspondant à l'emplacement d'offset donné de ligne et de personnage.
Méthode publique GetTaskProvider Obtient le fournisseur de tâche qui gère les tâches d'erreur.
Méthode publique GetText() Obtient tout le texte du fichier source.
Méthode publique GetText(TextSpan) Obtient le texte compris dans l'étendue de texte.
Méthode publique GetText(Int32, Int32, Int32, Int32) Obtient le texte entre les emplacements spécifiés.
Méthode publique GetTextLines Obtient l'objet IVsTextLines associé à cet objet Source.
Méthode publique GetTextUpToLine Obtient le texte de la source jusqu'au numéro de ligne donné.
Méthode publique GetTipText Obtient le texte dans la zone masquée donnée d'être utilisé dans une info-bulle.
Méthode publique GetTokenInfo Obtient des informations sur le jeton à la position spécifiée.
Méthode publique GetTokenInfoAt Obtient l'index de l'objet d'TokenInfo qui comprend le numéro de colonne fourni.
Méthode publique GetType Obtient le Type de l'instance actuelle. (Hérité de Object.)
Méthode publique GetUserData Obtient les données d'utilisateur associées avec GUID spécifié.
Méthode publique GetWordExtent Obtient l'étendue occupée par le mot à l'emplacement spécifié.
Méthode publique MakeBaseSpanVisible Garantit que l'étendue donnée dans zone masquée donnée est visible.
Méthode publique MatchBraces Met en surbrillance les étendues d'une paire d'éléments de langage, selon la position d'un des éléments.
Méthode protégée MemberwiseClone Crée une copie superficielle de l'objet Object actuel. (Hérité de Object.)
Méthode publique MethodTip Affiche un conseil de méthode d'Intellisense montrant la signature d'une méthode telle qu'elle est entrée.
Méthode publique NormalizeNewlines Convertit les sauts de ligne dans le texte spécifié au saut de ligne spécifié.
Méthode publique OnBeforeSessionEnd Appelé juste avant une session masquée de zone est fermé.
Méthode publique OnChangeLineAttributes Appelé lorsque les attributs d'un ou plusieurs lignes (la police, couleur) ont changé.
Méthode publique OnChangeLineText Appelé lorsque le texte d'une ligne a changé.
Méthode publique OnChangesCommitted Appelé lorsqu'un extrait de code est validé au fichier source.
Méthode publique OnCommand Les handles Intellisense- ont orienté des commandes.
Méthode publique OnHiddenRegionChange Appelé lorsqu'une zone masquée a changé.
Méthode publique OnIdle Appelé lorsque aucun autre événement n'est géré.
Méthode publique OnUserDataChange Appelé lorsque la donnée d'utilisateur a été modifiée dans une mémoire tampon de texte.
Méthode publique Open Marque l'objet d'Source comme étant ouvert.
Méthode publique ProcessHiddenRegions Met à jour les zones masquées selon la liste donnée de zones masquées.
Méthode publique Recolorize Met à jour la syntaxe mettant en surbrillance sur la plage spécifiée des lignes.
Méthode publique ReformatSpan Mettez en forme l'étendue spécifiée de la source.
Méthode publique RegisterTextBufferEventHandlers
Méthode publique RemoveHiddenRegions Supprime toutes les zones masquées de l'affichage en cours.
Méthode publique RemoveTask Supprime la tâche spécifiée d'erreur de la fenêtre de Tâche d'erreur.
Méthode publique ScanToNonWhitespaceChar Retourne l'offset du premier personnage du non- espace blanc sur la ligne donnée.
Méthode publique SetText(String) Remplace le contenu de source par le texte donné.
Méthode publique SetText(TextSpan, String) Remplace l'étendue spécifiée de la source par le texte donné.
Méthode publique SetText(Int32, Int32, Int32, Int32, String) Remplace la section spécifiée de la source par le texte donné.
Méthode publique SetUserData Définit la propriété des données donnée d'utilisateur à la valeur donnée.
Méthode publique ToString Retourne une chaîne qui représente l'objet actuel. (Hérité de Object.)
Méthode publique TrimSpan Règle l'étendue donnée pour ignorer l'espace blanc de début et de fin.
Méthode publique UncommentBlock Supprime des personnages de commentaire de autour de l'étendue spécifiée.
Méthode publique UncommentLines Supprime des personnages de commentaire de ligne du début de chaque entrée ligne l'étendue donnée.
Méthode publique UncommentSpan Supprime des personnages de commentaire du début et la fin de l'étendue donnée.
Méthode publique VisiblePositionToColumn Obtient l'offset de personnage sur la ligne donnée correspondant à la position de la colonne spécifiée d'écran.

Début

Remarques

Un objet d'Source représente le fichier source entier associé à une vue particulière.Les informations sur le fichier source peuvent être obtenues à partir de cette classe.Toutefois, la fonctionnalité primaire de cette classe est d'effectuer des opérations d'analyse sur la source une prise aux opérations d'Intellisense et les opérations de modification de spécifiques au fichier de source telles que les commentaires d'ajout à et supprimer commente des blocs de code et d'enregistrer des erreurs d'analyse.

Remarques à l'attention des implémenteurs

La classe de base prend en charge toutes les opérations d'Intellisense en coordination avec des méthodes dans la classe d'LanguageService (qui sont détaillés dans les descriptions de la méthode de la classe d'Source).Si vous :

  • prenez en charge les différents séparateurs de commentaire autres que les séparateurs du standard, C#/C++

  • remettez en forme code,

    et/ou

  • prenez en charge la fonctionnalité avancée pour les zones masquées (la modification d'analyse de l'état, garantissant une étendue reste des commandes de menu contextuel et visibles et marque- orientées),

vous devez dériver une classe de la classe d'Source et instancier votre classe dans l'CreateSource.

Remarques à l'attention des appelants

Cette classe est instanciée par un appel à la méthode d'CreateSource.Cela est effectué lorsque l'objet d'CodeWindowManager est instancié (l'objet d'Source est passé au constructeur d'CodeWindowManager).Un objet d'Colorizer peut être instancié et passé au constructeur de la classe d'Source.

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