Read-write. Indicates whether or not the current document should be refreshed whenever the corresponding back-end document changes. Refreshing the current document updates its representation in memory, and visually on the workspace, to reflect the changes that have been made to the back-end document.

Defined in

NotesUIDocument

Data type

Boolean

Syntax

To get: flag = notesUIDocument.AutoReload

To set: notesUIDocument.AutoReload = flag

Legal values

• True indicates that the current document will be automatically reloaded any time there is a change.
• False indicates that the current document will not automatically be reloaded; use the Reload method to reload it.

Modifications made to non-rich-text items on the back-end document accessed through the Document property appear on the current document immediately; AutoReload is unnecessary. Modifications made to non-rich-text items on the corresponding back-end document accessed from the front-end document but not through the Document property (for example, if you use GetDocumentByUNID) do not appear immediately unless AutoReload is True. To make the modifications appear when AutoReload is False, call the Reload method or close the document and reopen it.

Modifications made to rich-text items on the back-end document do not appear on the current document until it is closed and reopened.

Modifications made to items on the corresponding back-end document accessed outside the front-end document (for example, by an agent or another user) do not appear unless the document is closed and reopened.

Example
See Also

Document property
Reload method

Glossary