Window.Close Method

Definition

Namespace:

Microsoft.Office.InfoPath

Assembly:

Microsoft.Office.InfoPath.dll

Overloads

Close()	Closes the window that is represented by the Window object prompting to save changes to any unsaved form, or form with changes that have not been saved.
Close(Boolean)	Closes the window that is represented by the Window object and optionally forces an unsaved form or form with unsaved changes to be closed without saving.

Close()

Closes the window that is represented by the Window object prompting to save changes to any unsaved form, or form with changes that have not been saved.

public:
 abstract void Close();

public abstract void Close ();

abstract member Close : unit -> unit

Public MustOverride Sub Close ()

Examples

In the following example, the Close method of the Window class is used to close the currently active window, forcing a save if changes in the form have occurred.

this.Application.ActiveWindow.Close(); Me.Application.ActiveWindow.Close()

Remarks

The Close() method will close the associated window and the forms that it contains. If the form has not been saved, or has changes that have not been saved, the user will be prompted to save changes before closing.

The Close method can be used only with the editing window types; if used with a designing window type, it will raise an exception. In addition, the Close method can only be used with the SubmitEventHandler and ClickedEventHandler event handlers. If used with any other type of event handler, it will raise an exception.

Note: If the window being closed is the only window open in Microsoft InfoPath, the InfoPath application will also be closed.

This member can be accessed only by forms running in the same domain as the currently open form, or by forms that have been granted cross-domain permissions.

This type or member can be accessed only from code running in forms opened in Microsoft InfoPath Filler.

Close(Boolean)

Closes the window that is represented by the Window object and optionally forces an unsaved form or form with unsaved changes to be closed without saving.

public:
 abstract void Close(bool force);

public abstract void Close (bool force);

abstract member Close : bool -> unit

Public MustOverride Sub Close (force As Boolean)

Parameters

force

Boolean

Specifies whether open unsaved documents will be saved. The default value is false.

Exceptions

InvalidOperationException

The Close method was called from an event handler for the Loading event

ArgumentNullException

The parameter passed to this method is a null reference (Nothing in Visual Basic).

ArgumentException

The parameter passed to this method is not valid. For example, it is of the wrong type or format.

Examples

In the following example, the Close method of the Window class is used to close the currently active window, and will force an unsaved form with changes to close without saving changes.

this.Application.ActiveWindow.Close(true); Me.Application.ActiveWindow.Close(true)

Remarks

The Close(force) method will close the associated window and the forms that it contains. If the force parameter is set to true, all forms will be closed without saving, even if they have not been saved, or contain changes since they were last saved. If set to false, users will be prompted to save their changes.

The Close method can be used only with the editing window types; if used with a designing window type, it will raise an exception. In addition, the Close method can only be used with the SubmitEventHandler and ClickedEventHandler event handlers. If used with any other type of event handler, it will raise an exception.

Note: If the window being closed is the only window open in Microsoft InfoPath, the InfoPath application will also be closed.

This member can be accessed only by forms running in the same domain as the currently open form, or by forms that have been granted cross-domain permissions.

This type or member can be accessed only from code running in forms opened in Microsoft InfoPath Filler.