Partager via


CompletionSet.OnCommit, méthode

Obtient le texte d'être inséré dans le fichier source si le caractère spécifié est un caractère de validation.

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.10.0 (dans Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (dans Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (dans Microsoft.VisualStudio.Package.LanguageService.9.0.dll)

Syntaxe

'Déclaration
Public Overridable Function OnCommit ( _
    textSoFar As String, _
    index As Integer, _
    selected As Integer, _
    commitChar As UShort, _
    <OutAttribute> ByRef completeWord As String _
) As Integer
public virtual int OnCommit(
    string textSoFar,
    int index,
    int selected,
    ushort commitChar,
    out string completeWord
)

Paramètres

  • textSoFar
    Type : System.String
    [in] Chaîne contenant le texte qui a été tapé jusqu'à présent par l'utilisateur.
  • index
    Type : System.Int32
    [in] L'index dans la liste de saisie semi-automatique actuellement sélectionnée.
  • selected
    Type : System.Int32
    [in] Une valeur différente de zéro si un élément est sélectionné dans la liste de saisie semi-automatique (l'index de l'élément sélectionné est un paramètre d' index ).Si ce paramètre est zéro, le paramètre d' index est ignoré.
  • commitChar
    Type : System.UInt16
    [in] Le caractère typé qui déclenché la liste de saisie semi-automatique.
  • completeWord
    Type : System.String%
    [out] Retourne la chaîne à insérer dans la source.

Valeur de retour

Type : System.Int32
En cas de réussite, retourne S_OK.Si le paramètre d' commitChar n'est pas un caractère de validation, retourne S_FALSE (ne validez pas le texte au fichier source) ; sinon, retourne un code d'erreur.

Implémentations

IVsCompletionSet.OnCommit(String, Int32, Int32, UInt16, String%)

Remarques

Cette méthode détermine si le caractère donné est un caractère de validation et le cas échéant, détermine le texte à valider basé sur l'élément sélectionné dans la liste de saisie semi-automatique.Si le caractère n'est pas un caractère de validation, cette méthode retourne que le texte a tapés jusqu'à présent.

Cette méthode est une implémentation de la méthode de OnCommit sur l'interface d' IVsCompletionSet .

Si le paramètre d' commitChar n'est pas 0, la méthode de base que les éléments dans l'objet d' Declarations pour voir si le paramètre d' commitChar est contenu dans les correspondances possibles à l'aide de les au texte tapé jusqu'à présent (si le caractère potentiel de validation survient lorsque le texte non typé jusqu'à présent dans une déclaration, le caractère ne puisse pas être un caractère de validation).Si le paramètre d' commitChar peut être un vrai caractère de validation, la méthode de base appelle IsCommitChar sur l'objet d' Declarations pour que la dernière détermination.

Si le paramètre d' commitChar est 0 ou est déterminé pour être un caractère réel de validation, la méthode de base appelle la méthode de OnCommit sur l'objet d' Declarations pour obtenir le texte de l'élément sélectionné.Enfin, la méthode de base retourne le texte et le code de réussite, S_OK.Si le paramètre d' commitChar n'est pas un caractère de validation, la méthode de base retourne S_FALSE.

Sécurité .NET Framework

Voir aussi

Référence

CompletionSet Classe

Microsoft.VisualStudio.Package, espace de noms