Office Client Developer Content and Resources : help

Accessing Outlook Developer Help During the Office 2010 Beta Period

angelgolfer — Wed, 18 Nov 2009 10:10:00 GMT

The help model in Microsoft Office 2010 for Office client applications such as Access, Excel, Outlook, and Word has remained the same as in Office 2007: when you click F1, you can choose to access help that is installed on your computer, or help available on the Office Web site.

During the Office 2010 Beta timeframe, you can access developer help only from the computer; online developer help from the Office Web site will be set up when Office 2010 RTMs. What all of this means is that when you click F1 to view help in a client application, you should make sure that Developer Reference is selected under Content from This Computer in the drop-down menu adjacent to Search.

In Outlook 2010 Beta, you may notice very slight discrepancies between the objects and members displayed in the object browser, and the objects and members described in the developer help that is installed on your computer by Outlook 2010 Beta. This is because the installed help was a snap shot of the developer help taken after the cut-off date for the Beta version of Outlook 2010. Even though there are some discrepancies, this version of the developer help is reasonably sufficient to provide what you need to know to use the new object model members in Outlook 2010 Beta.

The Office Developer Documentation team has made available even more recent versions of the developer help for Access, Excel, Outlook, PowerPoint, Project, Publisher, Visio, and Word. You can download these developer references at Office 2010: Developer References. These versions of developer help are more recent snap shots, and similar to the developer help installed by Office 2010 Beta, you are likely to find discrepancies between the objects and members displayed in the object browser of the Beta product, and the objects and members described in the downloaded version of the help. Nonetheless, this downloadable help may still change between now and when Office 2010 RTMs. Meanwhile, if you are developing a solution to test against an Office 2010 Beta product, you can refer to the installed or downloadable help to learn about the product, and implement your solution based on the Beta product.

So how do you view the versions of help that you obtain by downloading? The help files are in the same .HxS file format that shipped with Office 2007 and Office 2010 Beta. For example, an Outlook developer help file named outlook.dev.hxs was shipped with Outlook 2007 and Outlook 2010 Beta. The best way to view the help file is to use the client help viewer that is part of each Office client product.

Follow these steps to use the client help viewer to view the most recent version of outlook.dev.hxs that you download:

1. Close Outlook 2010 Beta if it is open.

2. Search for the location of outlook.dev.hxs installed by Outlook 2010 Beta. For a computer running 32-bit Windows, typically the location is C:\Program Files\Microsoft Office\Office14\1033. For a computer running 32-bit Office on 64-bit Windows, typically the location is C:\Program Files (x86)\Microsoft Office\Office14\1033. And, for a computer running 64-bit Office, typically the location is C:\Program Files\Microsoft Office\Office14\1033.

3. Rename that copy of outlook.dev.hxs installed by Outlook 2010 Beta as outlook.dev.beta.hxs.

4. Copy the version of outlook.dev.hxs that you downloaded from Office 2010: Developer References to the location you found in step 2.

5. Start Outlook 2010 Beta.

6. Make sure that Developer Reference under Content from This Computer is selected for your client help viewer. You can now view the help you downloaded using the client help viewer.

To view a more recent version of the developer help that you download for any of the other Office applications listed earlier, follow the same steps 1 to 6, by first closing that application, replacing the installed version of the help file by the version you downloaded, and restarting the application. Make sure that you have specified Developer Reference under Content from This Computer for the client help viewer in that application.

For Outlook 2010 Beta, other than the developer reference, you can also view new technical articles on MSDN:

· What's New for Developers in Outlook 2010. This article provides a comprehensive list of new features in the Outlook 2010 object model.

· Extending the User Interface in Outlook 2010. This article describes the numerous new ways you can customize the Outlook 2010 user interface in the Office Fluent ribbons, menus, context menus, and Office Backstage view. This article includes a sample add-in as a download.

· Programming the Outlook 2010 Solutions Module. This article elaborates on the much demanded new APIs in the object model to allow add-ins to customize the Navigation Pane under a new Solutions module. This article includes a sample add-in as a download.

· Shutdown Changes for Outlook 2010 Beta. This article describes important shutdown changes in Outlook 2010 Beta for add-in developers and IT administrators to ensure that Outlook shuts down quickly and consistently.

· Developing an Outlook Social Connector Provider. This article describes how to implement an Outlook Social Connector (OSC) provider that connects a third-party social or professional networking site with a user in Outlook, and allows the user to view social network data from that site without having to leave Outlook. This article includes a sample provider as a download.

The first three of these technical articles provide details and code samples in addition to related content in the Outlook 2010 Developer Reference. The last two articles currently offer the only source of documentation in their respective subject areas.

We Get E-mails: Where Are the Object Members?

soliver — Wed, 03 Dec 2008 00:39:13 GMT

The object model reference documentation for the Office client applications (Word, Excel, Outlook, PowerPoint, Access, etc., etc.) provides detailed information about the associated properties, methods, and events for objects that are exposed through the API of each client application. This information is crucial if you develop applications that automate the client applications. You can find this documentation on both MSDN and within the help content that appears when you press the F1 key while using the Visual Basic Editor in one of the Office client applications.

The way this documentation is structured in the table of contents (TOC) in MSDN, the topmost topic node in the TOC is the object and under the main object topic node, you'll find the nodes for the associated properties, methods, and events.

For example, this is how Word's Document object topic and associated member topics are arranged in the TOC on MSDN:

