uiprogressdlg
Create progress dialog box
Description
d = uiprogressdlg(fig)fig and
returns the ProgressDialog object.
d = uiprogressdlg(fig,Name,Value)ProgressDialog property values by using
Name,Value arguments. Use property values to control the
appearance and behavior of the dialog box. For example, you can add a title or
message to the dialog box, or specify an indeterminate progress bar.
Examples
Create a program file called myprogress1.m that creates
a figure and a progress dialog box. Update the Value
and Message properties at three different points in the
code.
function myprogress1 fig = uifigure; d = uiprogressdlg(fig,'Title','Please Wait',... 'Message','Opening the application'); pause(.5) % Perform calculations % ... d.Value = .33; d.Message = 'Loading your data'; pause(1) % Perform calculations % ... d.Value = .67; d.Message = 'Processing the data'; pause(1) % Finish calculations % ... d.Value = 1; d.Message = 'Finishing'; pause(1) % Close dialog box close(d) end
Run the program to display the progress dialog box.
myprogress1
Create a program file called myprogress2.m that creates
a figure and displays an indeterminate progress bar during a singular value
decomposition.
function myprogress2 fig = uifigure; d = uiprogressdlg(fig,'Title','Computing SVD',... 'Indeterminate','on'); drawnow % Do the SVD computation svd(rand(5000)); % close the dialog box close(d) end
Setting the Indeterminate property to
'on' animates the progress bar to indicate that there
is no projected completion time. After completing the calculation, the
close function closes the dialog box.
Run the program to perform the singular value decomposition and display the progress dialog box.
myprogress2
Create a program file called myprogress3.m that creates
a figure and displays a progress bar while approximating the value of
pi.
function myprogress3 fig = uifigure; d = uiprogressdlg(fig,'Title','Approximating Pi',... 'Message','1','Cancelable','on'); drawnow % Approximate pi^2/8 as: 1 + 1/9 + 1/25 + 1/49 + ... pisqover8 = 1; denom = 3; valueofpi = sqrt(8 * pisqover8); steps = 20000; for step = 1:steps % Check for Cancel button press if d.CancelRequested break end % Update progress, report current estimate d.Value = step/steps; d.Message = sprintf('%12.9f',valueofpi); % Calculate next estimate pisqover8 = pisqover8 + 1 / (denom * denom); denom = denom + 2; valueofpi = sqrt(8 * pisqover8); end % Close the dialog box close(d) end
Setting the Cancelable property to
'on' creates a cancel button with the default label,
Cancel. The first command in the
for loop checks the value of
d.CancelRequested to see if the user clicked the
cancel button. If the value is true, the program exits
the loop. Finally, the close(d) command closes the dialog
box after the for loop finishes or the user
cancels.
Run the program to approximate pi and display the progress dialog box.
myprogress3
Specify a custom icon and format message text using HTML to modify the appearance of the progress dialog box.
Create a program file called myprogress4.m that creates
a figure and displays a progress bar. Specify an image file as the dialog
box icon, and then specify that the dialog box interpret its message text as
HTML. Create a matrix of RGB color values using the
winter colormap. Use a for loop to
update the progress bar value and to format and display the message color by
using HTML markup. Close the dialog box when the loop completes.
function myprogress4 fig = uifigure; d = uiprogressdlg(fig,'Icon','peppers.png', ... 'Interpreter','html'); steps = 100; cmap = winter(steps)*100; for step = 1:steps r = num2str(cmap(step,1)); g = num2str(cmap(step,2)); b = num2str(cmap(step,3)); msg = ['<p style=color:rgb(' r '%,' g '%,' b '%)> Calculating... </p>']; d.Message = msg; d.Value = step/steps; pause(0.05); end close(d) end
Run the program to display the progress dialog box.
myprogress4
Input Arguments
Name-Value Arguments
Tips
When you create a progress dialog box, store the
ProgressDialogobject as a variable by specifying an output argument. You can use this object to update the dialog box after you create it by setting properties and to manage when the dialog box is deleted by using thedeletefunction.
