Difference between revisions of "GUIFilePicker"
From Virtual World Web Wiki
(Documentation for the GUIFilePicker class) |
(Documentation for the GUIFilePicker class) |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | * '''Inherits class: [[ | + | Component representing a text field you can use to browse for files from |
| + | |||
| + | *'''Inherits class: [[GUIPanel]]''' | ||
* This is a JavaScript visible object | * This is a JavaScript visible object | ||
===Remarks <nowiki>[</nowiki>[{{fullurl:GUIFilePicker Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ===Remarks <nowiki>[</nowiki>[{{fullurl:GUIFilePicker Remarks|action=edit}} edit]<nowiki>]</nowiki>=== | ||
| − | {{:GUIFilePicker Remarks}} | + | {{#ifexist:GUIFilePicker Remarks|{{:GUIFilePicker Remarks}}|}} |
===Properties=== | ===Properties=== | ||
| − | |||
| − | |||
:{{CSharp|GUIButton Button {get;} }} | :{{CSharp|GUIButton Button {get;} }} | ||
| + | :: | ||
| + | ::Reference to the browse button | ||
:{{CSharp|bool CanReset {get; set;} }} | :{{CSharp|bool CanReset {get; set;} }} | ||
| + | :: | ||
| + | ::Whether or not to allow the reset button to appear | ||
:{{CSharp|bool Enabled {get; set;} }} | :{{CSharp|bool Enabled {get; set;} }} | ||
| − | |||
:{{CSharp|string FileFilter {get; set;} }} | :{{CSharp|string FileFilter {get; set;} }} | ||
| + | :: | ||
| + | ::The file filter to use for which files to suggest to the user | ||
:{{CSharp|string FullPath {get; set;} }} | :{{CSharp|string FullPath {get; set;} }} | ||
| + | :: | ||
| + | ::Gets or sets the server-ready path for the file | ||
:{{CSharp|string InitialDir {get; set;} }} | :{{CSharp|string InitialDir {get; set;} }} | ||
| + | :: | ||
| + | ::The initial directory to start searching form | ||
:{{CSharp|string Path {get; set;} }} | :{{CSharp|string Path {get; set;} }} | ||
| + | :: | ||
| + | ::The displayed value of the PathField | ||
:{{CSharp|GUITextField PathField {get;} }} | :{{CSharp|GUITextField PathField {get;} }} | ||
| + | :: | ||
| + | ::Reference to the text field that holds the file path | ||
| − | :{{CSharp| | + | :{{CSharp|float Progress {get; set;} }} |
| + | :: | ||
| + | ::Sets a percentage progress to display for the file | ||
:{{CSharp|GUIPanel ProgressBar {get;} }} | :{{CSharp|GUIPanel ProgressBar {get;} }} | ||
| + | :: | ||
| + | ::Reference to the containing progress bar for file uploads | ||
:{{CSharp|GUIPanel ProgressCompleted {get;} }} | :{{CSharp|GUIPanel ProgressCompleted {get;} }} | ||
| + | :: | ||
| + | ::Reference to the completed part of the progress bar | ||
:{{CSharp|GUIPanel ProgressRemaining {get;} }} | :{{CSharp|GUIPanel ProgressRemaining {get;} }} | ||
| + | :: | ||
| + | ::Reference to the remaining part of the progress bar | ||
:{{CSharp|GUIButton ResetButton {get;} }} | :{{CSharp|GUIButton ResetButton {get;} }} | ||
| + | :: | ||
| + | ::Reference to the reset button to clear the current file | ||
:{{CSharp|ResourceValue ResourceUri {get; set;} }} | :{{CSharp|ResourceValue ResourceUri {get; set;} }} | ||
| + | :: | ||
| + | ::The ResourceUri of the file (can be set with URLs or full ResourceValues) | ||
===Events=== | ===Events=== | ||
| − | :{{CSharp|OnFileChosen( | + | :{{CSharp|OnFileChosen()}} |
| + | :: | ||
| + | ::Event fired when the user picks a new file | ||
===Methods=== | ===Methods=== | ||
:{{CSharp|void Reset()}} | :{{CSharp|void Reset()}} | ||
| + | :: | ||
| + | ::Resets the file picker to no file selected | ||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ | ||
Latest revision as of 12:11, 30 April 2019
Component representing a text field you can use to browse for files from
- Inherits class: GUIPanel
- This is a JavaScript visible object
Remarks [edit]
Properties
- GUIButton Button {get;}
- Reference to the browse button
- bool CanReset {get; set;}
- Whether or not to allow the reset button to appear
- bool Enabled {get; set;}
- string FileFilter {get; set;}
- The file filter to use for which files to suggest to the user
- string FullPath {get; set;}
- Gets or sets the server-ready path for the file
- string InitialDir {get; set;}
- The initial directory to start searching form
- string Path {get; set;}
- The displayed value of the PathField
- GUITextField PathField {get;}
- Reference to the text field that holds the file path
- float Progress {get; set;}
- Sets a percentage progress to display for the file
- GUIPanel ProgressBar {get;}
- Reference to the containing progress bar for file uploads
- GUIPanel ProgressCompleted {get;}
- Reference to the completed part of the progress bar
- GUIPanel ProgressRemaining {get;}
- Reference to the remaining part of the progress bar
- GUIButton ResetButton {get;}
- Reference to the reset button to clear the current file
- ResourceValue ResourceUri {get; set;}
- The ResourceUri of the file (can be set with URLs or full ResourceValues)
Events
- OnFileChosen()
- Event fired when the user picks a new file
Methods
- void Reset()
- Resets the file picker to no file selected
