Native file browser various actions like open file, open folder and save file. More...

Inheritance diagram for Crosstales.FB.FileBrowser:

Public Member Functions
delegate void	OpenFilesStart ()

delegate void	OpenFilesComplete (bool selected, string singleFile, string[] files)

delegate void	OpenFoldersStart ()

delegate void	OpenFoldersComplete (bool selected, string singleFolder, string[] folders)

delegate void	SaveFileStart ()

delegate void	SaveFileComplete (bool selected, string file)

string	OpenSingleFile (string extension="*")
	Open native file browser for a single file. More...

string	OpenSingleFile (string title, string directory, string defaultName, params string[] extensions)
	Open native file browser for a single file. More...

string	OpenSingleFile (string title, string directory, string defaultName, params ExtensionFilter[] extensions)
	Open native file browser for a single file. More...

string[]	OpenFiles (string extension="*")
	Open native file browser for multiple files. More...

string[]	OpenFiles (string title, string directory, string defaultName, params string[] extensions)
	Open native file browser for multiple files. More...

string[]	OpenFiles (string title, string directory, string defaultName, params ExtensionFilter[] extensions)
	Open native file browser for multiple files. More...

string	OpenSingleFolder ()
	Open native folder browser for a single folder. More...

string	OpenSingleFolder (string title, string directory="")
	Open native folder browser for a single folder. NOTE: Title is not supported under Windows and UWP (WSA)! More...

string[]	OpenFolders ()
	Open native folder browser for multiple folders. NOTE: Title and multiple folder selection are not supported under Windows and UWP (WSA)! More...

string[]	OpenFolders (string title, string directory="")
	Open native folder browser for multiple folders. NOTE: Title and multiple folder selection are not supported under Windows and UWP (WSA)! More...

string	SaveFile (string defaultName="", string extension="*")
	Open native save file browser. More...

string	SaveFile (string title, string directory, string defaultName, params string[] extensions)
	Open native save file browser. More...

string	SaveFile (string title, string directory, string defaultName, params ExtensionFilter[] extensions)
	Open native save file browser More...

void	OpenSingleFileAsync (string extension="*")
	Asynchronously opens native file browser for a single file. More...

void	OpenSingleFileAsync (string title, string directory, string defaultName, params string[] extensions)
	Asynchronously opens native file browser for a single file. More...

void	OpenSingleFileAsync (string title, string directory, string defaultName, params ExtensionFilter[] extensions)
	Asynchronously opens native file browser for a single file. More...

void	OpenFilesAsync (bool multiselect=true, params string[] extensions)
	Asynchronously opens native file browser for multiple files. More...

void	OpenFilesAsync (string title, string directory, string defaultName, bool multiselect=true, params string[] extensions)
	Asynchronously opens native file browser for multiple files. More...

void	OpenFilesAsync (string title, string directory, string defaultName, bool multiselect=true, params ExtensionFilter[] extensions)
	Asynchronously opens native file browser for multiple files. More...

void	OpenSingleFolderAsync ()
	Asynchronously opens native folder browser for a single folder. More...

void	OpenSingleFolderAsync (string title, string directory="")
	Asynchronously opens native folder browser for a single folder. NOTE: Title is not supported under Windows and UWP (WSA)! More...

void	OpenFoldersAsync (bool multiselect=true)
	Asynchronously opens native folder browser for multiple folders. More...

void	OpenFoldersAsync (string title, string directory="", bool multiselect=true)
	Asynchronously opens native folder browser for multiple folders. More...

void	SaveFileAsync (string defaultName="", string extension="*")
	Asynchronously opens native save file browser. More...

void	SaveFileAsync (string title, string directory, string defaultName, params string[] extensions)
	Asynchronously opens native save file browser. More...

void	SaveFileAsync (string title, string directory, string defaultName, params ExtensionFilter[] extensions)
	Asynchronously opens native save file browser (async) More...

string[]	GetFiles (string path, bool isRecursive, params ExtensionFilter[] extensions)
	Find files inside a path. More...

string[]	GetFiles (string path, bool isRecursive=false, params string[] extensions)
	Find files inside a path. More...

string[]	GetFolders (string path, bool isRecursive=false)
	Find folders inside. More...

string[]	GetDrives ()
	Find all logical drives. More...

void	OpenFilesAsync (System.Action< string[]> cb, bool multiselect=true, params string[] extensions)
	Open native file browser for multiple files. More...

void	OpenFilesAsync (System.Action< string[]> cb, string title, string directory, string defaultName, bool multiselect=true, params string[] extensions)
	Open native file browser for multiple files. More...

void	OpenFilesAsync (System.Action< string[]> cb, string title, string directory, string defaultName, bool multiselect=true, params ExtensionFilter[] extensions)
	Open native file browser for multiple files (async). More...

void	OpenFoldersAsync (System.Action< string[]> cb, bool multiselect=true)
	Open native folder browser for multiple folders (async). More...

