设为首页 收藏本站
查看: 1257|回复: 0

[经验分享] SharePoint WebPart开发实战(一):定制属性及配置界面

[复制链接]

尚未签到

发表于 2017-5-24 10:39:48 | 显示全部楼层 |阅读模式
最近一段时间都在研究SharePoint下的开发,感觉SharePoint中的内容还是比较繁杂的,不知道自己入了门没有?顺手记录下了开发过程中的 一些心得和体会,以加深自己的理解和掌握,如有不对的地方,还请各位不吝指正。今天先讲讲SharePoint下Web Part的开发,这应该算是SharePoint下最常见的开发了吧,今天的重点是关于自定义属性及配置界面的实现。

一、开发环境
(1)Windows 2003 Server
  (2)Windows SharePoint Service 3.0(或Microsoft Office SharePoint Server 2007)
  (3)Visual Studio 2005
  (5)SQL Server 2005
  (6)Windows SharePoint Services 3.0 Tools: Visual Studio 2005 Extensions
   (7)Windows SharePoint Services SDK 3.0

二、WSS 2.0和WSS 3.0下Web Part开发的不同
众所周知,Windows SharePoint Service 3.0(以下简称WSS 3.0)是基于ASP.NET 2.0进行了重写,因此与WSS 2.0有很多地方存在一些不同。对于Web Part的开发,也是如此。目前网络上的很多资料介绍的Web Part开发,还是基于WSS 2.0的,而非WSS 3.0风格的。
Web Part是首先在WSS 2.0作为仪表板(Dashboard)的替代技术引入的,后来ASP.NET 2.0中也引入了一个新版本的Web Part Framework,该框架可以脱离SharePoint的环境运行。WSS 3.0的Web Part框架也基于该ASP.NET Web Part Framework进行了完全的重构。不过为了兼容性(主要是考虑到以前的解决方案的升级),原WSS 2.0的Web Part框架也得以保留,但对于以后的开发而言,都应该基于WSS 3.0的ASP.NET框架进行。
例如,基于WSS 2.0的Web Part都是从 Microsoft.SharePoint.WebPartPages.WebPart类派生的,而WSS 3.0的Web Part应该从标准的ASP.NET类System.Web.UI.WebControls.WebParts.WebPart继承。下表是基于 ASP.NET Web Part Framework中一些新的属性和类型,以及为了兼容性而保留的对应WSS 2.0模型中的属性和类型,具体的示例将在下面的章节中出现。

ASP.NET Web Parts
SharePoint Backward Compatibility  
WebBrowsableAttribute
BrowsableAttribute
WebDisplayName
FriendlyName
WebDescription
Description
Personalizable
WebPartStorage
PersonalizationScope
Storage
EditorPart
ToolPart
EditorPartCollection
ToolPart[]
CreateEditorParts()
GetToolParts()
RenderContents()
RenderWebPart()
SetPersonalizationDirty()
SaveProperties

三、SharePoint Web Part开发基础
Web Part是一种特殊类型的Web Control(Web控件),它被部署于Web Part Zone控件内。虽然基于ASP.NET的Web Part Framework可以脱离WSS环境运行,但是WSS 3.0中的Web Part Framework提供了一些附加的功能,包括:动态SharePoint站点模型、模板框架、安全框架以及使用WSS Web Part Gallery的Web Part管理。以下二图就是Web Part开发中涉及的基本类,虽然SharePoint针对Web Part Zone和Web PartManager类有特定的实现,但是我们仍将使用ASP.NET Web Part类作为我们开发Web Part应用程序的基类。
DSC0000.gif



DSC0001.gif

WSS 3.0中使用的Web Part Manager类为SPWebPartManager,它是在页面Web Part Zone对象和SharePoint内容数据库之间的桥梁。当在页面中添加一个Web Part时,实际上是在内容数据库中加入了一个Web Part的序列化实例。对于一个最简单的Web Part而言,只需从Web Part 基类System.Web.UI.WebControls.WebParts.WebPart.派生一个具体类,然后重写RenderContents方 法来以HTML方式呈现该Web Part,就像在ASP.NET中开发Web控件一样。一个Web Part的生命周期如下表所示:

方法/事件
描述
OnInit
处理控件的初始化
OnLoad
处理控件的装载
CreateChildControls
创建子控件
EnsureChildControls
确保CreateChildControls方法被调用,使用该方法来确保在访问控件的数据之前控件已经存在。  
OnPreRender
处理在呈现可控件之前必须完成的任务,例如数据装载。异步页面任务应该从该方法中被启动。
Page.PreRenderComplete
在所有的控件都完成其OnPreRender 方法并且页面已经完成了异步任务的执行之后,将会触发该事件。
Render
呈现整个控件,包括外部标签。
RenderContents
仅仅呈现控件在外部标签和样式属性内的内容。


四、Web Part属性
除了类似输出”Hello World“这样内容的最简单Web Part之外,一般实际的Web Part都是可动态配置的,这是通过Web Part属性来实现的。
在WSS 2.0中,一个Web Part属性是这样子的:
DSC0002.gif
[Description(
"DataSourceName"),
Category(
"Miscellaneous"),
DefaultValue(
""),
WebPartStorage(Storage.Shared),
FriendlyName(
"DataSourceName"),
Browsable(
false)]
publicstringDataSourceName
DSC0003.gif DSC0004.gif
...{
DSC0005.gif DSC0006.gif
get...{returnthis.dataSourceName;}
set...{this.dataSourceName=value;}
}




  当然,这不是我们推荐的用法,而应该采用如下新的语法:
[WebDescription("DataSourceName"),
Category(
"Miscellaneous"),
DefaultValue(
""),
Personalizable(PersonalizationScope.Shared),
WebDisplayName(
"DataSourceName"),
WebBrowsable(
false)]
publicstringDataSourceName
...{
get...{returnthis.dataSourceName;}
set...{this.dataSourceName=value;}
}




上述两个声明是完全等价的,大家可以参考第二节中的对应表来一一比较。注意到上述属性中WebBrowsable的属性为false,如果该属性为 true的话,就是使用默认的属性编辑界面,也就是一个文本输入框,如果想定制该属性的输入界面,则应该将WebBrowsable属性置为false, 然后提供定制属性界面。
在WSS 2.0中,自定义属性配置界面是通过重写Web Part的GetToolParts方法实现的,例如:

/**////<summary>
///配置界面。
///</summary>
///<returns></returns>
publicoverrideToolPart[]GetToolParts()
...{
ToolPart[]tools
=newToolPart[3];
tools[
0]=newMicrosoft.SharePoint.WebPartPages.WebPartToolPart();
tools[
1]=newMicrosoft.SharePoint.WebPartPages.CustomPropertyToolPart();
tools[
2]=new MyToolPart();
tools[
2].Title="My Properties";
returntools;
}



其中,Microsoft.SharePoint.WebPartPages.WebPartToolPart类提供标准的属性配置界面,如布局,大小等;而Microsoft.SharePoint.WebPartPages.CustomPropertyToolPart则提供默认的自定义属性配置界面,这是利用反射实现的,如上述属性WebBrowsable为false,则意味着使用该类来提供默认的配置界面;而第三项MyToolPart则是为自己实现的定制配置界面。
因为这是WSS 2.0中已经过时的用法,所以在此不再详述,我们重点关注一下WSS 3.0中的对应的实现。在WSS 3.0(ASP.NET 2.0)中,
自定义属性配置界面是通过重写Web Part的CreateEditorParts方法实现的:
/**////<summary>
///配置界面。
///</summary>
///<returns></returns>
publicoverrideEditorPartCollectionCreateEditorParts()
...{
EditorPartCollectionbaseParts
=base.CreateEditorParts();
List
<EditorPart>editorParts=newList<EditorPart>(1);
EditorPartpart
=newMyEditorPart();
part.ID
=this.ID+"_MyEditor";
editorParts.Add(part);
returnnewEditorPartCollection(baseParts,editorParts);
}



要实现一个EditorPart,最简单的是重写三个方法:
  (1)CreateChildControls:负责创建EditorPart的子控件
  (2)ApplyChanges:保存配置到Web Part的属性
  (3)SyncChanges:从Web Part属性初始化EditorPart

以下是一个具体的WebPart的代码:
usingSystem;
usingSystem.Runtime.InteropServices;
usingSystem.Web.UI;
usingSystem.Web.UI.WebControls.WebParts;
usingSystem.Xml.Serialization;
usingMicrosoft.SharePoint;
usingMicrosoft.SharePoint.Utilities;
usingSystem.ComponentModel;
usingSystem.Collections.Generic;

