GoFiler Legato Script Reference   Legato v 1.5b Application v 5.24b

Table of Contents	< < Previous	Next >>

 

Chapter Nine — Dialog Functions (continued)

9.21 Progress Control

9.21.1 Introduction

This section covers the Window progress bar, or progress control. Critical parts of the Windows API has been exposed through Legato. The following text is modified from MSDN.

A progress control is a window that an application can use to indicate the progress of a lengthy operation. It consists of a rectangle that is animated as an operation progresses. The following illustration shows a progress bar that does not use visual styles.

The following illustration shows a progress control using visual styles. The appearance of the control will vary depending on the operating system and the selected theme. For more information, see Visual Styles.

9.21.2 Range and Current Position

A progress control’s range represents the entire duration of the operation, and the current position represents the progress that the application has made toward completing the operation. The window procedure uses the range and the current position to determine the percentage of the progress bar to fill with the highlight color.

If you do not set the range values, the system sets the minimum value to 0 and the maximum value to 100. You can adjust the range to convenient integers by using the ProgressControlSetRange function.

A progress control provides several functions that to set the current position. The ProgressControlUpdate function sets the position to a given value. The ProgressControlSetDelta function advances the position by adding a specified value to the current position.

[The PBM_SETSTEP message allows you to specify a step increment for a progress bar. Subsequently, whenever you send the PBM_STEPIT message to the progress bar, the current position advances by the specified increment. By default, the step increment is set to 10.]

[marquee style]

9.21.3 Progress Control Types and Styles

The Windows class name is “msctls_progress32” but Legato allows for the alias of “ProgressBar” which is easier to understand. The name is also not case sensitive.

Control styles should be combined with regular window styles.

	Constant		Description
	PBS_MARQUEE		The progress bar does not grow in size but instead moves repeatedly along the length of the bar, indicating activity without specifying what proportion of the progress is complete.
	PBS_VERTICAL		The progress bar displays progress status vertically, from bottom to top.

 

Example of a progress bar control declaration:

CONTROL "", 101, "ProgressBar", WS_CHILD | WS_VISIBLE, 24, 20, 120, 10, 0

9.21.4 Progress Control Functions

ControlDisable — Disables specified control.

ControlEnable — Enables specified control.

ControlHide — Hides a specified control.

ControlShow — Shows a specified control (if hidden).

ProgressControlSetRange — Sets the range of a progress control.

ProgressControlUpdate — Updates the position of the progress bar.

Page revised 2024-10-21

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 10/21/2024

© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.