TX Text Control .NET Server

DialogViewGenerator 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. Component
  2. DialogViewGenerator

Description

An instance of the DialogViewGenerator class can be used to visualize a built-in dialog box through an image. It manages a ServerVisualization.UserInput and a ServerVisualization.View object. These objects can be used to inform the generator about user input and to get a generated view depending on the input.

Syntax

public class DialogViewGenerator : Component

Examples

The following example includes the activation state value from a Dialog View Generator object in application diagnostics. The created object is then available to the surrounding document workflow.

Console.WriteLine($"Activation State: {dialogViewGenerator.ActivationState}");
Console.WriteLine("Dialog View Generator is ready for use.");

Members

Properties

PropertyDescription
ActivationStateGets or sets a value indicating the dialog box's activation state. It can be activated, deactivated or disabled.
CaptionGets the dialog box's caption.
UserInputGets the dialog box's UserInput object, which can be used to inform the dialog box about user input. The generator uses this information to generate a new view.
ViewGets the dialog box's View object, which informs about view changes and provides an image of the dialog box's current state.

Events

EventDescription
CaretStateChangedOccurs when the state of the caret (size, position, visibility) has been changed. The event handler receives an argument of type ServerVisualization.CaretStateEventArgs containing data related to this event.
ClosedOccurs after the dialog box has been closed through clicking the Ok or Cancel button. The event handler receives an argument of type EventArgs containing data related to this event.
ShowDialogBoxOccurs when the dialog box should show a further dialog box. The event handler receives an argument of type ServerVisualization.ShowDialogBoxEventArgs containing data related to this event.
ShowErrorMessageOccurs when the dialog box should show an error message. The event handler receives an argument of type ServerVisualization.ShowErrorMessageEventArgs containing data related to this event.