JumpListItem (fable-electron-docs-api)

JumpListItem Type

Namespace: Fable.Electron
Assembly: Fable.Electron.dll
Parent Module: Types
Base Type: obj

Constructors

Constructor Description

Constructor	Description
`JumpListItem(?type, ?path, ?program, ?args, ?title, ?description, ?iconPath, ?iconIndex, ?workingDirectory)` Full Usage: `JumpListItem(?type, ?path, ?program, ?args, ?title, ?description, ?iconPath, ?iconIndex, ?workingDirectory)` Parameters: ?type : `Type` - One of the following: ?path : `string` - Path of the file to open, should only be set if `type` is `file`. ?program : `string` - Path of the program to execute, usually you should specify `process.execPath` which opens the current program. Should only be set if `type` is `task`. ?args : `string` - The command line arguments when `program` is executed. Should only be set if `type` is `task`. ?title : `string` - The text to be displayed for the item in the Jump List. Should only be set if `type` is `task`. ?description : `string` - Description of the task (displayed in a tooltip). Should only be set if `type` is `task`. Maximum length 260 characters. ?iconPath : `string` - The absolute path to an icon to be displayed in a Jump List, which can be an arbitrary resource file that contains an icon (e.g. `.ico`, `.exe`, `.dll`). You can usually specify `process.execPath` to show the program icon. ?iconIndex : `float` - The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero. ?workingDirectory : `string` - The working directory. Default is empty. Returns: `JumpListItem`	?type : `Type` One of the following: ?path : `string` Path of the file to open, should only be set if `type` is `file`. ?program : `string` Path of the program to execute, usually you should specify `process.execPath` which opens the current program. Should only be set if `type` is `task`. ?args : `string` The command line arguments when `program` is executed. Should only be set if `type` is `task`. ?title : `string` The text to be displayed for the item in the Jump List. Should only be set if `type` is `task`. ?description : `string` Description of the task (displayed in a tooltip). Should only be set if `type` is `task`. Maximum length 260 characters. ?iconPath : `string` The absolute path to an icon to be displayed in a Jump List, which can be an arbitrary resource file that contains an icon (e.g. `.ico`, `.exe`, `.dll`). You can usually specify `process.execPath` to show the program icon. ?iconIndex : `float` The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero. ?workingDirectory : `string` The working directory. Default is empty. Returns: `JumpListItem`


                
                  
                    
                      JumpListItem(?type, ?path, ?program, ?args, ?title, ?description, ?iconPath, ?iconIndex, ?workingDirectory)

Full Usage: JumpListItem(?type, ?path, ?program, ?args, ?title, ?description, ?iconPath, ?iconIndex, ?workingDirectory)

Parameters:

?type : Type - One of the following:

?path : string - Path of the file to open, should only be set if type is file.

?program : string - Path of the program to execute, usually you should specify process.execPath which opens the current program. Should only be set if type is task.

?args : string - The command line arguments when program is executed. Should only be set if type is task.

?title : string - The text to be displayed for the item in the Jump List. Should only be set if type is task.

?description : string - Description of the task (displayed in a tooltip). Should only be set if type is task. Maximum length 260 characters.

?iconPath : string - The absolute path to an icon to be displayed in a Jump List, which can be an arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll). You can usually specify process.execPath to show the program icon.

?iconIndex : float - The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero.

?workingDirectory : string - The working directory. Default is empty.

Returns: JumpListItem

?type : Type: One of the following:
?path : string: Path of the file to open, should only be set if type is file.
?program : string: Path of the program to execute, usually you should specify process.execPath which opens the current program. Should only be set if type is task.
?args : string: The command line arguments when program is executed. Should only be set if type is task.
?title : string: The text to be displayed for the item in the Jump List. Should only be set if type is task.
?description : string: Description of the task (displayed in a tooltip). Should only be set if type is task. Maximum length 260 characters.
?iconPath : string: The absolute path to an icon to be displayed in a Jump List, which can be an arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll). You can usually specify process.execPath to show the program icon.
?iconIndex : float: The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero.
?workingDirectory : string: The working directory. Default is empty.

Returns: JumpListItem

Instance members

Instance member	Description
`this.args` Full Usage: `this.args`	The command line arguments when program is executed. Should only be set if type is task.
`this.description` Full Usage: `this.description`	Description of the task (displayed in a tooltip). Should only be set if type is task. Maximum length 260 characters.
`this.iconIndex` Full Usage: `this.iconIndex`	The index of the icon in the resource file. If a resource file contains multiple icons this value can be used to specify the zero-based index of the icon that should be displayed for this task. If a resource file contains only one icon, this property should be set to zero.
`this.iconPath` Full Usage: `this.iconPath`	The absolute path to an icon to be displayed in a Jump List, which can be an arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll). You can usually specify process.execPath to show the program icon.
`this.path` Full Usage: `this.path`	Path of the file to open, should only be set if type is file.
`this.program` Full Usage: `this.program`	Path of the program to execute, usually you should specify process.execPath which opens the current program. Should only be set if type is task.
`this.title` Full Usage: `this.title`	The text to be displayed for the item in the Jump List. Should only be set if type is task.
`this.type` Full Usage: `this.type`	One of the following:
`this.workingDirectory` Full Usage: `this.workingDirectory`	The working directory. Default is empty.