Share via


CacheBehavior Property

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

The CacheBehavior property indicates how a dashboard factory should cache the HTML generated for a given Web Part. Caching this HTML might improve performance when refreshing dramatically, but the Web Part potentially will ignore new data from a content link until the cache timeout has occurred. This property can contain one of the following values.

Property Value
0 No caching.
1 Cache HTML for each user. If the dashboard factory cannot cache HTML for each user, it should not cache HTML at all.
2 Cache HTML for all users. The dashboard factory keeps one cache for all users. You should use this setting only when the content of the Web Part is not user-specific, because all users share the same cache.

Dashboard factories can handle values other than these; however, a dashboard uses the default setting of 0 (no caching) if it cannot interpret the value. If a dashboard factory cannot cache generated HTML for each user (for example, if there is no ASP application for the current folder), it does not cache the HTML for any Web Part whose CacheBehavior property is set to 1 (cache HTML for each user), because this would violate security and could expose personal information to other users. Any page you create to make it possible for users to edit a Web Part should include a warning if a user attempts to set this value to 2, or cache for all users, to explain to the user what that means.

**Note   **This property will not be supported in the DDRK 2.0 Dashboard Factory. This property might exist, but the factory will not use it. Future versions of the factory will use this property, so Web Part authors can define a value for it now in anticipation of support in a future version.

Property Value
Data Type Long
Default 0
IsContentIndexed FALSE
IsIndexed FALSE
IsMultiValued FALSE
IsReadOnly FALSE
IsRequired FALSE
IsVisible TRUE
Version 1
TextFormat NA

See Also

Web Part Schema Properties | CacheTimeout Property