PleaseWaitForm

Overview

The PleaseWaitForm class provides a convenient means of displaying a "Please Wait" status message for operations that might or might not take a longer time to execute (such as making calls to a remote server).

To avoid flickering of a status message when communication is fast, you can provide a timeout (default 1000ms) to affect the display of the dialog; execution of your action will start immediately, but a message dialog will only be shown if the timeout expires before the action completes.

You can pass an EventHandler or a parameterless method wrapped as an AsyncDelegate to the Execute method.

Location

 

constructor

 

constructor

 

PleaseWaitForm()

 

Sub New()

Caption

 

property Caption: String write;

 

String Caption { set; }

 

WriteOnly Property Caption() As String

Dispose  protected

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

EnableWindow

 

class method EnableWindow(HWnd: IntPtr; bEnable: Boolean): Boolean

 

static Boolean EnableWindow(IntPtr HWnd, Boolean bEnable)

 

Shared Function EnableWindow(HWnd As IntPtr, bEnable As Boolean) As Boolean

Parameters:

  • HWnd:
  • bEnable:

EnumThreadWindows

 

class method EnumThreadWindows(dwThreadId: Int32; lpfn: EnumThreadWndProc; lParam: IntPtr): Boolean

 

static Boolean EnumThreadWindows(Int32 dwThreadId, EnumThreadWndProc lpfn, IntPtr lParam)

 

Shared Function EnumThreadWindows(dwThreadId As Int32, lpfn As EnumThreadWndProc, lParam As IntPtr) As Boolean

Parameters:

  • dwThreadId:
  • lpfn:
  • lParam:

Execute (EventHandler, String)

 

method Execute(action: EventHandler; caption: String)

 

void Execute(EventHandler action, String caption)

 

Sub Execute(action As EventHandler, caption As String)

Parameters:

  • action:
  • caption:

Execute (EventHandler, String, Int32)

 

method Execute(action: EventHandler; caption: String; timeout: Int32)

 

void Execute(EventHandler action, String caption, Int32 timeout)

 

Sub Execute(action As EventHandler, caption As String, timeout As Int32)

Parameters:

  • action:
  • caption:
  • timeout:

Execute (EventHandler, String, Int32, Object, EventArgs, IWin32Window)

 

method Execute(action: EventHandler; caption: String; timeout: Int32; sender: Object; e: EventArgs; parent: IWin32Window)

 

void Execute(EventHandler action, String caption, Int32 timeout, Object sender, EventArgs e, IWin32Window parent)

 

Sub Execute(action As EventHandler, caption As String, timeout As Int32, sender As Object, e As EventArgs, parent As IWin32Window)

Parameters:

  • action:
  • caption:
  • timeout:
  • sender:
  • e:
  • parent:

Execute (AsyncDelegate, String)

Call this method to execute the passed delegate and simultaneously show a status dialog, as soon as execution exceeds a certain time limit. To avoid flickering of a status message when execution is fast, the message dialog will only be shown if the timeout expires before the action completes. Different overloads are provided to allow you to specify more or less information, dependingon your needs:

  • You can pass an EventHandler or a parameterless method wrapped as an AsyncDelegate to the Execute method.
  • When passing an EventHandler, Sender and EventArgs values can be provided as well; these will be passed on to your method and can be used to pass data back and forth, if necessary.
  • An optional Timeout value can be passed, default is 1000ms (1s).
  • Finally, an optional Parent window for the status message dialog can be passed.

Note: AsynkDelegate is a delegate type that can be used to pass a parameter-less method to Execute.

 

method Execute(action: AsyncDelegate; caption: String)

 

void Execute(AsyncDelegate action, String caption)

 

Sub Execute(action As AsyncDelegate, caption As String)

Parameters:

  • action:
  • caption:

Execute (AsyncDelegate, String, Int32)

 

method Execute(action: AsyncDelegate; caption: String; timeout: Int32)

 

void Execute(AsyncDelegate action, String caption, Int32 timeout)

 

Sub Execute(action As AsyncDelegate, caption As String, timeout As Int32)

Parameters:

  • action:
  • caption:
  • timeout:

Execute (AsyncDelegate, String, Int32, IWin32Window)

 

method Execute(action: AsyncDelegate; caption: String; timeout: Int32; parent: IWin32Window)

 

void Execute(AsyncDelegate action, String caption, Int32 timeout, IWin32Window parent)

 

