SftDirectory 2.5

SftDirectoryFolder.Reload Method

Softel vdm, Inc.

Reloads the file/folder's contents.

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 SftDirectoryFolder object.

SyncContents

Defines how the folder is updated.

SyncContents

Description

True

The folder's current contents are updated by inserting new subfolders and removing deleted subfolders.

False

The folder's contents are completely removed and all subfolders are reloaded.  

Depth

Defines how subfolders are updated.

Depth

Description

True

The folder's current contents are updated by visiting each already loaded subfolder and adding/removing new/deleted folders. 

False

The folder's contents are updated only.  If SyncContents is False, Depth is ignored and the folder's contents are reloaded.

Comments

The Reload method reloads the file/folder's contents.

By setting SyncContents to True, current content is left unmodified, preserving customizations to folders an application has made, such as folders' Tag properties. New folders are added and folders that no longer exist are removed.  Otherwise, if SyncContents is set to False, the folder's contents are removed and then reloaded.

The control's contents can be reloaded using the control's Reload method.


Feedback / comments / error reports for this topic
© 2003, 2008 - Softel vdm, Inc. - www.softelvdm.com