TX Text Control .NET Server

UserInput Class

Class|Introduced in 21.0
Namespace
TXTextControl.ServerVisualisation
Package
TXTextControl.TextControl.Core.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.Server.Core.dll
Install
dotnet add package TXTextControl.TextControl.Core.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.Server.dll from the setup.
Also in
TXTextControl.TextControl.ASP.SDK as TXTextControl.Server.dll
Inherits
  1. MarshalByRefObject
  2. UserInput

Description

An instance of the UserInput class can be used to inform a view generator about user input. It can be obtained through the ServerVisualization.TextViewGenerator.UserInput, ServerVisualization.RulerBarViewGenerator.UserInput, ServerVisualization.StatusBarViewGenerator.UserInput and ServerVisualization.DialogViewGenerator.UserInput properties.

Syntax

public class UserInput : MarshalByRefObject

Examples

The following example includes a User Input object in application diagnostics. The created object is then available to the surrounding document workflow.

Console.WriteLine(userInput);
Console.WriteLine("User Input is ready for use.");

Members

Methods

MethodDescription
SendKeyDownInforms the view generator about a key down event.
SendKeyPressInforms the view generator about a key press event.
SendKeyUpInforms the view generator about a key up event.
SendMouseDoubleClickInforms the view generator about a mouse double click event.
SendMouseDownInforms the view generator about a mouse down event.
SendMouseMoveInforms the view generator about a mouse move event.
SendMouseUpInforms the view generator about a mouse up event.
SendMouseWheelInforms the view generator about a mouse wheel event.

Enumerations

EnumerationDescription
ModifierKeysDetermines a pressed modifier key. It contains the following values:
MouseButtonsDetermines a pressed mouse button. It contains the following values: