LoadingEventArgs.CancelableArgs Property (Microsoft.Office.InfoPath)

Gets a reference to the XmlFormCancelEventArgs object.

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

Syntax

'Declaration
Public MustOverride ReadOnly Property CancelableArgs As XmlFormCancelEventArgs
'Usage
Dim instance As LoadingEventArgs
Dim value As XmlFormCancelEventArgs

value = instance.CancelableArgs

public abstract XmlFormCancelEventArgs CancelableArgs { get; }

Property Value

A XmlFormCancelEventArgs object.

Remarks

Access the XmlFormCancelEventArgs object to cancel the Loading event and specify a custom message to display when the event is cancelled.

By default, the LoadingEventArgs.CancelableArgs.Cancel property is set to false.

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 from code running in forms opened in Microsoft Office InfoPath 2007 or in a Web browser.

Example

public void FormEvents_Loading(object sender, LoadingEventArgs e)
{
   e.CancelableArgs.Message = "Loading this form was cancelled.";
   e.CancelableArgs.Cancel = true;
}

Public Sub FormEvents_Loading(ByVal sender As Object, _
   ByVal e As LoadingEventArgs)
   e.CancelableArgs.Message = "Loading this form was cancelled."
   e.CancelableArgs.Cancel = True
End Sub

See Also

Reference

LoadingEventArgs Class
LoadingEventArgs Members
Microsoft.Office.InfoPath Namespace