原文地址:Creating SharePoint Ribbon CustomActions
with Visual Studio 2012 本文由SPFarmer翻译
在SharePoint 2010里,创建一个ribbon custom actions并不是一个愉快的经历。你需要知道内部的XML的操作,以及选择正确CommandUIDefinition
Id的后台的原理。我们的社区有一些工具,比如 CKSDEV 可以帮一些忙。现在我们高兴的看到,有了一个新的Ribbon
Custom Action SharePoint ProjectItem。这个新的SPI
提供了一个简单易用的想到,来引导你创建一个Custom Action。我们来看一下。
首先你需要创建一个新的SharePoint App project。这个并不是在常规的SharePoint 2013 projects里面。在我今天的例子里,我将在list
item的ribbon里添加custom action,作用是返回到default.aspx
页面。当然你可以使用传统的技术,比如添加JavaScript,
传参,以及其它。我今天只是简要介绍一下这个tool怎么用。
在Add New Item
菜单里,你可以看到这个向导。选择 Ribbon Custom Action 然后输入一个名字。
当你点击添加,就进入到了下一步。这里你需要选择,你要应用到苏宿主 Web
还是App Web。记住, App Web
有你的app的所有的内同,宿主web是寄宿你的app的web。
这个功能的一个用途是,用户点击宿主web的条目时候,可以点击ribbon的action,然后被带到app。
你现在可以绑定custom action
到一个 list template
或者list instance。如果选择宿主Web ,它会提供一个list instance的列表让你选择。否则,如果你选择List
Template, 它会提供你常用的list template的列表让你选择。
在这里例子里,我选择了App Web
,然后是一个list实例。
继续下一步,它会让你定义ribbon上的位置,以及要显示的文字,以及点击之后重定向的目标页面。你可以选择当前project里任何已经存在的ASP.NET
页面。如果你想运行JavaScript
,你需要在向导完成之后编辑XML。
它会列出,这个控件可以被放置的所有的地点:
当你完成的时候,Visual Studio生成了你需要的XML,你可以根据需要修改。然后,在这个时候,你就不能再回到向导了。如果你还想要向导,你不得不删掉这个item,然后重新创建。
现在我们可以运行project,然后打开我们设置action的list,选择一个条目,在ribbon上就看到了这个action。
点击Ribbon Action,
我就被重定向到了我的app home页面。.
我对这个功能感到很兴奋,因为以前做Custom Action总是很艰难,现在做Custom Action就容易多了。这个很重要,因为这是链接宿主web和app
web的关键的方法之一。
Published Dec 11 2012, 11:18 AM by CoreyRoth
Filed under: SharePoint, Visual
Studio 11, SharePoint 2013, Apps