WebWindows Collection

A collection of WebWindow objects.

Remarks

Each WebWindow object represents an open Web site in Office SharePoint Designer. The WebWindow object is a member of the WebWindows collection.

Use WebWindows(Index), where Index is the index number of an item in the WebWindows collection, to return a single WebWindow object. The following example returns the Caption property for the fourth item in the WebWindows collection.

Function ReturnWebWindowCaption() As String
    Dim myCaption As String
    Dim myWebWindow As WebWindow
    Set myWebWindow = Application.WebWindows(3)
    myCaption = myWebWindow.Caption
    ReturnWebWindowCaption = myCaption
End Sub

Use the WebWindows property to return the WebWindows collection. The following example closes all of the open WebWindow objects in the WebWindows collection except the ActiveWebWindow object.

Private Sub CloseWebWindows
    Dim myWebWindows As WebWindows
    Dim myWebWindow As WebWindow
    Dim myActiveWebWindow As WebWindow
    Set myWebWindows = Application.WebWindows
    Set myActiveWebWindow = ActiveWebWindow
    For Each myWebWindow In myWebWindows
        If myWebWindow.Caption <> myActiveWebWindow.Caption Then _
            myWebWindow.Close
    Next
End Sub

Use the Application property to return the Application object. If you are working with the WebWindows collection and you want to check the version number of the application, you can easily access it by using the With myWebWindows statement as shown in the following example.

With myWebWindows
    myWebWindowCount = myWebWindows.Count
    myAppVersion =.Application.Version
    If myAppVersion < "4.0" Then
        MsgBox "Please upgrade your software."
    Else
        For Each myWebWindow In myWebWindows
            myCaption = myWebWindow.Caption
            With myPageWindows
                myPageCount = PageWindows.Count
            End With
        Next
    End If
End With

You can use the Close method to close an individual WebWindow object, multiple WebWindow objects, or all WebWindow objects in Office SharePoint Designer. For more details on the Close method, see the usage described in the following table.

Office SharePoint Designer closes the application if you use the Close method to close all WebWindow objects in Office SharePoint Designer.

Application.WebWindows(index).Close

Application.WebWindows.Close(index)

For Each myWebWindow In myWebWindows
    If myWebWindow.Caption <> _
        myActiveWebWindow.Caption Then _
        myWebWindow.Close
Next

Application.WebWindows.Close

Webs(index).WebWindows(index).Close

Set myWebWindows = Web(index).WebWindows
For Each myWebWindow In myWebWindows
    If myWebWindow.Caption _
      <> myActiveWebWindow.Caption Then _
        myWebWindow.Close
Next

Webs(index).WebWindows.Close

Use the Count property to return the number of WebWindow objects in the collection. The following example returns the number of WebWindow objects.

Web.WebWindows.Count

Use the Parent property when you want to return the container for the WebWindows collection. The following statement returns the Application object.

Application.WebWindows.Parent.Name

See Also

• WebWindows Object Members