PublishingWeb members

  • Article

Provides publishing behavior for an SPWeb instance that supports publishing.

The PublishingWeb type exposes the following members.

Properties

  Name Description
Public property AlternateCssUrl Gets the URL that points to the alternate cascading style sheets (CSS) file for this PublishingWeb object.
Public property AnonymousPageCacheProfileId Gets or sets the identifier (ID) of the ASP.NET output cache profile for this PublishingWeb object.
Public property Audience Gets or sets a string representing the audience whom this PublishingWeb targets.
Public property AuthenticatedPageCacheProfileId Gets or sets the identifier (ID) of the authenticated page output cache profile for this PublishingWeb object.
Public property CreatedBy Gets the SPUser who created this PublishingWeb object.
Public property CreatedDate Gets the date and time that this PublishingWeb was created.
Public property CustomMasterUrl Gets the custom master URL for this PublishingWeb object.
Public propertyStatic member DefaultDefaultPageName Gets the default URL name for the Welcome page for this PublishingWeb object.
Public property DefaultPage Gets and sets the Welcome page for this PublishingWeb object.
Public property DefaultPageLayout Gets the URL token that is used when creating “one-click” pages within this PublishingWeb.
Public propertyStatic member DefaultPagesListName Gets the default URL name that is used for the pages list in the existing locale for this PublishingWeb object.
Public property Description Gets or sets the description string for this PublishingWeb object.
Public property DocumentsLibrary Gets the designated Documents list of the current PublishingWeb object.
Public property ImagesLibrary Gets the specified Images list of the current PublishingWeb object.
Public property IncludeInCurrentNavigation Controls whether this Web site is included by PortalSiteMapProvider objects that have NavigationType set to Current.
Public property IncludeInGlobalNavigation Gets or sets a value that indicates whether this Web site is included by PortalSiteMapProvider objects that have NavigationType set to Global.
Public property IncludePagesInNavigation Obsolete. Gets or sets a value that indicates whether to automatically include pages in navigation.
Public property IncludeSubSitesInNavigation Obsolete. Gets or sets a value that indicates whether to automatically include subsites, or any type of SPWeb object, in navigation.
Public property InheritCurrentNavigation Obsolete. Gets or sets a value that indicates whether the current navigation should be inherited.
Public property InheritGlobalNavigation Obsolete. Gets or sets a value that indicates whether this PublishingWeb object should display its own global navigation or should use the global navigation of its parent.
Public property IsAllowingAllPageLayouts Gets a Boolean value that indicates whether the available PageLayout objects that are returned by the GetAvailablePageLayouts method are the complete set of page layouts.
Public property IsAllowingAllWebTemplates Gets a Boolean value that indicates whether the available Web templates that are returned by the GetAvailableWebTemplates() method are the complete set.
Public property IsInheritingAvailablePageLayouts Gets a Boolean value that indicates whether the available PageLayout objects that are returned by the GetAvailablePageLayouts method are inherited from the parent PublishingWeb() object.
Public property IsInheritingAvailableWebTemplates Gets a Boolean value that indicates whether the available Web templates that are returned by the GetAvailableWebTemplates() method are inherited from the parent PublishingWeb.
Public property IsInheritingDefaultPageLayout Specifies the page layout that will be used when creating “one-click” pages within this PublishingWeb object through the UI.
Public property IsInheritingNewPageUrlToken Gets a Boolean value indicating whether the new page URL token that is returned by the NewPageUrlToken property is inherited from the parent PublishingWeb object.
Public property IsRoot Gets a Boolean value that determines whether this PublishingWeb object is the root SPWeb object.
Public property Label Gets the VariationLabel object in whose hierarchy this PublishingWeb object is situated.
Public property LastModifiedDate Gets the date and time that an item in this PublishingWeb object was last modified.
Public property MasterUrl Gets the master URL for this PublishingWeb object.
Public property Name Gets or sets the URL name of this PublishingWeb object.
Public property Navigation Gets a PortalNavigation object that represents the navigation settings for the current publishing Web.
Public property NavigationAutomaticSortingMethod Obsolete. Gets or sets an enumeration value which indicates the sort method to use when automatically sorting navigation items owned by this PublishingWeb object.
Public property NavigationOrderingMethod Obsolete. Gets or sets an enumeration value that indicates the ordering of navigation items owned by this PublishingWeb object.
Public property NavigationShowSiblings Obsolete. Gets or sets a value that indicates whether this Web site should display siblings of the current Web site in current navigation.
Public property NavigationSortAscending Obsolete. Gets or sets a Boolean value that indicates whether navigation of this PublishingWeb object is sorted in ascending or descending order.
Public property NewPageUrlToken Gets the URL token that is usede when creating “one-click” pages within the current PublishingWeb object.
Public property PagesList Gets the pages list in which PublishingPage objects are stored for this PublishingWeb object.
Public property PagesListId Gets or sets the ID of the pages list in which the PublishingPage objects are stored for this PublishingWebobject.
Public property PagesListName Gets or sets the URL name of the pages list in which PublishingPage objects are stored for this PublishingWeb object.
Public property ParentPublishingWeb Gets the parent SPWeb object as a PublishingWeb instance.
Public property ThemedCssFolderUrl Gets the URL of the folder containing the themed CSS for the current PublishingWeb object, or a null reference (Nothing in Visual Basic) if no theme is applied.
Public property Title Gets or sets the title of the PublishingWeb object.
Public property Uri Gets the URI of this PublishingWeb object.
Public property Url Gets the URL for this PublishingWeb object.
Public property VariationPublishingWebUrls Gets a collection of URLs of the variant publishing Webs associated with this PublishingWeb object
Public property Web Gets the SPWeb object that is wrapped by this PublishingWeb instance.

