HTMLWindow.CurrentTabObject Property

Reference

Definition

Namespace:: EnvDTE

Assembly:: EnvDTE.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets the state (active or inactive) of the Source or the Designer tab in the HTML edit window.

public:
 property System::Object ^ CurrentTabObject { System::Object ^ get(); };

public:
 property Platform::Object ^ CurrentTabObject { Platform::Object ^ get(); };

[System.Runtime.InteropServices.DispId(5)]
public object CurrentTabObject { [System.Runtime.InteropServices.DispId(5)] get; }

[<System.Runtime.InteropServices.DispId(5)>]
[<get: System.Runtime.InteropServices.DispId(5)>]
member this.CurrentTabObject : obj

Public ReadOnly Property CurrentTabObject As Object

Property Value

Object

An object.

Attributes: DispIdAttribute

Examples

Sub CurrentTabObjectExample (ByVal dte As EnvDTE.DTE)  
    ' Open an HTML document before running this sample.  
    If TypeOf dte.ActiveDocument.ActiveWindow.Object Is HTMLWindow Then  
        ' Ask the user for a file to insert into the body of the HTML   
        ' document. This file should be an HTML fragment.  
        Dim strFile As String = InputBox("Enter the name of a file to _  
        insert at the end of the HTML document:")  
        ' Get the HTMLWindow object and determine which tab is   
        ' currently active.  
        Dim objHTMLWin As HTMLWindow = _  
        dte.ActiveDocument.ActiveWindow.Object  
        Dim Tab As vsHTMLTabs = objHTMLWin.CurrentTab  

        ' Switch to the "source" tab.  
        objHTMLWin.CurrentTab = vsHTMLTabs.vsHTMLTabsSource  

        ' Get an EditPoint at the start of the text.  
        Dim objTextWin As TextWindow = objHTMLWin.CurrentTabObject  
        Dim objEP As EditPoint = _  
        objTextWin.ActivePane.StartPoint.CreateEditPoint  

        ' Look for the end of the document body.  
        If objEP.FindPattern("</body>") Then  
            ' Insert the contents of the file.  
            objEP.InsertFromFile(strFile)  
        End If  

        ' Switch back to the original view of the HTML file.  
        objHTMLWin.CurrentTab = Tab  
    Else  
        MsgBox("You must open an HTML document.")  
    End If  
End Sub

public void CurrentTabObjectExample(_DTE dte)  
{  
    // Open an HTML document before running this sample.  
    if (dte.ActiveDocument.ActiveWindow.Object is HTMLWindow)  
    {  
        HTMLWindow 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 HTMLWindow object and determine which tab is   
        // currently active.  
        objHTMLWin = dte.ActiveDocument.ActiveWindow.Object as   
        HTMLWindow;  
        Tab = objHTMLWin.CurrentTab;  

        // Switch to the "source" tab.  
        objHTMLWin.CurrentTab = vsHTMLTabs.vsHTMLTabsSource;  

        // 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.");  
}

Remarks

If the current tab in the HTML edit window is the Source tab, the object returned is a TextWindow object. If the current tab is the Design tab, the object returned is an IHTMLDocument2 object.

Applies to

Condividi tramite