Office Development with Visual Studio : VS2010

Migrating an Outlook Solution to .NET Framework 4 in Visual Studio 2010 (Norm Estabrook)

VSTO Team — Wed, 16 Dec 2009 22:33:37 GMT

Visual Studio can help migrate your Outlook solutions from .NET Framework 3.5 to the .NET Framework 4. However, you still have to do a few things manually to make it all work.

Beth Massi converts an Outlook Solution that targets the .NET Framework 3.5 to an Outlook Solution that targets the .NET Framework 4 client profile in this very cool and informative blog entry - Migrating an Outlook Client to .NET Framework 4 in Visual Studio 2010.

Office 2010 Beta & SharePoint 2010 Beta Now Available to the Public (Beth Massi)

VSTO Team — Wed, 18 Nov 2009 18:54:34 GMT

Monday Office and SharePoint 2010 Beta were released to MSDN/TechNet subscribers. Today it was announced at PDC that these are available to the rest of the public! Come and get it…

Office 2010 Beta

SharePoint 2010 Beta

These Betas are compatible with Visual Studio 2010 Beta 2 which was released to the public a few weeks ago. We’ve also started a series on Channel 9 on SharePoint development in Visual Studio so check that out starting with:

Overview of SharePoint Development in Visual Studio 2010

Also check out…

Office 2010 resources

SharePoint 2010 Resources

And stay tuned here for more posts on Office Development with Visual Studio 2010!

Enjoy,
-Beth Massi, Visual Studio Community

Channel 9 Interview: John Durant on Developing Managed Applications for Office 2010 in Visual Studio 2010 (Beth Massi)

VSTO Team — Thu, 17 Sep 2009 21:41:19 GMT

Robert Hess posted an interview yesterday on Channel 9 with John Durant on Developing Managed Applications for Office 2010 in Visual Studio 2010. When you have 20 minutes you should check it out.

John provides some highlights as to what he’ll be showing in his PDC sessions, and some of the new features that developers can look forward to in Office and Visual Studio 2010.

Enjoy,
-Beth Massi, Visual Studio Community

Quick Videos of Visual Studio 2010 Features (Beth Massi, Mary Lee)

VSTO Team — Mon, 03 Aug 2009 21:38:55 GMT

If you’ve missed them, Kathleen has been interviewing writers on various documentation teams on some of the new features going into Visual Studio 2010. Our own Mary Lee now has a couple video interviews posted on new VSTO features that you should check out:

If you like reading better than watching videos, here are the walkthroughs in the MSDN library:

For more resources and information on how to download the VS2010 Beta, visit the Visual Studio Developer Center.

Enjoy,
-Beth Massi, Visual Studio Community

Video Interview: Mary Lee on Deploying Multiple Office Solutions (Kathleen McGrath)

VSTO Team — Fri, 05 Jun 2009 05:35:12 GMT

Mary Lee recently posted a blog entry that describes Deploying Multiple Office Solutions in a Single Installer, complete with graphics to help you visualize the process. I recently interviewed Mary to learn more about this topic, and to have her give a demonstration of some of the tasks described in this post.

If you’ve often wondered who’s hidden behind that motorcycle helmet, be sure to check out the video!

See video: Deploying Multiple Office Solutions in a Single ClickOnce Installer

I will be posting additional interviews, demonstrations, and featured Visual Studio 2010 Beta 1 content on my blog: http://blogs.msdn.com/kathleen.

-- Kathleen

Learning about Visual Studio 2010 and .NET Framework 4 (Mary Lee)

VSTO Team — Fri, 22 May 2009 18:29:23 GMT

To learn more about Visual Studio 2010 and .NET Framework 4, Kathleen McGrath is highlighting new documentation about these products with a weekly blog post and a daily tweet. If you want to learn more about the new features and scenarios, check out her blog at http://blogs.msdn.com/kathleen and her twitter feed at http://twitter.com/kathleenmcgrath.

Mary Lee, Programming Writer.

Copying a Document to the End User Computer after a ClickOnce Installation (Mary Lee)

VSTO Team — Thu, 21 May 2009 20:00:00 GMT

