語言服務及編輯器擴充點

 

如需 Visual Studio 2017 的最新文件請參閱 Visual Studio 2017 文件。

編輯器會提供擴充點，您可以擴充為 Managed Extensibility Framework (MEF) 元件組件，其中包括大部分的語言服務功能。 這些是主要的擴充點分類︰

• 內容類型

• 分類類型與分類格式

• 邊界和捲軸

• Tags

• 裝飾

• 滑鼠處理器

• 拖放處理常式

• 選項

• IntelliSense

擴充的內容類型

內容類型是一種文字編輯器，例如處理、 「 文字 」、 「 程式碼 」 或"CSharp"的定義。 您定義新的內容類型所宣告之型別的變數ContentTypeDefinition並提供新的內容類型的唯一名稱。 若要登錄編輯器的內容類型，請將它匯出以及下列屬性︰

• NameAttribute是內容類型的名稱。

• BaseDefinitionAttribute是這個內容類型衍生的內容類型的名稱。 內容類型可以繼承自多個內容的類型。

因為ContentTypeDefinition密封的類別，您可以將它匯出具有任何型別參數。

下列範例會顯示匯出屬性上的內容類型定義。

[Export]  
[Name("test")]  
[BaseDefinition("code")]  
[BaseDefinition("projection")]  
internal static ContentTypeDefinition TestContentTypeDefinition;  

內容類型可以根據零或多個預先存在的內容類型。 這些是內建型別︰

• 任何︰ 基本的內容類型。 所有其他內容類型的父代。

• 文字︰ 基本類型的非投影內容。 繼承自 「 任何 」。

• 純文字︰ 針對非程式碼的文字。 繼承自 「 文字 」。

• 程式碼︰ 所有種類的程式碼。 繼承自 「 文字 」。

• 惰性︰ 排除任何一種處理文字。 此內容類型的文字必須永遠不會套用至任何擴充功能。

• 投影︰ 針對投影緩衝區的內容。 繼承自 「 任何 」。

• Intellisense︰ 針對 IntelliSense 的內容。 繼承自 「 文字 」。

• Sighelp︰ 簽章說明。 繼承自 「 intellisense 」。

• Sighelp 文件︰ 簽章說明 」 文件。 繼承自 「 intellisense 」。

以下是一些內容類型所定義的 Visual Studio 裝載於 Visual Studio 中的語言︰

• 基本

• C/C++

• ConsoleOutput

• CSharp

• CSS

• ENC

• FindResults

• F#

• HTML

• JScript

• XAML

• XML

若要探索可用的內容類型的清單，匯入IContentTypeRegistryService，保留編輯器 中的內容類型的集合。 下列程式碼匯入此服務，做為屬性。

[Import]  
internal IContentTypeRegistryService ContentTypeRegistryService { get; set; }  

若要將內容類型與副檔名產生關聯，請使用FileExtensionToContentTypeDefinition。

注意

在 Visual Studio 中，檔案名稱的副檔名會登錄使用ProvideLanguageExtensionAttribute語言服務封裝上。 FileExtensionToContentTypeDefinition MEF 的內容類型關聯這種方式中已註冊的副檔名。

若要匯出的檔案名稱副檔名內容型別定義，您必須包含下列屬性︰

• FileExtensionAttribute︰ 指定檔案的副檔名。

• ContentTypeAttribute︰ 指定的內容類型。

因為FileExtensionToContentTypeDefinition密封的類別，您可以將它匯出具有任何型別參數。

下列範例會顯示匯出屬性上的內容類型定義的副檔名。

[Export]  
[FileExtension(".test")]  
[ContentType("test")]  
internal static FileExtensionToContentTypeDefinition TestFileExtensionDefinition;  

IFileExtensionRegistryService管理副檔名的檔案和內容類型之間的關聯。

擴充分類類型與分類格式

您可以使用分類類型來定義您想要提供不同的處理 （例如，藍色的 「 關鍵字 」 文字和 「 註解 」 文字著色綠色） 文字的類型。 藉由宣告型別的變數定義新的分類類型ClassificationTypeDefinition ，並指定唯一的名稱。

若要登錄編輯器的分類類型，請將它匯出以及下列屬性︰

• NameAttribute︰ 類別類型的名稱。

• BaseDefinitionAttribute︰ 此分類的型別所繼承的分類類型的名稱。 所有的分類類型繼承自 「 文字 」，而分類類型可以繼承自多個其他分類類型。

