HTMLWindow3 Interface
Represents an HTML document window in the Visual Studio integrated development environment (IDE).
Assembly: EnvDTE90 (in EnvDTE90.dll)
| Name | Description | |
|---|---|---|
![]() | CurrentPane | Gets or sets the current HTML Editor window type. |
![]() | CurrentView | Gets or sets whether the HTML Editor window is in Source, Designer, or Split view. |
| Name | Description | |
|---|---|---|
![]() | WaitForBackgroundProcessingComplete(vsHTMLBackgroundTasks) | Pauses program execution until background processing completes. |
HTMLWindow3 is returned by the Object property of the Window object when the document is an HTML document. Window.Selection and Document.Selection returns a TextSelection object when the CurrentTab property is set to vsHTMLTabsSource.
HTMLWindow3, vsHTMLPanes and vsHTMLViews were added with the introduction of Split view in the Visual Studio 2008 HTML editor. Split view separates the tab and view elements of the HTML Editor window. Switching the view (to either Design or Source) does not necessarily mean switching the tab (Design/Split/Source). For example, when you click the Split tab, switching views between Design and Source does not change the tab, it only activates or deactivates the Design and Source parts in the Split view.
The Visual Studio 2008 HTMLWindow object now also implements the HTMLWindow3 interface that returns the current view (either Design or Source) and the current pane (tab, either Design, Source, or Split).
The behavior of HTMLWindow3 is:
Get
Current Pane (Tab) | Current View Returns |
|---|---|
Either vsHTMLViewDesign or vsHTMLViewSource, depending on which part is active. |
Set
Current Pane (Tab) | Setting |
|---|---|
| |
| |
|
public void HTMLWindowExample(_DTE dte) { // Open an HTML document before running this sample. if (dte.ActiveDocument.ActiveWindow.Object is HTMLWindow3) { HTMLWindow3 objHTMLWin; vsHTMLTabs Tab; String strFileName; // Ask the user for a file to insert into the body of the HTML // document. This file should be an HTML fragment. strFileName = Microsoft.VisualBasic.Interaction.InputBox ("Enter the name of a file to insert at the end of the HTML document:","","",100,100); // Get the HTMLWindow3 object and determine which tab is // currently active. objHTMLWin = dte.ActiveDocument.ActiveWindow.Object as HTMLWindow3; Tab = objHTMLWin.CurrentTab; // Switch to the "source" tab. objHTMLWin.CurrentPane = vsHTMLPanes.vsHTMLPaneSplit; objHTMLWin.CurrentTab = vsHTMLViews.vsHTMLViewSource; // Get an EditPoint at the start of the text. TextWindow objTextWin; EditPoint ep; EditPoint ep2 = null; TextRanges textRanges = null; objTextWin = objHTMLWin.CurrentTabObject as TextWindow; ep = objTextWin.ActivePane.StartPoint.CreateEditPoint(); textRanges = objTextWin.Selection.TextRanges; // Look for the end of the document body. if (ep.FindPattern ("</body>",(int)vsFindOptions.vsFindOptionsNone, ref ep2, ref textRanges)) // Insert the contents of the file. ep.InsertFromFile (strFileName); // Switch back to the original view of the HTML file. objHTMLWin.CurrentTab = Tab; } else MessageBox.Show ("You must open an HTML document."); }

