How to: Programmatically Cache a Data Source in an Office Document
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. Remove a data object from the data cache by calling the
StopCaching method of a host item.
StartCaching method and the
StopCaching method are both private, but they appear in IntelliSense.
Applies to: The information in this topic applies to document-level projects for Excel and Word. For more information, see Features Available by Office Application and Project Type.
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.
Declare the data object at the class level, not inside a method. This example assumes that you are declaring a DataSet named
dataSet1that you want to cache programmatically.
Instantiate the data object, and then call the
StartCachingmethod of the document or worksheet instance and pass in the name of the data object.
StopCachingmethod of the document or worksheet instance and pass in the name of the data object. This example assumes that you have a DataSet named
dataSet1that you want to stop caching.
Do not call
StopCachingfrom the event handler for the
Shutdownevent of a document or worksheet. By the time the
Shutdownevent is raised, it is too late to modify the data cache. For more information about the
Shutdownevent, see Events in Office Projects.