void	OpenFoldersAsync (System.Action< string[]> cb, string title, string directory="", bool multiselect=true)
	Open native folder browser for multiple folders (async). More...

void	SaveFileAsync (System.Action< string > cb, string defaultName="", string extension="*")
	Open native save file browser More...

void	SaveFileAsync (System.Action< string > cb, string title, string directory, string defaultName, params string[] extensions)
	Open native save file browser More...

void	SaveFileAsync (System.Action< string > cb, string title, string directory, string defaultName, params ExtensionFilter[] extensions)
	Open native save file browser (async). More...

Static Public Member Functions
static void	CopyFile (string sourceFile, string destFile, bool move=false)
	Copy or move a file. More...

static void	CopyFolder (string sourcePath, string destPath, bool move=false)
	Copy or move a folder. More...

static void	ShowFile (string file)
	Shows the location of a file (or folder) in OS file explorer. NOTE: only works on standalone platforms More...

static void	ShowFolder (string path)
	Shows the location of a folder (or file) in OS file explorer. NOTE: only works on standalone platforms More...

static void	OpenFile (string file)
	Opens a file with the OS default application. NOTE: only works for standalone platforms More...

Static Public Member Functions inherited from Crosstales.Common.Util.Singleton< FileBrowser >
static void	CreateInstance (bool searchExistingGameObject=true, bool deleteExistingInstance=false)
	Creates an instance of this object. More...

static void	DeleteInstance ()
	Deletes the instance of this object. More...

Public Attributes
string	CurrentOpenSingleFileName => getNameFromPath(CurrentOpenSingleFile)
	Returns the file name (without path) from the last "OpenSingleFile"-action. More...

string	CurrentOpenSingleFolderName => getNameFromPath(CurrentOpenSingleFolder)
	Returns the folder name (without path) from the last "OpenSingleFolder"-action. More...

string	CurrentSaveFileName => getNameFromPath(CurrentSaveFile)
	Returns the file name (without path) from the last "SaveFile"-action. More...

byte[]	CurrentOpenSingleFileData => wrapperHolder?.PlatformWrapper?.CurrentOpenSingleFileData
	Returns the data of the file from the last "OpenSingleFile"-action. More...

bool	canOpenFile => wrapperHolder?.PlatformWrapper.canOpenFile ?? false
	Indicates if this wrapper can open a file. More...

bool	canOpenFolder => wrapperHolder?.PlatformWrapper.canOpenFolder ?? false
	Indicates if this wrapper can open a folder. More...

bool	canSaveFile => wrapperHolder?.PlatformWrapper.canSaveFile ?? false
	Indicates if this wrapper can save a file. More...

bool	canOpenMultipleFiles => wrapperHolder?.PlatformWrapper.canOpenMultipleFiles ?? false
	Indicates if this wrapper can open multiple files. More...

bool	canOpenMultipleFolders => wrapperHolder?.PlatformWrapper.canOpenMultipleFolders ?? false
	Indicates if this wrapper can open multiple folders. More...

bool	isPlatformSupported => wrapperHolder?.PlatformWrapper.isPlatformSupported ?? true
	Indicates if this wrapper is supporting the current platform. More...

bool	isWorkingInEditor => wrapperHolder?.PlatformWrapper.isWorkingInEditor ?? false
	Indicates if this wrapper is working directly inside the Unity Editor (without 'Play'-mode). More...

OnOpenFilesCompleted	OnOpenFilesCompleted

OnOpenFoldersCompleted	OnOpenFoldersCompleted

OnSaveFileCompleted	OnSaveFileCompleted

Protected Member Functions
override void	Awake ()

Protected Member Functions inherited from Crosstales.Common.Util.Singleton< FileBrowser >
virtual void	OnDestroy ()

virtual void	OnApplicationQuit ()

Properties
BaseCustomFileBrowser	CustomWrapper `[get, set]`
	Custom wrapper for File Browser. More...

bool	CustomMode `[get, set]`
	Enables or disables the custom wrapper. More...

bool	LegacyFolderBrowser `[get, set]`
	Use the legacy folder browser (Windows). More...

bool	AskOverwriteFile `[get, set]`
	Ask to overwrite existing file in save dialog (Windows). More...

bool	AllowSyncCalls `[get, set]`
	Allow synchronous calls (macOS). More...

bool	AlwaysReadFile `[get, set]`
	Always read the file data (UWP). More...

string	TitleOpenFile `[get, set]`
	Title for the 'Open File'-dialog. More...

string	TitleOpenFiles `[get, set]`
	Title for the 'Open Files'-dialog. More...

string	TitleOpenFolder `[get, set]`
	Title for the 'Open Folder'-dialog. More...

string	TitleOpenFolders `[get, set]`
	Title for the 'Open Folders'-dialog. More...

string	TitleSaveFile `[get, set]`
	Title for the 'Save File'-dialog. More...

string	TextAllFiles `[get, set]`
	Text for 'All Files'-filter (*). More...

string	NameSaveFile `[get, set]`
	Default name of the save-file. More...

