Export (0) Print
Expand All

Publishing Programming Model in SharePoint Server 2010 (ECM)

SharePoint 2010

Last modified: April 19, 2010

Applies to: SharePoint Server 2010

This topic introduces the Web Content Management (WCM) programming model. For a complete list of the types available in each namespace, click the link to that namespace.

This section introduces the namespaces in the WCM APIs.

Table 1. Namespaces in the WCM APIs

Namespace

Description

Microsoft.SharePoint.Publishing

Includes classes that provide the fundamental publishing infrastructure for Web content management (WCM).

Microsoft.SharePoint.Publishing.Administration

Includes classes that provide content deployment configuration, path, and job functionality.

Microsoft.SharePoint.Publishing.Administration.WebServices

Includes Web services that support the classes in the Microsoft.SharePoint.Publishing.Administration namespace.

Microsoft.SharePoint.Publishing.Cmdlet

Includes the Windows PowerShell cmdlet object model for publishing features.

Microsoft.SharePoint.Publishing.Fields

Includes classes that define fields, field values, and field behavior. Topics that these classes cover include base types; the Content Type ID; HTML fields, tags, and validation; image fields and field values; publishing schedule start dates and end dates; and summary link fields and field values.

Microsoft.SharePoint.Publishing.Navigation

Includes classes that represent the node, typing, collection, data source, provider, and proxy functionality that supports Microsoft SharePoint Server 2010 navigation.

Microsoft.SharePoint.Publishing.WebControls

Includes classes that define the structure, appearance, and behavior of Microsoft SharePoint Server 2010 Web controls. These include the console infrastructure; base fields and selector; and other container, display, display type, field, panels, state objects, and Web Parts that SharePoint Server 2010 delivers.

Microsoft.SharePoint.Publishing.WebControls.EditingMenuActions

Includes classes that define behaviors that are available to the Microsoft SharePoint Server 2010 Editing menu. The menu supports common actions such as add, check in, check out, copy, decline, exit, delete, modify, move, and save. It also supports actions that are specific to other SharePoint Server 2010 functionality, such as creating new sites and pages, importing Web Parts, implementing Quick Deploy actions, switching modes, and managing workflows.

Microsoft.SharePoint.Publishing.WebServices

Includes Web services that support the publishing infrastructure and control tools.

This section introduces the most notable types in the WCM APIs.

Table 2. Notable Microsoft.SharePoint.Publishing types

Type

Description

CbqQueryCache

Caches the CbqQueryVersionInfo for a specified Content By Query Web Part.

IDocumentConverterControl

Used for exposing the settings of document converters to the user. It is implemented by user controls that expose settings.

PublishingPage

Provides publishing-related behavior for an .aspx page that is stored in a PublishingWeb object.

PublishingSite

Provides publishing behavior for an SPSite object that supports publishing.

PublishingWeb

Provides publishing behavior for an SPWeb instance that supports publishing.

PublishingWebCollection

Represents a collection of PublishingWeb objects.

SummaryLink

A SummaryLink object that provides a way to store Web addresses.

Table 3. Notable Microsoft.SharePoint.Publishing.Administration types

Type

Description

ContentDeploymentSqlSnapshotSetting

Specifies whether a content deployment job uses a Microsoft SQL Server snapshot for the export operation.

PathAuthenticationOption

Specifies the authentication method on the content deployment path that is used to log on to the destination server.

Table 4. Notable Microsoft.SharePoint.Publishing.Navigation types

Type

Description

PortalNavigation

Represents navigation for portal pages and other portal navigation objects.

SiteNavigationSettings

Provides cached read access to the portal navigation settings for a specified site collection.

Table 5. Notable Microsoft.SharePoint.Publishing.WebControls types

Type

Description

AssetUrlSelector

Renders an HTML input field and button or generates that opens the Asset Picker dialog box that is used to select a link or image URL from a site collection.

ContentByQueryWebPart

A ContentByQueryWebPart object uses the CrossListQueryCache object to retrieve data. The data retrieved is cleaned and then sent to the XSLT engine. The XSLT engine uses the defaultHeader.xsl, defaultItem.xsl, and defaultMain.xsl files to translate the data into HTML markup that is presented to the user. You can customize the HTML output of the ContentByQueryWebPart by using the XSL transform. The DataProcessDelegate allows you to retrieve data to be modified before it is sent to the XSLT engine. If the Data property of this Web Part is specified, the data is not retrieved and the specified data is used instead. The ContentByQueryWebPart object derives from the CmsDataFormWebPart object that caches XSLT transforms.

ConsoleNode

Represents the basic structure that is used for the Console menu. Each ConsoleNode object can optionally have child ConsoleNode objects and associated console ConsoleAction objects.

Table 6. Notable Microsoft.SharePoint.Publishing.WebControls.EditingMenuActions type

Type

Description

ConsoleAction

Represents the base class that all specific console actions that are used in the ConsoleDataSource must inherit.

Show:
© 2014 Microsoft