[This is preliminary documentation and is subject to change.]
callback function, which the plugin can call to request input from the user. When using one of the standard parameters, the request will be in the selected language.
Namespace:
Tools.TotalCommanderTAssembly: Tools.TotalCommander (in Tools.TotalCommander.dll) Version: 1.5.2.0
Syntax
| C# |
|---|
public delegate string RequestCallback( FileSystemPlugin sender, InputRequestKind RequestType, string CustomTitle, string CustomText, string DefaultText, int maxlen ) |
| Visual Basic (Declaration) |
|---|
Public Delegate Function RequestCallback ( _ sender As FileSystemPlugin, _ RequestType As InputRequestKind, _ CustomTitle As String, _ CustomText As String, _ DefaultText As String, _ maxlen As Integer _ ) As String |
| Visual C++ |
|---|
public delegate String^ RequestCallback( FileSystemPlugin^ sender, InputRequestKind RequestType, String^ CustomTitle, String^ CustomText, String^ DefaultText, int maxlen ) |
| J# |
|---|
/** @delegate */ public delegate String RequestCallback( FileSystemPlugin sender, InputRequestKind RequestType, String CustomTitle, String CustomText, String DefaultText, int maxlen ) |
| JScript |
|---|
|
Parameters
- sender
- Type: Tools.TotalCommanderT..::.FileSystemPlugin
- RequestType
- Type: Tools.TotalCommanderT..::.InputRequestKind
Can be one of the InputRequestKind flags
- CustomTitle
- Type: System..::.String
Custom title for the dialog box. If NULL or empty, it will be "Total Commander"
- CustomText
- Type: System..::.String
Override the text defined with RequestType. Set this to NULL or an empty string to use the default text. The default text will be translated to the language set in the calling program.
- DefaultText
- Type: System..::.String
This string contains the default text presented to the user. Set DefaultText[0]=0 to have no default text.
- maxlen
- Type: System..::.Int32
Maximum length allowed for returned text.
Return Value
User-entered text if user clicked Yes or OK. Null otherwise
Remarks
Leave CustomText empty if you want to use the (translated) default strings!
Exceptions
| Exception | Condition |
|---|---|
| System..::.ArgumentException | DefaultText is longer than maxlen |
| System..::.ArgumentOutOfRangeException | maxlen is less than 1 |