namespaceKingFactoryTagValueWebPart2
{
[Guid(
"3fd90ae1-9ff9-4b5e-8262-ac2649be9ebe")]
publicclassKingFactoryTagValueWebPart2:System.Web.UI.WebControls.WebParts.WebPart
{
privatestringdataSourceName;
privatestringrtTagName;
privatestringrefreshInterval;
privatestringwebUrl;

///<summary>
///构造函数。
///</summary>
publicKingFactoryTagValueWebPart2()
{
this.ExportMode=WebPartExportMode.All;
this.refreshInterval="5000";

}

///<summary>
///输出错误信息。
///</summary>
///<paramname="writer"></param>
///<paramname="errorInfo"></param>
privatevoidRenderError(HtmlTextWriterwriter,stringerrorInfo)
{
stringcontent="<span><tableclass="ms-WPBody"style="padding:0px;width:100%;">"+
"< tr><tdvalign="top"style="padding-left:4px;padding-right:4px;"> <imgsrc="/_layouts/1033/images/error.gif"alt="错误信息"/>< /td>"+
"<tdwidth="100%"style="padding-left:4px;padding-right:4px;">"+
errorInfo
+
"</td></tr></table></span>";
writer.Write(content);
}


///<summary>
///输出结果
///</summary>
///<paramname="writer"></param>
protectedoverridevoidRender(HtmlTextWriterwriter)
{
//检查网址
if(this.webUrl==null||this.webUrl==string.Empty)
{
RenderError(writer,
"错误:请选择网站");
return;
}


//检查数据源
if(this.dataSourceName==null||this.dataSourceName==string.Empty)
{
RenderError(writer,
"错误:请选择数据源");
return;
}

//检查变量
if(this.rtTagName==null||this.rtTagName==string.Empty)
{
RenderError(writer,
"错误:请选择变量");
return;
}

//刷新间隔
if(this.refreshInterval==null||this.refreshInterval==string.Empty)
this.refreshInterval="5000";


//生成输出
SPWebweb=SPContext.Current.Web;
stringcontent=string.Format("<iframesrc="{0}?UserName={1}&DataSourceName={2}&TagName={3}&RefreshInterval={4}"width="100%"height="100%"></iframe>",
this.webUrl,
SPEncode.UrlEncode(web.CurrentUser.LoginName),
SPEncode.UrlEncode(
this.dataSourceName),
SPEncode.UrlEncode(
this.rtTagName),
this.RefreshInterval);
writer.Write(content);
}


///<summary>
///获得编辑界面。
///</summary>
///<returns></returns>
publicoverrideEditorPartCollectionCreateEditorParts()
{
EditorPartCollectionbaseParts
=base.CreateEditorParts();
List
<EditorPart>editorParts=newList<EditorPart>(1);
EditorPartpart
=newKingFactoryTagValueEditorPart2();
part.ID
=this.ID+"_tagValueEditor";
      part.Title = "KingFactory变量选择";  
editorParts.Add(part);
returnnewEditorPartCollection(baseParts,editorParts);
}




[WebDescription(
"WebURL"),
Category(
"Miscellaneous"),
DefaultValue(
""),
Personalizable(PersonalizationScope.Shared),
WebDisplayName(
"WebURL"),
WebBrowsable(
false)]
publicstringWebURL
{
get{returnthis.webUrl;}
set{this.webUrl=value;}
}

[WebDescription(
"DataSourceName"),
Category(
"Miscellaneous"),
DefaultValue(
""),
Personalizable(PersonalizationScope.Shared),
WebDisplayName(
"DataSourceName"),
WebBrowsable(
false)]
publicstringDataSourceName
{
get{returnthis.dataSourceName;}
set{this.dataSourceName=value;}
}


[WebDescription(
"TagName"),
Category(
"Miscellaneous"),
DefaultValue(
""),
Personalizable(PersonalizationScope.Shared),
WebDisplayName(
"TagName"),
WebBrowsable(
false)]
publicstringRtTagName
{
get{returnthis.rtTagName;}
set{this.rtTagName=value;}
}


[WebDescription(
"RefreshInterval"),
Category(
"Miscellaneous"),
DefaultValue(
""),
Personalizable(PersonalizationScope.Shared),
WebDisplayName(
"RefreshInterval"),
WebBrowsable(
false)]
publicstringRefreshInterval
{
get{returnthis.refreshInterval;}
set{this.refreshInterval=value;}
}

}
}