Starting in Visual Studio 2010 Beta 1, you can perform additional tasks after an Office solution is installed known as a post-deployment action. For example, you can copy a customized Office document and create registry keys on the end user computer. You can compare these to Windows Installer custom actions.

The Visual Studio Tools for Office runtime supports the ability to perform post-deployment actions after an Office solution is installed. However, Visual Studio does not generate the necessary sections of the ClickOnce application and deployment manifests to perform these actions. To run these post-deployment actions, you must modify the application and deployment manifests. This process is demonstrated in the Walkthrough: Copying a Document to the End User Computer after a ClickOnce Installation topic in the MSDN Library.

The walkthrough uses an Excel workbook project, but this example uses a Word document project for demonstration purposes.

Creating a New Project

1. Create a new Word document-level project that targets the .NET Framework 3.5 named FabrikamWordDocument.

2. Add code to the FabrikamWordDocument project.

3. Build the project.

Creating a Class Library Project that Defines the Post-Deployment Action

1. Create a class library called FileCopyPDA.

2. Add references to Microsoft.VisualStudio.Tools.Applications.Runtime.v10.0 and Microsoft.VisualStudio.ToolsApplications.ServerDocument.v10.0.

3. Rename the class to FileCopyPDA.

4. Replace the FileCopyPDA class with the following code that completes the following tasks:

Copies the Word document file to the user's desktop if the solution is installed or updated.

Changes the _AssemblyLocation property from a relative path to a fully qualified path for the deployment manifest. This is done using the AddCustomization and RemoveCustomization methods.

Deletes the file if the solution is uninstalled.

Public Class FileCopyPDA
    Implements IAddInPostDeploymentAction

    Sub Execute(ByVal args As AddInPostDeploymentActionArgs) Implements IAddInPostDeploymentAction.Execute
        Dim dataDirectory As String = "Data\FabrikamWordDocument.docx"
        Dim file As String = "FabrikamWordDocument.docx"
        Dim sourcePath As String = args.AddInPath
        Dim deploymentManifestUri As Uri = args.ManifestLocation
        Dim destPath As String = Environment.GetFolderPath(Environment.SpecialFolder.DesktopDirectory)
        Dim sourceFile As String = System.IO.Path.Combine(sourcePath, dataDirectory)
        Dim destFile As String = System.IO.Path.Combine(destPath, file)

        Select Case args.InstallationStatus
            Case AddInInstallationStatus.InitialInstall, AddInInstallationStatus.Update
                File.Copy(sourceFile, destFile)
                ServerDocument.RemoveCustomization(destFile)
                ServerDocument.AddCustomization(destFile, deploymentManifestUri)
                Exit Select
            Case AddInInstallationStatus.Uninstall
                If File.Exists(destFile) Then
                    File.Delete(destFile)
                End If
                Exit Select
        End Select
    End Sub

End Class

5. Build the FileCopyPDA project.

6. Add a reference to FileCopyPDA.dll in the FabrikamWordDocument project.

7. Create a directory called “Data” in the FabrikamWordDocument project.

8. Add the FabrikamWordDocument.docx file to the Data folder.

9. In Properties window for the FabrikamWordDocument.docx file, change the Build Action property to Content, and change the Copy to Output Directory property to Copy if newer.

10. Publish the FabrikamWordDocument project. This example uses the c:\publish directory.

Modifying the Application Manifest

1. Open the C:\publish\Application Files\FabrikamWordDocument_1_0_0_0\FabrikamWordDocument.dll.manifest file in the XML Editor in Visual Studio.

2. Add the following XML code after the </vstav3:update> element to run the FileCopy post-deployment action.

<vstav3:postActions>
  <vstav3:postAction>
    <vstav3:entryPoint
      class="FileCopyPDA.FileCopyPDA">
      <assemblyIdentity
        name="FileCopyPDA"
        version="1.0.0.0"
        language="neutral"
        processorArchitecture="msil" />
    </vstav3:entryPoint>
    <vstav3:postActionData>
    </vstav3:postActionData>
  </vstav3:postAction>
</vstav3:postActions>

Re-signing the Manifests

To prove that yes, you really meant to make these changes to the application manifest, you must re-sign the application manifest with a certificate. Then, re-sign and update the deployment manifest to point to the new application manifest.

