Colors Class
- Namespace
TXTextControl.ServerVisualisation
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. Core. SDK
- Assembly
TXTextControl.Server. Core. dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. Core. SDK TXTextControl.from the setup.Server. dll
- Also in
TXTextControl.asTextControl. ASP. SDK TXTextControl.Server. dll
- Inherits
- ColorBase
- Text
View Generator. Colors
Description
The TextViewGenerator.Colors class gets, sets or resets the display colors of a TextViewGenerator component. By default the display colors depend on sytem colors or a default value. With this class all colors can be individually designed.
Syntax
public sealed class TextViewGenerator.Colors : ColorBasePublic NotInheritable Class TextViewGenerator.Colors
Inherits ColorBaseExamples
The following example creates a Colors instance and configures its desktop color setting for a document workflow.
TXTextControl.ServerVisualisation.TextViewGenerator.Colors colors = new();
colors.DesktopColor = System.Drawing.Color.LightSteelBlue;Dim colors As New TXTextControl.ServerVisualisation.TextViewGenerator.Colors()
colors.DesktopColor = System.Drawing.Color.LightSteelBlueMembers
Constructors
| Constructor | Description |
|---|---|
| Colors | Initializes a new instance of the TextViewGenerator.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 default values. |
Properties
| Property | Description |
|---|---|
| ActiveFormFieldColor | Gets or sets the highlight color of a form field containing the current text input position. To suppress highlighting the active FormField the property value can be set to Color.Transparent. |
| DarkShadowColor | Gets or sets the display color for the shadow at the right and the bottom edge of the pages. |
| DesktopColor | Gets or sets the display color for the area around the pages. |
| FormFieldColor | Gets or sets the highlight color of a form field. This color can be overwritten with the TextField.HighlightColor property. To suppress highlighting a FormField the property value can be set to Color.Transparent. |
| HeaderFooterLabelColor | Gets or sets the display color for the label showing which header or footer is activated. |
| HeaderFooterLineColor | Gets or sets the display color for the dividing line between headers and footers and the main text. |
| LightShadowColor | Gets or sets the display color for the shadow at the left and the top edge of the pages. |
Methods
| Method | Description |
|---|---|
| ResetActiveFormFieldColor | Resets the text control's ActiveFormFieldColor to its default value. |
| ResetDarkShadowColor | Resets the text control's DarkShadowColor to its system dependent default value. |
| ResetDesktopColor | Resets the text control's DesktopColor to its system dependent default value. |
| ResetFormFieldColor | Resets the text control's FormFieldColor to its default value. |
| ResetHeaderFooterLabelColor | Resets the text control's HeaderFooterLabelColor to its system dependent default value. |
| ResetHeaderFooterLineColor | Resets the text control's HeaderFooterLineColor to its system dependent default value. |
| ResetLightShadowColor | Resets the text control's LightShadowColor to its system dependent default value. |