Web Object Members

  • Article
SharePoint Designer Developer Reference

Represents a Web site.

Methods

  Name Description
Activate Activates the specified Webobject.
ApplyNavigationStructure Applies the navigation structure to the specified object.
ApplyTemplate Applies an existing HTML template to the current Web site.
ApplyTheme Applies the theme properties for a specified theme to a Web site.
AssociateWorkflow
CancelRequests Immediately cancels all requests to the Web object without saving.
Close Closes a Web site.
CreatePackage Returns a WebPackage object that represents a collection of pages, files, and folders and their related dependencies, such as images, cascading style sheets, and JavaScript files.
Delete Closes an open Web site and deletes the entire Web site from the file system or removes FrontPage metadata from the Web site.
ImportWebPackage Returns a PackageImportResult object that represents whether the specified package was imported or whether there were problems with the import.
LocateFile Returns a WebFile object that represents a single file in the specified Web site.
LocateFolder Returns a WebFolder object that represents a folder in the specified Web site.
LocatePage Locates an open page in a Web site and returns a PageWindow object that represents the page window in which the page is displayed.
Publish Publishes a Web site to a Web server.
RecalcHyperlinks Recalculates all metadata on the server for the specified Web site.
Refresh Refreshes an entire Web site.
UpdateDynamicTemplate Updates the pages that are attached to a Dynamic Web Template so that any changes to the Dynamic Web Template are applied to pages that reference the Dynamic Web Template.
VerifyAllLinks Verifies all hyperlinks in the specified Web site.

Properties

  Name Description
ActiveWebWindow Returns a WebWindow object that represents the window in which the currently open Web site is displayed.
AllFiles Returns a WebFiles collection that represents all files in the specified Web site.
AllFolders Returns a WebFolders collection that represents all folders in the current Web site.
AllNavigationNodes Returns a NavigationNodes collection object that represents all of the navigation nodes in the specified Web site.
AllowsLongFilenames Returns True if the operating system on the machine where the Web site resides accepts long file names. Read-only Boolean.
Application Returns an Application object that represents the 2nd_SPDesignerGeneric application.
ContributorGlobalSettings Read-only.
HomeNavigationNode Returns a NavigationNode object for the home page in a Web site.
IsHiddenFoldersEnabled True to display hidden folders in the specified Web site. Read/write Boolean.
IsUnderRevisionControl True if source control is used on files in the specified Web site. Read-only Boolean.
Lists Returns a Lists collection object that represents a collection of all lists in a Web site.
OptimizeHTMLPublishFlags Sets or returns one or more OptimizeHTMLFlags constants that represent how the HyperText Markup Language (HTML) in the pages of a Web site is optimized during publishing.
Parent Returns an Object that represents the parent object of the specified object. Read-only.
Properties Returns a Properties collection that represents the properties for a Web site.
RevisionControlProject Returns or sets a String that represents whether a Web site has revision control set.
RootFolder Returns a WebFolder object that represents the root of the active Web object.
RootNavigationNode Returns a NavigationNode object that represents the top-level navigation node. Read-only.
SharedBorders True if any shared borders are in use for the Web site. Read/write Variant.
ThemeProperties Sets the theme properties for a Web site.
Themes Returns a Themes collection that represents the themes that have been applied to the Web site. This is the same as the list that appears in the _theme directory of a Web site.
Title Returns a String that represents the title of a Web site.
Url Returns a String that represents the URL for a Web site.
WebWindows Returns a WebWindows collection that represents the Web sites open in 2nd_SPDesignerGeneric.
WorkflowDoclibUrl Returns a String that represents the URL to the document library that contains the workflows for a Web site. Read-only.

Events

  Name Description
OnAfterPublish Occurs after a Web site is published.
OnBeforePublish Occurs before a Web site is published.
OnClose Occurs when a user closes the active Web site window.
OnRecalculateHyperlinks Occurs before the hyperlink structure in Hyperlinks view is recalculated to view changes made to the Web site.
OnWebFileCheckOut Occurs when a file in the current Web site is checked out.