Sub Execute(action As AsyncDelegate, caption As String, timeout As Int32, parent As IWin32Window)

Parameters:

  • action:
  • caption:
  • timeout:
  • parent:

ExecuteSynchronous (EventHandler, String)

 

method ExecuteSynchronous(action: EventHandler; caption: String)

 

void ExecuteSynchronous(EventHandler action, String caption)

 

Sub ExecuteSynchronous(action As EventHandler, caption As String)

Parameters:

  • action:
  • caption:

ExecuteSynchronous (EventHandler, String, Object, EventArgs, IWin32Window)

 

method ExecuteSynchronous(action: EventHandler; caption: String; sender: Object; e: EventArgs; parent: IWin32Window)

 

void ExecuteSynchronous(EventHandler action, String caption, Object sender, EventArgs e, IWin32Window parent)

 

Sub ExecuteSynchronous(action As EventHandler, caption As String, sender As Object, e As EventArgs, parent As IWin32Window)

Parameters:

  • action:
  • caption:
  • sender:
  • e:
  • parent:

ExecuteSynchronous (AsyncDelegate, String)

 

method ExecuteSynchronous(action: AsyncDelegate; caption: String)

 

void ExecuteSynchronous(AsyncDelegate action, String caption)

 

Sub ExecuteSynchronous(action As AsyncDelegate, caption As String)

Parameters:

  • action:
  • caption:

ExecuteSynchronous (AsyncDelegate, String, IWin32Window)

 

method ExecuteSynchronous(action: AsyncDelegate; caption: String; parent: IWin32Window)

 

void ExecuteSynchronous(AsyncDelegate action, String caption, IWin32Window parent)

 

Sub ExecuteSynchronous(action As AsyncDelegate, caption As String, parent As IWin32Window)

Parameters:

  • action:
  • caption:
  • parent:

GetCurrentThreadId

 

class method GetCurrentThreadId: Int32

 

static Int32 GetCurrentThreadId()

 

Shared Function GetCurrentThreadId() As Int32

HideMe

 

method HideMe

 

void HideMe()

 

Sub HideMe()

Image

 

property Image: Image read write;

 

Image Image { get; set; }

 

Property Image() As Image

IsWindow

 

class method IsWindow(HWnd: IntPtr): Boolean

 

static Boolean IsWindow(IntPtr HWnd)

 

Shared Function IsWindow(HWnd As IntPtr) As Boolean

Parameters:

  • HWnd:

IsWindowEnabled

 

class method IsWindowEnabled(HWnd: IntPtr): Boolean

 

static Boolean IsWindowEnabled(IntPtr HWnd)

 

Shared Function IsWindowEnabled(HWnd As IntPtr) As Boolean

Parameters:

  • HWnd:

IsWindowVisible

 

class method IsWindowVisible(HWnd: IntPtr): Boolean

 

static Boolean IsWindowVisible(IntPtr HWnd)

 

Shared Function IsWindowVisible(HWnd As IntPtr) As Boolean

Parameters:

  • HWnd:

SetParent

 

class method SetParent(hWndChild: IntPtr; hWndNewParent: IntPtr): IntPtr

 

static IntPtr SetParent(IntPtr hWndChild, IntPtr hWndNewParent)

 

Shared Function SetParent(hWndChild As IntPtr, hWndNewParent As IntPtr) As IntPtr

Parameters:

  • hWndChild:
  • hWndNewParent:

ShowMe

 

method ShowMe(parent: IWin32Window)

 

void ShowMe(IWin32Window parent)

 

Sub ShowMe(parent As IWin32Window)

Parameters:

  • parent:

WaitFor (IAsyncResult, String, Int32)

 

method WaitFor(ar: IAsyncResult; caption: String; timeout: Int32)

 

void WaitFor(IAsyncResult ar, String caption, Int32 timeout)

 

Sub WaitFor(ar As IAsyncResult, caption As String, timeout As Int32)

Parameters:

  • ar:
  • caption:
  • timeout:

WaitFor (IAsyncResult, String, Int32, IWin32Window)

 

method WaitFor(ar: IAsyncResult; caption: String; timeout: Int32; parent: IWin32Window)

 

void WaitFor(IAsyncResult ar, String caption, Int32 timeout, IWin32Window parent)

 