以下为对应的EditorPart的代码:
usingSystem;
usingSystem.Collections.Generic;
usingSystem.Text;
usingSystem.Web;
usingSystem.Web.UI;
usingSystem.Web.UI.WebControls;
usingSystem.Web.UI.WebControls.WebParts;
usingMicrosoft.SharePoint;
usingMicrosoft.SharePoint.Administration;

namespaceKingFactoryTagValueWebPart2
{
publicclassKingFactoryTagValueEditorPart2:EditorPart
{
protectedLabelLabel1;
protectedLabelLabel2;
protectedLabelLabel3;
protectedLabelLabel4;
protectedLabelLabel5;
protectedTextBoxrefreshInterval;
protectedTextBoxselectedTagName;
protectedTreeViewTagNameView;
protectedDropDownListwebSiteList;
protectedDropDownListdataSourceList;

///<summary>
///创建子控件。
///</summary>
protectedoverridevoidCreateChildControls()
{
base.CreateChildControls();

this.Label1=newLabel();
this.Label1.Text="选择网站:";
this.Label1.Width=80;
this.Label2=newLabel();
this.Label2.Text="选择数据源:";
this.Label3=newLabel();
this.Label3.Text="刷新间隔:";
this.Label4=newLabel();
this.Label4.Text="选择变量:";
this.refreshInterval=newTextBox();
this.selectedTagName=newTextBox();
this.TagNameView=newTreeView();
this.webSiteList=newDropDownList();
this.dataSourceList=newDropDownList();
this.dataSourceList.SelectedIndex=-1;
this.webSiteList.SelectedIndex=-1;
this.webSiteList.AutoPostBack=true;
this.webSiteList.SelectedIndexChanged+=newEventHandler(webSiteList_SelectedIndexChanged);
this.dataSourceList.AutoPostBack=true;
this.dataSourceList.SelectedIndexChanged+=newEventHandler(dataSourceList_SelectedIndexChanged);
this.TagNameView.ImageSet=TreeViewImageSet.XPFileExplorer;
this<span sty

运维网声明 1、欢迎大家加入本站运维交流群:群②:261659950 群⑤:202807635 群⑦870801961 群⑧679858003
2、本站所有主题由该帖子作者发表,该帖子作者与运维网享有帖子相关版权
3、所有作品的著作权均归原作者享有,请您和我们一样尊重他人的著作权等合法权益。如果您对作品感到满意,请购买正版
4、禁止制作、复制、发布和传播具有反动、淫秽、色情、暴力、凶杀等内容的信息,一经发现立即删除。若您因此触犯法律,一切后果自负,我们对此不承担任何责任
5、所有资源均系网友上传或者通过网络收集,我们仅提供一个展示、介绍、观摩学习的平台,我们不对其内容的准确性、可靠性、正当性、安全性、合法性等负责,亦不承担任何法律责任
6、所有作品仅供您个人学习、研究或欣赏,不得用于商业或者其他用途,否则,一切后果均由您自己承担,我们对此不承担任何法律责任
7、如涉及侵犯版权等问题,请您及时通知我们,我们将立即采取措施予以解决
8、联系人Email:admin@iyunv.com 网址:www.yunweiku.com

所有资源均系网友上传或者通过网络收集,我们仅提供一个展示、介绍、观摩学习的平台,我们不对其承担任何法律责任,如涉及侵犯版权等问题,请您及时通知我们,我们将立即处理,联系人Email:kefu@iyunv.com,QQ:1061981298 本贴地址:https://www.yunweiku.com/thread-380401-1-1.html 上篇帖子: Microsoft Office SharePoint Server 2007-协同办公之师 下篇帖子: SharePoint – Adding ECB Menu Item for Specific Custom List
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

扫码加入运维网微信交流群X

扫码加入运维网微信交流群

扫描二维码加入运维网微信交流群,最新一手资源尽在官方微信交流群!快快加入我们吧...

扫描微信二维码查看详情

客服E-mail:kefu@iyunv.com 客服QQ:1061981298


QQ群⑦:运维网交流群⑦ QQ群⑧:运维网交流群⑧ k8s群:运维网kubernetes交流群


提醒:禁止发布任何违反国家法律、法规的言论与图片等内容;本站内容均来自个人观点与网络等信息,非本站认同之观点.


本站大部分资源是网友从网上搜集分享而来,其版权均归原作者及其网站所有,我们尊重他人的合法权益,如有内容侵犯您的合法权益,请及时与我们联系进行核实删除!



合作伙伴: 青云cloud

快速回复 返回顶部 返回列表