Params (fable-electron-docs-api)

Params Type

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

Constructors

Constructor Description

Constructor	Description
`Params(x, y, frame, linkURL, linkText, pageURL, frameURL, srcURL, mediaType, hasImageContents, isEditable, selectionText, titleText, altText, suggestedFilename, selectionRect, selectionStartOffset, referrerPolicy, misspelledWord, dictionarySuggestions, frameCharset, formControlType, spellcheckEnabled, menuSourceType, mediaFlags, editFlags)` Full Usage: `Params(x, y, frame, linkURL, linkText, pageURL, frameURL, srcURL, mediaType, hasImageContents, isEditable, selectionText, titleText, altText, suggestedFilename, selectionRect, selectionStartOffset, referrerPolicy, misspelledWord, dictionarySuggestions, frameCharset, formControlType, spellcheckEnabled, menuSourceType, mediaFlags, editFlags)` Parameters: x : `int` - x coordinate. y : `int` - y coordinate. frame : `Option<WebFrameMain>` - Frame from which the context menu was invoked. May be `null` if accessed after the frame has either navigated or been destroyed. linkURL : `string` - URL of the link that encloses the node the context menu was invoked on. linkText : `string` - Text associated with the link. May be an empty string if the contents of the link are an image. pageURL : `string` - URL of the top level page that the context menu was invoked on. frameURL : `string` - URL of the subframe that the context menu was invoked on. srcURL : `string` - Source URL for the element that the context menu was invoked on. Elements with source URLs are images, audio and video. mediaType : `MediaType` - Type of the node the context menu was invoked on. Can be `none`, `image`, `audio`, `video`, `canvas`, `file` or `plugin`. hasImageContents : `bool` - Whether the context menu was invoked on an image which has non-empty contents. isEditable : `bool` - Whether the context is editable. selectionText : `string` - Text of the selection that the context menu was invoked on. titleText : `string` - Title text of the selection that the context menu was invoked on. altText : `string` - Alt text of the selection that the context menu was invoked on. suggestedFilename : `string` - Suggested filename to be used when saving file through 'Save Link As' option of context menu. selectionRect : `Rectangle` - Rect representing the coordinates in the document space of the selection. selectionStartOffset : `float` - Start position of the selection text. referrerPolicy : `Referrer` - The referrer policy of the frame on which the menu is invoked. misspelledWord : `string` - The misspelled word under the cursor, if any. dictionarySuggestions : `string[]` - An array of suggested words to show the user to replace the `misspelledWord`. Only available if there is a misspelled word and spellchecker is enabled. frameCharset : `string` - The character encoding of the frame on which the menu was invoked. formControlType : `FormControlType` - The source that the context menu was invoked on. Possible values include `none`, `button-button`, `field-set`, `input-button`, `input-checkbox`, `input-color`, `input-date`, `input-datetime-local`, `input-email`, `input-file`, `input-hidden`, `input-image`, `input-month`, `input-number`, `input-password`, `input-radio`, `input-range`, `input-reset`, `input-search`, `input-submit`, `input-telephone`, `input-text`, `input-time`, `input-url`, `input-week`, `output`, `reset-button`, `select-list`, `select-list`, `select-multiple`, `select-one`, `submit-button`, and `text-area`, spellcheckEnabled : `bool` - If the context is editable, whether or not spellchecking is enabled. menuSourceType : `MenuSourceType` - Input source that invoked the context menu. Can be `none`, `mouse`, `keyboard`, `touch`, `touchMenu`, `longPress`, `longTap`, `touchHandle`, `stylus`, `adjustSelection`, or `adjustSelectionReset`. mediaFlags : `MediaFlags` - The flags for the media element the context menu was invoked on. editFlags : `EditFlags` - These flags indicate whether the renderer believes it is able to perform the corresponding action. Returns: `Params`	x : `int` x coordinate. y : `int` y coordinate. frame : `Option<WebFrameMain>` Frame from which the context menu was invoked. May be `null` if accessed after the frame has either navigated or been destroyed. linkURL : `string` URL of the link that encloses the node the context menu was invoked on. linkText : `string` Text associated with the link. May be an empty string if the contents of the link are an image. pageURL : `string` URL of the top level page that the context menu was invoked on. frameURL : `string` URL of the subframe that the context menu was invoked on. srcURL : `string` Source URL for the element that the context menu was invoked on. Elements with source URLs are images, audio and video. mediaType : `MediaType` Type of the node the context menu was invoked on. Can be `none`, `image`, `audio`, `video`, `canvas`, `file` or `plugin`. hasImageContents : `bool` Whether the context menu was invoked on an image which has non-empty contents. isEditable : `bool` Whether the context is editable. selectionText : `string` Text of the selection that the context menu was invoked on. titleText : `string` Title text of the selection that the context menu was invoked on. altText : `string` Alt text of the selection that the context menu was invoked on. suggestedFilename : `string` Suggested filename to be used when saving file through 'Save Link As' option of context menu. selectionRect : `Rectangle` Rect representing the coordinates in the document space of the selection. selectionStartOffset : `float` Start position of the selection text. referrerPolicy : `Referrer` The referrer policy of the frame on which the menu is invoked. misspelledWord : `string` The misspelled word under the cursor, if any. dictionarySuggestions : `string[]` An array of suggested words to show the user to replace the `misspelledWord`. Only available if there is a misspelled word and spellchecker is enabled. frameCharset : `string` The character encoding of the frame on which the menu was invoked. formControlType : `FormControlType` The source that the context menu was invoked on. Possible values include `none`, `button-button`, `field-set`, `input-button`, `input-checkbox`, `input-color`, `input-date`, `input-datetime-local`, `input-email`, `input-file`, `input-hidden`, `input-image`, `input-month`, `input-number`, `input-password`, `input-radio`, `input-range`, `input-reset`, `input-search`, `input-submit`, `input-telephone`, `input-text`, `input-time`, `input-url`, `input-week`, `output`, `reset-button`, `select-list`, `select-list`, `select-multiple`, `select-one`, `submit-button`, and `text-area`, spellcheckEnabled : `bool` If the context is editable, whether or not spellchecking is enabled. menuSourceType : `MenuSourceType` Input source that invoked the context menu. Can be `none`, `mouse`, `keyboard`, `touch`, `touchMenu`, `longPress`, `longTap`, `touchHandle`, `stylus`, `adjustSelection`, or `adjustSelectionReset`. mediaFlags : `MediaFlags` The flags for the media element the context menu was invoked on. editFlags : `EditFlags` These flags indicate whether the renderer believes it is able to perform the corresponding action. Returns: `Params`


                
                  
                    
                      Params(x, y, frame, linkURL, linkText, pageURL, frameURL, srcURL, mediaType, hasImageContents, isEditable, selectionText, titleText, altText, suggestedFilename, selectionRect, selectionStartOffset, referrerPolicy, misspelledWord, dictionarySuggestions, frameCharset, formControlType, spellcheckEnabled, menuSourceType, mediaFlags, editFlags)