因為ClassificationTypeDefinition密封的類別，您可以將它匯出具有任何型別參數。

下列範例顯示分類的型別定義上的匯出屬性。

[Export]  
[Name("csharp.test")]  
[BaseDefinition("test")]  
internal static ClassificationTypeDefinition CSharpTestDefinition;  

IStandardClassificationService可讓您存取標準分類。 內建的分類類型包括︰

• 文字

• 「 自然語言 」 （衍生自 「 文字 」）

• （衍生自 「 文字 」） 「 正式語言 」

• 「 字串 」 （衍生自 「 常值 」）

• "character"（衍生自 「 常值 」）

• 「 數值 」 （衍生自 「 常值 」）

一組不同的錯誤型別繼承自ErrorTypeDefinition。 包括下列的錯誤類型︰

• 「 語法錯誤 」

• 「 編譯器錯誤 」

• 「 其他錯誤 」

• 「 警告 」

若要探索可用的分類類型的清單，匯入IClassificationTypeRegistryService，保留編輯器 中的分類類型的集合。 下列程式碼匯入此服務，做為屬性。

[Import]  
internal IClassificationTypeRegistryService ClassificationTypeRegistryService { get; set; }  

您可以定義分類格式定義新的分類類型。 自ClassificationFormatDefinition和匯出型別EditorFormatDefinition連同下列屬性︰

• NameAttribute︰ 格式的名稱。

• DisplayNameAttribute︰ 格式的顯示名稱。

• UserVisibleAttribute︰ 指定的格式是否出現在字型和色彩頁面選項對話方塊。

• OrderAttribute︰ 格式的優先順序。 有效值為優先順序。

• ClassificationTypeAttribute︰ 這種格式對應類型分類的名稱。

下列範例會顯示匯出屬性分類格式定義。

[Export(typeof(EditorFormatDefinition))]  
[ClassificationType(ClassificationTypeNames = "test")]  
[Name("test")]  
[DisplayName("Test")]  
[UserVisible(true)]  
[Order(After = Priority.Default, Before = Priority.High)]  
internal sealed class TestFormat : ClassificationFormatDefinition  

若要探索可用的格式清單，匯入IEditorFormatMapService，保留格式集合編輯器。 下列程式碼匯入此服務，做為屬性。

[Import]  
internal IEditorFormatMapService FormatMapService { get; set; }  

擴充的邊界和捲軸

邊界和捲軸是主要檢視的元素編輯器 中除了文字檢視本身。 您可以提供任何數目的邊界，除了標準文字檢視周圍出現的邊界。

實作IWpfTextViewMargin介面來定義邊界。 您也必須實作IWpfTextViewMarginProvider介面來建立邊界。

若要登錄編輯器邊界提供者，您必須將匯出的提供者，以及下列屬性︰

• NameAttribute︰ 邊界的名稱。

• OrderAttribute: 邊界顯示的順序，相對於其他邊界。

  這些是內建的邊界︰

  • 「 Wpf 的水平捲軸 」

  • 「 Wpf 的垂直捲軸 」

  • 「 Wpf 的列數字邊界 」

  有的順序屬性的水平邊界After="Wpf Horizontal Scrollbar"會顯示在下方的內建的邊界和有順序的屬性的水平邊界Before ="Wpf Horizontal Scrollbar"上面的內建的邊界會顯示。 垂直的邊界有順序的屬性，以滑鼠右鍵After="Wpf Vertical Scrollbar"會顯示捲軸的右側。 留有順序的屬性的垂直邊界After="Wpf Line Number Margin"會顯示在左邊的列數字邊界 （如果有顯示）。

• MarginContainerAttribute︰ 邊界 （左、 右邊、 上方或底部） 的類型。

• ContentTypeAttribute︰ 您邊界是有效的內容 （例如，「 文字 」 或 「 編碼 」） 類型。

下列範例會顯示匯出屬性出現在右邊的列數字邊界的邊界的邊界提供者上。

[Export(typeof(IWpfTextViewMarginProvider))]  
[Name("TestMargin")]  
[Order(Before = "Wpf Line Number Margin")]  
[MarginContainer(PredefinedMarginNames.Left)]  
[ContentType("text")]   

延伸標記

標記是文字的一種將資料與不同種類產生關聯。 在許多情況下，相關聯的資料會顯示為視覺效果，但並非所有標籤都有視覺呈現方式。 您可以藉由實作定義您自己的標記類型ITag。 您也必須實作ITagger<> </> >標記提供一組指定的文字範圍和ITaggerProvider提供標註器。 您必須匯出標註器提供者，以及下列屬性︰