1. Copy your certificate to the C:\publish\Application Files\FabrikamWordDocument_1_0_0_0 directory. In this example, I’m reusing the temporary certificate created by Visual Studio because I’ll be installing this to a test computer. For production deployment, we recommend that you use a certificate obtained from a certificate authority.

2. In a Visual Studio command prompt, change to the C:\publish\Application Files\FabrikamWordDocument_1_0_0_0 directory. (You may have to open the command prompt in Administrator mode to re-sign the files in the c:\publish directory.)

3. Re-sign the application manifest with the following command:

mage -sign FabrikamWordDocument.dll.manifest -certfile FabrikamWordDocument_TemporaryKey.pfx

4. Change to the c:\publish directory

5. Re-sign the deployment manifest with the following command (on one line):

mage -update FabrikamWordDocument.vsto

–appmanifest "Application Files\FabrikamWordDocument_1_0_0_0\FabrikamWordDocument.dll.manifest"

-certfile "Application Files\FabrikamWordDocument_1_0_0_0\FabrikamWordDocument_TemporaryKey.pfx"

6. Copy the c:\publish\FabrikamWordDocument.vsto file to the c:\publish\Application Files\FabrikamWordDocument_1_0_0_0 directory.

Testing the Installer

1. Copy the c:\publish directory to a test computer.

2. In the c:\publish directory, run the Setup.exe file or double-click FabrikamWordDocument.vsto.

3. Verify that FabrikamWordDocument appears in the Add/Remove Programs list in Windows XP or Programs and Features in Windows Vista.

4. Verify that the FabrikamWordDocument.docx file appears on the desktop.

5. Open the Word document file to verify that your code is running.

Feel free to leave comments and feedback about this new scenario at the bottom of this article.

Happy deployment!

Mary Lee, Programming Writer.

Deploying Multiple Office Solutions In a Single Installer (Mary Lee)

VSTO Team — Wed, 20 May 2009 20:00:00 GMT

Starting in Visual Studio 2010 Beta 1, you can deploy multiple Office solutions in a single ClickOnce installer. For example, you can develop two Office solutions (one for Outlook and another for Excel) and combine these into a single installer with a single entry in the Add/Remove Programs list in Windows XP and the Programs and Features list in Windows Vista.

The Visual Studio Tools for Office runtime supports the ability to deploy multiple Office solutions in a single installer. However, Visual Studio still generates the ClickOnce application and deployment manifests for individual deployment. To deploy multiple Office solutions in a single installer, you must modify the application and deployment manifests to install multiple assemblies. This process is demonstrated in the Walkthrough: Deploying Multiple Office Solutions in a Single ClickOnce Installer topic in the MSDN Library.

Creating Multiple Office Solutions

To continue the example mentioned in the introduction, you can develop an Excel workbook project and an Outlook add-in project for .NET Framework 3.5. Then, to deploy both of these, create an installer project, which you can re-use later to add a third or fourth project. By keeping this installer project separate, it’s possible to keep the original files for the individual projects intact. In this example, the installer project is based on a Word document project, but the document isn’t being deployed. The following figure shows Solution Explorer with three projects, one installer project and two projects to deploy to end user computers.

Publishing the Office Solutions

After you add your code to the Excel and Outlook projects, publish the ContosoExcelWorkbook, ContosoOutlookAddIn, and then ContosoInstaller projects (in that order) to a folder on the development computer. You can right-click on the projects in Solution Explorer, and then click Publish. In this example, the publish directory is c:\publish.

Modifying the Application Manifest

Visual Studio generates an application manifest and deployment manifest for each project. The ClickOnce application manifest is a description of all the files included in the project. Additionally, this file describes how the Office application could load the assembly and run your code. By modifying the application manifest, you can describe files from multiple projects and install all specified projects. There are three different sections of the application manifest to modify: install dependencies, entry points, and assemblies.

These changes may appear lengthy, but it really amounts to a few copy-paste operations and adding four words to the application manifest.

Adding the Install Dependencies

1. In the c:\publish\Application Files folder, copy the contents of the ContosoExcelWork_1_0_0_0 and ContosoOutlookAddIn_1_0_0_0 folder into the ContosoInstaller_1_0_0_0 folder.

