SftDirectory.AutoReload Property
Defines whether the control's contents are automatically updated when folders and their contents change.
Syntax
Get
| VB.NET | Boolean = object.AutoReload As Boolean |
| VB | Boolean = object.AutoReload As Boolean |
| C#.NET | bool Boolean = object.AutoReload; |
| VC++ | VARIANT_BOOL Boolean = object->AutoReload;
VARIANT_BOOL Boolean = object->GetAutoReload(); |
| C | HRESULT object->get_AutoReload(VARIANT_BOOL* Boolean); |
Put
| VB.NET | object.AutoReload = Boolean As Boolean |
| VB | object.AutoReload = Boolean As Boolean |
| C#.NET | bool object.AutoReload = Boolean; |
| VC++ | VARIANT_BOOL object->AutoReload = Boolean;
void object->PutAutoReload(VARIANT_BOOL Boolean); |
| C | HRESULT object->put_AutoReload(VARIANT_BOOL Boolean); |
object
A SftDirectory object.
Boolean
Defines whether the control's contents are automatically updated when folders and their contents change.
| Boolean | Description |
|---|
| True | The control's contents are automatically updated when folders and their contents change. |
| False | The control's contents are not updated. |
Comments
The AutoReload property defines whether the control's contents are automatically updated when folders and their contents change.
When setting the AutoReload property at run-time, the control's Reload method (SyncContents = False) must be used to reload the entire contents.
Changes to folders by the current application or system-wide can be monitored by the SftDirectory control and its folder displays can be automatically updated. This is generally desirable as it reflects the current file system. If AutoReload is set to True, folder listings are updated by inserting and removing new and deleted folders. This can affect the currently selected folder (see CurrentFolder property and Selection property). While many folder changes are reflected, certain changes do not cause the folder listings to be updated. The behavior of the SftDirectory control is similar to Windows Explorer. To insure that the current folder listings are accurate, an application can refresh the control's contents using the Reload method.
Setting AutoReload to False prevents updates to the current folder listing, saving system resources.
The user can request the contents to be refreshed using the F5 key, if the control has the input focus.
An application can refresh the control's contents using the Reload method.
See Also SftDirectory Object | Object Hierarchy
On
Off