Full Usage:

Params(x, y, frame, linkURL, linkText, pageURL, frameURL, srcURL, mediaType, hasImageContents, isEditable, selectionText, titleText, altText, suggestedFilename, selectionRect, selectionStartOffset, referrerPolicy, misspelledWord, dictionarySuggestions, frameCharset, formControlType, spellcheckEnabled, menuSourceType, mediaFlags, editFlags)

Parameters:

x : int - x coordinate.

y : int - y coordinate.

frame : Option<WebFrameMain> - Frame from which the context menu was invoked. May be null if accessed after the frame has either navigated or been destroyed.

linkURL : string - URL of the link that encloses the node the context menu was invoked on.

linkText : string - Text associated with the link. May be an empty string if the contents of the link are an image.

pageURL : string - URL of the top level page that the context menu was invoked on.

frameURL : string - URL of the subframe that the context menu was invoked on.

srcURL : string - Source URL for the element that the context menu was invoked on. Elements with source URLs are images, audio and video.

mediaType : MediaType - Type of the node the context menu was invoked on. Can be none, image, audio, video, canvas, file or plugin.

hasImageContents : bool - Whether the context menu was invoked on an image which has non-empty contents.

isEditable : bool - Whether the context is editable.

selectionText : string - Text of the selection that the context menu was invoked on.

