ExpansionProvider.InsertNamedExpansion Method
Inserts the specified snippet into the source at the given position.
Namespace: Microsoft.VisualStudio.Package
Assemblies: Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
Syntax
'Declaration
Public Overridable Function InsertNamedExpansion ( _
view As IVsTextView, _
title As String, _
path As String, _
pos As TextSpan, _
showDisambiguationUI As Boolean _
) As Boolean
public virtual bool InsertNamedExpansion(
IVsTextView view,
string title,
string path,
TextSpan pos,
bool showDisambiguationUI
)
public:
virtual bool InsertNamedExpansion(
IVsTextView^ view,
String^ title,
String^ path,
TextSpan pos,
bool showDisambiguationUI
)
abstract InsertNamedExpansion :
view:IVsTextView *
title:string *
path:string *
pos:TextSpan *
showDisambiguationUI:bool -> bool
override InsertNamedExpansion :
view:IVsTextView *
title:string *
path:string *
pos:TextSpan *
showDisambiguationUI:bool -> bool
public function InsertNamedExpansion(
view : IVsTextView,
title : String,
path : String,
pos : TextSpan,
showDisambiguationUI : boolean
) : boolean
Parameters
view
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextView[in] An IVsTextView object representing the view showing the source.
title
Type: String[in] A string containing the name or title of the snippet.
path
Type: String[in] A string containing the path to the snippet template file.
pos
Type: Microsoft.VisualStudio.TextManager.Interop.TextSpan[in] A TextSpan object specifying the position where the snippet is to be inserted.
showDisambiguationUI
Type: Boolean[in] This is true if there is more than one snippet with the given title and a dialog box must be shown so the user can select which snippet to insert; otherwise, this is false (accept the first snippet with the given title).
Return Value
Type: Boolean
If a snippet was inserted, returns true; otherwise, returns false.
Remarks
This is a helper method that can be called from your own code, typically in association with the FindExpansionByShortcut method. See the example in the ViewFilter class to see how this method is used.
The base method calls the InsertNamedExpansion method on the IVsExpansion object. If InsertNamedExpansion succeeds, the ExpansionProvider class is put into the edit expansion mode and the base method returns true. Otherwise, the edit session is ended and the base method returns false.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.