DocActionEvent.ReturnStatus Property

Definition

Namespace:

Microsoft.Office.Interop.InfoPath.SemiTrust

Assembly:

Microsoft.Office.Interop.InfoPath.SemiTrust.dll

Gets or sets the return status of the OnClick event.

public:
 property bool ReturnStatus { bool get(); void set(bool value); };

public bool ReturnStatus { get; set; }

member this.ReturnStatus : bool with get, set

Public Property ReturnStatus As Boolean

Property Value

Boolean

Implements

ReturnStatus

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.<span class="label">ReturnStatus</span> = false;
}

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.