Sub WaitFor(ar As IAsyncResult, caption As String, timeout As Int32, parent As IWin32Window)

Parameters:

  • ar:
  • caption:
  • timeout:
  • parent:

 

Caption

 

property Caption: String write;

 

String Caption { set; }

 

WriteOnly Property Caption() As String

Image

 

property Image: Image read write;

 

Image Image { get; set; }

 

Property Image() As Image

 

EnableWindow

 

class method EnableWindow(HWnd: IntPtr; bEnable: Boolean): Boolean

 

static Boolean EnableWindow(IntPtr HWnd, Boolean bEnable)

 

Shared Function EnableWindow(HWnd As IntPtr, bEnable As Boolean) As Boolean

Parameters:

  • HWnd:
  • bEnable:

EnumThreadWindows

 

class method EnumThreadWindows(dwThreadId: Int32; lpfn: EnumThreadWndProc; lParam: IntPtr): Boolean

 

static Boolean EnumThreadWindows(Int32 dwThreadId, EnumThreadWndProc lpfn, IntPtr lParam)

 

Shared Function EnumThreadWindows(dwThreadId As Int32, lpfn As EnumThreadWndProc, lParam As IntPtr) As Boolean

Parameters:

  • dwThreadId:
  • lpfn:
  • lParam:

GetCurrentThreadId

 

class method GetCurrentThreadId: Int32

 

static Int32 GetCurrentThreadId()

 

Shared Function GetCurrentThreadId() As Int32

IsWindow

 

class method IsWindow(HWnd: IntPtr): Boolean

 

static Boolean IsWindow(IntPtr HWnd)

 

Shared Function IsWindow(HWnd As IntPtr) As Boolean

Parameters:

  • HWnd:

IsWindowEnabled

 

class method IsWindowEnabled(HWnd: IntPtr): Boolean

 

static Boolean IsWindowEnabled(IntPtr HWnd)

 

Shared Function IsWindowEnabled(HWnd As IntPtr) As Boolean

Parameters:

  • HWnd:

IsWindowVisible

 

class method IsWindowVisible(HWnd: IntPtr): Boolean

 

static Boolean IsWindowVisible(IntPtr HWnd)

 

Shared Function IsWindowVisible(HWnd As IntPtr) As Boolean

Parameters:

  • HWnd:

SetParent

 

class method SetParent(hWndChild: IntPtr; hWndNewParent: IntPtr): IntPtr

 

static IntPtr SetParent(IntPtr hWndChild, IntPtr hWndNewParent)

 

Shared Function SetParent(hWndChild As IntPtr, hWndNewParent As IntPtr) As IntPtr

Parameters:

  • hWndChild:
  • hWndNewParent:

 

constructor

 

constructor

 

PleaseWaitForm()

 

Sub New()

Dispose  protected

 

method Dispose(disposing: Boolean)

 

void Dispose(Boolean disposing)

 

Sub Dispose(disposing As Boolean)

Parameters:

  • disposing:

Execute (EventHandler, String)

 

method Execute(action: EventHandler; caption: String)

 

void Execute(EventHandler action, String caption)

 

Sub Execute(action As EventHandler, caption As String)

Parameters:

  • action:
  • caption:

Execute (EventHandler, String, Int32)

 

method Execute(action: EventHandler; caption: String; timeout: Int32)

 

void Execute(EventHandler action, String caption, Int32 timeout)

 

Sub Execute(action As EventHandler, caption As String, timeout As Int32)

Parameters:

  • action:
  • caption:
  • timeout:

Execute (EventHandler, String, Int32, Object, EventArgs, IWin32Window)

 

method Execute(action: EventHandler; caption: String; timeout: Int32; sender: Object; e: EventArgs; parent: IWin32Window)

 

void Execute(EventHandler action, String caption, Int32 timeout, Object sender, EventArgs e, IWin32Window parent)

 

Sub Execute(action As EventHandler, caption As String, timeout As Int32, sender As Object, e As EventArgs, parent As IWin32Window)

Parameters:

  • action:
  • caption:
  • timeout:
  • sender:
  • e:
  • parent:

Execute (AsyncDelegate, String)

