Show / Hide Table of Contents

Class ImGuiFilePicker

Inheritance
System.Object
ImGuiFilePicker
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Fusee.ImGuiImp.Desktop.Templates
Assembly: Fusee.ImGuiImp.Desktop.dll
Syntax
public class ImGuiFilePicker

Constructors

ImGuiFilePicker(String, Boolean, String)

Generate a new ImGuiFilePicker instance

Declaration
public ImGuiFilePicker(string startingPath = "C:\\", bool onlyAllowFolders = true, string allowedExtensions = "")
Parameters
Type Name Description
System.String startingPath

Starting path, defaults to C:\

System.Boolean onlyAllowFolders

Allow folder picking only

System.String allowedExtensions

search filter with dot. Example (".json")

Fields

_isOpen

Declaration
protected bool _isOpen
Field Value
Type Description
System.Boolean

_sizeOfInputText

Declaration
protected Vector2 _sizeOfInputText
Field Value
Type Description
System.Numerics.Vector2

AllowedExtensions

Declaration
public readonly List<string> AllowedExtensions
Field Value
Type Description
System.Collections.Generic.List<System.String>

BackTxt

Declaration
public string BackTxt
Field Value
Type Description
System.String

BottomButtonSize

Declaration
protected readonly Vector2 BottomButtonSize
Field Value
Type Description
System.Numerics.Vector2

BrowserHeight

Declaration
protected const float BrowserHeight = 200F
Field Value
Type Description
System.Single

CancelFileOpenTxt

Caption of the "Cancel" button.

Declaration
public string CancelFileOpenTxt
Field Value
Type Description
System.String

CurrentlySelectedFolder

Declaration
protected string CurrentlySelectedFolder
Field Value
Type Description
System.String

CurrentOpenFolder

Declaration
protected string CurrentOpenFolder
Field Value
Type Description
System.String

DoFocusPicker

Declaration
protected bool DoFocusPicker
Field Value
Type Description
System.Boolean

DriveSelectionWidth

Declaration
protected const float DriveSelectionWidth = 100F
Field Value
Type Description
System.Single

FileInputHintTxt

File input hint text.

Declaration
public string FileInputHintTxt
Field Value
Type Description
System.String

FileLabelTxt

Caption of file input text

Declaration
public string FileLabelTxt
Field Value
Type Description
System.String

FileNotFoundTxt

File not found warning text.

Declaration
public string FileNotFoundTxt
Field Value
Type Description
System.String

FileSelectionMenuBackground

Background of file selection menu

Declaration
public Vector4 FileSelectionMenuBackground
Field Value
Type Description
System.Numerics.Vector4

FileTextInputWidth

Declaration
protected const float FileTextInputWidth = 300F
Field Value
Type Description
System.Single

FolderColor

Text color of folder

Declaration
public Vector4 FolderColor
Field Value
Type Description
System.Numerics.Vector4

FolderLabelTxt

Caption of folder input text

Declaration
public string FolderLabelTxt
Field Value
Type Description
System.String

FolderNotFoundTxt

Folder not found warning text.

Declaration
public string FolderNotFoundTxt
Field Value
Type Description
System.String

FolderTextInputWidth

Declaration
protected const float FolderTextInputWidth = 350F
Field Value
Type Description
System.Single

FontSize

Declaration
public int FontSize
Field Value
Type Description
System.Int32

Id

Title of window (visible in top bar).

Declaration
public string Id
Field Value
Type Description
System.String

LastOpenendFolders

Declaration
protected readonly Stack<string> LastOpenendFolders
Field Value
Type Description
System.Collections.Generic.Stack<System.String>

OnCancel

Invoked on cancel.

Declaration
public EventHandler OnCancel
Field Value
Type Description
System.EventHandler

OnlyAllowFolders

Declaration
public readonly bool OnlyAllowFolders
Field Value
Type Description
System.Boolean

OnPicked

Invoked on clicked "open".

Declaration
public EventHandler<string> OnPicked
Field Value
Type Description
System.EventHandler<System.String>

ParentFolderTxt

Declaration
public string ParentFolderTxt
Field Value
Type Description
System.String

PathToFolderTxt

Path to folder text.

Declaration
public string PathToFolderTxt
Field Value
Type Description
System.String

PickedFileTxt

Caption of the "Open" button.

Declaration
public string PickedFileTxt
Field Value
Type Description
System.String

SelectedColor

Background color of one object

Declaration
public Vector4 SelectedColor
Field Value
Type Description
System.Numerics.Vector4

StartingFolder

Declaration
protected readonly string StartingFolder
Field Value
Type Description
System.String

SymbolsFontPtr

Declaration
public ImFontPtr SymbolsFontPtr
Field Value
Type Description
ImFontPtr

TopButtonSize

Declaration
protected readonly Vector2 TopButtonSize
Field Value
Type Description
System.Numerics.Vector2

WarningTextColor

Color of when an error occurs

Declaration
public Vector4 WarningTextColor
Field Value
Type Description
System.Numerics.Vector4

WindowBackground

Background color of pop up window

Declaration
public Vector4 WindowBackground
Field Value
Type Description
System.Numerics.Vector4

WindowPadding

Declaration
protected readonly Vector2 WindowPadding
Field Value
Type Description
System.Numerics.Vector2

WinSize

Declaration
protected Vector2 WinSize
Field Value
Type Description
System.Numerics.Vector2

Properties

IsOpen

Declaration
public bool IsOpen { get; set; }
Property Value
Type Description
System.Boolean

RootFolder

Declaration
public string RootFolder { get; protected set; }
Property Value
Type Description
System.String

SelectedFile

Declaration
public string SelectedFile { get; protected set; }
Property Value
Type Description
System.String

Methods

Draw(ref Boolean)

Declaration
public virtual void Draw(ref bool filePickerOpen)
Parameters
Type Name Description
System.Boolean filePickerOpen

HandlePickedFile(String)

Declaration
protected virtual bool HandlePickedFile(string selectedFile)
Parameters
Type Name Description
System.String selectedFile
Returns
Type Description
System.Boolean
Generated by DocFX
GitHub Repo
Back to top