• ContentTypeAttribute︰ 您的標籤是有效的內容 （例如，「 文字 」 或 「 編碼 」） 類型。

• TagTypeAttribute︰ 標記的類型。

下列範例會顯示匯出屬性標註器提供者。

[Export(typeof(ITaggerProvider))]  
[ContentType("text")]  
[TagType(typeof(TestTag))]  
internal class TestTaggerProvider : ITaggerProvider  

下列幾種標籤是內建︰

• ClassificationTag︰ 聯IClassificationType。

• ErrorTag︰ 錯誤類型相關聯。

• TextMarkerTag︰ 透過裝飾相關聯。

  注意

  如需TextMarkerTag，請參閱 HighlightWordTag 定義逐步解說︰ 反白顯示文字。

• OutliningRegionTag︰ 展開或摺疊的大綱區域相關聯。

• SpaceNegotiatingAdornmentTag︰ 文字檢視中定義透過裝飾佔用的空間。 如需空間交涉裝飾的詳細資訊，請參閱下一節。

• IntraTextAdornmentTag︰ 提供自動的間距和大小，裝飾。

若要尋找並使用標記緩衝區和檢視表，匯入IViewTagAggregatorFactoryService或IBufferTagAggregatorFactoryService，這可讓您ITagAggregator<> </> >所要求型別。 下列程式碼匯入此服務，做為屬性。

[Import]  
internal IViewTagAggregatorFactoryService ViewTagAggregatorFactoryService { get; set; }  

標記和 MarkerFormatDefinitions

您可以擴充MarkerFormatDefinition類別，定義標籤的外觀。 您必須將匯出您的類別 (為EditorFormatDefinition) 具有下列屬性︰

• NameAttribute︰ 用來參考此格式的名稱

• UserVisibleAttribute︰ 這會導致在 UI 中顯示的格式

在建構函式，您可以定義顯示名稱和標記的外觀。 BackgroundColor定義的填滿色彩，以及ForegroundColor定義的框線色彩。 DisplayName格式定義的可當地語系化的名稱。

格式定義的範例如下︰

[Export(typeof(EditorFormatDefinition))]  
[Name("MarkerFormatDefinition/HighlightWordFormatDefinition")]  
[UserVisible(true)]  
internal class HighlightWordFormatDefinition : MarkerFormatDefinition  
{  
    public HighlightWordFormatDefinition()  
    {  
        this.BackgroundColor = Colors.LightBlue;  
        this.ForegroundColor = Colors.DarkBlue;  
        this.DisplayName = "Highlight Word";   
        this.ZOrder = 5;  
    }  
}  
  

若要套用此格式定義標記，請參考您設定的類別 （而不顯示名稱） 的名稱屬性的名稱。

注意

如需MarkerFormatDefinition，請參閱中的 HighlightWordFormatDefinition 類別逐步解說︰ 反白顯示文字。

擴充裝飾

裝飾定義視覺效果，可以加入至文字檢視中顯示的文字或文字檢視本身。 您可以定義自己的裝飾的任何一種UIElement。

在裝飾類別中，您必須宣告AdornmentLayerDefinition。 若要註冊您的裝飾層，請將它匯出以及下列屬性︰

• NameAttribute: 裝飾名稱。

• OrderAttribute︰ 相對於其他裝飾層裝飾的順序。 類別PredefinedAdornmentLayers定義四種預設階層︰ 選取項目、 大綱、 插入號和文字。

下列範例會顯示匯出屬性裝飾層定義。

[Export]  
[Name("TestEmbeddedAdornment")]  
[Order(After = PredefinedAdornmentLayers.Selection, Before = PredefinedAdornmentLayers.Text)]  
internal AdornmentLayerDefinition testLayerDefinition;  

您必須建立第二個類別可實作IWpfTextViewCreationListener並處理其TextViewCreated事件，以具現化的裝飾。 您必須匯出這個類別，以及下列屬性︰

• ContentTypeAttribute: 裝飾是有效的內容 （例如，「 文字 」 或 「 編碼 」） 類型。

• TextViewRoleAttribute︰ 此裝飾是有效的文字檢視的類型。 類別PredefinedTextViewRoles具有一組預先定義的文字檢視角色。 例如，文件主要做為文字檢視的檔案。 互動式用於文字檢視，使用者可以編輯，或使用滑鼠和鍵盤瀏覽。 範例互動式檢視是編輯器文字檢視和輸出視窗。