string??	CurrentOpenSingleFile `[get, set]`
	Returns the file from the last "OpenSingleFile"-action. More...

string[]??	CurrentOpenFiles `[get, set]`
	Returns the array of files from the last "OpenFiles"-action. More...

string??	CurrentOpenSingleFolder `[get, set]`
	Returns the folder from the last "OpenSingleFolder"-action. More...

string[]??	CurrentOpenFolders `[get, set]`
	Returns the array of folders from the last "OpenFolders"-action. More...

string??	CurrentSaveFile `[get, set]`
	Returns the file from the last "SaveFile"-action. More...

byte[]??	CurrentSaveFileData `[get, set]`
	The data for the "SaveFile"-action. More...

Properties inherited from Crosstales.Common.Util.Singleton< FileBrowser >
static T	Instance `[get, protected set]`
	Returns the singleton instance of this class. More...

bool	DontDestroy `[get, set]`
	Don't destroy gameobject during scene switches. More...

Events
OpenFilesStart	OnOpenFilesStart
	An event triggered whenever "OpenFiles" is started. More...

OpenFilesComplete	OnOpenFilesComplete
	An event triggered whenever "OpenFiles" is completed. More...

OpenFoldersStart	OnOpenFoldersStart
	An event triggered whenever "OpenFolders" is started. More...

OpenFoldersComplete	OnOpenFoldersComplete
	An event triggered whenever "OpenFolders" is completed. More...

SaveFileStart	OnSaveFileStart
	An event triggered whenever "SaveFile" is started. More...

SaveFileComplete	OnSaveFileComplete
	An event triggered whenever "SaveFile" is completed. More...

Additional Inherited Members
Static Public Attributes inherited from Crosstales.Common.Util.Singleton< FileBrowser >
static string	PrefabPath
	Fully qualified prefab path. More...

static string	GameObjectName
	Name of the gameobject in the scene. More...

Static Protected Attributes inherited from Crosstales.Common.Util.Singleton< FileBrowser >
static T	instance

Detailed Description

Native file browser various actions like open file, open folder and save file.

Member Function Documentation

◆ CopyFile()

static void Crosstales.FB.FileBrowser.CopyFile	(	string	sourceFile,
		string	destFile,
		bool	move = `false`
	)

static

Copy or move a file.

Parameters

sourceFile	Source file path
destFile	Destination file path
move	Move file instead of copy (default: false, optional)

◆ CopyFolder()

static void Crosstales.FB.FileBrowser.CopyFolder	(	string	sourcePath,
		string	destPath,
		bool	move = `false`
	)

static

Copy or move a folder.

Parameters

sourcePath	Source folder path
destPath	Destination folder path
move	Move folder instead of copy (default: false, optional)

◆ GetDrives()

string [] Crosstales.FB.FileBrowser.GetDrives ( )

Find all logical drives.

Returns: Returns array of the found drives. Zero length array when an error occured.

◆ GetFiles() [1/2]

string [] Crosstales.FB.FileBrowser.GetFiles	(	string	path,
		bool	isRecursive,
		params ExtensionFilter[]	extensions
	)

Find files inside a path.

Parameters

path	Path to find the files
isRecursive	Recursive search
extensions	List of extension filters for the search (optional)

Returns: Returns array of the found files inside the path. Zero length array when an error occured.

◆ GetFiles() [2/2]

string [] Crosstales.FB.FileBrowser.GetFiles	(	string	path,
		bool	isRecursive = `false`,
		params string[]	extensions
	)

Find files inside a path.

Parameters

path	Path to find the files
isRecursive	Recursive search (default: false, optional)
extensions	Extensions for the file search, e.g. "png" (optional)

Returns: Returns array of the found files inside the path (alphabetically ordered). Zero length array when an error occured.

◆ GetFolders()

string [] Crosstales.FB.FileBrowser.GetFolders	(	string	path,
		bool	isRecursive = `false`
	)

Find folders inside.

Parameters

path	Path to find the directories
isRecursive	Recursive search (default: false, optional)

Returns: Returns array of the found directories inside the path. Zero length array when an error occured.

◆ OpenFile()

static void Crosstales.FB.FileBrowser.OpenFile ( string file )

static

Opens a file with the OS default application. NOTE: only works for standalone platforms

Parameters

file File path

◆ OpenFiles() [1/3]

string [] Crosstales.FB.FileBrowser.OpenFiles ( string extension = "*" )

Open native file browser for multiple files.

Parameters

extension Allowed extension, e.g. "png" (optional)

Returns: Returns array of chosen files. Zero length array when cancelled

◆ OpenFiles() [2/3]

string [] Crosstales.FB.FileBrowser.OpenFiles	(	string	title,
		string	directory,
		string	defaultName,
		params ExtensionFilter[]	extensions
	)

Open native file browser for multiple files.

Parameters

title	Dialog title
directory	Root directory
defaultName	Default file name (currently only supported under Windows standalone)
extensions	List of extension filters (optional)

Returns: Returns array of chosen files. Zero length array when cancelled

◆ OpenFiles() [3/3]

string [] Crosstales.FB.FileBrowser.OpenFiles	(	string	title,
		string	directory,
		string	defaultName,
		params string[]	extensions
	)

Open native file browser for multiple files.

Parameters

title	Dialog title
directory	Root directory
defaultName	Default file name (currently only supported under Windows standalone)
extensions	Allowed extensions, e.g. "png" (optional)

Returns: Returns array of chosen files. Zero length array when cancelled

◆ OpenFilesAsync() [1/6]

void Crosstales.FB.FileBrowser.OpenFilesAsync	(	bool	multiselect = `true`,
		params string[]	extensions
	)

Asynchronously opens native file browser for multiple files.

Parameters

multiselect	Allow multiple file selection (default: true, optional)
extensions	Allowed extensions, e.g. "png" (optional)

Returns: Returns array of chosen files. Zero length array when cancelled

◆ OpenFilesAsync() [2/6]

void Crosstales.FB.FileBrowser.OpenFilesAsync	(	string	title,
		string	directory,
		string	defaultName,
		bool	multiselect = `true`,
		params ExtensionFilter[]	extensions
	)

Asynchronously opens native file browser for multiple files.

Parameters

title	Dialog title
directory	Root directory
defaultName	Default file name (currently only supported under Windows standalone)
multiselect	Allow multiple file selection (default: true, optional)
extensions	List of extension filters (optional)

Returns: Returns array of chosen files. Zero length array when cancelled

◆ OpenFilesAsync() [3/6]

void Crosstales.FB.FileBrowser.OpenFilesAsync	(	string	title,
		string	directory,
		string	defaultName,
		bool	multiselect = `true`,
		params string[]	extensions
	)

Asynchronously opens native file browser for multiple files.

Parameters

title	Dialog title
directory	Root directory
defaultName	Default file name (currently only supported under Windows standalone)
multiselect	Allow multiple file selection (default: true, optional)
extensions	Allowed extensions, e.g. "png" (optional)

Returns: Returns array of chosen files. Zero length array when cancelled

◆ OpenFilesAsync() [4/6]

void Crosstales.FB.FileBrowser.OpenFilesAsync	(	System.Action< string[]>	cb,
		bool	multiselect = `true`,
		params string[]	extensions
	)

Open native file browser for multiple files.

Parameters

cb	Callback for the async operation.
multiselect	Allow multiple file selection (default: true, optional)
extensions	Allowed extensions, e.g. "png" (optional)

Returns: Returns array of chosen files. Zero length array when cancelled

◆ OpenFilesAsync() [5/6]

void Crosstales.FB.FileBrowser.OpenFilesAsync	(	System.Action< string[]>	cb,
		string	title,
		string	directory,
		string	defaultName,
		bool	multiselect = `true`,
		params ExtensionFilter[]	extensions
	)

Open native file browser for multiple files (async).

Parameters

cb	Callback for the async operation.
title	Dialog title
directory	Root directory
defaultName	Default file name (currently only supported under Windows standalone)
multiselect	Allow multiple file selection (default: true, optional)
extensions	List of extension filters (optional)

Returns: Returns array of chosen files. Zero length array when cancelled

◆ OpenFilesAsync() [6/6]

void Crosstales.FB.FileBrowser.OpenFilesAsync	(	System.Action< string[]>	cb,
		string	title,
		string	directory,
		string	defaultName,
		bool	multiselect = `true`,
		params string[]	extensions
	)

Open native file browser for multiple files.

Parameters

cb	Callback for the async operation.
title	Dialog title
directory	Root directory
defaultName	Default file name (currently only supported under Windows standalone)
multiselect	Allow multiple file selection (default: true, optional)
extensions	Allowed extensions, e.g. "png" (optional)

Returns: Returns array of chosen files. Zero length array when cancelled

◆ OpenFolders() [1/2]

string [] Crosstales.FB.FileBrowser.OpenFolders ( )

Open native folder browser for multiple folders. NOTE: Title and multiple folder selection are not supported under Windows and UWP (WSA)!

Returns: Returns array of chosen folders. Zero length array when cancelled

◆ OpenFolders() [2/2]

string [] Crosstales.FB.FileBrowser.OpenFolders	(	string	title,
		string	directory = `""`
	)

Open native folder browser for multiple folders. NOTE: Title and multiple folder selection are not supported under Windows and UWP (WSA)!

Parameters

title	Dialog title
directory	Root directory (default: current, optional)

Returns: Returns array of chosen folders. Zero length array when cancelled

◆ OpenFoldersAsync() [1/4]

void Crosstales.FB.FileBrowser.OpenFoldersAsync ( bool multiselect = true )

Asynchronously opens native folder browser for multiple folders.

Parameters

multiselect Allow multiple folder selection (default: true, optional)

Returns: Returns array of chosen folders. Zero length array when cancelled

