Introducción para el programador de SharePoint Laboratorio práctico Manual del laboratorio SPCHOL303 Usar el MO cliente y REST en una aplicación.net C#
Este documento se proporciona tal cual. Es posible que la información y los puntos de vista reflejados en este documento, incluidas la dirección URL y otras referencias a sitios web de Internet, cambien sin previo aviso. El usuario asume el riesgo de su uso. Este documento no proporciona ningún derecho legal sobre la propiedad intelectual e industrial de ningún producto de Microsoft. Este documento puede copiarse y usarse para fines internos y de referencia. 2010 Microsoft. Todos los derechos reservados.
Contenido SPCHOL303 USAR EL MODELO DE OBJETOS CLIENTE Y REST EN UNA APLICACIÓN.NET... 2 Objetivo del laboratorio... 2 Recursos adicionales... 2 Introducción... 2 Iniciar sesión en la máquina virtual... 2 Ubicaciones... 2 Requisitos previos para el laboratorio... 3 Copiar las muestras de código desde un documento de Word... 3 Fragmentos de código... 4 Ejercicio 1 : generar una aplicación WPF con el modelo de objetos cliente... 5 Tarea 1: crear una aplicación.net WPF nueva... 5 Tarea 2: usar el modelo de objetos cliente... 7 Ejercicio 2: generar una aplicación de Windows Forms con los servicios REST de SharePoint... 11 Tarea 1: crear una aplicación nueva de Windows Forms... 11 Tarea 2: agregar la referencia al servicio de datos de WCF de la lista de SharePoint... 13 Tarea 3: obtener acceso a los datos de la lista de SharePoint... 18 Tarea 4: actualizar los datos de la lista de SharePoint... 24 Tarea 5: comprobar los datos actualizados... 26 Resumen del laboratorio... 26 Página 1
SPCHOL303 Usar el modelo de objetos cliente y REST en una aplicación.net Tiempo estimado para completar este laboratorio: 30 minutos Es obligatorio disponer de Visual Studio 2010 y SharePoint Foundation 2010 para realizar estos ejercicios. Se encuentran instalados en la máquina virtual que se usa en este laboratorio. Objetivo del laboratorio El modelo de objetos cliente ofrece un modelo de objetos unificado y completo que permite a SharePoint obtener acceso a los datos del sitio de SharePoint desde clientes remotos. Al incluir la biblioteca del modelo de objetos cliente, los programadores pueden generar aplicaciones de SharePoint con gran rapidez. Proporciona un acceso íntegro a los datos del sitio de SharePoint. El objetivo de este laboratorio es obtener información sobre cómo: Usar el nuevo modelo de objetos cliente. Usar el nuevo marco API de REST en SharePoint 2010. Recursos adicionales Este laboratorio incluye los siguientes recursos adicionales: Este manual del laboratorio. SPCHOL303_Manual_CS.docx Este documento. Código fuente. Completed\CS\Ex1 Completed\CS\Ex2 Código fuente del laboratorio completado en C#. Recursos Resources\CS Otros recursos varios usados a lo largo de este laboratorio. Introducción Iniciar sesión en la máquina virtual Inicie sesión en la máquina virtual como el usuario siguiente: Nombre de usuario: Administrator Contraseña: pass@word1 Ubicaciones Este laboratorio práctico contiene diversos recursos adicionales en ubicaciones establecidas. De forma predeterminada, se asume que el directorio HOL base es C:\Content Packs\Packs\SharePoint 2010 Developer Labs 1.0\Supporting Files\SPCHOL303\Resources. La carpeta de trabajo predeterminada para este laboratorio es C:\SPHOLS\SPCHOL303 Página 2
Requisitos previos para el laboratorio 1. Vaya al directorio HOL base Supporting Files\SPCHOL303\Resources y ejecute el script de PowerShell optimize.ps1: Haga clic con el botón secundario en optimize.ps1 y seleccione Ejecutar con PowerShell: Figura 1 - Ejecutar el script de PowerShell De esta forma se abrirá la ventana de PowerShell para ejecutar el script. Espere mientras PowerShell completa la ejecución del script y cierra la ventana de PowerShell (esto puede tardar varios minutos): Página 3 Figura 2 - Ventana de PowerShell donde se ejecuta el script Copiar las muestras de código desde un documento de Word Solo será posible copiar y pegar código desde este documento de Word en Visual Studio para las secciones que contengan código con formato, por ejemplo: Console.WriteLine (" Esto es código seguro!"); Es posible que el código que no se encuentre en estas secciones contenga Unicode o caracteres invisibles que no sean código XML o C#/VB válido, por ejemplo: Console.WriteLine( Esto NO es código seguro!! );
Fragmentos de código También se pueden usar fragmentos de código para insertar el código apropiado en el laboratorio. Para usar el fragmento de código necesario para este laboratorio: Haga clic con el botón secundario en el archivo de código donde desee insertar el fragmento de código. Seleccione Insertar fragmento de código...: Figura 3 - Insertar fragmento de código Seleccione los fragmentos de código necesarios en la galería Mis fragmentos de código. Página 4
Ejercicio 1 : generar una aplicación WPF con el modelo de objetos cliente En este ejercicio, creará una aplicación.net WPF que usa el nuevo modelo de objetos cliente de SharePoint para obtener acceso a los datos de SharePoint. Tarea 1: crear una aplicación.net WPF nueva En esta tarea, creará una aplicación.net WPF nueva. 1. Abra Visual Studio 2010; para ello, vaya al Menú Inicio Todos los programas Microsoft Visual Studio 2010 Microsoft Visual Studio 2010. 2. En el menú, seleccione Archivo Nuevo Proyecto. 3. En el cuadro de diálogo Nuevo proyecto, elija Visual C# Windows en Plantillas instaladas. 4. Seleccione la plantilla Aplicación WPF de la lista. Figura 4 - Proyecto de la aplicación WPF Página 5
5. En el cuadro de texto Nombre, escriba SPCHOL303-Ex1. 6. En el cuadro de texto Ubicación, escriba C:\SPHOLS\SPCHOL303\CS\Ex1. Figura 5 - Ventana del cuadro de diálogo Nuevo proyecto de Visual Studio 7. Desactive Crear directorio para la solución. 8. Haga clic en Aceptar. Página 6
9. Visual Studio creará el nuevo proyecto SPCHOL303-Ex1 y agregará los archivos necesarios. Figura 6 - Explorador de soluciones Tarea 2: usar el modelo de objetos cliente 1. Haga clic con el botón secundario en SPCHOL303-Ex1 en el Explorador de soluciones y seleccione Propiedades. 2. En la pestaña Aplicación, cambie la propiedad.net Framework de destino a.net Framework 4. 3. En el Explorador de soluciones, haga clic con el botón secundario en Referencias y seleccione Agregar referencia... Figura 7 - Agregar referencia 4. Cambie a la pestaña Examinar. 5. Escriba la ruta de acceso siguiente en el cuadro de texto Nombre de archivo y presione entrar: C:\Archivos de programa\archivos comunes\microsoft Shared\Web Server Extensions\14\ISAPI Página 7
6. Seleccione Microsoft.SharePoint.Client.dll y Microsoft.SharePoint.Client.Runtime.dll y, a continuación, haga clic en Aceptar. Figura 8 - Ventana de diálogo Agregar referencia 7. En el Explorador de soluciones, haga doble clic en MainWindow.xaml para abrir la vista XAML. 8. Inserte el código XAML siguiente en el elemento Cuadrícula en la vista XAML. <ListBox Height="238" Margin="12,11,12,13" Name="ListBox1" Width="254" /> Este código XAML crear una control ListBox nuevo. Página 8
9. Debería ver ListBox agregado a la vista del diseñador. Figura 9 - Vista del diseñador Window1.xaml 10. En el Explorador de soluciones, haga clic con el botón secundario en Main Window.xaml y seleccione Vista Código. Figura 10 - Vista Código 11. Agregue las siguientes instrucciones using: using Microsoft.SharePoint.Client; using SP = Microsoft.SharePoint.Client; Fragmentos de código: Mis fragmentos de código spchol303_ex1_namespaces Página 9
12. Inserte el siguiente bloque de código en el constructor Window1 tras la llamada al método InitializeComponent(): ClientContext context = new ClientContext("http://intranet.contoso.com"); Web site = context.web; context.load(site, osite => osite.title); context.executequery(); Title = site.title; ListCollection lists = site.lists; IEnumerable<SP.List>listsCollection = context.loadquery(lists.include(l => l.title, l => l.id)); context.executequery(); ListBox1.ItemsSource = listscollection; ListBox1.DisplayMemberPath = "Título"; Fragmento de código: Mis fragmentos de código spchol303_ex1_constructor Este bloque de código: Crea un contexto de cliente nuevo en el sitio de SharePoint. Realiza consultas a las listas de SharePoint disponibles en el sitio y recupera las listas junto con sus propiedades: Title e Id.. Enlaza la colección de listas al control ListBox de WPF. 13. Presione F5 para iniciar la depuración de la aplicación. 14. La Ventana de aplicación debería tener ListBox lleno con las listas de SharePoint disponibles. Figura 11 - Ventana de aplicación 15. Cierre la Ventana de aplicación. Acaba de ver cómo se usa el nuevo modelo de objetos cliente de SharePoint y se crea una aplicación.net de WPF para recuperar datos de SharePoint en un sitio. Página 10
Ejercicio 2: generar una aplicación de Windows Forms con los servicios REST de SharePoint En este ejercicio, tendrá acceso a datos y los podrá actualizar en una lista de SharePoint con el servicio de datos de WCF de la lista de SharePoint. Tarea 1: crear una aplicación nueva de Windows Forms En esta tarea, creará una aplicación nueva de Windows Forms. 1. Abra Visual Studio 2010; para ello, vaya al Menú Inicio Todos los programas Microsoft Visual Studio 2010 Microsoft Visual Studio 2010. 2. En el menú, seleccione Archivo Nuevo Proyecto. 3. En el cuadro de diálogo Nuevo proyecto, elija Visual C# Windows en Plantillas instaladas. 4. Seleccione Aplicación de Windows Forms en las plantillas de proyecto. Figura 12 - Proyecto nuevo de aplicación de Windows Forms Página 11
5. En el cuadro de texto Nombre, escriba SPCHOL303-Ex2. 6. En el cuadro de texto Ubicación, escriba C:\SPHOLS\SPCHOL303\CS\Ex-2.. Figura 13 - Ventana del cuadro de diálogo Nuevo proyecto de Visual Studio 7. Desactive Crear directorio para la solución. 8. Haga clic en Aceptar. Página 12
9. Visual Studio creará el nuevo proyecto SPCHOL303-Ex2 y agregará los archivos necesarios. Figura 14 - Explorador de soluciones para SPCHOL303-Ex2 Tarea 2: agregar la referencia al servicio de datos de WCF de la lista de SharePoint En esta tarea, agregará una referencia al nuevo servicio de datos de la lista ADO.NET de SharePoint con el fin de tener acceso a los datos de la lista Employees desde el sitio de SharePoint local. 1. En la barra de menús superior de Visual Studio, seleccione Datos Agregar nuevo origen de datos... Figura 15 - Agregar nuevo origen de datos Página 13
2. En el Asistente para la configuración de orígenes de datos, seleccione SharePoint y haga clic en el botón Siguiente >. Figura 16 - Asistente para la configuración de orígenes de datos 3. En la ventana del cuadro de diálogo Agregar referencia de servicio, escriba la dirección URL siguiente en el cuadro de texto Dirección y haga clic en Ir: http://intranet.contoso.com/_vti_bin/listdata.svc Página 14
4. Debería ver que se ha agregado un servicio en el panel Servicios a la izquierda de la ventana del cuadro de diálogo (es posible que el nombre varíe) y en el cuadro de texto Espacio de nombres debería aparecer ServiceReference1, como en la figura: Figura 17 - Servicio de datos de lista Los servicios web de SharePoint se encuentran en el directorio virtual _vti_bin. ListData.svc es el servicio de datos de lista de SharePoint que usa la API de REST. Al usar este servicio web, podrá trabajar con los datos de lista de SharePoint a través de la interfaz de REST. Página 15
5. Haga clic en TeamSiteDataContext y expándalo para explorar los diversos elementos del servicio: Figura 18 - Elementos del servicio 6. Haga clic en Aceptar. Página 16
7. Haga clic en el botón Finalizar en el Asistente para la configuración de orígenes de datos. Figura 19 - Se agregó una referencia de servicio 8. De esta forma se agregará la referencia del servicio a la solución: Figura 20 - Referencia del servicio Página 17
Tarea 3: obtener acceso a los datos de la lista de SharePoint 1. En esta tarea, tendrá acceso a los datos de la lista Employees y podrá recuperarlos con el servicio de datos de WCF de la lista de SharePoint. 2. Haga clic con el botón secundario en Referencias y seleccione Agregar referencia... 3. En la ventana de diálogo Agregar referencia, pase a la pestaña.net y seleccione WindowsBase 4. Haga clic en Aceptar. 5. Haga clic con el botón secundario en Form1.cs en el Explorador de soluciones. Se abrirá el Diseñador de formularios. 6. En el menú de Visual Studio, haga clic en Datos Mostrar orígenes de datos. Figura 21 - Mostrar orígenes de datos 7. Se abrirá la ventana Orígenes de datos donde se muestra la referencia del servicio que se agregó en la Tarea 2 junto a las listas de SharePoint disponibles en el sitio. El origen de datos está formado por las listas de SharePoint y las bibliotecas de documentos en forma de modelo de datos de entidad. Haga clic en el icono del alfiler para bloquear la lista en una posición abierta. Página 18
Figura 22 - Ventana Orígenes de datos 8. Arrastre y coloque Employees desde la ventana Orígenes de datos a la ventana Formulario. Se insertará el DataGrid Employees en el formulario. Ajuste el formulario y el DataGrid para que encaje su ancho y alto: Página 19
Figura 23 - Ventana de Windows Forms y DataGrid Employees 9. Haga clic con el botón secundario en el DataGrid Employees vacío y seleccione Editar columnas... Figura 24 - Editar columnas Página 20
10. En la ventana Editar columnas, quite todas las columnas menos las tres siguientes. Para quitar una columna, seleccione una columna en la lista Columnas seleccionadas y haga clic en el botón Quitar: Nombre completo Puesto Equipo Figura 25 - Ventana Editar columnas 11. Haga clic en Aceptar. Página 21
12. Debería aparecer el DataGrid actualizado con los cambios: Figura 26 - DataGrid actualizado 13. Haga doble clic en la barra de título del diseñador (donde pone Form1) para agregar el método Form1_Load (se abrirá la vista Código): Figura 27 - Método Form1_Load 14. Agregue las siguientes instrucciones using al código subyacente: using SPCHOL303_Ex2.ServiceReference1; using System.Net; Fragmento de código: Mis fragmentos de código spchol303_ex2_namespaces 15. Inserte el código siguiente inmediatamente detrás de la declaración de clase Form1: TeamSiteDataContext context = new TeamSiteDataContext(new Uri("http://intranet.contoso.com/_vti_bin/ListData.svc")); Fragmento de código: Mis fragmentos de código spchol303_ex2_context Página 22
Figura 28 TeamSiteDataContext 16. Inserte el siguiente código en el método Form1_Load: context.credentials = CredentialCache.DefaultCredentials; employeesbindingsource.datasource = context.employees; Fragmento de código: Mis fragmentos de código spchol303_ex2_form_load 17. Presione F5 para iniciar la depuración de la aplicación. 18. Debería ver la ventana de la aplicación con el DataGrid lleno con la lista Employees: Figura 29 - Ventana de aplicación 19. Cierre la ventana de aplicación. Acaba de ver cómo se obtiene acceso a los datos de la lista de SharePoint con el nuevo servicio de datos de WCF de la lista de SharePoint. Página 23
Tarea 4: actualizar los datos de la lista de SharePoint En esta tarea, actualizará el nombre completo de un empleado y guardará los cambios en el sitio de SharePoint. 1. En el Explorador de soluciones, haga clic con el botón secundario en Form1.cs y seleccione Vista Diseñador. 2. En el DataGrid Employees, haga clic en BindingNavigator. Figure 30 - BindingNavigator 3. En BindingNavigator, haga clic con el botón secundario en el botón Guardar ( ) y seleccione Enabled. Figura 31 - Habilitar el botón Guardar 4. Haga doble clic en el botón Guardar en BindingNavigator para generar el método Save: Figura 32 - Método Save 5. Inserte el código siguiente en el método employeesbindingnavigatorsaveitem_click: context.savechanges(); Fragmento de código: Mis fragmentos de código spchol303_ex2_save_method 6. En el Explorador de soluciones, haga clic con el botón secundario en Form1.cs y seleccione Vista Diseñador. Página 24
7. En la parte inferior de la ventana del diseñador, haga clic con el botón secundario en employeesbindingsource y seleccione Propiedades: Figura 33 - Propiedades employeesbindingsource 8. En la ventana Propiedades, haga clic en el icono Eventos ( ) 9. Haga doble clic en el evento CurrentItemChanged. Visual Studio generará el evento modificado del elemento para employeesbindingsource: Figura 34 - Método employeesbindingsource_currentitemchanged 10. Inserte el código siguiente en el método employeesbindingsource_currentitemchanged: context.updateobject(employeesbindingsource.current); Fragmento de código: Mis fragmentos de código spchol303_ex2_item_changed 11. Presione F5 para iniciar la depuración de la aplicación. 12. Debería ver la ventana de la aplicación con la lista de Employees. 13. Haga clic en el primer empleado y cambie el Nombre completo de Kim Abercrombie a Kim: Figura 35 - Cambiar el nombre completo 14. Presione la tecla Entrar y haga clic en el botón Guardar ( ) 15. Ahora los cambios realizados en el Nombre completo del empleado seleccionado se deberían guardar en el sitio de SharePoint. 16. Cierre la ventana de aplicación. Página 25
Tarea 5: comprobar los datos actualizados En esta tarea, comprobará los datos actualizados del empleado de la Tarea 4. 1. Abra Internet Explorer y vaya al siguiente sitio de SharePoint: http://intranet.contoso.com 2. Si se le pide autenticación, escriba los siguientes detalles: Nombre de usuario: Administrator Contraseña: pass@word1 3. En la zona de navegación izquierda, haga clic en la lista Employees para abrir la lista Employees: Figura 36 - Zona de navegación izquierda 4. Debería ver el empleado actualizado Kim: Figura 37 - Elemento de la lista Employees actualizado Acaba de ver cómo actualizar un elemento de lista desde una aplicación cliente y cómo volver a publicar los datos en el sitio de SharePoint. Resumen del laboratorio En este laboratorio, ha realizado los ejercicios siguientes: Generar una aplicación WPF con el modelo de objetos cliente. Generar una aplicación Windows Forms con los servicios REST de SharePoint. Actualizar un elemento List desde la aplicación de Windows Forms y guardar los cambios de nuevo en el sitio de SharePoint. En este laboratorio, aprendió a escribir aplicaciones de cliente de Windows que tienen acceso a los datos de la lista de SharePoint mediante un nuevo modelo de objetos cliente y el servicio de datos de WCF de la lista de SharePoint. Página 26