Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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)
public virtual bool InsertNamedExpansion(
	IVsTextView view,
	string title,
	string path,
	TextSpan pos,
	bool showDisambiguationUI
)

Parameters

view
Type: Microsoft.VisualStudio.TextManager.Interop.IVsTextView

[in] An IVsTextView object representing the view showing the source.

title
Type: System.String

[in] A string containing the name or title of the snippet.

path
Type: System.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: System.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: System.Boolean
If a snippet was inserted, returns true; otherwise, returns false.

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.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.