titleText : string - Title text of the selection that the context menu was invoked on.

altText : string - Alt text of the selection that the context menu was invoked on.

suggestedFilename : string - Suggested filename to be used when saving file through 'Save Link As' option of context menu.

selectionRect : Rectangle - Rect representing the coordinates in the document space of the selection.

selectionStartOffset : float - Start position of the selection text.

referrerPolicy : Referrer - The referrer policy of the frame on which the menu is invoked.

misspelledWord : string - The misspelled word under the cursor, if any.

dictionarySuggestions : string[] - An array of suggested words to show the user to replace the misspelledWord. Only available if there is a misspelled word and spellchecker is enabled.

frameCharset : string - The character encoding of the frame on which the menu was invoked.

formControlType : FormControlType - The source that the context menu was invoked on. Possible values include none, button-button, field-set, input-button, input-checkbox, input-color, input-date, input-datetime-local, input-email, input-file, input-hidden, input-image, input-month, input-number, input-password, input-radio, input-range, input-reset, input-search, input-submit, input-telephone, input-text, input-time, input-url, input-week, output, reset-button, select-list, select-list, select-multiple, select-one, submit-button, and text-area,

spellcheckEnabled : bool - If the context is editable, whether or not spellchecking is enabled.

menuSourceType : MenuSourceType - Input source that invoked the context menu. Can be none, mouse, keyboard, touch, touchMenu, longPress, longTap, touchHandle, stylus, adjustSelection, or adjustSelectionReset.

mediaFlags : MediaFlags - The flags for the media element the context menu was invoked on.

editFlags : EditFlags - These flags indicate whether the renderer believes it is able to perform the corresponding action.

Returns: Params

x : int: x coordinate.
y : int: y coordinate.
frame : Option<WebFrameMain>: Frame from which the context menu was invoked. May be null if accessed after the frame has either navigated or been destroyed.
linkURL : string: URL of the link that encloses the node the context menu was invoked on.
linkText : string: Text associated with the link. May be an empty string if the contents of the link are an image.
pageURL : string: URL of the top level page that the context menu was invoked on.
frameURL : string: URL of the subframe that the context menu was invoked on.
srcURL : string: Source URL for the element that the context menu was invoked on. Elements with source URLs are images, audio and video.
mediaType : MediaType: Type of the node the context menu was invoked on. Can be none, image, audio, video, canvas, file or plugin.
hasImageContents : bool: Whether the context menu was invoked on an image which has non-empty contents.
isEditable : bool: Whether the context is editable.
selectionText : string: Text of the selection that the context menu was invoked on.
titleText : string: Title text of the selection that the context menu was invoked on.
altText : string: Alt text of the selection that the context menu was invoked on.
suggestedFilename : string: Suggested filename to be used when saving file through 'Save Link As' option of context menu.
selectionRect : Rectangle: Rect representing the coordinates in the document space of the selection.
selectionStartOffset : float: Start position of the selection text.
referrerPolicy : Referrer: The referrer policy of the frame on which the menu is invoked.
misspelledWord : string: The misspelled word under the cursor, if any.
dictionarySuggestions : string[]: An array of suggested words to show the user to replace the misspelledWord. Only available if there is a misspelled word and spellchecker is enabled.
frameCharset : string: The character encoding of the frame on which the menu was invoked.
formControlType : FormControlType: The source that the context menu was invoked on. Possible values include none, button-button, field-set, input-button, input-checkbox, input-color, input-date, input-datetime-local, input-email, input-file, input-hidden, input-image, input-month, input-number, input-password, input-radio, input-range, input-reset, input-search, input-submit, input-telephone, input-text, input-time, input-url, input-week, output, reset-button, select-list, select-list, select-multiple, select-one, submit-button, and text-area,
spellcheckEnabled : bool: If the context is editable, whether or not spellchecking is enabled.
menuSourceType : MenuSourceType: Input source that invoked the context menu. Can be none, mouse, keyboard, touch, touchMenu, longPress, longTap, touchHandle, stylus, adjustSelection, or adjustSelectionReset.
mediaFlags : MediaFlags: The flags for the media element the context menu was invoked on.
editFlags : EditFlags: These flags indicate whether the renderer believes it is able to perform the corresponding action.

