Reload Method  
 

Forces a complete reload of the current page.

Syntax

object.Reload( ClearCache )

Parameters

ClearCache
An optional boolean which indicates if the document cache for the session should be cleared. A value of True specifies the cache should be cleared; False specifies the cache should not be cleared. If this parameter is not specified, the cache will not be cleared.

Return Value

Returns True if the method succeeds or False if the method fails.

Remarks

The Reload method refreshes the currently loaded page, similar to pressing F5 in a web browser. If the ClearCache parameter is True, the document cache is also cleared before reloading, ensuring that all resources are fetched again from the server instead of being served from the local cache.

This method is generally preferred over Refresh when an application only needs to reload the content without forcing the host window and browser control to repaint. It provides a lightweight way to refresh the page and optionally reset cached resources, without the overhead of a full redraw of the hosting window.

An application would typically use this method in response to a user action or when it needs to ensure the latest version of a document is displayed after cached data may have become stale.

See Also

Refresh Method, Reset Method