IVsLanguageTextOps.Format, méthode
Met en forme le texte sélectionné.
Espace de noms : Microsoft.VisualStudio.TextManager.Interop
Assembly : Microsoft.VisualStudio.TextManager.Interop (dans Microsoft.VisualStudio.TextManager.Interop.dll)
Syntaxe
'Déclaration
Function Format ( _
pTextLayer As IVsTextLayer, _
ptsSel As TextSpan() _
) As Integer
int Format(
IVsTextLayer pTextLayer,
TextSpan[] ptsSel
)
int Format(
[InAttribute] IVsTextLayer^ pTextLayer,
[InAttribute] array<TextSpan>^ ptsSel
)
abstract Format :
pTextLayer:IVsTextLayer *
ptsSel:TextSpan[] -> int
function Format(
pTextLayer : IVsTextLayer,
ptsSel : TextSpan[]
) : int
Paramètres
pTextLayer
Type : Microsoft.VisualStudio.TextManager.Interop.IVsTextLayer[in] un objet d'IVsTextLayer contenant le texte a formater.
ptsSel
Type : array<Microsoft.VisualStudio.TextManager.Interop.TextSpan[][in] l'étendue de texte a formater dans la couche spécifiée. Pour plus d'informations, consultez TextSpan.
Valeur de retour
Type : Int32
Si la méthode réussit, elle retourne S_OK.En cas d'échec, un code d'erreur est retourné.
Notes
Signature de COM
De textmgr.idl :
HRESULT IVsLanguageTextOps::Format(
[in] IVsTextLayer *pTextLayer,
[in] const TextSpan *ptsSel
);
Cette fonction est appelée lorsque l'utilisateur sélectionne Mettre le document en forme ou Mettre la sélection en forme d'Edit - > menu d'Avancé, et les demandes que le service de langage fournissent le formatage pour l'étendue de texte référencée. Mettre en forme en général signifie à régler la mise en retrait de ligne, les espaces d'ajout après des virgules, voire l'accolade mobile à une nouvelle ligne avec la mise en retrait appropriée.
Cette méthode peut également être appelée chaque fois que les types d'utilisateur un personnage qui peut déclencher un remettre en forme (ce qui est ce personnage dépend du service de langage mais en général c'est une accolade fermante ou un point-virgule).
Notes
Il est vivement recommandé que si vous appliquez cette méthode, vous encapsuliez tous les changements faits au document d'un objet d'IVsCompoundAction donc l'utilisateur peut annuler l'opération entière de format dans une action.
Sécurité .NET Framework
- Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, voir Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.