The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

How to: Programmatically Cache a Data Source in an Office Document

Applies to

The information in this topic applies only to the specified Visual Studio Tools for Office projects and versions of Microsoft Office.

Project type

  • Document-level projects

Microsoft Office version

  • 2007 Microsoft Office system

  • Microsoft Office 2003

For more information, see Features Available by Application and Project Type.

You can programmatically add a data object to the data cache in a document by calling the StartCaching method of a host item, such as a Document, Workbook, or Worksheet. The StartCaching method is private, but it appears in IntelliSense.

When you use the StartCaching method to add a data object to the data cache, the data object does not need to be declared with the CachedAttribute attribute. However, the data object must meet certain requirements to be added to the data cache. For more information, see Caching Data.

To programmatically cache a data object

  1. Declare the data object at the class level, not inside a method. This example assumes that you are declaring a DataSet named dataSet1 that you want to cache programmatically.

    public DataSet dataSet1;
  2. Instantiate the data object, and then call the StartCaching method of the document or worksheet instance and pass in the name of the data object.

    dataSet1 = new DataSet();
    if (!this.IsCached("dataSet1"))
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2015 Microsoft