Top

Methods

  Name Description
Public method AddPublishingPage() Creates a new PublishingPage object in the PublishingWeb.
Public method AddPublishingPage(String, PageLayout) Creates a new PublishingPage object in the PublishingWeb.
Public method AddPublishingPage(String, PageLayout, SPFolder) Creates a new PublishingPage object in the PublishingWeb.
Public method AddPublishingPage(String, SPFile, Guid, PageConversionPriority) Obsolete. Creates a new PublishingPage object in the PublishingWeb.
Public method AddPublishingPage(String, SPFile, Guid, PageConversionPriority, SPFolder) Obsolete. Creates a new PublishingPage object in the PublishingWeb.
Public method AddPublishingPage(String, SPFile, Guid, String, PageConversionPriority) Creates a new PublishingPage object in the PublishingWeb.
Public method AddPublishingPage(String, SPFile, Guid, String, PageConversionPriority, SPFolder) Creates a new PublishingPage object in the PublishingWeb.
Public method AllowAllPageLayouts Resets the available PageLayout objects on this PublishingWeb to the complete set of layouts.
Public method AllowAllWebTemplates Resets the available Web templates on this PublishingWeb object to the complete set of Web templates.
Public method Close Closes the wrapped SPWeb object if it was instantiated internally.
Public method Delete() Deletes the current PublishingWeb object.
Public method Delete(Boolean) Deletes the current PublishingWeb instance and potentially all sites in the subtree with a node in this PublishingWeb.
Public methodStatic member DisableScheduling Disables scheduling behavior on an SPList object.
Public methodStatic member EnableScheduling Enables scheduling behavior on an SPList object.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetAvailableCrossLanguageWebTemplates Returns the cross-language Web templates available for creating subsites below this PublishingWeb.
Public method GetAvailablePageLayouts() Returns the PageLayout objects available for creating PublishingPage objects within this PublishingWeb.
Public method GetAvailablePageLayouts(SPContentTypeId) Returns the PageLayout objects available for creating PublishingPage objects within this PublishingWeb object, filtered by an associated SPContentTypeId object.
Public method GetAvailableWebTemplates Returns the Web templates available for creating subsites below this PublishingWeb.
Public method GetHashCode (Inherited from Object.)
Public methodStatic member GetIsSchedulingEnabled Returns the web templates that are available for creating subsites below this PublishingWeb object.
Public methodStatic member GetPagesListId Returns ID of the pages list in which PublishingPage objects are stored for this PublishingWeb object.
Public methodStatic member GetPagesListName The URL name of the pages list in which PublishingPage objects are stored for this PublishingWeb.
Public method GetPublishingPage(Int32) This member is reserved for internal use and is not intended to be used directly from your code.
Public method GetPublishingPage(String) This member is reserved for internal use and is not intended to be used directly from your code.
Public method GetPublishingPages() Gets a collection of PublishingPage objects contained in this PublishingWeb object.
Public method GetPublishingPages(SPQuery) Gets a collection of PublishingPage objects contained in this PublishingWeb object.
Public method GetPublishingPages(String) Gets a collection of PublishingPage objects contained in this PublishingWeb object.
Public method GetPublishingPages(UInt32) Gets a collection of PublishingPage objects contained in this PublishingWeb object.
Public method GetPublishingPages(String, UInt32) Gets a collection of PublishingPage objects that are contained in this PublishingWeb object.
Public methodStatic member GetPublishingWeb Retrieves an instance of the PublishingWeb that wraps the specified SPWeb object.
Public method GetPublishingWebs Returns child PublishingWeb objects immediately below this PublishingWeb object.
Public method GetType (Inherited from Object.)
Public method GetVariation(VariationLabel) Gets the peer Variation Publishing site of this PublishingWeb object for the given varlabel.
Public method GetVariation(VariationLabel, Boolean) Get the peer variation PublishingWeb object of this PublishingWeb object for the given label.
Public method GetVariationUrlFromSourceUrl Returns the current Variation URL for the current PublishingWeb object for a specific source PublishingWeb location.
Public method InheritAvailablePageLayouts Sets the PageLayouts available on this PublishingWeb object to be inherited from the parent PublishingWeb object.
Public method InheritAvailableWebTemplates Sets the available web templates on this PublishingWeb to be inherited from the parent PublishingWeb.
Public method InheritDefaultPageLayout Sets the new page URL token on this PublishingWeb object to be inherited from the parent PublishingWeb object.
Public method InheritNewPageUrlToken This member is reserved for internal use and is not intended to be used directly from your code.
Public methodStatic member IsPublishingWeb Checks the SPWeb object to verify whether it is a PublishingWeb object.
Public method IterateOverAllPages Iterates over all PublishingPage objects in the current PublishingWeb object and processes each PublishingPage by using the given delegate.
Protected method MemberwiseClone (Inherited from Object.)
Public method SetAvailableCrossLanguageWebTemplates Specifies the cross-language Web templates that are available for creating subsites below this PublishingWeb object.
Public method SetAvailablePageLayouts Specifies PageLayout objects that are available for use in creating PublishingPage objects within this PublishingWeb object.
Public method SetAvailableWebTemplates Specifies the Web templates that are available for creating subsites below this PublishingWeb object for a specific locale
Public method SetDefaultPageLayout Specifies the URL token that will be used when creating “one-click” pages within the current PublishingWeb object.
Public method SetNewPageUrlToken Sets the available web templates on this PublishingWeb object to be inherited from the parent PublishingWeb object.
Public method ToString (Inherited from Object.)
Public method Update Saves changes to this PublishingWeb object.

Top

See also

Reference

PublishingWeb class

Microsoft.SharePoint.Publishing namespace