◆ OpenFoldersAsync() [2/4]

void Crosstales.FB.FileBrowser.OpenFoldersAsync	(	string	title,
		string	directory = `""`,
		bool	multiselect = `true`
	)

Asynchronously opens native folder browser for multiple folders.

Parameters

title	Dialog title
directory	Root directory (default: current, optional)
multiselect	Allow multiple folder selection (default: true, optional)

Returns: Returns array of chosen folders. Zero length array when cancelled

◆ OpenFoldersAsync() [3/4]

void Crosstales.FB.FileBrowser.OpenFoldersAsync	(	System.Action< string[]>	cb,
		bool	multiselect = `true`
	)

Open native folder browser for multiple folders (async).

Parameters

cb	Callback for the async operation.
multiselect	Allow multiple folder selection (default: true, optional)

Returns: Returns array of chosen folders. Zero length array when cancelled

◆ OpenFoldersAsync() [4/4]

void Crosstales.FB.FileBrowser.OpenFoldersAsync	(	System.Action< string[]>	cb,
		string	title,
		string	directory = `""`,
		bool	multiselect = `true`
	)

Open native folder browser for multiple folders (async).

Parameters

cb	Callback for the async operation.
title	Dialog title
directory	Root directory (default: current, optional)
multiselect	Allow multiple folder selection (default: true, optional)

Returns: Returns array of chosen folders. Zero length array when cancelled

◆ OpenSingleFile() [1/3]

string Crosstales.FB.FileBrowser.OpenSingleFile ( string extension = "*" )

Open native file browser for a single file.

Parameters

extension Allowed extension, e.g. "png" (optional)

Returns: Returns a string of the chosen file. Empty string when cancelled

◆ OpenSingleFile() [2/3]

string Crosstales.FB.FileBrowser.OpenSingleFile	(	string	title,
		string	directory,
		string	defaultName,
		params ExtensionFilter[]	extensions
	)

Open native file browser for a single file.

Parameters

title	Dialog title
directory	Root directory
defaultName	Default file name (currently only supported under Windows standalone)
extensions	List of extension filters (optional)

Returns: Returns a string of the chosen file. Empty string when cancelled

◆ OpenSingleFile() [3/3]

string Crosstales.FB.FileBrowser.OpenSingleFile	(	string	title,
		string	directory,
		string	defaultName,
		params string[]	extensions
	)

Open native file browser for a single file.

Parameters

title	Dialog title
directory	Root directory
defaultName	Default file name (currently only supported under Windows standalone)
extensions	Allowed extensions, e.g. "png" (optional)

Returns: Returns a string of the chosen file. Empty string when cancelled

◆ OpenSingleFileAsync() [1/3]

void Crosstales.FB.FileBrowser.OpenSingleFileAsync ( string extension = "*" )

Asynchronously opens native file browser for a single file.

Parameters

extension Allowed extension, e.g. "png" (optional)

Returns: Returns a string of the chosen file. Empty string when cancelled

◆ OpenSingleFileAsync() [2/3]

void Crosstales.FB.FileBrowser.OpenSingleFileAsync	(	string	title,
		string	directory,
		string	defaultName,
		params ExtensionFilter[]	extensions
	)

Asynchronously opens native file browser for a single file.

Parameters

title	Dialog title
directory	Root directory
defaultName	Default file name (currently only supported under Windows standalone)
extensions	List of extension filters (optional)

Returns: Returns a string of the chosen file. Empty string when cancelled

◆ OpenSingleFileAsync() [3/3]

void Crosstales.FB.FileBrowser.OpenSingleFileAsync	(	string	title,
		string	directory,
		string	defaultName,
		params string[]	extensions
	)

Asynchronously opens native file browser for a single file.

Parameters

title	Dialog title
directory	Root directory
defaultName	Default file name (currently only supported under Windows standalone)
extensions	Allowed extensions, e.g. "png" (optional)

Returns: Returns a string of the chosen file. Empty string when cancelled

◆ OpenSingleFolder() [1/2]

string Crosstales.FB.FileBrowser.OpenSingleFolder ( )

Open native folder browser for a single folder.

Returns: Returns a string of the chosen folder. Empty string when cancelled

◆ OpenSingleFolder() [2/2]

string Crosstales.FB.FileBrowser.OpenSingleFolder	(	string	title,
		string	directory = `""`
	)

Open native folder browser for a single folder. NOTE: Title is not supported under Windows and UWP (WSA)!

Parameters

title	Dialog title
directory	Root directory (default: current, optional)

Returns: Returns a string of the chosen folder. Empty string when cancelled

◆ OpenSingleFolderAsync() [1/2]

void Crosstales.FB.FileBrowser.OpenSingleFolderAsync ( )

Asynchronously opens native folder browser for a single folder.

Returns: Returns a string of the chosen folder. Empty string when cancelled

◆ OpenSingleFolderAsync() [2/2]

void Crosstales.FB.FileBrowser.OpenSingleFolderAsync	(	string	title,
		string	directory = `""`
	)

