Export (0) Print
Expand All

Application Class

Provides static methods and properties to manage an application, such as methods to start and stop an application, to process Windows messages, and properties to get information about an application. This class cannot be inherited.

System.Object
  System.Windows.Forms.Application

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public sealed class Application

The Application type exposes the following members.

  NameDescription
Public propertyStatic memberAllowQuitGets a value indicating whether the caller can quit this application.
Public propertyStatic memberCommonAppDataPathGets the path for the application data that is shared among all users.
Public propertyStatic memberCommonAppDataRegistryGets the registry key for the application data that is shared among all users.
Public propertyStatic memberCompanyNameGets the company name associated with the application.
Public propertyStatic memberCurrentCultureGets or sets the culture information for the current thread.
Public propertyStatic memberCurrentInputLanguageGets or sets the current input language for the current thread.
Public propertyStatic memberExecutablePathGets the path for the executable file that started the application, including the executable name.
Public propertyStatic memberLocalUserAppDataPathGets the path for the application data of a local, non-roaming user.
Public propertyStatic memberMessageLoopGets a value indicating whether a message loop exists on this thread.
Public propertyStatic memberOpenFormsGets a collection of open forms owned by the application.
Public propertyStatic memberProductNameGets the product name associated with this application.
Public propertyStatic memberProductVersionGets the product version associated with this application.
Public propertyStatic memberRenderWithVisualStylesGets a value specifying whether the current application is drawing controls with visual styles.
Public propertyStatic memberSafeTopLevelCaptionFormatGets or sets the format string to apply to top-level window captions when they are displayed with a warning banner.
Public propertyStatic memberStartupPathGets the path for the executable file that started the application, not including the executable name.
Public propertyStatic memberUserAppDataPathGets the path for the application data of a user.
Public propertyStatic memberUserAppDataRegistryGets the registry key for the application data of a user.
Public propertyStatic memberUseWaitCursorGets or sets whether the wait cursor is used for all open forms of the application.
Public propertyStatic memberVisualStyleStateGets a value that specifies how visual styles are applied to application windows.
Top

  NameDescription
Public methodStatic memberAddMessageFilterAdds a message filter to monitor Windows messages as they are routed to their destinations.
Public methodStatic memberDoEventsProcesses all Windows messages currently in the message queue.
Public methodStatic memberEnableVisualStylesEnables visual styles for the application.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodStatic memberExit()Informs all message pumps that they must terminate, and then closes all application windows after the messages have been processed.
Public methodStatic memberExit(CancelEventArgs)Informs all message pumps that they must terminate, and then closes all application windows after the messages have been processed.
Public methodStatic memberExitThreadExits the message loop on the current thread and closes all windows on the thread.
Public methodStatic memberFilterMessageRuns any filters against a window message, and returns a copy of the modified message.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodStatic memberOleRequiredInitializes OLE on the current thread.
Public methodStatic memberOnThreadExceptionRaises the ThreadException event.
Public methodStatic memberRaiseIdleRaises the Idle event in hosted scenarios.
Public methodStatic memberRegisterMessageLoopRegisters a callback for checking whether the message loop is running in hosted environments.
Public methodStatic memberRemoveMessageFilterRemoves a message filter from the message pump of the application.
Public methodStatic memberRestartShuts down the application and starts a new instance immediately.
Public methodStatic memberRun()Begins running a standard application message loop on the current thread, without a form.
Public methodStatic memberRun(ApplicationContext)Begins running a standard application message loop on the current thread, with an ApplicationContext.
Public methodStatic memberRun(Form)Begins running a standard application message loop on the current thread, and makes the specified form visible.
Public methodStatic memberSetCompatibleTextRenderingDefaultSets the application-wide default for the UseCompatibleTextRendering property defined on certain controls.
Public methodStatic memberSetSuspendStateSuspends or hibernates the system, or requests that the system be suspended or hibernated.
Public methodStatic memberSetUnhandledExceptionMode(UnhandledExceptionMode)Instructs the application how to respond to unhandled exceptions.
Public methodStatic memberSetUnhandledExceptionMode(UnhandledExceptionMode, Boolean)Instructs the application how to respond to unhandled exceptions, optionally applying thread-specific behavior.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodStatic memberUnregisterMessageLoopUnregisters the message loop callback made with RegisterMessageLoop.
Top

  NameDescription
Public eventStatic memberApplicationExitOccurs when the application is about to shut down.
Public eventStatic memberEnterThreadModalOccurs when the application is about to enter a modal state.
Public eventStatic memberIdleOccurs when the application finishes processing and is about to enter the idle state.
Public eventStatic memberLeaveThreadModalOccurs when the application is about to leave a modal state.
Public eventStatic memberThreadExceptionOccurs when an untrapped thread exception is thrown.
Public eventStatic memberThreadExitOccurs when a thread is about to shut down. When the main thread for an application is about to be shut down, this event is raised first, followed by an ApplicationExit event.
Top

The Application class has methods to start and stop applications and threads, and to process Windows messages, as follows:

  • Run starts an application message loop on the current thread and, optionally, makes a form visible.

  • Exit or ExitThread stops a message loop.

  • DoEvents processes messages while your program is in a loop.

  • AddMessageFilter adds a message filter to the application message pump to monitor Windows messages.

  • IMessageFilter lets you stop an event from being raised or perform special operations before invoking an event handler.

This class has CurrentCulture and CurrentInputLanguage properties to get or set culture information for the current thread.

You cannot create an instance of this class.

The following code example lists numbers in a list box on a form. Each time you click button1, the application adds another number to the list.

The Main method calls Run to start the application, which creates the form, listBox1 and button1. When the user clicks button1, the button1_Click method displays a MessageBox. If the user clicks No on the MessageBox, the button1_Click method adds a number to the list. If the user clicks Yes, the application calls Exit to process all remaining messages in the queue and then to quit.

NoteNote

The call to Exit will fail in partial trust.

public class Form1 : Form
{
    [STAThread]
    public static void Main()
    {
        // Start the application.
        Application.Run(new Form1());
    }

    private Button button1;
    private ListBox listBox1;

    public Form1()
    {
        button1 = new Button();
        button1.Left = 200;
        button1.Text = "Exit";
        button1.Click += new EventHandler(button1_Click);

        listBox1 = new ListBox();
        this.Controls.Add(button1);
        this.Controls.Add(listBox1);
    }

    private void button1_Click(object sender, System.EventArgs e)
    {
        int count = 1;
        // Check to see whether the user wants to exit the application. 
        // If not, add a number to the list box. 
        while (MessageBox.Show("Exit application?", "", 
            MessageBoxButtons.YesNo)==DialogResult.No)
        {
            listBox1.Items.Add(count);
            count += 1;
        }

        // The user wants to exit the application.  
        // Close everything down.
        Application.Exit();
    }
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft