Text Control
The Text control displays static text, which may use a predefined style.
The recommended method for displaying text with specified line breaks is to use multiple one-line text controls located below each other. The character sequences \n, \r\n, or \n\r in the text field for the control are not displayed as a line break. These character sequences are literally displayed by the control.
Control Attributes
You can use the following attributes with the Text control. To change the value of an attribute using an event, subscribe the control to a ControlEvent in the EventMapping table and list the attribute's identifier in the Attribute column. Enter the identifier of the ControlEvent in the Event column.
| Attribute identifier | Hexadecimal bit | Description |
|---|---|---|
| Position | Position of control in the dialog box. Enter the control's width, height, and coordinates of the control's left corner into the Width, Height, X, and Y columns of the Control table or BBControl table. Use installer units for length and distance. |
|
| Text | Text displayed by the control. To set the font and font style of a text string, prefix the string of displayed characters with {\style} or {&style}. Where style is an identifier listed in the TextStyle column of the TextStyle table. If neither of these are present, but the DefaultUIFont property is defined as a valid text style, that font will be used. |
|
| TimeRemaining | This attribute enables a Text control to display the approximate number of minutes and seconds remaining for an installation. Subscribe the Text control to the TimeRemaining ControlEvent in the Eventmapping table and enter TimeRemaining into the Attribute column. The installer publishes a record containing one integer representing the number of seconds remaining in the installation. Include a row in the UIText table with TimeRemaining in the Key column. Enter a formatted text string into the Text column authored to display minutes and seconds. Format this string as described for MsiFormatRecord. |
|
| Visible | 0x00000000 0x00000001 |
Hidden control. Visible control. Include this bit in the bit word of the Attributes column in the Control table or BBControl table.to make the control visible or hidden upon its creation. You can also hide or show a control by using the ControlCondition table. |
| Enabled | 0x00000000 0x00000002 |
Control in a disabled state. Control in an enabled state. Include this bit in the bit word in the Attributes column of the Control or BBControl tables to enable the control on creation. You can also enable or disable a control by using the ControlCondition table. |
| Sunken | 0x00000000 0x00000004 |
Displays the default visual style. Displays the control with a sunken, 3-D, look. Include these bits in the bit word in the Attributes column of the Control table. |
| RTLRO | 0x00000000 0x00000020 |
Text in the control is displayed in left-to-right reading order. Text in the control is displayed in right-to-left reading order. |
| RightAligned | 0x00000000 0x00000040 |
Text in the control is aligned to the left. Text in the control is aligned to the right. |
| Transparent | 0x00000000 0x00010000 |
Opaque control. Background shows through control. The control has the WS_EX_TRANSPARENT style. Include this bit in the Attributes column of the Control or BBControl tables. |
| NoPrefix | 0x00000000 0x00020000 |
Use & in a text string to display the next character as underscored. The character & in a string is displayed as itself. Include this bit in the bit word in the Attributes column of the Control or BBControl tables. |
| NoWrap | 0x00000000 0x00040000 |
Text wraps. Text is displayed on a single line. If the text extends beyond the control's margins, it is clipped and an ellipsis ("...") is inserted. Include this bit in the bit word in the Attributes column of the Control or BBControl tables. |
| UsersLanguage | 0x00000000 0x00100000 |
Fonts created in the database code page. Fonts created in the user's default UI code page. |
| FormatSize Control Attribute | 0x00000000 0x00080000 |
Formatted as text. If this bit is set the control attempts to format the displayed text as a number representing a count of bytes. For proper formatting, the control's text must be set to a string representing a number expressed in units of 512 bytes. The displayed value will then be formatted in terms of kilobytes (KB), megabytes (MB), or gigabytes (GB), and displayed with the appropriate string representing the units. |
Remarks
This control can be created from the STATIC class by using the CreateWindowEx function. It has the SS_LEFT, WS_CHILD, and WS_GROUP styles.
Do not place transparent Text controls on top of colored bitmaps. The text may not be visible if the user changes the display color scheme. For example, text may become invisible if the user sets the high contrast parameter for accessibility reasons.