DocActionEvent.ReturnStatus Property
Gets or sets the return status of the OnClick event.
Namespace: Microsoft.Office.Interop.InfoPath.SemiTrust
Assembly: Microsoft.Office.Interop.InfoPath.SemiTrust (in Microsoft.Office.Interop.InfoPath.SemiTrust.dll)
Syntax
'Declaration
Property ReturnStatus As Boolean
Get
Set
'Usage
Dim instance As DocActionEvent
Dim value As Boolean
value = instance.ReturnStatus
instance.ReturnStatus = value
bool ReturnStatus { get; set; }
Property Value
Type: System.Boolean
Implements
Remarks
The ReturnStatus property of the DocActionEventObject object is available, as the DocActionEvent object inherits from the DocReturnEventObject object, but setting this property to false does not cause the event to fail.
Important
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.
Examples
In the following example, the ReturnStatus property of the DocActionEventObject object is used to indicate that the OnClick event was not successful:
[InfoPathEventHandler(MatchPath="ShowViewNames", EventType=InfoPathEventType.OnClick)]
public void ShowViewNames_OnClick(DocActionEvent e)
{
// Cancel the event.
e.ReturnStatus = false;
}