Хитрости »
26 Февраль 2016 56343 просмотров
Отобразить процесс выполнения
Часто при создании кодов в VBA используется обращение к ячейкам, листам, книгам и т.д. и их обработка в циклах. Пара примеров подобных циклов:
- Просмотреть все файлы в папке — цикл по файлам в папке — Do While sFiles <> «» и For Each objFile In objFolder.Files
- Массовая замена слов — цикл по ячейкам(массивам) — For lr = 1 To UBound(avArr, 1)
- Не работают/пропали меню — цикл по всем панелям — For Each cmdBar In Application.CommandBars
Если операция в цикле выполняется за пару секунд — это вполне приемлемо и отражать графически подобные действия нет нужды. Но, если циклы «крутятся» по полчаса — вполне неплохо иметь возможность видеть на какой стадии цикл. Здесь есть один нюанс: циклы могут быть как с заранее известным кол-вом итераций, так и без этого понимания.
Цикл Do While из первого кода статьи Просмотреть все файлы в папке является циклом условия. Т.е. заранее неизвестно сколько файлов будет обработано и следовательно невозможно отразить прогресс выполнения задачи в процентах.
Циклы вроде For Each и For … Next как правило дают возможность определить общее кол-во элементов к обработке, т.к. применяются как правило к коллекциям и объектам, у которых есть свойство .Count. Углубляться в этой статье не стану — это лишь предисловие, чтобы было ясно, почему и зачем далее в статье продемонстрированы разные подходы отображения процесса выполнения.
Отобразить же процесс можно двумя способами:
- Использование Application.StatusBar
- Использование UserForm
Использование Application.StatusBar
Самый простой вариант отображения процесса выполнения кода. Он может быть без проблем использован на любом ПК.
Application.StatusBar
— это специальный элемент интерфейса, расположенный в левой нижней части окна Excel и который может показывать дополнительную информацию в зависимости от действий пользователя. Все не раз видели его в работе. Например, после того как мы скопировали ячейки StatusBar покажет нам доп.информацию:
И из VBA есть доступ к этому элементу. Чтобы написать слово привет в StatusBar надо выполнить всего одну строку кода:
Application.StatusBar = "Привет"
Чтобы сбросить значения StatusBar и передать управление им обратно самому Excel необходимо выполнить строку:
Application.StatusBar = False
делать это обязательно, т.к. в противном случае вместо системных доп.сообщений будет постоянно показываться то значение, которое мы задали. Конечно, можно перезапустить Excel, но куда правильнее дописать в код строку, приведенную выше.
Как я уже упоминал — циклы могут быть с заранее неизвестным кол-вом итераций. В таких случаях очень удобно показывать стадию выполнения хотя бы из тех побуждений, чтобы пользователь видел, что программа не «зависла». на примере кода из статьи Просмотреть все файлы в папке:
Sub Get_All_File_from_Folder() Dim sFolder As String, sFiles As String 'диалог запроса выбора папки с файлами With Application.FileDialog(msoFileDialogFolderPicker) If .Show = False Then Exit Sub sFolder = .SelectedItems(1) End With sFolder = sFolder & IIf(Right(sFolder, 1) = Application.PathSeparator, "", Application.PathSeparator) 'отключаем обновление экрана, чтобы наши действия не мелькали Application.ScreenUpdating = False sFiles = Dir(sFolder & "*.xls*") Do While sFiles <> "" 'показываем этап выполнения Application.StatusBar = "Обрабатывается файл '" & sFiles & "'" 'открываем книгу Workbooks.Open sFolder & sFiles 'действия с файлом 'Запишем на первый лист книги в ячейку А1 - www.excel-vba.ru ActiveWorkbook.Sheets(1).Range("A1").Value = "www.excel-vba.ru" 'Закрываем книгу с сохранением изменений ActiveWorkbook.Close True 'если поставить False - книга будет закрыта без сохранения sFiles = Dir Loop 'возвращаем ранее отключенное обновление экрана Application.ScreenUpdating = True 'сбрасываем значение статусной строки Application.StatusBar = False End Sub
Если запустить код, то перед открытием каждой книги в строке StatusBar будет показано какой именно файл отрывается и обрабатывается. И так с каждым файлом:
В случае же с циклами, количество итераций которых есть возможность определить, можно показывать этап выполнения в процентах. Например, цикл по всем выделенным ячейкам:
Sub ShowProgressBar() Dim lAllCnt As Long, lr as Long Dim rc As Range 'кол-во ячеек в выделенной области lAllCnt = Selection.Count 'цикл по всем ячейкам в выделенной области For Each rc In Selection 'прибавляем 1 при каждом шаге lr = lr + 1 Application.StatusBar = "Выполнено: " & Int(100 * lr / lAllCnt) & "%" DoEvents 'чтобы форма перерисовывалась Next 'сбрасываем значение статусной строки Application.StatusBar = False End Sub
В строке статуса это будет выглядеть так:
Но можно показывать информацию и в чуть более изощренных формах:
Вариант отображения % и блоками-цифрами от 1 до 10(1 = 10% выполнения)
Sub StatusBar1() Dim lr As Long, lrr As Long, lp As Double Dim lAllCnt As Long 'кол-во итераций Dim s As String lAllCnt = 10000 'основной цикл For lr = 1 To lAllCnt lp = lr 100 'десятая часть всего массива s = "" 'формируем строку символов(от 1 до 10) For lrr = 10102 To 10102 + lp 10 s = s & ChrW(lrr) Next 'выводим текущее состояние выполнения Application.StatusBar = "Выполнено: " & lp & "% " & s: DoEvents DoEvents Next 'очищаем статус-бар от значений после выполнения Application.StatusBar = False End Sub
Вариант отображения % и стрелками ->(1 стрелка = 10% выполнения)
Sub StatusBar2() Dim lr As Long, lp As Double Dim lAllCnt As Long 'кол-во итераций Dim s As String lAllCnt = 10000 For lr = 1 To lAllCnt lp = lr 100 'десятая часть всего массива 'формируем строку символов(от 1 до 10) s = String(lp 10, ChrW(10152)) & String(11 - lp 10, ChrW(8700)) Application.StatusBar = "Выполнено: " & lp & "% " & s: DoEvents DoEvents Next 'очищаем статус-бар от значений после выполнения Application.StatusBar = False End Sub
Вариант отображения % и квадратами (кол-во квадратов можно изменять. Если lMaxQuad=20 — каждый квадрат одна 20-я часть всего массива)
Sub StatusBar3() Dim lr As Long Dim lAllCnt As Long 'кол-во итераций Const lMaxQuad As Long = 20 'сколько квадратов выводить lAllCnt = 10000 For lr = 1 To lAllCnt Application.StatusBar = "Выполнено: " & Int(100 * lr / lAllCnt) & "%" & String(CLng(lMaxQuad * lr / lAllCnt), ChrW(9632)) & String(lMaxQuad - CLng(lMaxQuad * lr / lAllCnt), ChrW(9633)) DoEvents Next 'очищаем статус-бар от значений после выполнения Application.StatusBar = False End Sub
Этот вариант мне нравится больше всего.
При желании можно сделать и иные варианты — главное найти символы, которые будут показываться и определить их числовой код.
Использование UserForm
Использование стандартного элемента ProgressBar
Для Userform можно использовать стандартный контрол ProgressBar, но я лично не люблю добавлять на формы элементы, которые надо подключать отдельно. Потому как впоследствии контрол может отказаться работать, т.к. нужной версии не окажется на конечном ПК пользователя. Например в моем офисе 2010 для 64-битных систем его нет.
Поэтому про него кратко и в файле примере его нет. Как его создать:
- создаем UserForm (в меню VBE —Insert —UserForm. Подробнее про вставку модулей и форм — Что такое модуль? Какие бывают модули?)
- отображаем окно конструктора(если не отображено): View —Toolbox
- далее в меню Tools —Additional Controls
- там ищем что-то имеющее в названии ProgressBar и отмечаем его. Жмем Ок.
Теперь в окне Toolbox появится элемент ProgressBar. Просто перетаскиваем его на форму. В свойствах можно задать цвет и стиль отображения полосы прогресса. Останется лишь при необходимости программно показывать форму и задавать для элемента ProgressBar значения минимума и максимума. Примерно это выглядеть будет так:
Практический код
Например, надо обработать все выделенные ячейки. Если форма называется UserForm1, а ProgressBar — ProgressBar1, то код будет примерно такой:
Sub ShowProgressBar() Dim lAllCnt As Long Dim rc As Range 'кол-во ячеек в выделенной области lAllCnt = Selection.Count 'показываем форму прогресс-бара UserForm1.Show UserForm1.ProgressBar1.Min = 1 UserForm1.ProgressBar1.Max = lAllCnt 'цикл по всем ячейкам в выделенной области For Each rc In Selection 'прибавляем 1 при каждом шаге UserForm1.ProgressBar1.Value = UserForm1.ProgressBar1.Value + 1 DoEvents 'чтобы форма перерисовывалась Next 'закрываем форму Unload UserForm1 End Sub
Использование своего собственного прогресс-бара
Я использую в своих приложениях свой прогресс-бар с процентами. Для этого я использую стандартную UserForm, на которой располагаю два элемента Caption. Первый отвечает за визуальную составляющую в виде синей полосы заполнения, а так же за отображение процентов белыми цифрами на синем фоне. Второй Caption прозрачный и на нем в том же месте, что и у первого, отображаются проценты цифрами, но уже черным шрифтом. В результате в работе это выглядит так:
Как использовать эту форму и коды
Первоначально надо скачать файл, приложенный к статье, и в свой проект перенести форму frmStatusBar и модуль mCustomProgressBarModule.
Далее просто внедряем нужные строки в свои коды с циклами:
- До начала цикла необходимо вызывать процедуру инициализации формы:
Call Show_PrBar_Or_No(lAllCnt, «Обрабатываю данные…»)
первым аргументом задается общее кол-во обрабатываемых элементов, а вторым заголовок формы. Если второй аргумент не указан, то по умолчанию будет показан заголовок «Выполнение…». Так же внутри кодов есть кусок кода, отвечающий за минимальное кол-во элементов к обработке. По умолчанию задано 10. Это значит, что если обрабатывается менее 10 ячеек, то форма прогресс-бара показана не будет. Нужно для случаев, когда производятся разные действия над ячейками, но неизвестно сколько их будет. Но зато известно, что с ними будет делать код. Часто для кол-ва ячеек менее 100 нет смысла отображать прогресс выполнения, т.к. это и так секундное дело.
Чтобы изменить минимальное кол-во достаточно в строке bShowBar = (lCnt > 10) заменить 10 на нужное число. - Далее в каждом проходе цикла вызвать перерисовку формы под новое значение цикла:
If bShowBar Then Call MyProgresBar - и в конце не забыть закрыть форму, чтобы не висела:
If bShowBar Then Unload frmStatusBar
Пример применения формы:
Sub Test_ProgressForm() Dim lr As Long Dim lAllCnt As Long 'кол-во итераций lAllCnt = 10000 'инициализируем форму прогресс-бара Call Show_PrBar_Or_No(lAllCnt, "Обрабатываю данные...") 'сам цикл For lr = 1 To lAllCnt If bShowBar Then Call MyProgresBar Next 'закрываем форму, если она была показана If bShowBar Then Unload frmStatusBar End Sub
Так же все описанные примеры и коды можно найти в приложенном файле:
Скачать пример:
Tips_ShowProgressBar.xls (79,0 KiB, 6 153 скачиваний)
Статья помогла? Поделись ссылкой с друзьями!
Видеоуроки
Поиск по меткам
Access
apple watch
Multex
Power Query и Power BI
VBA управление кодами
Бесплатные надстройки
Дата и время
Записки
ИП
Надстройки
Печать
Политика Конфиденциальности
Почта
Программы
Работа с приложениями
Разработка приложений
Росстат
Тренинги и вебинары
Финансовые
Форматирование
Функции Excel
акции MulTEx
ссылки
статистика
I know this is an old thread but I had asked a similar question not knowing about this one. I needed an Excel VBA Progress Bar and found this link: Excel VBA StatusBar. Here is a generalized version that I wrote. There are 2 methods, a simple version DisplaySimpleProgressBarStep that defaults to ‘[|| ] 20% Complete’ and a more generalized version DisplayProgressBarStep that takes a laundry list of optional arguments so that you can make it look like just about anything you wish.
Option Explicit
' Resources
' ASCII Chart: https://vbaf1.com/ascii-table-chart/
Private Enum LabelPlacement
None = 0
Prepend
Append
End Enum
#If VBA7 Then
Public Declare PtrSafe Sub Sleep Lib "kernel32" (ByVal dwMilliseconds As LongPtr) 'For 64 Bit Systems
#Else
Public Declare Sub Sleep Lib "kernel32" (ByVal dwMilliseconds As Long) 'For 32 Bit Systems
#End If
Public Sub Test()
Call ProgressStatusBar(Last:=10)
End Sub
Public Sub Test2()
Const lMilliseconds As Long = 500
Dim lIndex As Long, lNumberOfBars As Long
Dim sBarChar As String
sBarChar = Chr$(133) ' Elipses …
sBarChar = Chr$(183) ' Middle dot ·
sBarChar = Chr$(176) ' Degree sign °
sBarChar = Chr$(171) ' Left double angle «
sBarChar = Chr$(187) ' Right double angle »
sBarChar = Chr$(166) ' Broken vertical bar ¦
sBarChar = Chr$(164) ' Currency sign ¤
sBarChar = Chr$(139) ' Single left-pointing angle quotation mark ‹
sBarChar = Chr$(155) ' Single right-pointing angle quotation mark ›
sBarChar = Chr$(149) ' Bullet •
sBarChar = "|"
For lIndex = 1 To 10
Call DisplayProgressBarStep(lIndex, 10, 50, LabelPlacement.Append, sBarChar)
Call Sleep(lMilliseconds)
Next
Call MsgBox("Status bar test completed.", vbOKOnly Or vbInformation, "Test2 Completed")
Call DisplayProgressBarStep(lIndex, 10, bClearStatusBar:=True)
End Sub
Public Sub Test2Simple()
Const lMilliseconds As Long = 500
Dim lIndex As Long, lNumberOfBars As Long
For lIndex = 1 To 10
Call DisplayProgressBarStep(lIndex, 10, 50)
Call Sleep(lMilliseconds)
Next
Call MsgBox("Status bar test completed.", vbOKOnly Or vbInformation, "Test2Simple Completed")
Call DisplayProgressBarStep(lIndex, 10, bClearStatusBar:=True)
End Sub
''' <summary>
''' Method to display an Excel ProgressBar. Called once for each step in the calling code process.
''' Defaults to vertical bar surrounded by square brackets with a trailing percentage label (e.g. [|||||] 20% Complete).
'''
''' Adapted
''' From: Excel VBA StatusBar
''' Link: https://www.wallstreetmojo.com/vba-status-bar/
''' </summary>
''' <param name="Step">The current step count.</param>
''' <param name="StepCount">The total number of steps.</param>
''' <param name="NumberOfBars">Optional, Number of bars displayed for StepCount. Defaults to StepCount. The higher the number, the longer the string.</param>
''' <param name="LabelPlacement">Optional, Can be None, Prepend or Append. Defaults to Append.</param>
''' <param name="BarChar">Optional, Character that makes up the horizontal bar. Defaults to | (Pipe).</param>
''' <param name="PrependedBoundaryText">Optional, Boundary text prepended to the StatusBar. Defaults to [ (Left square bracket).</param>
''' <param name="AppendedBoundaryText">Optional, Boundary text appended to the StatusBar. Defaults to ] (Right square bracket).</param>
''' <param name="ClearStatusBar">Optional, True to clear the StatusBar. Defaults to False.</param>
Private Sub DisplayProgressBarStep( _
lStep As Long, _
lStepCount As Long, _
Optional lNumberOfBars As Long = 0, _
Optional eLabelPlacement As LabelPlacement = LabelPlacement.Append, _
Optional sBarChar As String = "|", _
Optional sPrependedBoundaryText As String = "[", _
Optional sAppendedBoundaryText As String = "]", _
Optional bClearStatusBar As Boolean = False _
)
Dim lCurrentStatus As Long, lPctComplete As Long
Dim sBarText As String, sLabel As String, sStatusBarText As String
If bClearStatusBar Then
Application.StatusBar = False
Exit Sub
End If
If lNumberOfBars = 0 Then
lNumberOfBars = lStepCount
End If
lCurrentStatus = CLng((lStep / lStepCount) * lNumberOfBars)
lPctComplete = Round(lCurrentStatus / lNumberOfBars * 100, 0)
sLabel = lPctComplete & "% Complete"
sBarText = sPrependedBoundaryText & String(lCurrentStatus, sBarChar) & Space$(lNumberOfBars - lCurrentStatus) & sAppendedBoundaryText
Select Case eLabelPlacement
Case LabelPlacement.None: sStatusBarText = sBarText
Case LabelPlacement.Prepend: sStatusBarText = sLabel & " " & sBarText
Case LabelPlacement.Append: sStatusBarText = sBarText & " " & sLabel
End Select
Application.StatusBar = sStatusBarText
''Debug.Print "CurStatus:"; lCurrentStatus, "PctComplete:"; lPctComplete, "'"; sStatusBarText; "'"
End Sub
''' <summary>
''' Method to display a simple Excel ProgressBar made up of vertical bars | with a trailing label. Called once for each step in the calling code process.
'''
''' Adapted
''' From: Excel VBA StatusBar
''' Link: https://www.wallstreetmojo.com/vba-status-bar/
''' </summary>
''' <param name="Step">The current step count.</param>
''' <param name="StepCount">The total number of steps.</param>
''' <param name="NumberOfBars">Optional, Number of bars displayed for StepCount. Defaults to StepCount. The higher the number, the longer the string.</param>
''' <param name="ClearStatusBar">Optional, True to clear the StatusBar. Defaults to False.</param>
Private Sub DisplaySimpleProgressBarStep( _
lStep As Long, _
lStepCount As Long, _
Optional lNumberOfBars As Long = 0, _
Optional bClearStatusBar As Boolean = False _
)
Call DisplayProgressBarStep(lStep, lStepCount, lNumberOfBars, bClearStatusBar:=bClearStatusBar)
End Sub
Excel VBA Progress Bar in Excel
Progress Bar shows us how much of a process has been done or finished. For example, when we run large sets of codes that require a larger execution time, we use the progress bar in VBA to show the user the status of the process. Or, if we have multiple processes running in a single code, we use the progress bar to show which process has progressed and how much.
A progress bar shows the percentage of tasks completed when the actual task is running behind the screen with a set of instructions given by the code.
When the VBA code takes a considerable amount of time to execute, it is the user’s anxiety to know how soon it can finish. By default, we need to wait for the full time to complete the task, but by inserting the progress bar, we get to know the progress of the VBA codeVBA code refers to a set of instructions written by the user in the Visual Basic Applications programming language on a Visual Basic Editor (VBE) to perform a specific task.read more.
In almost all computer software, we see a progress bar chart that shows the progress of the task we are performing, just like the below image.
In Excel, we can create a progress bar by using VBA coding. If you have ever wondered how we can create a progress bar, this is the tailor-made article for you.
You can download this VBA Progress Bar Template here – VBA Progress Bar Template
Table of contents
- Excel VBA Progress Bar in Excel
- Create Your Own Progress Bar
- Recommended Articles
Create Your Own Progress Bar
To create a progress bar, we need to follow several steps. Below are the steps to involve while creating the progress bar chart.
Step 1: Create or Insert a new UserForm.
As soon as you click on the option above, you will see a UserForm like the one below.
Step 2: Press the F4 key to see the VBA Properties window.
In this Properties tab, we need to change the properties of the VBA UserformIn VBA, userforms are customized user-defined forms that are designed to accept user input in the form of a form. It has various sets of controls to add such as text boxes, checkboxes, and labels.read more we have inserted.
Step 3: Change the name of the UserForm to UFProgressBar.
Now, we can refer to this UserForm with the name “UFProgressBar” while coding.
Step 4: Change the “Show Modal” property of the UserForm to “FALSE.”
Step 5: Now, adjust the user’s alignment to fit your needs. We have changed the height of the UserForm to 120 and the width to 300.
Step 6: Change the “Caption” of the UserForm to “Progress Bar.”
Step 7: Now, from the toolbox of the UserForm, insert LABEL to the UserForm at the top.
With this label, we need to set the properties of the label. First, delete the caption, make it blank, and adjust the width of the label.
Step 8: Change the “Name” of the label to “ProgessLabel.”
Step 9: Take the frame from the toolbox and draw just below the label we inserted in the previous steps. Make sure the frame is at the center of the UserForm.
Step 10: We need to change some of the frame’s properties to make it look the same as the UserForm we have inserted.
Property 1: Change the “Name” of the frame to “ProgressFrame.”
Property 2: Delete the “Caption” and make it blank.
Property 3: Change the “SpecialEffect” of the frame to 6 – fmSpecialEffectBump.
After all these changes, our UserForm should look like this.
Step 11: Now, insert one more label. This time insert the label just inside the frame we have inserted.
While inserting the label, ensure the left side of the label exactly fits the frame we have inserted, as shown in the above image.
Step 12: After inserting the label, change the label’s properties as follows.
Property 1: Change the “Name” of the label to “MainProgressLabel.”
Property 2: Delete the “Caption.”
Property 3: Change the background color as per your wish
Now, we have completed setting up the progress bar. At this point, it looks like this.
Now, we need to enter codes to make this work perfectly.
Step 13: To make the framework add the below macro in excelA macro in excel is a series of instructions in the form of code that helps automate manual tasks, thereby saving time. Excel executes those instructions in a step-by-step manner on the given data. For example, it can be used to automate repetitive tasks such as summation, cell formatting, information copying, etc. thereby rapidly replacing repetitious operations with a few clicks.
read more.
Code:
Sub InitUFProgressBarBar() With UFProgressBar .Bar.Width = 0 .Text.Caption = "0%" .Show vbModeless End With
Note: “UFProgressBar” is the name given to the UserForm, “Bar” is the name given to the frame we have created, and “Text” is the name given to the label inside the frame.
Now, if you run this code manually or through the F5 key, we should see the progress bar like this.
Step 14: We need to create a Macro to perform our task. We are performing the task of inserting serial numbers from 1 to 5,000. We also need to configure the progress bar chart along with this code. The code is tailor-made code for you.
Code:
Sub ProgressBar_Chart() Dim i As Long Dim CurrentUFProgressBar As Double Dim UFProgressBarPercentage As Double Dim BarWidth As Long i = 1 Call InitUFProgressBarBar Do While i <= 5500 Cells(i, 1).Value = i CurrentUFProgressBar = i / 2500 BarWidth = UFProgressBar.Border.Width * CurrentUFProgressBar UFProgressBarPercentage = Round(CurrentUFProgressBar * 100, 0) UFProgressBar.Bar.Width = BarWidth UFProgressBar.Text.Caption = UFProgressBarPercentage & "% Complete" DoEvents i = i + 1 Loop Unload UFProgressBar End Sub
Recommended Articles
This article is a guide to VBA Progress Bar. Here, we learn how to create a progress bar chart, practical examples, and a downloadable template. Below you can find some useful Excel VBA articles: –
- VBA ArrayList in Excel
- VBA UCase Function
- VBA ENUM
- Integer in VBA
Данный прогресс-бар позволяет отображать ход выполнения любого макроса.
Для использования этого индикатора перетащите из файла-примера в свой файл модуль класса ProgressIndicator и форму F_Progress
Использовать прогресс бар сравнительно просто — достаточно добавить в макрос несколько строк кода:
Sub ПростейшийПримерИспользованияПрогрессБара() Dim pi As New ProgressIndicator ' создаём новый прогресс-бар pi.Show "Подождите, работает макрос" ' отбражаем индикатор ' здесь код вашего макроса pi.Hide ' закрываем индикатор End Sub
Sub ПримерИспользованияПрогрессБара() КоличествоЗапусковВнешнегоМакроса = 3000 Dim pi As New ProgressIndicator ' создаём новый прогресс-бар pi.Show "Форматирование ячеек" ' отбражаем индикатор ' первое действие (на шкале индикатора от 0 до 95 процентов) - это окраска ячеек pi.StartNewAction 0, 95, "Окраска ячеек", , , КоличествоЗапусковВнешнегоМакроса ' цикл с вызовом внешнего макроса "ФорматированиеЯчейки" For i = 1 To КоличествоЗапусковВнешнегоМакроса ' инициируем очередное действие в индикаторе pi.SubAction , "Обрабатывается ячейка $index из $count", "$time" ' собственно, код цикла ФорматированиеЯчейки i Next ' всё покрасили - теперь пора чистить ячейки ) pi.StartNewAction 95, 100, "Очистка ячеек" Cells.Clear pi.Hide ' закрываем индикатор End Sub Sub ФорматированиеЯчейки(ByVal n As Long) ' вызываемый макрос Cells(n).Interior.ColorIndex = 15: Cells(n).BorderAround xlContinuous End Sub
Давайте рассмотрим подробнее работу с индикатором.
Прогресс-бар выполнен в виде модуля класса, поэтому, для начала работы с ним,
надо прежде всего создать экземпляр этого класса:
Dim pi As New ProgressIndicator ' создаём новый прогресс-бар
Итак, прогресс-бар создан, и теперь надо его отобразить.
Для этого мы используем метод Show объекта типа ProgressIndicator:
pi.Show "Форматирование ячеек" ' отбражаем индикатор
При использовании метода Show мы сразу задаём заголовок индикатора (можно здесь указать название вашего макроса)
Индикатор появился на экране — но полоса не отображается, ибо процент выполнения по-умолчанию равен нулю.
Для каждого действия мы будем задавать начальный и конечный процент выполнения задачи
К примеру, если первое действие вашего макроса занимает по времени примерно пятую часть от времени выполнения всего макроса,
то мы укажем интервал для индикатора от 0% до 20%:
Как вы заметили, для запуска очередного действия используется метод StartNewAction объекта ProgressIndicator.
При вызове этого метода можно сразу задать текст для каждой из 3 текстовых строк индикатора:
pi.StartNewAction 0, 20, "Текст первой строки", "Текст строки 2", "Текст строки 3"
Если действие состоит из нескольких отдельных «поддействий», то можно также сразу задать и количество этих «поддействий»
(например, основное действие — это форматирование ячеек (от 0% до 20% индикатора), а поддействия — это окраска отдельных ячеек (первая строка — от 0% до 1% индикатора, вторая строка — от 1% до 2%, и т.д.))
Чтобы нам не мучиться с расчётами этих процентов, мы просто задаём количество действий (например, количество форматируемых ячеек, равное 3000),
и индикатор сам разделит диапазон от 0% до 20% на 3000 равных частей, плавно увеличивая длину полосы индикатора по мере форматирования отдельных ячеек.
pi.StartNewAction 0, 20, "Окраска ячеек", , , 3000
Чтобы уведомить индикатор об очередном «поддействии» внутри цикла, мы используем метод SubAction объекта ProgressIndicator
' инициируем очередное действие в индикаторе pi.SubAction , "Обрабатывается ячейка $index из $count", "$time"
Как вы могли заметить, мы задали только значение второй и третьей строки индикатора, не указав никакого текста для первой строки.
В этом случае (если значения некоторых из 3 строк индикатора не заданы), эти строки не изменяются
(в первой строке индикатора останется текст, заданный ранее при использовании метода StartNewAction)
Кроме того, в тексте для строк индикатора можно использовать следующие ключевые слова:
- $index и $count — для вывода строк типа «Обрабатывается ячейка 515 из 3000«,
- $time — для вывода ожидаемого времени до окончания макроса
(макрос анализирует текущий процент выполнения и затраченное время, и предсказывает, сколько времени осталось до окончания всех действий)
Если же необходимо просто увеличить длину полоски индикатора — можете использовать метод SubAction без параметров:
Вы можете выводить сколько угодно действий в индикаторе, причем совсем не обязательно, чтобы начальный процент очередного действия был равен конечному проценту предыдущего.
Вполне допустим следующий код:
pi.StartNewAction 5, 20, "Действие 1" ' начинаем не с нуля pi.StartNewAction 20, 50, "Действие 2" ' начинается сразу после предыдущего pi.StartNewAction 35, 60, "Действие 3" ' начинается раньше предыдущего pi.StartNewAction 85, 90, "Действие 4" ' начинается через время после предыдущего pi.StartNewAction 10, 100, "Действие 5" ' начинаем почти всё сначала
По окончании макроса желательно закрыть прогресс бар:
pi.Hide ' закрываем индикатор
У объекта ProgressIndicator имеется много различных свойств и методов.
Вкратце расскажу о некоторых свойствах:
- свойство Caption позволяет задать новый заголовок индикатора
-
свойство FP позволяет получить доступ к отображаемой форме (и всем её элементам управления)
(например, код pi.FP.PrintForm выведет индикатор на печать) - свойства Line1, Line2 и Line3 позволяют в любом месте кода задать текст конкретной строки индикатора
-
свойства ShowPercents и ShowTime включают или выключают отображение процента выполнения и времени в заголовке индикатора
(по умолчанию оба свойства имеют значение TRUE, т.е. в заголовке отображается и время, и процент выполнения макроса)
Из функций объекта мы рассмотрим только одну: AddChildIndicator
Эта функция создаёт дочерний прогресс бар, и отображает его выше или ниже родительского:
' создаём дочерний индикатор, и выводим его ниже основного Dim pi2 As ProgressIndicator Set pi2 = pi.AddChildIndicator("Раскрашивание ячеек", 1)
При изменении процента выполнения в дочернем индикаторе пропорционально меняется и процент выполнения главного (родительского) прогресс-бара.
В прикреплённом файле, помимо модуля класса и формы индикатора,
присутствует также стандартный модуль с несколькими примерами использования прогресс-бара.
На индикаторе присутствует кнопка «Отмена» — её нажатие вызывает останов всех запущенных макросов
(выполняется команда End, останавливающая все макросы, и обнуляющая все переменные)
Поскольку у этой кнопки свойство Cancel установлено в TRUE, нажатие на клавиатуре клавиши ESC равносильно нажатию кнопки «Отмена»
(при нажатии Esc макрос останавливается)
добавлено 23.02.2012
Новая версия прогресс-бара — с поддержкой отображения лога на индикаторе, и возможностью отображения лога в виде текстового файла.
Высоту текстового поля с логом можно изменять:
Новая версия индикатора, и примеры его использования — во втором прикреплённом файле.
PS: Идеальный прогресс-бар должен работать так
- 115747 просмотров
Не получается применить макрос? Не удаётся изменить код под свои нужды?
Оформите заказ у нас на сайте, не забыв прикрепить примеры файлов, и описать, что и как должно работать.
The primary ingredients to making this work are:
- VBA
- UserForms
- Loops
The complete code and the downloadable file can be found at the end of this post. The following sections provide high-level explanations of each major facet of code. For a more in-depth explanation of each facet, consider enrolling in the complete “Unlock Excel VBA & Excel Macros” course at XelPlus.
Part 1: The Task(s) to be Automated
What we are automating can be anything our Excel minds can imagine. The great thing about this progress bar tutorial is that it can be inserted into almost any existing or future macro.
In this demonstration, our automation process will “walk” through records in a table, pausing for 1/10th of a second at every record.
In reality, we would likely be performing much more sophisticated operations on each record.
Part 2: The Visual Interface
The scroll bar window is created using a VBA UserForm.
- In the Visual Basic Editor, insert the UserForm (Insert – Userform).
This presents us with a blank, generic UserForm which acts as a canvas for our imagination’s unlimited creativity.
NOTE: If you are missing the Toolbox controls, select View -> Toolbox.
- Rename the UserForm by selecting (Name) in the Properties We will name our UserForm “UserForm_v1”.
- Set the UserForm Caption (what is displayed in the Title Bar area) to read “Create PDF Documentation”. This, of course, can be anything you wish it to display.
- Using the ToolBox Label feature, insert a label and set the Caption to read “Your Assistant at Work…”
- Using the Toolbox Image feature, insert an image placeholder. Set the Picture property to the location of your image. The ellipse button to the right of the property will allow you to browse out to your image file.
- Using the Toolbox Frame feature, insert a frame object. This will serve as a border for the scroll bar as well as display a numeric percent counter. Set the Caption to read “0%”. This will be changed to read a progressive percentage during code execution.
- Within the boundary of the Frame, insert another Label This label will not contain text, rather it will act as the scroll bar. This is performed by coloring the interior of the label and resizing it incrementally, making it larger and larger as the macro progresses. Label Properties you may wish to experiment with are:
- BackColor – &H00C00000& (Blue)
- BackStyle – 1-fmBackStyleOpaque
- BorderColor – &H80000006& (Gray)
- Height – 30
- SpecialEffect – 1-fmSpecialEffectRaised
- Width – 18
Part 3: The Code That Drives the Visual
Double-clicking on any blank area of the UserForm will open the code window for the UserForm.
Some of the major features of the code are:
Variable Declarations
Turning off screen updating (to reduce screen flicker) and suppressing alerts (if encountered.)
Check to ensure there is at least one record in the table being processed
Looping through the table rows
A few notes about the above snip of code:
- The loop will execute ‘N’ number of times as there are rows in the table.
- The PCT = calculates an ever-increasing percentage. This begins at 1/N and ends with N/N. (i.e. 1% to 100%). The more records in the table, the more granular the percentage calculation.
- The timer will count to 1/10th of a second, creating a very small pause effect. This keeps the progress bar from moving too fast for this demonstration. In the real world, you would want to omit this self-induced “pause” as it hampers performance.
- The Call UpdateProgress(Pct) line passes the calculated percentage (Pct) to the UpdateProgress This percentage will be displayed in the Caption of the Frame object.
Removing the form from the screen when finished
Part 4: Launching the UserForm
To display the UserForm when the user clicks the macro launch button, we create a traditional Module sheet (Insert -> Module) and load the UserForm into memory.
To ensure the UserForm for the progress bar appears in the center of the screen, we calculate the center position with some crafty math. After the calculations are complete, we Show the memory-loaded UserForm.
Part 5: Announcing Code Completion
You can inform the user that the code has completed in a myriad of ways. Our code will display a Message Box that informs the user to retrieve their report from the printer.
A forced line break was added to the code for easier reading.
Part 6: Cleanup
The screen updating and error reporting are re-enabled.
This is where the magic happens.
Remember that part earlier where we made a call to another macro named “UpdateProgress”? We passed that macro a value stored in a variable named Pct.
The value in Pct serves two purposes:
- The value of Pct is displayed in the Caption of the Frame
- Pct is used to calculate the Width property of the label object.
- The .Repaint instruction forces the label object to be visually refreshed based on the newly calculated Width
By redrawing the label object at an ever-increasing larger width, we achieve the illusion that the label object is growing. Ingenious, no?
The “DoEvents” instruction allows VBA to detect user-interaction via the keyboard. This is helpful during long-duration macros where the user may wish to break out of a loop prematurely.
Part 8: Assigning the Macro to the Launch Button
You can launch a macro variety of objects: buttons, images, icons, shapes, etc.
We will add an Excel icon image and assign the macro to the image. This is done by right-clicking on the image and selecting “Assign Macro”.
Next, in the Assign Macro dialog box, select the macro located on the traditional module sheet that loads and shows the UserForm. In our case, it was named “GetMyForm_v1”.
Part 9: Testing the Progress Bar Macro
Click the launch icon to test your amazing creation.
And there you have it, a homemade progress bar.
This second version of the progress bar was designed by my friend Bryon Smedley. I love it! It’s really creative.
It takes the opposite approach to displaying progress. Instead of the Label “grow”, we will have the Label “shrink”.
The trick here is that our Label will not be the indicator of progress. Instead, we have a static image indicating progress and the Label will act as a mask that hides part of the static graphic.
By coloring the Label the same as the background and placing the Label in front of the Image, we can reveal portions of the Image as we reduce the size of the Label.
When we “shrink” the Label it will give us the illusion of “growing” the Image.
Code Differences
For the most part, the code is the same. The main differences lie in the scroll bar/mask and the percentage display.
Percentage Display
Instead of inserting a Frame object and changing the Caption property, we will add a Text object and change the Caption property.
The gray background is an inserted Image object that pointed to a simple image of a gray, bordered shape.
Progress Bar (Static Image)
The green “Excel” progress bar is a static image of a green rectangle with the Excel logo repeated four times.
Progress Bar (“Shrinking” Mask)
The Label object that “shrinks” has two main differences in operation compared to the first example.
- The Width property is calculated by multiplying Pct by 218 (the maximum width) and deducting that from 218. Ex: if Pct is .5, then the Width is 109; half of the original 218.
- Instead of fixing the Left property to a set position, the left side of the Label will be calculated. The logic is to deduct the calculated Width from 230 (the far-right side of the Label). Ex: if Pct is .5, the calculated Width is 109, then the Left property is calculated at 121.
NOTE: These results represent the number of pixels. 109 represents the number of pixels wide. 121 represents 121 pixels from the left edge of the UserForm. Depending on your UserForm size, you may need to experiment with these values. A bit of experimentation may be required to achieve the perfect look.
Be Careful of the Stacking Order (Layers)
Make certain that the Label object is in front of the Image object. This can be accomplished by right-clicking on an object and selecting either “Bring Forward” or “Send Backward”.
Macro Assignment & Testing
After you have assigned the “GetMyForm_v2” macro to the launch button, we can see the magic that is the “shrinking” progress bar.
Download Workbook
Feel free to Download the Workbook HERE.
Full Code for Version 1
Procedure “GetMyForm_v1”
Sub GetMyForm_v1()
Load UserForm_v1
With UserForm_v1
.StartUpPosition = 0
.Left = Application.Left + (0.5 * Application.Width) - (0.5 * .Width)
.Top = Application.Top + (0.5 * Application.Height) - (0.5 * .Height)
.Show
End With
End Sub
Procedure “UserForm Activate” (v1)
Private Sub UserForm_Activate()
Dim startrow As Integer
Dim endrow As Integer
Dim i As Integer
Dim myScrollTest As Object
Set mainbook = ThisWorkbook
Application.ScreenUpdating = False
Application.DisplayAlerts = False
Set myScrollTest = Worksheets("ScrollTest_v1")
mylabel = Worksheets("ScrollTest_v1").Range("A2").Value
With myScrollTest
'where to start
startrow = .Range("A1").Row + 1
'where to end
endrow = .Range("A1").End(xlDown).Row
If .Range("A2").Value = "" Then
MsgBox "Please paste your entity codes starting from Row 2"
Exit Sub
End If
End With
'start the loop
For i = startrow To endrow
Pct = (i - startrow + 1) / (endrow - startrow + 1)
Call UpdateProgress(Pct)
' This is where your workbook does many things that take a bit of time
startTime = Timer ' Capture the current time
Do
Loop Until Timer - startTime >= 0.1 ' Advance after 1/10th of a second
' This is where your workbook has finished an itteration of work
Next i
Unload UserForm_v1
myScrollTest.Select
MsgBox "Report generation is complete" & vbLf & vbLf _
& "Please retrieve your report from the printer", vbInformation
Application.ScreenUpdating = True
Application.DisplayAlerts = True
End Sub
Procedure “UpdateProgress” v1
Sub UpdateProgress(Pct)
With UserForm_v1
.FrameProgress.Caption = Format(Pct, "0%")
.LabelProgress.Width = Pct * (.FrameProgress.Width - 10)
.Repaint
End With
DoEvents
End Sub
Full Code for Version 2
Procedure “GetMyForm_v2”
Sub GetMyForm_v2()
Load UserForm_v2
With UserForm_v2
.StartUpPosition = 0
.Left = Application.Left + (0.5 * Application.Width) - (0.5 * .Width)
.Top = Application.Top + (0.5 * Application.Height) - (0.5 * .Height)
.Show
End With
End Sub
Procedure “UserForm Activate” (v2)
Private Sub UserForm_Activate()
Dim startrow As Integer
Dim endrow As Integer
Dim i As Integer
Dim myScrollTest As Object
Set mainbook = ThisWorkbook
Application.ScreenUpdating = False
Application.DisplayAlerts = False
Set myScrollTest = Worksheets("ScrollTest_v2")
mylabel = Worksheets("ScrollTest_v2").Range("A2").Value
With myScrollTest
'where to start
startrow = .Range("A1").Row + 1
'where to end
endrow = .Range("A1").End(xlDown).Row
If .Range("A2").Value = "" Then
MsgBox "Please paste your entity codes starting from Row 2"
Exit Sub
End If
End With
'start the loop
For i = startrow To endrow
Pct = (i - startrow + 1) / (endrow - startrow + 1)
Call UpdateProgress(Pct)
' This is where your workbook does many things that take a bit of time
startTime = Timer ' Capture the current time
Do
Loop Until Timer - startTime >= 0.1 ' Advance after 1/10th of a second
' This is where your workbook has finished an itteration of work
Next i
Unload UserForm_v2
myScrollTest.Select
MsgBox "Report generation is complete" & vbLf & vbLf & "Please retrieve your report from the printer", vbInformation
Application.ScreenUpdating = True
Application.DisplayAlerts = True
End Sub
Procedure “UpdateProgress” v2
Sub UpdateProgress(Pct)
With UserForm_v2
.Complete.Caption = Format(Pct, "0%") ' Percentage displayed to user as numeric
.LabelProgress.Width = 218 - Pct * 218 ' Shortens the mask
.LabelProgress.Left = 218 - .LabelProgress.Width + 12 ' Repositions the mask
.Repaint
End With
DoEvents
End Sub
Published on: April 15, 2020
Last modified: February 26, 2023
Leila Gharani
I’m a 5x Microsoft MVP with over 15 years of experience implementing and professionals on Management Information Systems of different sizes and nature.
My background is Masters in Economics, Economist, Consultant, Oracle HFM Accounting Systems Expert, SAP BW Project Manager. My passion is teaching, experimenting and sharing. I am also addicted to learning and enjoy taking online courses on a variety of topics.
Hello, Excellers. Bit of a fun Macro today, which is also very useful. If you’ve ever written a macro in Excel, you know there’s no built-in way to display a progress message in the status bar. Knowing the progress of the VBA macro is helpful for users who have no idea how long their Macro will take to run. In this blog post, I will show you how to write a VBA macro that displays a progress message in the status bar so your users always know what’s going on. So stay tuned while I demonstrate how to display a progress bar while any other Macros are updating.
What Does The Macro Do?
This Macro will display a VBA progress bar whilst your other Macro is busy running. The progress bar is useful if
- Your Macro takes a while to run
- You do not want your users thinking that nothing is happening
In this example, I combine the VBA progress bar with some dummy code. This sample code takes a while to execute (a counter of 1 to 500). The Macro displays a % of the progress of the count while running until 100% or 500 is reached.
How Does It Work?
Step 1. Insert A New Module. And Name The Macro
First, you will need to open the Visual Basic Editor. There are two ways to do this. Either by hitting ALT +F11 or selecting the Developer Tab | Code Group | Visual Basic. Both methods have the same result. As this code is specific to this workbook, I am creating. I will insert the module in the current workbook. This Macro is named UpdateStatusBar. Note that Excel inserts the End Sub line of code at this point. All other lines of code belong between these first two lines.
Sub updateStatusBar() End Sub
Step 2. Application.StatusBar Property.
The second step in this VBA code is to make use of the Applications.StatusBar property. This returns or sets the text in the status bar. This is therefore used to display the text of of the progress of the VBA macro. This particular line of code displays the first part of the message to the status bar at the bottom of the Excel window.
Application.StatusBar = "Percent Completed"
Step 3. Dummy Macro. Counting From 1 To 500.
This is our dummy or example macro, we are counting from 1 to 500 in cell B5. I have used the For Next loop to count from 1 to 500. FOR LOOP loops through the range of cells and perform a specific task until the condition is TRUE. In this example Excel counts form 1 until 500 is reached. The cell B5 contains the counter.
For i = 1 To 500 Cells(5, 2).Value = i
Step 4. Display The Status Bar Progress.
The next line of code displays the status bar progress, achieved by a simple calculation. The value of (i) is divided by 500. The result of the value is displayed as a percentage. The value of (i) changes with every loop, and so does the percentage displayed. Excel loops from VBA code lines 4 to 6 until (i) reaches 500.
Application.StatusBar = "Percent Complete:" & Format(i / 500, "0%") Next
Step 5. Display ‘Finished’
As soon as the counter reached reaches 500, the status bar will display ‘Finished’.
Application.StatusBar = "Finished"
Step 6. Ending and Testing Your Macro.
Finally, the macro ends when all loops are finished and the status bar displays ‘Finished’. All that is left is the best part right. Test Your Macro!.
The Progess Bar will update as the Macro progresses as you can see in my example below.
Want To Copy The Code?
Sub updateStatusBar() 'macro by howtoexcelatexcelcom Application.StatusBar = "Percent Completed" For i = 1 To 500 Cells(5, 2).Value = i Application.StatusBar = "Percent Complete:" & Format(i / 500, "0%") Next Application.StatusBar = "Finished" End Sub
*Disclaimer. Feel free to copy the code above to try this Excel VBA macro yourself. Always back up your work before running any code!.
That’s all there is to it! You can now write your own VBA macros to display progress messages in the status bar. If you want more help with Excel or VBA, be sure to check out our other tutorials. And as always, feel free to reach out if you have any questions. Thanks for reading!
Let me know in the comments below if you use an Excel VBA progress bar with your Excel VBA macros. If you have share the results. Did the end users find them useful?.
If you want more Excel and VBA tips then sign up to my monthly Newsletter where I share 3 Excel Tips on the first Wednesday of the month and receive my free Ebook, 50 Excel Tips.
If you want to see all of the blog posts in the Macro Mondays Series or the example worksheets you can do so by clicking on the links below.
How To Excel At Excel – Macro Mondays Blog Posts.
Home / VBA / VBA Status Bar (Hide, Show, and Progress)
In VBA, there’s a “Status Bar” property that can help you to show a value to the status bar and there’s also “DisplayStatusBar” to hide and show the status from the Excel window. While using these properties you need to reset the status bar, at the end, otherwise, the last message or setting will stay there.
In the tutorial, we will see a few examples that we can use while working in Excel.
Show a Value on the Status Bar
As I said, you can use the StatusBar property to show a value to the status bar. In the below code, you have used the value “Hello” to add to the status bar.
- Use the keyword “Application” to refer to the Excel application.
- Type a dot to get the list of properties and methods.
- Select the “StatusBar” property.
- In the end, use the equals sign to specify the value you want to display on the status bar.
Sub vba_status_bar()
Application.StatusBar = "Hello"
End Sub
Hide the Status Bar using VBA
Now let’s say if you want to hide the status bar you can use the DisplayStatusBar and specify that property to the “False” (consider the following code).
- Use the keyword “Application” to refer to the Excel application.
- Type a dot to get the list of properties and methods.
- Select the “DisplayStatusBar” property.
- In the end, use the equals sign to specify the “False”.
Sub vba_status_bar_hide()
Application.DisplayStatusBar = False
End Sub
Update Progress on Status Bar
The following code runs show a progress counter on the status bar using the count 1 to 100, which you can change as per your need.
Sub vba_status_bar_update()
Dim x As Integer
Dim iTimer As Double
'you can change the loop if you need
For x = 1 To 100
'dummy loop to run, you can change it as well
iTimer = Timer
Do
Loop While Timer - MyTimer < 0.03
Application.StatusBar = "Progress: " & x & " of 100: " & Format(x / 100, "Percent")
DoEvents
Next x
Application.StatusBar = False
End Sub
Important Points to Remember
- You need to use the “Application” with the status bar properties to use them.
- Once you show a message on the status you need to clear that message.
There’s More
VBA With Statement | VBA Wait and Sleep Commands | VBA ScreenUpdating | VBA Random Number | Line Break in a VBA Code | VBA Immediate Window (Debug.Print) | VBA Concatenate | VBA Module | VBA Random Number