2. From the c:\publish\Application Files\ContosoInstaller_1_0_0_0 folder, open the three .dll.manifest files in the XML editor in Visual Studio.

3. Copy the <dependency> block for the Office customization assembly from the ContosoOutlookAddIn.dll.manifest and ContosoExcelWorkbook.dll.manifest files into the ContosoInstaller.dll.manifest file. This code specifies that the ContosoOutlookAddIn.dll and ContosoExcelWorkbook.dll files are part of the ContosoInstaller project.

4. Delete the <dependency> block for the ContosoInstaller.dll. This file is not part of the project, because you are only using the ContosoInstaller project to generate the application manifest template.

Adding the Entry Points

1. In the ContosoInstaller.dll.manifest file, delete the text between the <vstav3:entryPointsCollection> and </vstav3:entryPointsCollection> elements.

2. In the ContosoOutlookAddIn.dll.manifest and ContosoExcelWorkbook.dll.manifest files, copy the text between the <vstav3:entryPointsCollection> and </vstav3:entryPointsCollection> elements and paste them into the ContosoInstaller.dll.manifest file.

3. Add an id to the <vstav3:entryPoints> elements.

Adding the assemblies

1. In the ContosoInstaller.dll.manifest file, delete the text between the <vstov4:customizations xmlns:vstov4="urn:schemas-microsoft-com:vsto.v4"> and </vstov4:customizations> elements.

2. In the ContosoOutlookAddIn.dll.manifest and ContosoExcelWorkbook.dll.manifest files, copy the <vstov4:customizations xmlns:vstov4="urn:schemas-microsoft-com:vsto.v4"> and </vstov4:customizations> elements and paste them into the ContosoInstaller.dll.manifest file.

3. Add the id name to the <vstov4:customization> elements.

4. Save the changes in the ContosoInstaller.dll.manifest file, and close the ContosoExcelWorkbook.dll.manifest and ContosoOutlookAddIn.dll.manifest files.

Re-Signing the Manifests

1. Copy your certificate to the c:\publish\Application Files\ContosoInstaller_1_0_0_0 directory. In this example, I’m reusing the temporary certificate created by Visual Studio because I’ll be installing this to a test computer. For production deployment, we recommend that you use a certificate obtained from a certificate authority.

2. In a Visual Studio command prompt, change to the c:\publish\Application Files\ContosoInstaller_1_0_0_0 directory. (You may have to open the command prompt in Administrator mode to re-sign the files in the c:\publish directory.)

3. Re-sign the application manifest with the following command:

mage -sign ContosoInstaller.dll.manifest -certfile ContosoInstaller_TemporaryKey.pfx

4. Change to the c:\publish directory

5. Re-sign the deployment manifest with the following command (on one line):

mage -update ContosoInstaller.vsto

-appmanifest "Application Files\ContosoInstaller_1_0_0_0\ContosoInstaller.dll.manifest"

-certfile "Application Files\ContosoInstaller_1_0_0_0\ContosoInstaller_TemporaryKey.pfx"

6. Copy the c:\publish\ContosoInstaller.vsto file to the c:\publish\Application Files\ContosoInstaller_1_0_0_0 directory.

Testing the Installer

1. Copy the c:\publish directory to a test computer.

2. In the publish directory, run the Setup.exe file or double-click ContosoInstaller.vsto.

3. Verify that ContosoInstaller appears in the Add/Remove Programs list in Windows XP or Programs and Features in Windows Vista.

4. Open the Excel workbook file and Outlook to verify that your code is running.

Feel free to leave comments and feedback about this new scenario at the bottom of this article.

Happy deployment!

Mary Lee, Programming Writer.

Office Programmability in Visual Basic and C# in VS 2010 (Beth Massi)

VSTO Team — Tue, 16 Dec 2008 00:39:43 GMT

The Visual Basic team posted a walkthrough today on some of the new language features in Visual Basic and C# to help with Office programmability in Visual Studio 2010. Specific features include adding optional parameters to C# 4.0 (VB already has this) and removing the dependency on the Primary Interop Assemblies (PIAs).

You can download the CTP and see it in action for yourself and give feedback here.

Enjoy,
-Beth Massi, Visual Studio Community