TX Text Control .NET Server

Colors 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. ColorBase
  2. StatusBarViewGenerator.Colors

Description

The StatusBarViewGenerator.Colors class gets, sets or resets the display colors of a ServerVisualization.StatusBarViewGenerator component. By default the display colors depend on sytem colors. With this class all colors can be individually designed. The colors are only used when the status bar's BorderStyle property has been set to ColorScheme.

Syntax

public sealed class StatusBarViewGenerator.Colors : ColorBase

Examples

The following example creates a Colors instance and configures its fore color setting for a document workflow.

TXTextControl.ServerVisualisation.StatusBarViewGenerator.Colors colors = new();
colors.ForeColor = System.Drawing.Color.LightSteelBlue;

Members

Constructors

ConstructorDescription
ColorsInitializes a new instance of the StatusBarViewGenerator.Colors class. After creating the object with this constuctor, individual colors can be set. If the Colors object is assigned to the DisplayColors property, non-set colors are reset to their system dependent default values.

Properties

PropertyDescription
BackColorGets or sets the background color at the left edge of the status bar. This color is only used with the ColorScheme border style.
BackColorBottomGets or sets the background color at the bottom of the status bar. This color is only used with the VerticalColorScheme border style.
BackColorMiddleGets or sets the background color in the middle of the status bar. This color is only used with the VerticalColorScheme border style.
BackColorTopGets or sets the background color at the top of the status bar. This color is only used with the VerticalColorScheme border style.
ForeColorGets or sets the color used for text and numbers.
FrameColorGets or sets the color of the status bar's frames. This color is only used with the ColorScheme border style.
GradientBackColorGets or sets the background color at the right edge of the status bar. This color is only used with the ColorScheme border style.
SeparatorColorDarkGets or sets the color of the dark part of a separator. This color is only used with the VerticalColorScheme border style.
SeparatorColorLightGets or sets the color of the light part of a separator. This color is only used with the VerticalColorScheme border style.

Methods

MethodDescription
ResetBackColorResets the status bar's BackColor to its system dependent default value.
ResetBackColorBottomResets the status bar's BackColorBottom to its system dependent default value.
ResetBackColorMiddleResets the status bar's BackColorMiddle to its system dependent default value.
ResetBackColorTopResets the status bar's BackColorTop to its system dependent default value.
ResetForeColorResets the status bar's ForeColor to its system dependent default value.
ResetFrameColorResets the status bar's FrameColor to its system dependent default value.
ResetGradientBackColorResets the status bar's GradientBackColor to its system dependent default value.
ResetSeparatorColorDarkResets the status bar's SeparatorColorDark to its system dependent default value.
ResetSeparatorColorLightResets the status bar's SeparatorColorLight to its system dependent default value.