API Reference › core-frontend› Tools › ToolAssistance

ToolAssistance Class

Tool Assistance helper methods.

Methods

Name Description
constructor(): ToolAssistance    
createInstruction(image: string | ToolAssistanceImage, text: string, isNew?: boolean, inputMethod?: ToolAssistanceInputMethod, keyboardInfo?: ToolAssistanceKeyboardInfo): ToolAssistanceInstruction Static Creates a ToolAssistanceInstruction.  
createInstructions(mainInstruction: ToolAssistanceInstruction, sections?: ToolAssistanceSection[]): ToolAssistanceInstructions Static Creates a ToolAssistanceInstructions.  
createKeyboardInfo(keys: string[], bottomKeys?: string[]): ToolAssistanceKeyboardInfo Static Creates a ToolAssistanceKeyboardInfo.  
createKeyboardInstruction(keyboardInfo: ToolAssistanceKeyboardInfo, text: string, isNew?: boolean, inputMethod?: ToolAssistanceInputMethod): ToolAssistanceInstruction Static Creates a ToolAssistanceInstruction with a ToolAssistanceKeyboardInfo.  
createModifierKeyInstruction(modifierKey: string, image: string | ToolAssistanceImage, text: string, isNew?: boolean, inputMethod?: ToolAssistanceInputMethod): ToolAssistanceInstruction Static Creates a ToolAssistanceInstruction with a modifier key and an image.  
createSection(instructions: ToolAssistanceInstruction[], label?: string): ToolAssistanceSection Static Creates a ToolAssistanceSection.  
createTouchCursorInstructions(instructions: ToolAssistanceInstruction[]): boolean Static Creates instructions for interaction with the touch cursor that are appended to the supplied ToolAssistanceInstruction array.  
translateInput(key: ToolAssistanceInputKey): string Static Return the translated string for the specified input instruction key  
translatePrompt(key: ToolAssistancePromptKey): string Static Return the translated string for the specified main instruction key  

Properties

Name Type Description
altKey Accessor Static ReadOnly string Alt key text.  
altKeyboardInfo Accessor Static ReadOnly ToolAssistanceKeyboardInfo Keyboard info for Alt key.  
altSymbol Static Readonly string Alt key symbol.  
altSymbolKeyboardInfo Accessor Static ReadOnly ToolAssistanceKeyboardInfo Keyboard info for Alt key symbol.  
arrowKeyboardInfo Static Readonly ToolAssistanceKeyboardInfo Keyboard info for Arrow keys.  
ctrlKey Accessor Static ReadOnly string Ctrl key text.  
ctrlKeyboardInfo Accessor Static ReadOnly ToolAssistanceKeyboardInfo Keyboard info for Ctrl key.  
ctrlSymbol Static Readonly string Ctrl key symbol.  
ctrlSymbolKeyboardInfo Accessor Static ReadOnly ToolAssistanceKeyboardInfo Keyboard info for Ctrl key symbol.  
downSymbol Static Readonly string Down key symbol.  
inputsLabel Accessor Static ReadOnly string Inputs text.  
leftSymbol Static Readonly string Left key symbol.  
rightSymbol Static Readonly string Right key symbol.  
shiftKey Accessor Static ReadOnly string Shift key text.  
shiftKeyboardInfo Accessor Static ReadOnly ToolAssistanceKeyboardInfo Keyboard info for Shift key with symbol.  
shiftKeyboardInfoNoSymbol Accessor Static ReadOnly ToolAssistanceKeyboardInfo Keyboard info for Shift key without symbol.  
shiftSymbol Static Readonly string Shift key symbol.  
shiftSymbolKeyboardInfo Accessor Static ReadOnly ToolAssistanceKeyboardInfo Keyboard info for Shift key symbol.  
upSymbol Static Readonly string Up key symbol.  

Defined in

Last Updated: 17 May, 2024