PromptPlus API:IControlBrowserMultiSelect
IControlBrowserMultiSelect
Namespace: PPlus.Controls
Represents the interface with all Methods of the BrowserMultiSelect control
public interface IControlBrowserMultiSelect : IPromptControls<ItemBrowser[]>
Implements IPromptControls<ItemBrowser[]>
Methods
AcceptHiddenAttributes(Boolean)
Accept hidden folder and files in browser. Default is false
IControlBrowserMultiSelect AcceptHiddenAttributes(bool value)
Parameters
value Boolean
true accept hidden folder and files, otherwise ‘no’
Returns
AcceptSystemAttributes(Boolean)
Accept system folder and files in browser. Default is false
IControlBrowserMultiSelect AcceptSystemAttributes(bool value)
Parameters
value Boolean
true accept system folder and files, otherwise ‘no’
Returns
AddFixedSelect(params String[])
Fixed select (immutable) items in list
IControlBrowserMultiSelect AddFixedSelect(params String[] values)
Parameters
values String[]
list with fullpath immutable items selected
Returns
AfterCollapsed(Action<ItemBrowser>)
Action to execute after Collapsed
IControlBrowserMultiSelect AfterCollapsed(Action<ItemBrowser> value)
Parameters
value Action<ItemBrowser>
The action
Returns
AfterExpanded(Action<ItemBrowser>)
Action to execute after Expanded
IControlBrowserMultiSelect AfterExpanded(Action<ItemBrowser> value)
Parameters
value Action<ItemBrowser>
The action
Returns
BeforeCollapsed(Action<ItemBrowser>)
Action to execute before Collapsed
IControlBrowserMultiSelect BeforeCollapsed(Action<ItemBrowser> value)
Parameters
value Action<ItemBrowser>
The action
Returns
BeforeExpanded(Action<ItemBrowser>)
Action to execute before Expanded
IControlBrowserMultiSelect BeforeExpanded(Action<ItemBrowser> value)
Parameters
value Action<ItemBrowser>
The action
Returns
Config(Action<IPromptConfig>)
Custom config the control.
IControlBrowserMultiSelect Config(Action<IPromptConfig> context)
Parameters
context Action<IPromptConfig>
action to apply changes. IPromptConfig
Returns
Default(String)
Default item (fullpath) selected when started
IControlBrowserMultiSelect Default(string value)
Parameters
value String
fullpath
Returns
DisabledRecursiveExpand(Boolean)
Disabled ExpandAll Feature. Only item in Top-level are expanded. Default false
DisabledRecursiveExpand cannot be used when Root setted with parameter expandall = true
IControlBrowserMultiSelect DisabledRecursiveExpand(bool value)
Parameters
value Boolean
Disabled ExpandAll Feature
Returns
FilterType(FilterMode)
Filter strategy for filter items in colletion
Default value is FilterMode.Contains
IControlBrowserMultiSelect FilterType(FilterMode value)
Parameters
value FilterMode
Filter Mode
Returns
HotKeyFullPath(HotKey)
Overwrite a HotKey toggle current name folder to FullPath. Default value is ‘F2’
IControlBrowserMultiSelect HotKeyFullPath(HotKey value)
Parameters
value HotKey
The HotKey to toggle current name folder to FullPath
Returns
HotKeyToggleExpand(HotKey)
Overwrite a HotKey expand/Collap current folder selected. Default value is ‘F3’
IControlBrowserMultiSelect HotKeyToggleExpand(HotKey value)
Parameters
value HotKey
The HotKey to expand/Collapse current folder selected
Returns
HotKeyToggleExpandAll(HotKey)
Overwrite a HotKey expand/Collap all folders. Default value is ‘F4’
IControlBrowserMultiSelect HotKeyToggleExpandAll(HotKey value)
Parameters
value HotKey
The HotKey to expand/Collap all folders
Returns
NoSpinner(Boolean)
Not show Spinner. default value is false (SpinnersType.Ascii)
IControlBrowserMultiSelect NoSpinner(bool value)
Parameters
value Boolean
Returns
OnlyFolders(Boolean)
Load only Folders on browser. Default is false
IControlBrowserMultiSelect OnlyFolders(bool value)
Parameters
value Boolean
true only Folders, otherwise Folders and files
Returns
PageSize(Int32)
Set max.item view per page.
Default value : 10.The value must be greater than or equal to 1
IControlBrowserMultiSelect PageSize(int value)
Parameters
value Int32
Number of Max.items
Returns
Range(Int32, Nullable<Int32>)
Defines a minimum and maximum (optional) range of items selected in the list
IControlBrowserMultiSelect Range(int minvalue, Nullable<Int32> maxvalue)
Parameters
minvalue Int32
Minimum number of items
maxvalue Nullable<Int32>
Maximum number of items
Returns
Root(String, Boolean, Func<ItemBrowser, Boolean>, Func<ItemBrowser, Boolean>)
Set folder root to browser
parameter expandall = true cannot be used with DisabledRecursiveExpand
IControlBrowserMultiSelect Root(string value, bool expandall, Func<ItemBrowser, Boolean> validselect, Func<ItemBrowser, Boolean> setdisabled)
Parameters
value String
full path folder root
expandall Boolean
true expand all folder, otherwise ‘no’. Expandall = true cannot be used with DisabledRecursiveExpand
validselect Func<ItemBrowser, Boolean>
Accept select/mark item that satisfy the function
setdisabled Func<ItemBrowser, Boolean>
Disabled all items that satisfy the disabled function
Returns
SearchFilePattern(String)
Search file pattern. Default is ‘*’
IControlBrowserMultiSelect SearchFilePattern(string value)
Parameters
value String
Search pattern
Returns
SearchFolderPattern(String)
Search folder pattern. Default is ‘*’
IControlBrowserMultiSelect SearchFolderPattern(string value)
Parameters
value String
Search pattern
Returns
SelectAll(Func<ItemBrowser, Boolean>)
Select all items that satisfy the selection function
IControlBrowserMultiSelect SelectAll(Func<ItemBrowser, Boolean> validselect)
Parameters
validselect Func<ItemBrowser, Boolean>
the function
Returns
ShowCurrentFolder(Boolean)
Append name current folder on description. Default value true
IControlBrowserMultiSelect ShowCurrentFolder(bool value)
Parameters
value Boolean
true Append current name folder on description, not append
Returns
ShowExpand(Boolean)
Show expand SymbolType.Expanded. Default is true
IControlBrowserMultiSelect ShowExpand(bool value)
Parameters
value Boolean
true Show Expanded SymbolType, otherwise ‘no’
Returns
ShowLines(Boolean)
Show lines of level. Default is true
IControlBrowserMultiSelect ShowLines(bool value)
Parameters
value Boolean
true Show lines, otherwise ‘no’
Returns
ShowSize(Boolean)
Show folder and file size in browser. Default is true
IControlBrowserMultiSelect ShowSize(bool value)
Parameters
value Boolean
true Show size, otherwise ‘no’
Returns
Spinner(SpinnersType, Nullable<Int32>, IEnumerable<String>)
Overwrite SpinnersType. Default value is SpinnersType.Ascii
When use custom spinner, if has unicode values console does not support it, the rendering may not be as expected
IControlBrowserMultiSelect Spinner(SpinnersType spinnersType, Nullable<Int32> speedAnimation, IEnumerable<String> customspinner)
Parameters
spinnersType SpinnersType
The SpinnersType
speedAnimation Nullable<Int32>
Number of mileseconds foreach iteration of spinner. Valid only to SpinnersType.custom, otherwise will be ignored
customspinner IEnumerable<String>
IEnumerable values for custom spinner. Valid only to SpinnersType.custom, otherwise will be ignored
Returns
Styles(BrowserStyles, Style)
Overwrite Styles
IControlBrowserMultiSelect Styles(BrowserStyles content, Style value)
Parameters
content BrowserStyles
content Browser. BrowserStyles