How to: Programmatically Cache a Data Source in an Office Document
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here. ArchiveDisclaimer

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

Note Required applications

The features in this topic are available only if you have the required applications installed.

For more information, see Features Available by Product Combination.

  • One of these development environments:

    VSTO 2005

    -or-

    Visual Studio Team System

  • Microsoft Office 2003

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 Objects.

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"))
    {
        this.StartCaching("dataSet1");
    }
    
    

See Also

Show:
© 2016 Microsoft