下列範例會顯示匯出屬性裝飾的提供者。

[Export(typeof(IWpfTextViewCreationListener))]  
[ContentType("csharp")]  
[TextViewRole(PredefinedTextViewRoles.Document)]  
internal sealed class TestAdornmentProvider : IWpfTextViewCreationListener  

空間交涉的裝飾是佔用的空間，做為文字相同層級。 若要建立這類的裝飾，您必須定義標記類別繼承自SpaceNegotiatingAdornmentTag，以定義裝飾所佔用的空間量。

如同所有裝飾時，您必須匯出裝飾層定義。

[Export]  
[Name("TestAdornment")]  
[Order(After = DefaultAdornmentLayers.Text)]  
internal AdornmentLayerDefinition testAdornmentLayer;  

具現化空間交涉的裝飾，您必須建立類別以實作ITaggerProvider，除了實作的類別IWpfTextViewCreationListener （就像其他種類的裝飾）。

若要註冊的標註器提供者，您必須將它匯出以及下列屬性︰

• ContentTypeAttribute︰ 您裝飾是有效的內容 （例如，「 文字 」 或 「 編碼 」） 類型。

• TextViewRoleAttribute︰ 文字檢視，以及此種標記或裝飾是否有效。 類別PredefinedTextViewRoles具有一組預先定義的文字檢視角色。 例如，文件主要做為文字檢視的檔案。 互動式用於文字檢視，使用者可以編輯，或使用滑鼠和鍵盤瀏覽。 範例互動式檢視是編輯器文字檢視和輸出視窗。

• TagTypeAttribute︰ 的標籤或裝飾您已經定義的類型。 您必須新增第二個TagTypeAttribute的SpaceNegotiatingAdornmentTag。

下列範例會顯示匯出屬性標註器提供者以進行空間交涉裝飾標記。

[Export(typeof(ITaggerProvider))]  
[ContentType("text")]  
[TextViewRole(PredefinedTextViewRoles.Document)]  
[TagType(typeof(SpaceNegotiatingAdornmentTag))]  
[TagType(typeof(TestSpaceNegotiatingTag))]  
internal sealed class TestTaggerProvider : ITaggerProvider  

擴充滑鼠處理器

您可以將滑鼠輸入的特殊處理。 建立繼承自類別MouseProcessorBase並覆寫的輸入您想要處理的滑鼠事件。 您也必須實作IMouseProcessorProvider在第二個類別並將它搭配匯出ContentTypeAttribute ，指定您的滑鼠處理常式是有效的內容 （例如，「 文字 」 或 「 編碼 」） 類型。

下列範例顯示滑鼠處理器提供者上的匯出屬性。

[Export(typeof(IMouseProcessorProvider))]  
[Name("test mouse processor")]  
[ContentType("text")]  
[TextViewRole(PredefinedTextViewRoles.Interactive)]   
internal sealed class TestMouseProcessorProvider : IMouseProcessorProvider  

擴充拖放處理常式

您可以藉由建立類別以實作自訂行為的特定種類的文字的拖放處理常式IDropHandler和第二個類別可實作IDropHandlerProvider建立拖放處理常式。 您必須匯出放處理常式，以及下列屬性︰

• DropFormatAttribute︰ 這個拖放處理常式是有效的文字格式。 依優先順序最高到最低，會處理下列格式︰

  1. 任何自訂的格式

  2. FileDrop

  3. EnhancedMetafile

  4. WaveAudio

  5. Riff

  6. 差異

  7. 地區設定

  8. 調色盤

  9. PenData

  10. 可序列化

  11. SymbolicLink

  12. Xaml

  13. XamlPackage

  14. Tiff

  15. Bitmap

  16. Dib

  17. MetafilePicture

  18. CSV

  19. System.String

  20. HTML 格式

  21. UnicodeText

  22. OEMText

  23. Text

• NameAttribute︰ 拖放處理常式的名稱。

• OrderAttribute︰ 排序的拖放處理常式之前或之後的預設拖放處理常式。 Visual Studio 的預設拖放處理常式命名為 「 DefaultFileDropHandler 」。

下列範例會顯示匯出屬性上拖放處理常式提供者。

[Export(typeof(IDropHandlerProvider))]  
[DropFormat("Text")]   
[Name("TestDropHandler")]  
[Order(Before="DefaultFileDropHandler")]   
internal class TestDropHandlerProvider : IDropHandlerProvider  

