SftDirectory.Reload Method
|
|
|
|
|
|
SftDirectory.Reload Method |
Reloads all files/folders.
Syntax
|
VB.NET |
object.Reload(ByVal SyncContents As Boolean, ByVal Depth As Boolean) |
||
|
VB |
object.Reload(ByVal SyncContents As Boolean, ByVal Depth As Boolean) |
||
|
C#.NET |
void object.Reload(bool SyncContents, bool Depth); |
||
|
VC++ |
HRESULT object->Reload(VARIANT_BOOL SyncContents, VARIANT_BOOL Depth); |
||
|
C |
HRESULT object->raw_Reload(VARIANT_BOOL SyncContents, VARIANT_BOOL Depth); |
||
|
Delphi |
procedure object.Reload(SyncContents : WordBool, Depth : WordBool); |
object
A SftDirectory object.
SyncContents
Defines how the contents are updated.
|
SyncContents |
Description |
|
True |
The control's current contents are updated by inserting new files/folders and removing deleted files/folders. |
|
False |
The control's contents are completely removed and all files/folders are reloaded. |
Depth
Defines how files/folders are updated.
|
Depth |
Description |
|
True |
The control's current contents are updated by visiting each already loaded file/folder and adding/removing new/deleted files/folders. |
|
False |
The root folder's contents are updated only. If SyncContents is False, Depth is ignored and the complete contents are reloaded. |
Comments
The Reload method reloads all files/folders.
By setting SyncContents to True, current content is left unmodified, preserving customizations to files/folders an application has made, such as files/folders' Tag properties. New files/folders are added and folders that no longer exist are removed. Otherwise, if SyncContents is set to False, the control's contents are removed and then reloaded.
One single folder's entries can be reloaded using the file/folder's Folder.Reload method.
An end-user can click F5 to refresh the control contents.