2010年12月8日,星期三

SP2010 AJAX第5部分-为客户端OM和jQuery启用Intellisense

  1. 将jQuery精简为基本要素 (技术)
  2. 使用JavaScript Client OM处理列表 (技术)
  3. 结合使用jQuery AJAX和HTTP处理程序 (技术)
  4. 从HTTP处理程序返回JSON (技术)
  5. 为客户端OM和jQuery启用Intellisense(小费) - 本文
  6. 调试jQuery / JavaScript (小费)
  7. 构建AJAX应用程序时的有用工具 (小费)
  8. 将现有应用程序迁移到jQuery / AJAX

本文标志着本系列的变化–前四篇文章是有关关键技术的详细指南,而下几篇是简短而甜蜜的技巧,它们可能会对您的旅程有所帮助。今天,我们谈论Intellisense,专门针对SharePoint开发人员可能使用的JavaScript库(例如jQuery或SharePoint 2010)’的客户端对象模型。

尽管许多开发人员提出了 没有 具有此类代码的Intellisense’在默认情况下未启用),’s no 真实 reason not to enable it if you’重新写了几行。没有它,您只会得到用不到的默认JavaScript Intellisense,它看起来像这样:

默认JSIntellisense

这里以客户OM为例’适当的Intellisense看起来像什么’s enabled – that’一个很长的下拉列表,请相信我,您想要它:

FullClientOMJSIntellisense

在启用它方面,根据您在哪里需要Intellisense以及我们是否需要’在谈论jQuery或客户端OM。让’s run through them.

在.js双色球推荐一注中启用客户端OM Intellisense

您所需要做的就是在.js双色球推荐一注顶部的几个参考路径:

/// <reference path="C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\MicrosoftAjax.js" />
/// <reference path="C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\SP.debug.js" />

旁注:如果要在其他JS双色球推荐一注上使用Intellisense,则可以’需要添加相应的引用。例如,深入研究在SP.Core.js中找到一个不错的SP.XmlWriter类,用于在JavaScript中构建XML– you’上面的代码片段将无法获得Intellisense,但是对SP.Core.debug.js的适当引用将解决此问题。 在本文结尾处,我列出了客户端OM的哪些位在哪个JS双色球推荐一注中。

在标记(.aspx / .ascx)中启用客户端OM Intellisense

对于前端代码双色球推荐一注(人们是否仍将其称为?),我们需要添加<script>标签,就像我们在页面/控件中添加普通的.js双色球推荐一注一样。但是请考虑一下,SharePoint已经在确保在运行时在页面上引用正确的JavaScript双色球推荐一注,并且通过添加重复的引用会造成问题。所有的’所需的是一个内联ASP.Net条件语句,该条件语句在运行时将为false(因此,内容’(已处理),但是在设计时Visual Studio认为就很好(在此为颜色编码表示歉意,ASP.Net括号在Visual Studio中为亮黄色):

<% if (false) { %>
<脚本 type="text/javascript" src="C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\MicrosoftAjax.js" ></script>
<脚本 type="text/javascript" src="C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\TEMPLATE\LAYOUTS\SP.debug.js" ></script>
<% } %>


在.js双色球推荐一注中启用jQuery Intellisense

Here, the process is slightly different - 视觉工作室 needs a special ‘vsdoc’提供jQuery文档的双色球推荐一注。可以从 官方jQuery网站,寻找‘Visual Studio’实际jQuery发布双色球推荐一注旁边的链接–在撰写本文时,带有文档的最新jQuery版本是1.4.1。在JavaScript双色球推荐一注中,我们再次需要使用参考标记,这一次指向vsdoc双色球推荐一注(顺便说一句,该路径可以是相对的或绝对的):

/// <reference path="jquery-1.4.1-vsdoc.js" />

在标记(.aspx / .ascx)中启用jQuery Intellisense

您’大概现在就知道了,但实际上’在这种情况下需要额外考虑。在标记中引用JavaScript双色球推荐一注时,Visual Studio会自动在同一目录中查找关联的vsdoc双色球推荐一注–如果找到一个,你’会有Intellisense。以便’太好了,我们所需要的只是对我们的参考‘real’JS双色球推荐一注(无论如何我们都需要运行时)– however, we’不太可能为此使用绝对路径,这意味着VS可能无法解析位置。例如,在SharePoint-land中,您’将最有可能想要使用‘LAYOUTS’相对路径,例如‘/_layouts/jquery-1.4.1.min.js’,但由于IIS相对于IIS而言,IIS网站是未知的’否Intellisense。为了获得两全其美的效果,我将两个引用合并在一起,如下所示:

<% if (false) { %>
<;script type="text/javascript" src="../jquery-1.4.1.min.js"></script>
<% } %>
<script type="text/javascript" src="/_layouts/jquery-1.4.1.min.js"></script>

附录-JavaScript客户端OM双色球推荐一注

取自 http://msdn.microsoft.com/en-us/library/ee538253.aspx:


命名空间

ECMAScript双色球推荐一注

CUI命名空间

CUI.js,SP.UI.Rte.js

CUI.Controls命名空间

CUI.js

CUI.Page命名空间

CUI.js,SP.UI.Rte.js

SP命名空间

SP.Core.js,SP.js,SP.Ribbon.js,SP.Runtime.js

SP.ListOperation命名空间

SP.Core.js

SP.Ribbon命名空间

SP.Ribbon.js

SP.Ribbon.PageState命名空间

SP.Ribbon.js

SP.UI命名空间

SP.Core.js,SP.js,SP.UI.Dialog.js

SP.Utilities命名空间

SP.Core.js,SP.js,SP.Exp.js

SP.WebParts命名空间

SP.js

SP.Workflow命名空间

SP.js


下次: 调试jQuery / JavaScript (小费)

2条评论:

达伦 said...

太棒了,谢谢克里斯!

Pagial said...

克里斯,你好

I have been looking for this info... All I can say is well done! 您 deserve your MVP.

太感谢了!