Returns: Params

Instance members

Instance member	Description
`this.altText` Full Usage: `this.altText`	Alt text of the selection that the context menu was invoked on.
`this.dictionarySuggestions` Full Usage: `this.dictionarySuggestions`	An array of suggested words to show the user to replace the misspelledWord. Only available if there is a misspelled word and spellchecker is enabled.
`this.editFlags` Full Usage: `this.editFlags`	These flags indicate whether the renderer believes it is able to perform the corresponding action.
`this.formControlType` Full Usage: `this.formControlType`	The source that the context menu was invoked on. Possible values include none, button-button, field-set, input-button, input-checkbox, input-color, input-date, input-datetime-local, input-email, input-file, input-hidden, input-image, input-month, input-number, input-password, input-radio, input-range, input-reset, input-search, input-submit, input-telephone, input-text, input-time, input-url, input-week, output, reset-button, select-list, select-list, select-multiple, select-one, submit-button, and text-area,
`this.frame` Full Usage: `this.frame`	Frame from which the context menu was invoked. May be null if accessed after the frame has either navigated or been destroyed.
`this.frameCharset` Full Usage: `this.frameCharset`	The character encoding of the frame on which the menu was invoked.
`this.frameURL` Full Usage: `this.frameURL`	URL of the subframe that the context menu was invoked on.
`this.hasImageContents` Full Usage: `this.hasImageContents`	Whether the context menu was invoked on an image which has non-empty contents.
`this.isEditable` Full Usage: `this.isEditable`	Whether the context is editable.
`this.linkText` Full Usage: `this.linkText`	Text associated with the link. May be an empty string if the contents of the link are an image.
`this.linkURL` Full Usage: `this.linkURL`	URL of the link that encloses the node the context menu was invoked on.
`this.mediaFlags` Full Usage: `this.mediaFlags`	The flags for the media element the context menu was invoked on.
`this.mediaType` Full Usage: `this.mediaType`	Type of the node the context menu was invoked on. Can be none, image, audio, video, canvas, file or plugin.
`this.menuSourceType` Full Usage: `this.menuSourceType`	Input source that invoked the context menu. Can be none, mouse, keyboard, touch, touchMenu, longPress, longTap, touchHandle, stylus, adjustSelection, or adjustSelectionReset.
`this.misspelledWord` Full Usage: `this.misspelledWord`	The misspelled word under the cursor, if any.
`this.pageURL` Full Usage: `this.pageURL`	URL of the top level page that the context menu was invoked on.
`this.referrerPolicy` Full Usage: `this.referrerPolicy`	The referrer policy of the frame on which the menu is invoked.
`this.selectionRect` Full Usage: `this.selectionRect`	Rect representing the coordinates in the document space of the selection.
`this.selectionStartOffset` Full Usage: `this.selectionStartOffset`	Start position of the selection text.
`this.selectionText` Full Usage: `this.selectionText`	Text of the selection that the context menu was invoked on.
`this.spellcheckEnabled` Full Usage: `this.spellcheckEnabled`	If the context is editable, whether or not spellchecking is enabled.
`this.srcURL` Full Usage: `this.srcURL`	Source URL for the element that the context menu was invoked on. Elements with source URLs are images, audio and video.
`this.suggestedFilename` Full Usage: `this.suggestedFilename`	Suggested filename to be used when saving file through 'Save Link As' option of context menu.
`this.titleText` Full Usage: `this.titleText`	Title text of the selection that the context menu was invoked on.
`this.x` Full Usage: `this.x`	x coordinate.
`this.y` Full Usage: `this.y`	y coordinate.