xtd::forms::progress_box Class Reference

Inheritance diagram for xtd::forms::progress_box:

Definition

Represents a common dialog box that displays a progress dialog.

Header

#include <xtd/forms/progress_box>

Namespace

xtd::forms

Library

xtd.forms

Appearance

	Windows	macOS	Gnome
Light
Dark

Examples

The following code example demonstrates the use of xtd::forms::progress_box dialog.

#include <xtd/xtd>
 
class form1 : public form {
public:
  form1() {
    text("Progress box example");
    client_size({ 400, 200 });
    
    download_button.parent(*this)
    .text("Download")
    .location({ 10, 10 })
    .size({ 150, 35 })
    .click += delegate_ {
      progress_box::show(*this, "Downloading", "Please wait...", 0, 0, 100, progress_box_options::show_cancel_button | progress_box_options::show_skip_button);
      for (auto index = progress_box::minimum(); index <= progress_box::maximum(); ++index) {
        threading::thread::sleep(100_ms); // Do some work...
        progress_box::update(index, "Downloading", xtd::string::format("{}/{}", index, progress_box::maximum()));
        if (progress_box::skipped()) index++;
        if (progress_box::cancelled()) break;
      }
      progress_box::hide();
    };
  }
  
private:
  button download_button;
};
 
auto main() -> int {
  application::run(form1 {});
}

Public Static Properties
static auto	cancelled () -> bool
	Check if the progress dialog is canceled.
static auto	skipped () -> bool
	Check if the progress dialog is skipped.
static auto	minimum () -> xtd::int32
	Gets the minimum value of the range of the progress dialog.
static auto	maximum () -> xtd::int32
	Gets the maximum value of the range of the progress dialog.

Public Static Methods
static auto	hide () -> void
	Hides a progress box in front.
static auto	show (const xtd::string &title) -> void
	Displays a progress box.
static auto	show (const xtd::string &title, xtd::forms::progress_box_options options) -> void
	Displays a progress box.
static auto	show (const xtd::string &title, const xtd::string &message) -> void
	Displays a progress box.
static auto	show (const xtd::string &title, const xtd::string &message, xtd::forms::progress_box_options options) -> void
	Displays a progress box.
static auto	show (const xtd::string &title, const xtd::string &message, xtd::int32 initial_value) -> void
	Displays a progress box.
static auto	show (const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::forms::progress_box_options options) -> void
	Displays a progress box.
static auto	show (const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum) -> void
	Displays a progress box.
static auto	show (const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::forms::progress_box_options options) -> void
	Displays a progress box.
static auto	show (const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum) -> void
	Displays a progress box.
static auto	show (const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, xtd::forms::progress_box_options options) -> void
	Displays a progress box.
static auto	show (const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed) -> void
	Displays a progress box.
static auto	show (const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, xtd::forms::progress_box_options options) -> void
	Displays a progress box.
static auto	show (const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, const xtd::array< xtd::string > &informations) -> void
	Displays a progress box.
static auto	show (const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, const xtd::array< xtd::string > &informations, xtd::forms::progress_box_options options) -> void
	Displays a progress box.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title) -> void
	Displays a progress dialog box in front of a specified window.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title, xtd::forms::progress_box_options options) -> void
	Displays a progress dialog box in front of a specified window.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &message) -> void
	Displays a progress dialog box in front of a specified window.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &message, xtd::forms::progress_box_options options) -> void
	Displays a progress dialog box in front of a specified window.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &message, xtd::int32 initial_value) -> void
	Displays a progress dialog box in front of a specified window.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::forms::progress_box_options options) -> void
	Displays a progress dialog box in front of a specified window.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum) -> void
	Displays a progress dialog box in front of a specified window.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::forms::progress_box_options options) -> void
	Displays a progress dialog box in front of a specified window.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum) -> void
	Displays a progress dialog box in front of a specified window.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, xtd::forms::progress_box_options options) -> void
	Displays a progress dialog box in front of a specified window.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed) -> void
	Displays a progress dialog box in front of a specified window.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, xtd::forms::progress_box_options options) -> void
	Displays a progress dialog box in front of a specified window.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, const xtd::array< xtd::string > &informations) -> void
	Displays a progress dialog box in front of a specified window.
static auto	show (const xtd::forms::iwin32_window &owner, const xtd::string &title, const xtd::string &message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, const xtd::array< xtd::string > &informations, xtd::forms::progress_box_options options) -> void
	Displays a progress dialog box in front of a specified window.
static auto	update (xtd::forms::progress_box_options options) -> void
	Updates progress box.
static auto	update (xtd::int32 value) -> void
	Updates progress box.
static auto	update (xtd::int32 value, const xtd::string &title) -> void
	Updates progress box.
static auto	update (xtd::int32 value, const xtd::string &title, const xtd::string &message) -> void
	Updates progress box.
static auto	update (xtd::int32 value, const xtd::string &title, const xtd::string &message, xtd::int32 minimum) -> void
	Updates progress box.
static auto	update (xtd::int32 value, const xtd::string &title, const xtd::string &message, xtd::int32 minimum, xtd::int32 maximum) -> void
	Updates progress box.
static auto	update (xtd::int32 value, const xtd::string &title, const xtd::string &message, xtd::int32 minimum, xtd::int32 maximum, bool marquee) -> void
	Updates progress box.
static auto	update (xtd::int32 value, const xtd::string &title, const xtd::string &message, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed) -> void
	Updates progress box.
static auto	update (xtd::int32 value, const xtd::string &title, const xtd::string &message, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, const xtd::array< xtd::string > &informations) -> void
	Updates progress box.

Member Function Documentation

cancelled()

auto xtd::forms::progress_box::cancelled ( ) -> bool

staticnodiscard

Check if the progress dialog is canceled.

Returns

true if the progress dialog is canceled

skipped()

auto xtd::forms::progress_box::skipped ( ) -> bool

staticnodiscard

Check if the progress dialog is skipped.

Returns

true if the progress dialog is skipped

minimum()

auto xtd::forms::progress_box::minimum ( ) -> xtd::int32

staticnodiscard

Gets the minimum value of the range of the progress dialog.

Returns

The minimum value of the range. The default is 0.

maximum()

auto xtd::forms::progress_box::maximum ( ) -> xtd::int32

staticnodiscard

Gets the maximum value of the range of the progress dialog.

Returns

The maximum value of the range. The default is 100.

hide()

auto xtd::forms::progress_box::hide ( ) -> void

static

Hides a progress box in front.

show() [1/28]

auto xtd::forms::progress_box::show ( const xtd::string & title ) -> void

static

Displays a progress box.

Parameters

title

An xtd::string that specifies the title of the progress dialog.

show() [2/28]

auto xtd::forms::progress_box::show ( const xtd::string & title, xtd::forms::progress_box_options options ) -> void

static

Displays a progress box.

Parameters

title	An xtd::string that specifies the title of the progress dialog.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

show() [3/28]

auto xtd::forms::progress_box::show ( const xtd::string & title, const xtd::string & message ) -> void

static

Displays a progress box.

Parameters

title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.

show() [4/28]

auto xtd::forms::progress_box::show ( const xtd::string & title, const xtd::string & message, xtd::forms::progress_box_options options ) -> void

static

Displays a progress box.

Parameters

title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

show() [5/28]

auto xtd::forms::progress_box::show ( const xtd::string & title, const xtd::string & message, xtd::int32 initial_value ) -> void

static

Displays a progress box.

Parameters

title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.

show() [6/28]

auto xtd::forms::progress_box::show ( const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::forms::progress_box_options options ) -> void

static

Displays a progress box.

Parameters

title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

show() [7/28]

auto xtd::forms::progress_box::show ( const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum ) -> void

static

Displays a progress box.

Parameters

title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.

show() [8/28]

auto xtd::forms::progress_box::show ( const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::forms::progress_box_options options ) -> void

static

Displays a progress box.

Parameters

title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

show() [9/28]

auto xtd::forms::progress_box::show ( const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum ) -> void

static

Displays a progress box.

Parameters

title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.

show() [10/28]

auto xtd::forms::progress_box::show ( const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, xtd::forms::progress_box_options options ) -> void

static

Displays a progress box.

Parameters

title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

show() [11/28]

auto xtd::forms::progress_box::show ( const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed ) -> void

static

Displays a progress box.

Parameters

title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.

show() [12/28]

auto xtd::forms::progress_box::show ( const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, xtd::forms::progress_box_options options ) -> void

static

Displays a progress box.

Parameters

title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

show() [13/28]

auto xtd::forms::progress_box::show ( const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, const xtd::array< xtd::string > & informations ) -> void

static

Displays a progress box.

Parameters

title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speed	An integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
informations	An xtd::array of xtd::string that specifies the information texts of the progress dialog.

show() [14/28]

auto xtd::forms::progress_box::show ( const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, const xtd::array< xtd::string > & informations, xtd::forms::progress_box_options options ) -> void

static

Displays a progress box.

Parameters

title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speed	An integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
informations	An xtd::array of xtd::string that specifies the information texts of the progress dialog.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

show() [15/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.

show() [16/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title, xtd::forms::progress_box_options options ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

show() [17/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title, const xtd::string & message ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.

show() [18/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title, const xtd::string & message, xtd::forms::progress_box_options options ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

show() [19/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title, const xtd::string & message, xtd::int32 initial_value ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.

show() [20/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::forms::progress_box_options options ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

show() [21/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.

show() [22/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::forms::progress_box_options options ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

show() [23/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.

show() [24/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, xtd::forms::progress_box_options options ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

show() [25/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.

show() [26/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, xtd::forms::progress_box_options options ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

show() [27/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, const xtd::array< xtd::string > & informations ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speed	An integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
informations	An xtd::array of xtd::string that specifies the information texts of the progress dialog.

show() [28/28]

auto xtd::forms::progress_box::show ( const xtd::forms::iwin32_window & owner, const xtd::string & title, const xtd::string & message, xtd::int32 initial_value, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, const xtd::array< xtd::string > & informations, xtd::forms::progress_box_options options ) -> void

static

Displays a progress dialog box in front of a specified window.

Parameters

owner	An If xtd::forms::iwin32_window that represents the owner window of the progress dialog box.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
initial_value	An integer that indicates the initial value of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speed	An integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
informations	An xtd::array of xtd::string that specifies the information texts of the progress dialog.
options	A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

update() [1/9]

auto xtd::forms::progress_box::update ( xtd::forms::progress_box_options options ) -> void

static

Updates progress box.

Parameters

options

A bitwise combination of enum xtd::forms::progress_box_options to specify additional options to the progress dialog box.

update() [2/9]

auto xtd::forms::progress_box::update ( xtd::int32 value ) -> void

static

Updates progress box.

Parameters

value

An integer that indicates the value of the progress dialog.

update() [3/9]

auto xtd::forms::progress_box::update ( xtd::int32 value, const xtd::string & title ) -> void

static

Updates progress box.

Parameters

value	An integer that indicates the value of the progress dialog.
title	An xtd::string that specifies the title of the progress dialog.

update() [4/9]

auto xtd::forms::progress_box::update ( xtd::int32 value, const xtd::string & title, const xtd::string & message ) -> void

static

Updates progress box.

Parameters

value	An integer that indicates the value of the progress dialog.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.

update() [5/9]

auto xtd::forms::progress_box::update ( xtd::int32 value, const xtd::string & title, const xtd::string & message, xtd::int32 minimum ) -> void

static

Updates progress box.

Parameters

value	An integer that indicates the value of the progress dialog.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.

update() [6/9]

auto xtd::forms::progress_box::update ( xtd::int32 value, const xtd::string & title, const xtd::string & message, xtd::int32 minimum, xtd::int32 maximum ) -> void

static

Updates progress box.

Parameters

value	An integer that indicates the value of the progress dialog.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.

update() [7/9]

auto xtd::forms::progress_box::update ( xtd::int32 value, const xtd::string & title, const xtd::string & message, xtd::int32 minimum, xtd::int32 maximum, bool marquee ) -> void

static

Updates progress box.

Parameters

value	An integer that indicates the value of the progress dialog.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.

update() [8/9]

auto xtd::forms::progress_box::update ( xtd::int32 value, const xtd::string & title, const xtd::string & message, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed ) -> void

static

Updates progress box.

Parameters

value	An integer that indicates the value of the progress dialog.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speed	An integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.

update() [9/9]

auto xtd::forms::progress_box::update ( xtd::int32 value, const xtd::string & title, const xtd::string & message, xtd::int32 minimum, xtd::int32 maximum, bool marquee, xtd::usize marquee_animation_speed, const xtd::array< xtd::string > & informations ) -> void

static

Updates progress box.

Parameters

value	An integer that indicates the value of the progress dialog.
title	An xtd::string that specifies the title of the progress dialog.
message	An xtd::string that specifies the message of the progress dialog.
minimum	An integer that indicates the minimum value of the progress dialog.
maximum	An integer that indicates the maximum value of the progress dialog.
marquee	A boolean that Indicates progress by continuously scrolling a block across a xtd::forms::progress_bar in a marquee fashion.
marquee_animation_speed	An integer that indicates the time period, in milliseconds, that it takes the progress block to scroll across the progress bar.
informations	An xtd::array of xtd::string that specifies the information texts of the progress dialog.

---

The documentation for this class was generated from the following file:

• xtd.forms/include/xtd/forms/progress_box.hpp