Share via

Window.Close Method (Boolean) (Microsoft.Office.InfoPath)

  • Article

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.

Namespace: Microsoft.Office.InfoPath
Assembly: Microsoft.Office.InfoPath (in microsoft.office.infopath.dll)

Syntax

'Declaration
Public MustOverride Sub Close ( _
    force As Boolean _
)
'Usage
Dim instance As Window
Dim force As Boolean

instance.Close(force)

public abstract void Close (
    bool force
)

Parameters

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

Exceptions

Exception type Condition

InvalidOperationException

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

ArgumentNullException

The parameter passed to this method is null.

ArgumentException

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

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 Office InfoPath 2007, 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 Office InfoPath 2007.

Example

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)

See Also

Reference

Window Class
Window Members
Microsoft.Office.InfoPath Namespace