Asynchronously opens native folder browser for a single folder. NOTE: Title is not supported under Windows and UWP (WSA)!

Parameters

title	Dialog title
directory	Root directory (default: current, optional)

Returns: Returns a string of the chosen folder. Empty string when cancelled

◆ SaveFile() [1/3]

string Crosstales.FB.FileBrowser.SaveFile	(	string	defaultName = `""`,
		string	extension = `"*"`
	)

Open native save file browser.

Parameters

defaultName	Default file name (optional)
extension	File extensions, e.g. "png" (optional)

Returns: Returns chosen file. Empty string when cancelled

◆ SaveFile() [2/3]

string Crosstales.FB.FileBrowser.SaveFile	(	string	title,
		string	directory,
		string	defaultName,
		params ExtensionFilter[]	extensions
	)

Open native save file browser

Parameters

title	Dialog title
directory	Root directory
defaultName	Default file name
extensions	List of extension filters (optional)

Returns: Returns chosen file. Empty string when cancelled

◆ SaveFile() [3/3]

string Crosstales.FB.FileBrowser.SaveFile	(	string	title,
		string	directory,
		string	defaultName,
		params string[]	extensions
	)

Open native save file browser.

Parameters

title	Dialog title
directory	Root directory
defaultName	Default file name
extensions	File extensions, e.g. "png" (optional)

Returns: Returns chosen file. Empty string when cancelled

◆ SaveFileAsync() [1/6]

void Crosstales.FB.FileBrowser.SaveFileAsync	(	string	defaultName = `""`,
		string	extension = `"*"`
	)

Asynchronously opens native save file browser.

Parameters

defaultName	Default file name (optional)
extension	File extension, e.g. "png" (optional)

Returns: Returns chosen file. Empty string when cancelled

◆ SaveFileAsync() [2/6]

void Crosstales.FB.FileBrowser.SaveFileAsync	(	string	title,
		string	directory,
		string	defaultName,
		params ExtensionFilter[]	extensions
	)

Asynchronously opens native save file browser (async)

Parameters

title	Dialog title
directory	Root directory
defaultName	Default file name
extensions	List of extension filters (optional)

Returns: Returns chosen file. Empty string when cancelled

◆ SaveFileAsync() [3/6]

void Crosstales.FB.FileBrowser.SaveFileAsync	(	string	title,
		string	directory,
		string	defaultName,
		params string[]	extensions
	)

Asynchronously opens native save file browser.

Parameters

title	Dialog title
directory	Root directory
defaultName	Default file name
extensions	File extensions, e.g. "png" (optional)

Returns: Returns chosen file. Empty string when cancelled

◆ SaveFileAsync() [4/6]

void Crosstales.FB.FileBrowser.SaveFileAsync	(	System.Action< string >	cb,
		string	defaultName = `""`,
		string	extension = `"*"`
	)

Open native save file browser

Parameters

cb	Callback for the async operation.
defaultName	Default file name (optional)
extension	File extension, e.g. "png" (optional)

Returns: Returns chosen file. Empty string when cancelled

◆ SaveFileAsync() [5/6]

void Crosstales.FB.FileBrowser.SaveFileAsync	(	System.Action< string >	cb,
		string	title,
		string	directory,
		string	defaultName,
		params ExtensionFilter[]	extensions
	)

Open native save file browser (async).

Parameters

cb	Callback for the async operation.
title	Dialog title
directory	Root directory
defaultName	Default file name
extensions	List of extension filters (optional)

Returns: Returns chosen file. Empty string when cancelled

◆ SaveFileAsync() [6/6]

void Crosstales.FB.FileBrowser.SaveFileAsync	(	System.Action< string >	cb,
		string	title,
		string	directory,
		string	defaultName,
		params string[]	extensions
	)

Open native save file browser

Parameters

cb	Callback for the async operation.
title	Dialog title
directory	Root directory
defaultName	Default file name
extensions	File extensions, e.g. "png" (optional)

Returns: Returns chosen file. Empty string when cancelled

◆ ShowFile()

static void Crosstales.FB.FileBrowser.ShowFile ( string file )

static

Shows the location of a file (or folder) in OS file explorer. NOTE: only works on standalone platforms

◆ ShowFolder()

static void Crosstales.FB.FileBrowser.ShowFolder ( string path )

static

Shows the location of a folder (or file) in OS file explorer. NOTE: only works on standalone platforms

Member Data Documentation

◆ canOpenFile

bool Crosstales.FB.FileBrowser.canOpenFile => wrapperHolder?.PlatformWrapper.canOpenFile ?? false

Indicates if this wrapper can open a file.

Returns: Wrapper can open a file.

◆ canOpenFolder

bool Crosstales.FB.FileBrowser.canOpenFolder => wrapperHolder?.PlatformWrapper.canOpenFolder ?? false

Indicates if this wrapper can open a folder.

Returns: Wrapper can open a folder.

◆ canOpenMultipleFiles

