Platforms to show: All Mac Windows Linux Cross-Platform

Back to ProgressHUDMBS class.

ProgressHUDMBS.AnimationType as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The animation type that should be used when the HUD is shown and hidden.
Notes: (Read and Write property)
ProgressHUDMBS.backgroundView as ProgressBackgroundViewMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: View covering the entire HUD area, placed behind bezelView.
Example:

// set background color for this HUD
dim p as ProgressHUDMBS // your instance
p.backgroundView.ColorValue = &c00FF00
Notes: (Read only property)
ProgressHUDMBS.bezelView as ProgressBackgroundViewMBS
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The view containing the labels and indicator (or customView).
Notes: (Read only property)
ProgressHUDMBS.ButtonTitle as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The title of the button.
Notes: (Read and Write property)
ProgressHUDMBS.ButtonView as Variant
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: A button that is placed below the labels.
Notes:
Value is NSViewMBS object.
(Read only property)
ProgressHUDMBS.ContentColor as Variant
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: A color that gets forwarded to all labels and supported indicators.
Notes:
Also sets the tintColor
for custom views on iOS 7+. Set to nil to manage color individually.
Defaults to semi-translucent black on iOS 7 and later and white on earlier iOS versions.
This uses NSColorMBS to wrap the UIColor.
(Read and Write property)
ProgressHUDMBS.ContentColorValue as Color
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: A color that gets forwarded to all labels and supported indicators.
Example:

dim p as ProgressHUDMBS // your view

// change color to red
p.ContentColorValue = &cFF0000
Notes:
Also sets the tintColor
for custom views on iOS 7+. Set to nil to manage color individually.
Defaults to semi-translucent black on iOS 7 and later and white on earlier iOS versions.
This is the color as a Xojo color value.
(Read and Write property)
ProgressHUDMBS.defaultMotionEffectsEnabled as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: When enabled, the bezel center gets slightly affected by the device accelerometer data.
Notes:
Defaults to false.

This can cause main thread checker assertions on certain devices. https://github.com/jdg/MBProgressHUD/issues/552
(Read and Write property)
ProgressHUDMBS.DetailsLabelText as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The text for the details label.
Notes:
The details text can span multiple lines.
(Read and Write property)
ProgressHUDMBS.DetailsLabelView as Variant
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: A label that holds an optional details message displayed below the labelText message.
Notes:
The details text can span multiple lines.
Value is NSViewMBS object.
(Read only property)
ProgressHUDMBS.graceTime as Double
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function:
Grace period is the time (in seconds) that the invoked method may be run without
showing the HUD.
Notes:
If the task finishes before the grace time runs out, the HUD will not be shown at all.
This may be used to prevent HUD display for very short tasks.
Defaults to 0 (no grace time).

The graceTime needs to be set before the hud is shown.
(Read and Write property)
ProgressHUDMBS.Handle as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The internal object reference.
Notes: (Read and Write property)
ProgressHUDMBS.Indicator as Variant
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The indicator control in use.
Notes:
Either ProgressBarProgressViewMBS or ProgressRoundProgressViewMBS object.
(Read only property)
ProgressHUDMBS.LabelText as String
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The label text.
Notes:
The HUD is automatically resized to fit the entire text.
(Read and Write property)
ProgressHUDMBS.LabelView as Variant
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: A label that holds an optional short message to be displayed below the activity indicator. #
Notes:
The HUD is automatically resized to fit the entire text.
Value is NSViewMBS object.
(Read only property)
ProgressHUDMBS.margin as Double
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The amount of space between the HUD edge and the HUD elements (labels, indicators or custom views).
Notes:
This also represents the minimum bezel distance to the edge of the HUD view.
Defaults to 20.
(Read and Write property)
ProgressHUDMBS.MinHeight as Double
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The minimum size of the HUD bezel.
Notes:
Defaults to zero (no minimum size).
(Read and Write property)
ProgressHUDMBS.minShowTime as Double
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The minimum time (in seconds) that the HUD is shown.
Notes:
This avoids the problem of the HUD being shown and than instantly hidden.
Defaults to 0 (no minimum show time).
(Read and Write property)
ProgressHUDMBS.MinWidth as Double
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The minimum size of the HUD bezel.
Notes:
Defaults to zero (no minimum size).
(Read and Write property)
ProgressHUDMBS.Mode as Integer
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: MBProgressHUD operation mode.
Notes:
The default is ModeIndeterminate.
(Read and Write property)
ProgressHUDMBS.offsetX as Double
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The bezel offset relative to the center of the view.
Notes:
You can use MBProgressMaxOffset and -MBProgressMaxOffset to move the HUD all the way to the screen edge in each direction.
E.g., CGPointMake(0, MBProgressMaxOffset) would position the HUD centered on the bottom edge.
(Read and Write property)
ProgressHUDMBS.offsetY as Double
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The bezel offset relative to the center of the view.
Notes:
You can use MBProgressMaxOffset and -MBProgressMaxOffset to move the HUD all the way to the screen edge in each direction.
E.g., CGPointMake(0, MBProgressMaxOffset) would position the HUD centered on the bottom edge.
(Read and Write property)
ProgressHUDMBS.Progress as Double
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The progress of the progress indicator, from 0.0 to 1.0.
Notes:
Defaults to 0.0.
(Read and Write property)
ProgressHUDMBS.RemoveFromSuperViewOnHide as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: Removes the HUD from its parent view when hidden.
Notes:
Defaults to false.
(Read and Write property)
ProgressHUDMBS.Square as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: Force the HUD dimensions to be equal if possible.
Notes: (Read and Write property)
ProgressHUDMBS.userInteractionEnabled as Boolean
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: A Boolean value that determines whether user events are ignored and removed from the event queue.
Notes:
When set to false, touch, press, keyboard, and focus events intended for the view are ignored and removed from the event queue. When set to YES, events are delivered to the view normally. The default value of this property is true.

During an animation, user interactions are temporarily disabled for all views involved in the animation, regardless of the value in this property. You can disable this behavior by specifying the UIViewAnimationOptionAllowUserInteraction option when configuring the animation.
(Read and Write property)
ProgressHUDMBS.View as Variant
Type Topic Plugin Version macOS Windows Linux iOS Targets
property ProgressView MBS iOS Plugin 22.5 ❌ No ❌ No ❌ No ✅ Yes iOS only
Function: The view as NSViewMBS object.
Notes:
Value is NSViewMBS object.
(Read only property)

The items on this page are in the following plugins: MBS iOS Plugin.


💬 Ask a question or report a problem
The biggest plugin in space...


Start Chat