Shulou(Shulou.com)06/01 Report--

Today, I would like to share with you how to use the template Editor ViewPort Adornment to achieve the expansion of the relevant knowledge, detailed content, clear logic, I believe that most people still know too much about this knowledge, so share this article for your reference, I hope you can learn something after reading this article, let's take a look at it.

Step 1: create a Viewport Adornment project

We select the Viewport Adornment template from Extensibility to create a project. This generates a SourceManifest file and two class files. One is the Adornment class itself and the other is the AdornmentFactory class.

Step 2: add a WPF user control

Right-click the project and select add a new WPF user control. For simplicity, I used a user control. This user control actually contains an Expander control, which sets its ExpandDirection = Left, which also contains some TextBlock controls and another Expander, and sets the ExpandDirection = Down of the Expander in it. Look at the following code (I removed unnecessary elements to make it easier):

As you can see, the code is very simple, two Expanders, one used to display basic statistics and the other to display extended statistics. I also use StackPanel to fix the TextBlocks layout. Now, if you look at the background code, it's just as simple. In fact, I have created a CodeInfoTracker class to use to analyze the source code files for us. I just added a constructor to our user control to make it more extensible.

Private CodeInfoTracker _ cinfo; private CodeInfoTracker.Calculators _ calculator; public ucInfoBox (CodeInfoTracker cinfo): this () {this._cinfo = cinfo;} public void UpdateInfo (CodeInfoTracker info) {_ calculator = info.PerFormCalculate (); this.txtNoLines.Text = string.Format ("No of Lines: {0}", _ calculator.no_of_lines); this.txtNoCharacters.Text = string.Format ("No of Characters: {0}", _ calculator.no_of_characters) This.txtFileSize.Text = string.Format ("Total FileSize: {0}", _ calculator.totalfilesize); StringBuilder builder = new StringBuilder (); if (this._calculator.interfaces! = 0) builder.AppendFormat ("Interfaces: {0}\ n\ r", this._calculator.interfaces); if (this._calculator.namespaces! = 0) builder.AppendFormat ("NameSpaces: {0}\ n\ r", this._calculator.namespaces) If (this._calculator.classes! = 0) builder.AppendFormat ("Classes: {0}\ n\ r", this._calculator.classes); if (this._calculator.methods! = 0) builder.AppendFormat ("Methods: {0}\ n\ r", this._calculator.methods); if (this._calculator.properties! = 0) builder.AppendFormat ("Properties: {0}\ n\ r", this._calculator.properties) If (this._calculator.fields! = 0) builder.AppendFormat ("Fields: {0}\ n\ r", this._calculator.fields); if (this._calculator.comments! = 0) builder.AppendFormat ("Comments: {0}\ n\ r", this._calculator.comments); if (builder.Length > 0) {this.txtClassInfo.Visibility = System.Windows.Visibility.Visible; this.txtClassInfo.Text = builder.ToString () } else {this.txtClassInfo.Text = ""; this.txtClassInfo.Visibility = System.Windows.Visibility.Hidden;}}

A structure Calculators is used, which is placed in our custom class and has several int properties to hold all the information obtained by the analysis source file. Info.PerFormCalculate (); gives the results of the analysis. All the acquired information is used here to update the UIElements.

Step 3: create a class that gets the information about the source file

Although there is some complexity in the code, this class is actually very simple. I am very grateful to CS Parser [^], which helps me parse the source code automatically. This class requires an IWpfTextView object that represents a Visual Studio 2010 text editor. WpfTextView actually implements IWpfTextView. This class accepts this object during execution.

I can get the source code from WPFTextView.TextSnapshot.GetText (). When I call this analysis, I only need to detect what language the code is written in. At first I wanted to do it myself, but thank God I found that this object already exists in WPFTextView.

