TX Text Control .NET Server

StatusBarViewGenerator Class

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

Description

An instance of the StatusBarViewGenerator class can be used to visualize a status bar 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. A StatusBarViewGenerator object can be connected with a TextViewGenerator object to show the position of the curent text input position and other status information. The StatusBarViewGenerator class is inherited from the System.ComponentModel.Component class. The following describes only the properties, methods and events defined through the StatusBarViewGenerator class. For a list of properties, methods and events inherited from the System.ComponentModel.Component class see the .NET Framework reference.

Syntax

public class StatusBarViewGenerator : Component

Examples

The following example creates a Status Bar View Generator instance and configures its border style setting for a document workflow.

using TXTextControl.ServerVisualisation.StatusBarViewGenerator statusBarViewGenerator = new();
statusBarViewGenerator.BorderStyle = StatusBarBorderStyle.Fixed3D;

Members

Constructors

ConstructorDescription
StatusBarViewGeneratorInitializes a new instance of the StatusBarViewGenerator class. After initialization the Create method must be called to enable further resources.

Properties

PropertyDescription
BorderStyleGets or sets the border style of the status bar.
ColumnTextGets or sets the text in the 'Column' area of the status bar.
DisplayColorsGets or sets the colors of the status bar. These colors are only used when the BorderStyle property has been set to ColorScheme. The property value is an object of the type ServerVisualization.StatusBarViewGenerator.Colors.
FontGets or sets the font which is used to display text.
LineTextGets or sets the text in the 'Line' area of the status bar.
LocationNot described in the reference. public Point Location { get; set; }
PageCounterTextGets or sets the text in the 'Page counter' area of the status bar.
PageTextGets or sets the text in the 'Page' area of the status bar.
ResolutionGets or sets a resolution, in dots per inch (dpi) for all images, provided through the View property. When this property is set to zero, the system resolution is used.
SectionCounterTextGets or sets the text in the 'Section counter' area of the status bar.
SectionTextGets or sets the text in the 'Section' area of the status bar.
ShowColumnSpecifies whether the status bar shows the column number of the current text input position.
ShowKeyStatesSpecifies whether the status bar shows the key state of the CAPSLOCK and the NUMLOCK key and the current insertion mode, insert or overwrite.
ShowLanguageSpecifies whether the status bar shows the language of the text selection or the text input position.
ShowLineSpecifies whether the status bar shows the line number of the current text input position.
ShowPageSpecifies whether the status bar shows the page number of the current text input position.
ShowPageCounterSpecifies whether the status bar shows the number of pages the document consists of.
ShowSectionSpecifies whether the status bar shows the section number of the current text input position.
ShowSectionCounterSpecifies whether the status bar shows the number of sections the document consists of.
ShowZoomSpecifies whether the status bar shows the current zoom factor.
ShowZoomTrackBarSpecifies whether the status bar displays a track bar instead of a simple number to show and to set the zooming factor.
UserInputGets the UserInput object, which can be used to inform the StatusBarViewGenerator about user input. The generator uses this information to generate a new view.
ViewGets the View object, which informs about view changes and provides an image of the StatusBarViewGenerator's current state.

Methods

MethodDescription
CreateInitializes the resources of a newly instantiated object. This method must be called before using the object. To release created resources, Dispose should be called after using the object.
ResetDisplayColorsResets all display colors of a status bar to their system dependent default values.
ResetFontNot described in the reference. public void ResetFont();