Component:FileBrowser

This is a userspace component — you cannot attach it anywhere but the userspace. Messing with the userspace can be fun, but it is not recommended as you risk messing your dash up if you don't know what you're doing.

Component image 

File:FileBrowserComponent.png

File Browser component as seen in the Scene Inspector

The FileBrowser component is used to show file lists of files on the user's PC in the dash world Dash Menu.

Fields

Fields

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
SelectedItem	BrowserItem	The currently selected item being highlighted.
_previousSelectedItem	BrowserItem	The item previously highlighted.
AllowSelect	Bool	Whether this file browser allows selecting item elements.
ItemSize	Float	How big the items are on the view.
_selectedText	Text	The text to fill with the name of the selected item.
_pathRoot	Slot	The root of the area being used to display the current path.
_buttonsRoot	Slot	The root of the area being used to show the different button actions.
_folderGrid	GridLayout	The grid layout Component being used to align the folders in the directory.
_itemGrid	GridLayout	The grid layout Component being used to align the files in the directory.
_tabSprite	SpriteProvider	The sprite being used to show the tab sprite.
_loadingIndicator	Slot	The slot that stores the loading indicator for a newly opened directory.
_swapper	SlideSwapRegion	The component to handle the slide animation when opening a different directory.
CurrentPath	String	The current folder path.
_lastPath	String	The last folder path.
_user	direct MachineUserRef	The user using this file browser.
_importButton	Button	The button to import a selected folder or file.
_rawImportButton	Button	The button to import a selected file as a raw file object.
_createNewButton	Button	The button to create a new file directory.
_reloadButton	Button	The button used to refresh the folder and file list.

Sync Delegates

Triggers

Method Name	Method type and Arguments.	Is the method hidden?	Description
CreateDirectory:CreateHandler	CreateHandler	✓	Called when a directory is created.
RunImport:ButtonEventHandler	ButtonEventHandler	✓	Called when an import needs to be made of a file.
RunRawImport:ButtonEventHandler	ButtonEventHandler	✓	Called when a raw file import needs to be made of a file.
CreateNew:ButtonEventHandler	ButtonEventHandler	✓	Called when a new item needs to be made.
Reload:ButtonEventHandler	ButtonEventHandler	✓	Called when a reload needs to be done.
OnGoUp:ButtonEventHandler<int>	ButtonEventHandler<int>	✓	Called when the user wants to go up in directories.

CreateHandler

Handles creation of directories. Is a sync delegate type.

Usage

Not used directly by the user.

Examples

Used in the dash menu on the file browser tab.