Public enum Language {CSharp, VisualBasic, Indeterminate} internal Language DetectLanguage {get {string langtype = this._view.FormattedLineSource.TextAndAdornmentSequencer. SourceBuffer.ContentType.DisplayName; if (langtype.Equals ("CSHARP", StringComparison.InvariantCultureIgnoreCase) return Language.CSharp; else if (langtype.Equals ("BASIC", StringComparison.InvariantCultureIgnoreCase)) return Language.VisualBasic; else return Language.Indeterminate;}}

DetectLanguage makes good use of the FormattedLineSource.TextAndAdornmentSequencer of WPFTextView objects. SourceBuffer.ContentType.DisplayName, this attribute tells me which language is used. Then I created a new method, PerFormCalculate, which is used to parse the source code, which returns a Calculation structure object.

Step 4: create the Adornment Factory class

Going back to this extension, I create a Factory class for Adornment (InfoBoxAdornmentFactory). This class inherits from IWpfTextViewCreationListener and is used to listen for WPF editing and creation events.

[Export (typeof (IWpfTextViewCreationListener))] [ContentType ("text")] [TextViewRole (PredefinedTextViewRoles.Document)] internal sealed class InfoBoxAdornmentFactory: IWpfTextViewCreationListener {[Export (typeof (AdornmentLayerDefinition))] [Name ("AlwaysVisibleInfoBox")] [Order (After = PredefinedAdornmentLayers.Selection)] [TextViewRole (PredefinedTextViewRoles.Interactive)] public AdornmentLayerDefinition editorAdornmentLayer = null; public void TextViewCreated (IWpfTextView textView) {new AlwaysVisibleInfoBox (textView);}}

Here, you can see that I use a lot of Attributes on this class, such as ContentType, which defines our editor that only deals with text format, and TextViewRole, which defines the type of textview that will be processed by this class. In this class, I create an AdornmentLayerDefination object. Maybe you want to know that we don't use it, there's nothing to define it, it's just for configuring properties. The Order attribute specifies that when InfoBox listens after the layer is selected, Name is the name of the editing extension.

Step 5: create the Adornment class

The Adornment class actually creates a WPF user control object and sets its view canvas. In the internal constructor, I handle the IWpfTextView.LayoutChanged event, which is triggered when the code is modified or the layout changes.

Therefore, through this event, when we edit the document, we can easily get a callback. When the size of the browser editor changes, I also get a callback by processing the WPFTextView.ViewportHeightChanged,WPFTextView.ViewportWidthChanged so that we can relocate the corresponding UserControl.

Public AlwaysVisibleInfoBox (IWpfTextView view) {_ view.LayoutChanged + = this.OnLayoutChanged; this.GetLayer ();} private void GetLayer () {_ adornmentLayer = this._view.GetAdornmentLayer ("AlwaysVisibleInfoBox"); _ view.ViewportHeightChanged + = delegate {this.onSizeChange ();}; _ view.ViewportWidthChanged + = delegate {this.onSizeChange ();} private void OnLayoutChanged (object sender, TextViewLayoutChangedEventArgs e) {this._info = new CodeInfoTracker (_ view); this.infobox.UpdateInfo (this._info) } public void onSizeChange () {_ adornmentLayer.RemoveAllAdornments (); Canvas.SetLeft (infobox, _ view.ViewportRight-255); Canvas.SetTop (infobox, _ view.ViewportTop + 10); _ adornmentLayer.AddAdornment (AdornmentPositioningBehavior.ViewportRelative, null, null, infobox, null);}

Therefore, the constructor simply calls GetLayer to get the Layer object, which occurs in the ViewportHeightChanged and ViewportWidthChanged ViewPortSizeChage events. When a layout changes, I can update the user's controls. At this point, we have successfully built our expansion. You can run it with F5 and it will open an Experimental instance of Visual Studio 2010.

Install and uninstall this extension:

It is very easy to install and uninstall this extension. When you compile the project, it produces a VSIX file. You can simply double-click the file and it will be automatically installed to Visual Studio 2010.

These are all the contents of the article "how to use template Editor ViewPort Adornment to implement extensions". Thank you for reading! I believe you will gain a lot after reading this article. The editor will update different knowledge for you every day. If you want to learn more knowledge, please pay attention to the industry information channel.

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.