bool Crosstales.FB.FileBrowser.canOpenMultipleFiles => wrapperHolder?.PlatformWrapper.canOpenMultipleFiles ?? false

Indicates if this wrapper can open multiple files.

Returns: Wrapper can open multiple files.

◆ canOpenMultipleFolders

bool Crosstales.FB.FileBrowser.canOpenMultipleFolders => wrapperHolder?.PlatformWrapper.canOpenMultipleFolders ?? false

Indicates if this wrapper can open multiple folders.

Returns: Wrapper can open multiple folders.

◆ canSaveFile

bool Crosstales.FB.FileBrowser.canSaveFile => wrapperHolder?.PlatformWrapper.canSaveFile ?? false

Indicates if this wrapper can save a file.

Returns: Wrapper can save a file.

◆ CurrentOpenSingleFileData

byte [] Crosstales.FB.FileBrowser.CurrentOpenSingleFileData => wrapperHolder?.PlatformWrapper?.CurrentOpenSingleFileData

Returns the data of the file from the last "OpenSingleFile"-action.

Returns: Data of the file from the last "OpenSingleFile"-action.

◆ CurrentOpenSingleFileName

string Crosstales.FB.FileBrowser.CurrentOpenSingleFileName => getNameFromPath(CurrentOpenSingleFile)

Returns the file name (without path) from the last "OpenSingleFile"-action.

Returns: File name from the last "OpenSingleFile"-action.

◆ CurrentOpenSingleFolderName

string Crosstales.FB.FileBrowser.CurrentOpenSingleFolderName => getNameFromPath(CurrentOpenSingleFolder)

Returns the folder name (without path) from the last "OpenSingleFolder"-action.

Returns: Folder name from the last "OpenSingleFolder"-action.

◆ CurrentSaveFileName

string Crosstales.FB.FileBrowser.CurrentSaveFileName => getNameFromPath(CurrentSaveFile)

Returns the file name (without path) from the last "SaveFile"-action.

Returns: File name from the last "SaveFile"-action.

◆ isPlatformSupported

bool Crosstales.FB.FileBrowser.isPlatformSupported => wrapperHolder?.PlatformWrapper.isPlatformSupported ?? true

Indicates if this wrapper is supporting the current platform.

Returns: True if this wrapper supports current platform.

◆ isWorkingInEditor

bool Crosstales.FB.FileBrowser.isWorkingInEditor => wrapperHolder?.PlatformWrapper.isWorkingInEditor ?? false

Indicates if this wrapper is working directly inside the Unity Editor (without 'Play'-mode).

Returns: True if this wrapper is working directly inside the Unity Editor.

Property Documentation

◆ AllowSyncCalls

bool Crosstales.FB.FileBrowser.AllowSyncCalls

getset

Allow synchronous calls (macOS).

◆ AlwaysReadFile

bool Crosstales.FB.FileBrowser.AlwaysReadFile

getset

Always read the file data (UWP).

◆ AskOverwriteFile

bool Crosstales.FB.FileBrowser.AskOverwriteFile

getset

Ask to overwrite existing file in save dialog (Windows).

◆ CurrentOpenFiles

string []?? Crosstales.FB.FileBrowser.CurrentOpenFiles

getset

Returns the array of files from the last "OpenFiles"-action.

Returns: Array of files from the last "OpenFiles"-action.

◆ CurrentOpenFolders

string []?? Crosstales.FB.FileBrowser.CurrentOpenFolders

getset

Returns the array of folders from the last "OpenFolders"-action.

Returns: Array of folders from the last "OpenFolders"-action.

◆ CurrentOpenSingleFile

string?? Crosstales.FB.FileBrowser.CurrentOpenSingleFile

getset

Returns the file from the last "OpenSingleFile"-action.

Returns: File from the last "OpenSingleFile"-action.

◆ CurrentOpenSingleFolder

string?? Crosstales.FB.FileBrowser.CurrentOpenSingleFolder

getset

Returns the folder from the last "OpenSingleFolder"-action.

Returns: Folder from the last "OpenSingleFolder"-action.

◆ CurrentSaveFile

string?? Crosstales.FB.FileBrowser.CurrentSaveFile

getset

Returns the file from the last "SaveFile"-action.

Returns: File from the last "SaveFile"-action.

◆ CurrentSaveFileData

byte []?? Crosstales.FB.FileBrowser.CurrentSaveFileData

getset

The data for the "SaveFile"-action.

◆ CustomMode

bool Crosstales.FB.FileBrowser.CustomMode

getset

Enables or disables the custom wrapper.

◆ CustomWrapper

BaseCustomFileBrowser Crosstales.FB.FileBrowser.CustomWrapper

getset

Custom wrapper for File Browser.

◆ LegacyFolderBrowser

bool Crosstales.FB.FileBrowser.LegacyFolderBrowser

getset

Use the legacy folder browser (Windows).

◆ NameSaveFile

string Crosstales.FB.FileBrowser.NameSaveFile

