《SPS开发导引》word版.doc

SharePoint开发导引Microsoft SharePoint Product & Technology 开发导引V1.0拟 制 人_Richard Gao_ 日期2005-3-16审 核 人_ 日期批 准 人_ 日期NReserved目录1引言31.1编写目的31.2定义31.3阅读前提31.4参考资料32开发技术32.1Site Definition32.1.1直接修改源文件模板对各种元素进行定制42.1.2编写任意自定义的ASP.Net Application来修改目标元素52.2Customization52.2.1通过web UI的操作，定制某元素的Template62.2.2通过FrontPage 2003打开站点，对其自定义修改62.3Web Part62.3.1Build Web Part62.3.2Web Part Library Content62.3.3Web Part Life Cycle72.3.4Web Part Connection72.4Another Way (Document Library Events)8Appendix I9Appendix II181 引言1.1 编写目的SharePoint Product & Technology是Microsoft公司推出的系列服务器组件中的重要单元。在这套产品中，Microsoft推出了很多重要的概念和技术趋势。本文就是对这种新概念、新技术的引导性的介绍。她总结了NESC内部经过研发而得到的知识积累，为后续应用这一技术领域的人员提供研发导向。 1.2 定义WSS-Microsoft Windows SharePoint ServicesSPSMicrosoft SharePoint Portal Server1.3 阅读前提阅读本文之前，读者应该对SharePoint产品的组成，构成Portal的各项元素，SPS和WSS的基本操作有大致了解。并且对ASP.Net，C#，SQL Server比较熟悉。最好有.Net Framework和Visual Studio .Net的实际使用背景。1.4 参考资料1Microsoft SharePoint Products and Technologies 2003 Software Development Kit2 /library/en-us/odc_2003_ta/html/odc_landsppt03_ta.asp 2 开发技术就SharePoint开发技术而言主要有3个领域：Site Definition，Customization，Web Part。下面将分别介绍各项技术。2.1 Site DefinitionSite Definition包括2方面的修改定义。l 通过直接修改源文件模板，从而对各种元素进行定制；l 通过编写任意自定义的ASP.Net Application来修改目标元素。2.1.1 直接修改源文件模板对各种元素进行定制SharePoint中所有运行的源文件（包括各种资源文件）都在这个物理位置：Drive:Program FilesCommon FilesMicrosoft SharedWeb Server Extensions60Template其中，每个子文件夹中又分别是与标题相对应的运行文件。例如，SQL文件夹中保存的就是SharePoint自己生成的存储过程文件。各个区域运用的模板文件和WSS的站点模板文件就在1033文件夹下。它们的对应关系见下表：TemplateMaps toSPSHomeSPSBWEBTo create bucket Web sitesSPSCOMMUCommunitiesSPSMSITESite RegistrySPSNEWSSubareas under NewsSPSNHOMENews HomeSPSPERSMySiteSPSTOCTopics HomeSPSTOPICTopicSTSTeam SitesMPSTeam WorkStations用VS.Net或者FrontPage2003或者其它任何编辑工具打开具体的文件（注意：是打开文件而不是打开站点）就可以对文件进行任意修改。为了保持原模板的最初状态，建议以原模板的副本为基准建立自己的模板，并且把自己的模板通过60BINSTSADM.exe这个工具发布，以后就可以在需要指定模板的时候在DropdownListBox / ListBox中看见自己定制的模板了。在修改的模板源文件中主要涉及到如下namespace中的对象：Microsoft.SharePoint;Microsoft.SharePoint.WebControls;Microsoft.SharePoint.WebPartPages;Microsoft.SharePoint.Portal;Microsoft.SharePoint.Portal.WebControls;Microsoft.SharePoint.Portal.WebPartPages;具体如何应用，请参见Microsoft SharePoint Products and Technologies 2003 Software Development Kit中的Platform和Applications。另外，需要强调几个特别重要的文件。这几个文件是对Site Definition的深层次的应用。它可以对对象的很多细粒度的基本Schema进行定制：- Onet.xml - for “site” definition (每个模板都有)- Schema.xml - for “list” definition (每个模板的子元素都有)- Webtemp.xml - for specifying available configurations 60template1033XML(所有模板共有，显示模板列表时的配置文件)2.1.2 编写任意自定义的ASP.Net Application来修改目标元素可以通过编写自定义的ASP.Net Application来定制SPS和WSS中的各种元素。具体方法如下：Step1: 在IIS中增加允许执行的文件(.tmp);Step2: 用VS.Net在http:/_layout/ 建立Web Application，VS.Net将会在Drive:Program FilesCommon FilesMicrosoft SharedWeb Server Extensions60TemplateLayouts建立一个以命名的文件夹，存放此Web Application的文件。Step3: Programming;运用Microsoft.SharePoint namespace以及相关的namespace可以完成SPS和WSS支持的所有定制功能。Step4: Implement the application2.2 CustomizationCustomization和Site Definition的主要区别在于：Site Definition的变动会直接保存在模板源文件中；Customization的变动不会修改模板源文件，只会在SPS或WSS自身维护的数据库中记录相应的定制参数。在实际的load page过程中，SharePoint会首先到Database中查找目的页面的custom参数。如果找到了就将这个带有custom参数的page返回给浏览器，否则就去物理路径下文件系统找到应用的模板，将page返回给浏览器。Customization也包括2方面的定制：l 通过web UI的操作，定制某元素的Template，以后可以根据这个Template创建相应的元素对象；l 通过FrontPage 2003打开站点，对其自定义修改。2.2.1 通过web UI的操作，定制某元素的Template全部是在Web页面上直接操作，可以将任何ShsrePoint支持的对象经过定制后保存为Template供以后使用。详细操作方法请参见Microsoft Office SharePoint Portal Server 2003 Administrators Guide和Microsoft Windows SharePoint Services 20. Administrators Guide。2.2.2 通过FrontPage 2003打开站点，对其自定义修改在FrontPage 2003中打开站点，打开需要自定制的页面文件进行自定制。自定制过程中同样运用Microsoft.SharePoint namespace以及相关的namespace中的支持。2.3 Web PartWeb Part是Microsoft推出的全新概念。将页面元素以组件方式生成，并以这些组件实现快速高效的Site自定义、部署。2.3.1 Build Web PartStep1: Install “Web Part Template”(Web Part Template is a component from Microsoft);Step2: Create “Web Part Library” within VS.Net (Inherited from WebPart class);Step3: Register the Web Part control within web.config file in servers root (Information from the Manifest.xml file and .dwp file);Step4: Build applicationStep5: Create a folder named “bin” into wwwroot rootStep6: Copy the .dll file into bin folder;Step7: Import .dwp file into SharePoint site.2.3.2 Web Part Library Contentl WebPart1.cs - programming business logicl WebPart1.dwp - import to SharePoint sitel AssemblyInfo.cs - version and strongnamel Manifest.xml - deployment config file所要完成的业务逻辑代码全部在WebPart1.cs中完成，这个文件中的WebPart1 class继承Microsoft.SharePoint.WebPartPages.WebPart class。其中，最常用的方法RenderWebPart(HtmlTextWriter output) 是用来显示输出的。其他方法请参见Microsoft SharePoint Products and Technologies 2003 Software Development Kit中关于这个class的详细描述。2.3.3 Web Part Life Cycle2.3.4 Web Part ConnectionWeb Part是支持互相之间传递消息的。Microsoft提供了IProvider和IConsumer来实现Connectable Interface。顾名思义，IProvider用于实现提供消息，IConsumer用于实现接收消息。以下是Microsoft提供的Provider和Consumerl ICellProvider / ICellConsumerl IRowProvider / IRowConsumerl IListProvider / IListConsumerl IFilterProvider / IFilterConsumerl IParametersOutProvider / IParametersOutConsumerl IParametersInProvider / IParametersInConsumer他们的详细使用方法请参见Microsoft SharePoint Products and Technologies 2003 Software Development Kit中关于IProvider和IConsumer协作的内容。2.4 Another Way (Document Library Events)通过编程，将生成的.dll放入GAC, 可以定义Document Library Events。这样，可以扩展联想到用Lists定义workflow。The system must allow us to specify:1. A List of Approves for a Document Library in a certain order;2. Approves can be controlled by level.Appendix IWhen use the Object-Modle to develop, the below lists of namespace is very important.WSS Namespace:NamespaceDescriptionMicrosoft.HTMLTrans.InterfaceAllows you to write custom applications that can create an HTML version of documents stored on a server running Windows SharePoint Services for users who do not have the required client application or viewer installed on their computers.Microsoft.SharePointProvides types and members for working with a top-level site and its subsites or lists.Microsoft.SharePoint.AdministrationUsed for managing the server or server farm in a deployment of Windows SharePoint Services. Microsoft.SharePoint.DspProvides the base class for the data retrieval service adapters used in Microsoft Windows SharePoint Services. Microsoft.SharePoint.Dsp.OleDbProvides the data retrieval service adapter for performing queries against OLE DB data sources.Microsoft.SharePoint.Dsp.SoapPTProvides the data retrieval service adapter for performing pass-through queries against arbitrary Web services.Microsoft.SharePoint.Dsp.StsProvides the data retrieval service adapter for performing queries against sites, lists, and document libraries in Microsoft Windows SharePoint Services.Microsoft.SharePoint.Dsp.XmlUrlProvides the data retrieval service adapter for performing queries against arbitrary XML data sources.Microsoft.SharePoint.MeetingsProvides types and members that can be used to customize Meeting Workspace sites.Microsoft.SharePoint.SecurityProvides a set of code access permission and attribute classes designed to protect a specific set of resources and operations, such as access to the Windows SharePoint Services object model, the ability to do unsafe saving on HTTP Gets, and enabling point-to-point WebPart connections.Microsoft.SharePoint.SoapServerContains classes that implement the Windows SharePoint Services Web Service and Web services for working with Web Part pages and Web Parts. In most cases, the members of these classes are not designed to be called from the server but remotely from client applications.Microsoft.SharePoint.UtilitiesUsed for various purposes, including encoding strings and processing user information.Microsoft.SharePoint.WebControlsProvides server controls that are used on site and list pages in a SharePoint site. Its major class is SPControl, from which other controls in this namespace are derived.SPS Namespace:NamespaceDescriptionMicrosoft.SharePoint.PortalContains classes that create the Web-based components and services of the portal site, such as areas and resource management. Microsoft.SharePoint.Portal.AdminThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.Admin.DMThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.Admin.SearchContains classes that support administration of the Search service.Microsoft.SharePoint.Portal.Admin.Search.WebControlsThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.AlertsContains classes that implement the Alerts feature in SharePoint Portal Server. Microsoft.SharePoint.Portal.Alerts.NotificationTypesContains classes that implement notification types for alerts. Microsoft.SharePoint.Portal.Alerts.TypesContains classes that implement types of alerts that can exist in SharePoint Portal Server. Microsoft.SharePoint.Portal.Alerts.WebServiceThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.AudienceContains classes that create audiences and target data to a specific set of users.Microsoft.SharePoint.Portal.Audience.AdminUIThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.DiagnosticsThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.InfrastructureThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.InstallThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.IntegrationThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.SchemaThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.SearchContains classes that implement the query interface for the Search service.Microsoft.SharePoint.Portal.Search.AdminThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.Search.Admin.NotesWizardThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.Search.Admin.PagesThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.Search.Admin.PropertiesThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.Search.Admin.PropertyPropertiesThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.Search.Admin.SearchConfigThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.Search.Admin.WebControlsThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.Search.ObjectModelContains classes that define a search scope list and the search scopes that it contains.Microsoft.SharePoint.Portal.Search.PortalCrawlThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.Search.WebQueryServiceContains classes that implement the Query Service, a Web service in SharePoint Portal Server that provides a query interface for remote clients.Microsoft.SharePoint.Portal.SecurityContains classes that help manage security on a portal site.Microsoft.SharePoint.Portal.ServerAdminThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.SingleSignonContains classes that allow you to centralize account credentials from multiple application definitions through a single portal that uses secured applications.Microsoft.SharePoint.Portal.SingleSignonAdministrationThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.SingleSignOn.SecurityContains classes that control the ability to access Single SignOn object model resources.Microsoft.SharePoint.Portal.SiteAdmin.DMThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.SiteAdmin.GeneralThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.SiteAdmin.UpgradeThe members of this class or namespace are reserved for internal use. It is recommended that you refrain from using unsupported classes or members when developing solutions for Microsoft SharePoint Products and Technologies.Microsoft.SharePoint.Portal.SiteDataContains classes that help manage areas and listings.Microsoft.SharePoint.Portal.TopologyContains classes that configure and manage the topology of a server or server farm deployment for Microsoft Office SharePoint Portal Server 2003. These classes allow you to identify, configure, and manage various server components and services such as database or search components across a deployment of SharePoint Portal Server.Microsoft.SharePoint.Portal.UserProfilesContains classes that create, manage, and personalize user profiles. Microsoft.SharePoint.Portal.UserProfiles.AdminUIThe members of this class or namespace are