Platforms to show: All Mac Windows Linux Cross-Platform

Back to FileListMBS class.

FileListMBS.Cancel as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Files MBS Util Plugin 22.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Tells FileListMBS to stop gathering files.

To be used with threaded flag to stop background threads from working on directory listings soon. You may want to set FileListMBS.cancel to true in app.CancelClose when you let the application has a running thread, so you can quit properly.

The constructors set cancel = false to make sure they work.
(Read and Write property)

FileListMBS.Threaded as Boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Files MBS Util Plugin 22.5 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Whether you want to run FileListMBS constructors threaded.

If you run code in a Xojo thread, which uses FileListMBS, you can set this property to true. We then do the work on a preemptive thread to keep the GUI responsive.
(Read and Write property)

FileListMBS.YieldTicks as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared property Files MBS Util Plugin 19.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
How much time is given back to Xojo for other ticks.
Example
FileListMBS.YieldTicks = 6

If value is greater than zero, the application will yield to another Xojo thread after the given number of ticks have passed. 60 ticks are one second. Using a small value can slow down processing a lot while a big value keeps your application not responding to mouse clicks.
If you use this property with e.g. 6 as the value, you may also want to use this method in a thread so you can handle mouse events or let Xojo redraw a progressbar.

For threaded FileListMBS, this property has no effect.
(Read and Write property)

The items on this page are in the following plugins: MBS Util Plugin.


The biggest plugin in space...