DocReturnEvent.ReturnStatus Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets a value indicating the return status of the OnLoad event and the OnSubmitRequest event.
public:
property bool ReturnStatus { bool get(); void set(bool value); };public bool ReturnStatus { get; set; }member this.ReturnStatus : bool with get, setPublic Property ReturnStatus As BooleanProperty Value
Examples
In the following example, the ReturnStatus property of the DocReturnEventObject object is used to indicate that the OnLoad event was not successful:
public void OnLoad(DocReturnEvent e)
{
// Cancel the event.
e.<span class="label">ReturnStatus</span> = false;
}
Remarks
If the ReturnStatus property is set to false, the OnLoad and OnSubmitRequest events fail. If set to true, the OnLoad and OnSubmitRequest events are successful. The default value for the OnLoad event is true, and the default value for the OnSubmitRequest event is false.