getset

Default name of the save-file.

◆ TextAllFiles

string Crosstales.FB.FileBrowser.TextAllFiles

getset

Text for 'All Files'-filter (*).

◆ TitleOpenFile

string Crosstales.FB.FileBrowser.TitleOpenFile

getset

Title for the 'Open File'-dialog.

◆ TitleOpenFiles

string Crosstales.FB.FileBrowser.TitleOpenFiles

getset

Title for the 'Open Files'-dialog.

◆ TitleOpenFolder

string Crosstales.FB.FileBrowser.TitleOpenFolder

getset

Title for the 'Open Folder'-dialog.

◆ TitleOpenFolders

string Crosstales.FB.FileBrowser.TitleOpenFolders

getset

Title for the 'Open Folders'-dialog.

◆ TitleSaveFile

string Crosstales.FB.FileBrowser.TitleSaveFile

getset

Title for the 'Save File'-dialog.

Event Documentation

◆ OnOpenFilesComplete

OpenFilesComplete Crosstales.FB.FileBrowser.OnOpenFilesComplete

An event triggered whenever "OpenFiles" is completed.

◆ OnOpenFilesStart

OpenFilesStart Crosstales.FB.FileBrowser.OnOpenFilesStart

An event triggered whenever "OpenFiles" is started.

◆ OnOpenFoldersComplete

OpenFoldersComplete Crosstales.FB.FileBrowser.OnOpenFoldersComplete

An event triggered whenever "OpenFolders" is completed.

◆ OnOpenFoldersStart

OpenFoldersStart Crosstales.FB.FileBrowser.OnOpenFoldersStart

An event triggered whenever "OpenFolders" is started.

◆ OnSaveFileComplete

SaveFileComplete Crosstales.FB.FileBrowser.OnSaveFileComplete

An event triggered whenever "SaveFile" is completed.

◆ OnSaveFileStart

SaveFileStart Crosstales.FB.FileBrowser.OnSaveFileStart

An event triggered whenever "SaveFile" is started.

The documentation for this class was generated from the following file:

C:/Users/slaub/Unity/assets/FileBrowser/FileBrowserPro/Assets/Plugins/crosstales/FileBrowser/Scripts/FileBrowser.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Properties

Events

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CopyFile()

◆ CopyFolder()

◆ GetDrives()

◆ GetFiles() [1/2]

◆ GetFiles() [2/2]

◆ GetFolders()

◆ OpenFile()

◆ OpenFiles() [1/3]

◆ OpenFiles() [2/3]

◆ OpenFiles() [3/3]

◆ OpenFilesAsync() [1/6]

◆ OpenFilesAsync() [2/6]

◆ OpenFilesAsync() [3/6]

◆ OpenFilesAsync() [4/6]

◆ OpenFilesAsync() [5/6]

◆ OpenFilesAsync() [6/6]

◆ OpenFolders() [1/2]

◆ OpenFolders() [2/2]

◆ OpenFoldersAsync() [1/4]

◆ OpenFoldersAsync() [2/4]

◆ OpenFoldersAsync() [3/4]

◆ OpenFoldersAsync() [4/4]

◆ OpenSingleFile() [1/3]

◆ OpenSingleFile() [2/3]

◆ OpenSingleFile() [3/3]

◆ OpenSingleFileAsync() [1/3]

◆ OpenSingleFileAsync() [2/3]

◆ OpenSingleFileAsync() [3/3]

◆ OpenSingleFolder() [1/2]

◆ OpenSingleFolder() [2/2]

◆ OpenSingleFolderAsync() [1/2]

◆ OpenSingleFolderAsync() [2/2]

◆ SaveFile() [1/3]

◆ SaveFile() [2/3]

◆ SaveFile() [3/3]

◆ SaveFileAsync() [1/6]

◆ SaveFileAsync() [2/6]

◆ SaveFileAsync() [3/6]

◆ SaveFileAsync() [4/6]

◆ SaveFileAsync() [5/6]

◆ SaveFileAsync() [6/6]

◆ ShowFile()

◆ ShowFolder()

Member Data Documentation

◆ canOpenFile

◆ canOpenFolder

◆ canOpenMultipleFiles

◆ canOpenMultipleFolders

◆ canSaveFile

◆ CurrentOpenSingleFileData

◆ CurrentOpenSingleFileName

◆ CurrentOpenSingleFolderName

◆ CurrentSaveFileName

◆ isPlatformSupported

◆ isWorkingInEditor

Property Documentation

◆ AllowSyncCalls

◆ AlwaysReadFile

◆ AskOverwriteFile

◆ CurrentOpenFiles

◆ CurrentOpenFolders

◆ CurrentOpenSingleFile

◆ CurrentOpenSingleFolder

◆ CurrentSaveFile

◆ CurrentSaveFileData

◆ CustomMode

◆ CustomWrapper

◆ LegacyFolderBrowser

◆ NameSaveFile

◆ TextAllFiles

◆ TitleOpenFile