Call this method to execute the passed delegate and simultaneously show a status dialog, as soon as execution exceeds a certain time limit. To avoid flickering of a status message when execution is fast, the message dialog will only be shown if the timeout expires before the action completes. Different overloads are provided to allow you to specify more or less information, dependingon your needs:

  • You can pass an EventHandler or a parameterless method wrapped as an AsyncDelegate to the Execute method.
  • When passing an EventHandler, Sender and EventArgs values can be provided as well; these will be passed on to your method and can be used to pass data back and forth, if necessary.
  • An optional Timeout value can be passed, default is 1000ms (1s).
  • Finally, an optional Parent window for the status message dialog can be passed.

Note: AsynkDelegate is a delegate type that can be used to pass a parameter-less method to Execute.

 

method Execute(action: AsyncDelegate; caption: String)

 

void Execute(AsyncDelegate action, String caption)

 

Sub Execute(action As AsyncDelegate, caption As String)

Parameters:

  • action:
  • caption:

Execute (AsyncDelegate, String, Int32)

 

method Execute(action: AsyncDelegate; caption: String; timeout: Int32)

 

void Execute(AsyncDelegate action, String caption, Int32 timeout)

 

Sub Execute(action As AsyncDelegate, caption As String, timeout As Int32)

Parameters:

  • action:
  • caption:
  • timeout:

Execute (AsyncDelegate, String, Int32, IWin32Window)

 

method Execute(action: AsyncDelegate; caption: String; timeout: Int32; parent: IWin32Window)

 

void Execute(AsyncDelegate action, String caption, Int32 timeout, IWin32Window parent)

 

Sub Execute(action As AsyncDelegate, caption As String, timeout As Int32, parent As IWin32Window)

Parameters:

  • action:
  • caption:
  • timeout:
  • parent:

ExecuteSynchronous (EventHandler, String)

 

method ExecuteSynchronous(action: EventHandler; caption: String)

 

void ExecuteSynchronous(EventHandler action, String caption)

 

Sub ExecuteSynchronous(action As EventHandler, caption As String)

Parameters:

  • action:
  • caption:

ExecuteSynchronous (EventHandler, String, Object, EventArgs, IWin32Window)

 

method ExecuteSynchronous(action: EventHandler; caption: String; sender: Object; e: EventArgs; parent: IWin32Window)

 

void ExecuteSynchronous(EventHandler action, String caption, Object sender, EventArgs e, IWin32Window parent)

 

Sub ExecuteSynchronous(action As EventHandler, caption As String, sender As Object, e As EventArgs, parent As IWin32Window)

Parameters:

  • action:
  • caption:
  • sender:
  • e:
  • parent:

ExecuteSynchronous (AsyncDelegate, String)

 

method ExecuteSynchronous(action: AsyncDelegate; caption: String)

 

void ExecuteSynchronous(AsyncDelegate action, String caption)

 

Sub ExecuteSynchronous(action As AsyncDelegate, caption As String)

Parameters:

  • action:
  • caption:

ExecuteSynchronous (AsyncDelegate, String, IWin32Window)

 

method ExecuteSynchronous(action: AsyncDelegate; caption: String; parent: IWin32Window)

 

void ExecuteSynchronous(AsyncDelegate action, String caption, IWin32Window parent)

 

Sub ExecuteSynchronous(action As AsyncDelegate, caption As String, parent As IWin32Window)

Parameters:

  • action:
  • caption:
  • parent:

HideMe

 

method HideMe

 

void HideMe()

 

Sub HideMe()

ShowMe

 

method ShowMe(parent: IWin32Window)

 

void ShowMe(IWin32Window parent)

 

Sub ShowMe(parent As IWin32Window)

Parameters:

  • parent:

WaitFor (IAsyncResult, String, Int32)

 

method WaitFor(ar: IAsyncResult; caption: String; timeout: Int32)

 

void WaitFor(IAsyncResult ar, String caption, Int32 timeout)

 

Sub WaitFor(ar As IAsyncResult, caption As String, timeout As Int32)

Parameters:

  • ar:
  • caption:
  • timeout:

WaitFor (IAsyncResult, String, Int32, IWin32Window)

 

method WaitFor(ar: IAsyncResult; caption: String; timeout: Int32; parent: IWin32Window)

 

void WaitFor(IAsyncResult ar, String caption, Int32 timeout, IWin32Window parent)

 

Sub WaitFor(ar As IAsyncResult, caption As String, timeout As Int32, parent As IWin32Window)

Parameters:

  • ar:
  • caption:
  • timeout:
  • parent: