HTMLWindow3 Interface

 

Represents an HTML document window in the Visual Studio integrated development environment (IDE).

Namespace:   EnvDTE90
Assembly:  EnvDTE90 (in EnvDTE90.dll)

[GuidAttribute("BAD0A3DD-8109-4684-B806-A5282267BFE4")]
public interface class HTMLWindow3

NameDescription
System_CAPS_pubpropertyCurrentPane

Gets or sets the current HTML Editor window type.

System_CAPS_pubpropertyCurrentView

Gets or sets whether the HTML Editor window is in Source, Designer, or Split view.

NameDescription
System_CAPS_pubmethodWaitForBackgroundProcessingComplete(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

vsHTMLPaneDesign

vsHTMLViewDesign

vsHTMLPaneSource

vsHTMLViewSource

vsHTMLPaneSplit

Either vsHTMLViewDesign or vsHTMLViewSource, depending on which part is active.

Set

Current Pane (Tab)

Setting

vsHTMLPaneDesign

vsHTMLPaneSource

vsHTMLPaneSplit

  • Setting the view to vsHTMLViewDesign switches the editor to the Design part of the Split pane. The pane does NOT change to Design view.

  • Setting the view to vsHTMLViewSource switches the editor to the Source part of the Split pane. The pane does not change to Source pane.

  • Setting the pane to vsHTMLPaneDesign switches the editor to Design view and Design pane.

  • Setting the pane to vsHTMLPaneSource switches the editor to Source view and Source pane.

No code example is currently available or this language may not be supported.
Return to top
Show: