StatusBar.Animate(Boolean, Object) Method

  • Reference

Definition

Namespace:
EnvDTE
Assembly:
EnvDTE.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.11.40262

Displays an animated picture in the StatusBar.

public:
 void Animate(bool On, System::Object ^ AnimationType);
public:
 void Animate(bool On, Platform::Object ^ AnimationType);
void Animate(bool On, winrt::Windows::Foundation::IInspectable const & AnimationType);
[System.Runtime.InteropServices.DispId(5)]
public void Animate (bool On, object AnimationType);
[<System.Runtime.InteropServices.DispId(5)>]
abstract member Animate : bool * obj -> unit
Public Sub Animate (On As Boolean, AnimationType As Object)

Parameters

On
Boolean

Required. Indicates whether to turn the animation on (True) or off (False).

AnimationType
Object

Required. A vsStatusAnimation constant indicating an animated icon to display.

Alternatively, AnimationType can also take an IPicture or IPictureDisp which is a bitmap 16 pixels high and a multiple of 16 pixels wide. To turn off the custom animation, you must pass the same exact IPicture or IPictureDisp.

Attributes
DispIdAttribute

Examples

Sub AnimateExample()  
   Dim SBar As StatusBar  
   SBar = DTE.StatusBar  
   ' Turn on the "save" Status Bar animation.  
   SBar.Animate(True, vsstatusanimation.vsStatusAnimationSave)  
   MsgBox("Notice the Status Bar animation.")  
   ' Turn off the animation.  
   SBar.Animate(False, vsstatusanimation.vsStatusAnimationSave)  
End Sub

Applies to