SparkleXrm 开源项目使用指南

1. 项目介绍

SparkleXrm 是一个开源库，用于使用 Script#、jQuery 和 Knockout.js 构建 Dynamics CRM XRM 解决方案。该项目旨在简化 Dynamics CRM 客户端扩展的开发，使其尽可能接近服务器端扩展的开发体验。SparkleXrm 提供了用户界面控件、UI 验证控件、本地化支持等功能，适用于 CRM2011、CRM2013 和 CRM2015。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保您已经安装了以下工具：

• Visual Studio 2012
• Script# v0.7.5（通过 Visual Studio 的扩展和更新安装）
• PowerShell Tools for Visual Studio 2012 v1.0.5（通过 Visual Studio 的扩展和更新安装）

2.2 下载并构建项目

1. 克隆 SparkleXrm 项目到本地：

   git clone https://github.com/scottdurow/SparkleXrm.git
   

2. 打开项目解决方案文件 SparkleXrm.sln。

3. 在 Visual Studio 中，右键点击解决方案并选择“还原 NuGet 包”。

4. 构建解决方案：

   msbuild SparkleXrm.sln
   

2.3 运行示例项目

1. 打开 DebugWeb 项目，该项目允许您在不发布到 CRM 的情况下运行和调试示例。

2. 配置 DebugWeb 项目中的连接字符串，指向您的 Dynamics CRM 实例。

3. 运行 DebugWeb 项目，您将能够在本地调试 SparkleXrm 示例。

3. 应用案例和最佳实践

3.1 应用案例

SparkleXrm 的一个典型应用案例是构建可编辑的网格和表单字段。例如，您可以使用 SparkleXrm 创建一个报价产品编辑器，用户可以在其中添加、编辑和删除报价产品。

3.2 最佳实践

• 使用 MVVM 模式：SparkleXrm 鼓励使用 MVVM（Model-View-ViewModel）模式，将 HTML 与应用程序逻辑分离，从而使代码更简洁和易于维护。
• 本地化支持：利用 SparkleXrm 的本地化功能，支持多语言、日期和数字格式。
• 代码复用：通过使用 SparkleXrm，您可以复用服务器端代码，减少重复工作。

4. 典型生态项目

4.1 Script#

Script# 是一个开源项目，允许您使用 C# 编写 JavaScript 代码。SparkleXrm 依赖 Script# 来生成 JavaScript 代码，从而提高开发效率。

4.2 jQuery 和 Knockout.js

SparkleXrm 使用 jQuery 和 Knockout.js 来构建用户界面。jQuery 提供了强大的 DOM 操作功能，而 Knockout.js 则提供了数据绑定和 MVVM 支持。

4.3 Dynamics CRM SDK

SparkleXrm 与 Dynamics CRM SDK 紧密集成，提供了对 CRM 数据的访问和操作功能。通过结合使用 SparkleXrm 和 CRM SDK，您可以快速构建复杂的 CRM 解决方案。

通过以上步骤，您可以快速上手 SparkleXrm 项目，并利用其强大的功能构建 Dynamics CRM 解决方案。