From there you can easily see that there is a node to a topic ("Document Object Members") that lists all the members associated with the Document object.

But sometimes readers are not browsing the TOC. They might get to the object's main page through a link in a search result or from some other web link. The object's main page looks like this (again using the Document object as an example):

So we get e-mails--"Hey! Where is the list of object members?" For one reason or another, many readers end up on the main page for an object and expect to see a list of the object's members. While there isn't a list of all the object's members on this page, there is a link to the topic that shows all the members for an object. Unfortunately the link is tucked away at the bottom of the page under the See Also section, so it's easy to miss:

Clicking the <Object Name> Object Members link takes you to the topic that shows you all the object's members:

The story is similar for the "F1" help documentation. The main object topic has a link at the bottom that takes you to the topic that lists all the members for the object. Here's the Word Document Object topic in the client help viewer (note the link to the Document Object Members topic under See Also at the bottom):

The link then takes you to the Document Object Members topic where you can see all the objects listed:

Usage Analysis of the Access Developer Reference

Mike Stowe — Fri, 07 Dec 2007 02:07:00 GMT

The 2007 Microsoft Office System was released into the wild about a year ago. I’d like to share what we've learned about your usage of the Access 2007 Developer Reference since its release. BTW, I'm Mike Stowe, the programmability writer for Access.

The data that drives this analysis comes from users who are in a "connected" state while using the Access Developer Reference. When you're in a connected state, help topics are being served to the Help window from Office Online. This is the first time we've had the opportunity to collect usage data and comments from our users. David Hale's Let's Talk about Office VBA Help post contains more information about this connection and how it benefits everyone.

I'll begin by borrowing a chart from David's post. It summarizes the total page views for the top Office 2007 developer references.

I never tire of looking at this one. The Access topics receive, by far, the most views. The Excel and Visual Basic Core topics are also utilized fairly often. We've always known that the Access Developer community was large, but this is the first time that we've had data that compares the relative usage of each content set.

Note that the chart doesn't contain the actual number of page views. I can't share any specific numbers with you, but I hope that you find this analysis useful without them.

The Access Developer Reference is made up of several components. The Access object model help is the core component of the developer reference. Help for DAO, ADO, the Access SQL functions and the Access error messages are the other components included in the Access Developer Reference. In earlier versions of Access, the help topics for each of these components were scattered on your hard disk in separate .chm files. In Access 2007, we unified the components into one browsable, searchable unit.

The next chart breaks down the usage of the Access Developer Reference by component.

This chart reveals the single biggest surprise of our analysis. The error topics make up 1/3 of the page views! We had NO IDEA that this was the case. I'll discuss the ramifications of this finding later when we examine the most-viewed error topics.

Object topics

Which individual topics are used the most? Let's start by examining the top 20 object or collection help topics in the Access Developer Reference.

DoCmd. Form. Application. ComboBox. That's pretty much what I expected to see at or near the top of this chart.

Member topics

Next, let's take a look at the top 20 member topics.

The first thing you'll notice is that the most view topic, DataType Property, isn't part of the Access object model. This topic appears when you press F1 in the Data Type column while in table design view. It's also the most-commented topic outside of the error topics

I don't see any surprises among the actual object model topics in the rest of the chart.

Error topics

Now, let's examine the top 20 error topics.

As I said earlier, I can't share specific numbers, but the top three error topics tower over the rest of the topics in both page views and comments. The interesting data is in the comments left for each topic rather than the page views.

The comments reveal that the topics aren't appropriate for the audience. The topics contain developer-focused terminology such as "Null" and "primary key". The topics were written for a developer who would likely understand the issue and trap the error before it surfaces to their user. Most of the comments appear to come from information workers who just want to make their form work!

I'm going to start addressing these problems by rewriting the topics for the top three errors in a way that will better serve an information worker tasked with using an Access form.

Comment Analysis

The page view data is a useful for spotting usage trends, but comments are much more useful for improving individual topics. Examining all of your comments has revealed the following points:

The top error topics have been, by far, commented on the most.
The DataType Property topic has many people asking about data types for items such as phone numbers and social security numbers. The topic should be modified to clearly explain the relation of a field's Format and Input Mask properties to its data type.
The ValidationRule topics need many more examples.
The new help layout has spawned a couple of common usage issues. You should take a moment to view Quick Tips on using VBA Help with Office video if you've ever wondered why there isn't a table of contents or where to find a list of properties, methods, and events for a particular object.
There have been 84 specific "How do I?" requests.
74 topics contain a general request for code sample.

Most of the topics never reach a critical mass of comments, so the "How do I?" and code sample requests indicate where we should invest our time and resources.

The Bottom Line

The data clearly indicates that the top error topics should be rewritten. I'm working on top three error topics right now.

The DataType Property topic would be more useful if it better explained the relationship between a field's DataType, Format, and Input Mask properties. That's on my to-do list.

I'll prioritize and address "How do I?" and code sample requests as time allows. Requests that touch on the most-used object and members receive the highest priority.

I'd love to hear from you if you have any questions or comments about the Access Developer Reference.

Video: Quick Tips on using VBA Help with Office

dhale — Tue, 06 Nov 2007 01:28:00 GMT

There are some quick and easy things you can do to make sure you are getting the optimal VBA Developer Help experience when working with the 2007 Office System. Watch this three minute video to learn more.