擴充編輯器選項

您可以定義為只能在特定範圍內，例如，文字檢視中有效的選項。 編輯器會提供這組預先定義的選項︰ 編輯器選項、 檢視表選項和 Windows Presentation Foundation (WPF) 檢視選項。 這些選項可在DefaultOptions， DefaultTextViewOptions，和DefaultWpfViewOptions。

若要加入新的選項，請從這些選項定義類別的其中一個衍生類別︰

• EditorOptionDefinition<>>

• ViewOptionDefinition<>>

• WpfViewOptionDefinition<>>

下列範例示範如何匯出選項定義具有布林值。

[Export(typeof(EditorOptionDefinition))]  
internal sealed class TestOption : EditorOptionDefinition<bool>  

擴充 IntelliSense

IntelliSense 是一組功能，可提供結構化的文字的相關資訊的一般詞彙和它的陳述式完成。 這些功能包括陳述式完成、 簽章說明、 快速諮詢和燈泡。 陳述式完成可幫助使用者正確地輸入語言關鍵字或成員名稱。 簽章說明會顯示簽章或簽章的方法，使用者只要輸入。 滑鼠停留在其上時快速諮詢 會顯示完整簽章的型別或成員的名稱。 燈泡會提供已重新命名一次之後，重新命名變數的所有項目在特定內容，例如，特定識別項的其他動作。

IntelliSense 功能的設計是在所有情況下大致相同︰

• IntelliSense broker負責的整體程序。

• IntelliSense工作階段表示之間的演講者的順序或取消選取範圍的觸發事件的順序。 工作階段通常會觸發某些使用者手勢。

• IntelliSense控制器負責決定工作階段應該在何時開始和結束。 它也會決定當的資訊應該認可和工作階段時應取消。

• IntelliSense來源提供內容，並決定最符合項目。

• IntelliSense主持人會負責顯示內容。

在大部分情況下，我們建議您提供最少的來源和控制站。 如果您想要自訂的顯示，您也可以提供一個展示者。

實作 IntelliSense 來源

若要自訂來源，您必須實作其中一個 （或以上） 下列來源介面︰

• ICompletionSource

• IQuickInfoSource

• ISignatureHelpSource

• ISuggestedActionsSource

重要

ISmartTagSource已被取代之喜好ISuggestedActionsSource。

此外，您必須實作相同類型的提供者︰

• ICompletionSourceProvider

• IQuickInfoSourceProvider

• ISignatureHelpSourceProvider

• ISuggestedActionsSourceProvider

重要

ISmartTagSourceProvider已被取代之喜好ISuggestedActionsSourceProvider。

您必須將匯出的提供者，以及下列屬性︰

• NameAttribute︰ 來源的名稱。

• ContentTypeAttribute︰ 來源適用於內容 （例如，「 文字 」 或 「 編碼 」） 的類型。

• OrderAttribute︰ 來源 （相對於其他來源） 應該出現的順序。

• 下列範例會顯示匯出屬性上完成來源提供者。

Export
(typeof(ICompletionSourceProvider))]  
[Name
(" Test Statement Completion Provider")]  
[Order
(Before = "default")]  
[ContentType
("text")]  
internal class TestCompletionSourceProvider : ICompletionSourceProvider  

如需實作 IntelliSense 來源的詳細資訊，請參閱下列逐步解說︰

逐步解說︰ 顯示 QuickInfo 工具提示

逐步解說︰ 顯示簽章說明

逐步解說︰ 顯示陳述式完成

實作 IntelliSense 控制器

若要自訂控制器，您必須實作IIntellisenseController介面。 此外，您必須實作的控制站提供者，以及下列屬性︰

• NameAttribute︰ 控制站的名稱。

• ContentTypeAttribute︰ 控制器適用於內容 （例如，「 文字 」 或 「 編碼 」） 的類型。

• OrderAttribute︰ 控制器 （相對於其他控制站） 應該出現的順序。

下列範例會顯示匯出屬性上完成控制站提供者。

Export
(typeof(IIntellisenseControllerProvider))]  
[Name
(" Test Controller Provider")]  
[Order
(Before = "default")]  
[ContentType
("text")]  
internal class TestIntellisenseControllerProvider : IIntellisenseControllerProvider  

如需有關使用 IntelliSense 控制器的詳細資訊，請參閱下列逐步解說︰

逐步解說︰ 顯示 QuickInfo 工具提示