RefreshListing Method

Description

Refreshes the listing.

Syntax

Visual Basic
Public Sub RefreshListing( _ ByVal smartUpdate As Boolean, _ ByVal refreshFromServer As Boolean, _ ByVal forceFullRefreshFromServer As Boolean _ )

Parameters

smartUpdate: If true, performs a "smart update" for the listing, preserving current selection and expand/collapse states.
refreshFromServer: If true, refreshes the contents of the listing from the server.
forceFullRefreshFromServer: Controls how refreshing from the server is performed. Specify true to force the retrieval of a full listing from the server. Specify false to allow using previously retrieved listing data as the basis, only applying known changes made after the latest listing retrieval. This parameter is effective only if the refreshFromServer parameter is true.

Remarks

To refresh the listing from the server, but preserving current selection and expand/collapse states, specify the parameters as follows:

smartUpdate = true
refreshFromServer = true
forceFullRefreshFromServer = false

For refreshing behavior that corresponds to pressing F5 in the listing window, specify the parameters as follows:

smartUpdate = false
refreshFromServer = true
forceFullRefreshFromServer = false

For refreshing behavior that corresponds to pressing Shift+F5 in the listing window, specify the parameters as follows:

smartUpdate = false
refreshFromServer = true
forceFullRefreshFromServer = true

Note that the F5 and Shitf+F5 commands in Windows Explorer perform some additional actions that this method does not perform. To invoke the exact same user-initiated behavior as the F5 and Shift+F5 commands perform, use the ExecuteCommand method to invoke the BuiltinCommand_Refresh or BuiltinCommand_RefreshFull command.

Supported in M-Files 10.1.3915.45 and newer.