Share via

  • Article

AutomationEventArgs.Arguments Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets the event arguments from the Automation event.

Namespace:  System.Runtime.InteropServices.Automation
Assembly:  System.Windows (in System.Windows.dll)

Syntax

'Declaration
Public Property Arguments As Object()

public Object[] Arguments { get; private set; }

Property Value

Type: array<System.Object[]
The event arguments from the Automation event.

Remarks

For more information, see AutomationFactory.

Examples

The following code example demonstrates how to handle Automation events.

This example is part of a larger example in How to: Use Automation in Trusted Applications.

Private Sub SearchEmail()

    UpdateStatusMessage("Searching Inbox for 'Silverlight'...")

    ' The following code demonstrates three ways to handle Automation 
    ' events. In Visual Basic, all three ways use the AutomationEvent class. 

    searchEvent =
        AutomationFactory.GetEvent(outlook, "AdvancedSearchComplete")

    ' The first way is demonstrated by the Handles clause of the 
    ' SearchEvent_EventRaised method, which requires the WithEvents modifier
    ' on the searchEvent variable declaration.

    ' The second way uses the AddHandler syntax with the EventRaised event,
    ' and does not require the WithEvents modifier. 
    ' AddHandler searchEvent.EventRaised, AddressOf SearchEvent_EventRaised

    ' The third way uses the AutomationEvent.AddEventHandler method, and
    ' requires the use of a delegate with an API signature that matches the
    ' Automation event. 
    ' searchEvent.AddEventHandler( 
    '   New AdvancedSearchCompleteDelegate(AddressOf SearchComplete))

    ' Begin the search.
    outlook.AdvancedSearch("Inbox",
        "urn:schemas:mailheader:subject ci_phrasematch 'Silverlight'",
        True, "SubjectSearch")

End Sub

Private WithEvents searchEvent As AutomationEvent

Sub SearchEvent_EventRaised(ByVal sender As Object,
    ByVal e As AutomationEventArgs) Handles searchEvent.EventRaised

    SearchComplete(e.Arguments(0))

End Sub

' Required only with the second two ways of handling Automation events. 
' Private Delegate Sub AdvancedSearchCompleteDelegate(ByRef search As Object)

' Note: Visual Basic does not support the use of custom delegates for 
' events with optional parameters. 

Private Sub SearchComplete(ByRef search As Object)

    Dim searchResults As New List(Of String)
    For Each result As Object In search.Results
        searchResults.Add(result.Subject)
    Next
    SetResultsList(searchResults)

End Sub

private void SearchEmail()
{
    UpdateStatusMessage("Searching Inbox for 'Silverlight'...");

    // The following code demonstrates three ways to handle Automation 
    // events. The first two ways use the AutomationEvent class. 
    // The last two ways require the use of a delegate with 
    // an API signature that matches the Automation event. 

    AutomationEvent searchEvent = AutomationFactory
        .GetEvent(outlook, "AdvancedSearchComplete");

    // The first way: 
    searchEvent.EventRaised += (sender, e) =>
    {
        SearchComplete(e.Arguments[0]);
    };

    // The second way:
    // searchEvent.AddEventHandler(
    //    new AdvancedSearchCompleteDelegate(SearchComplete));

    // The third way:
    // outlook.AdvancedSearchComplete +=
    //    new AdvancedSearchCompleteDelegate(SearchComplete);

    // Begin the search. 
    outlook.AdvancedSearch("Inbox",
        "urn:schemas:mailheader:subject ci_phrasematch 'Silverlight'",
        true, "SubjectSearch");
}

// Required only with the second two ways of handling Automation events. 
private delegate void AdvancedSearchCompleteDelegate(dynamic search);

// To use custom delegates for events with optional parameters, you
// must specify default values in the delegate signature as shown here:
// private delegate void MyEventHandlerDelegate(int i, float f=77);

private void SearchComplete(dynamic search)
{
    List<String> searchResults = new List<String>();
    foreach (dynamic result in search.Results) 
    { 
        searchResults.Add(result.Subject);
    }
    SetResultsList(searchResults);
}

Version Information

Silverlight

Supported in: 5, 4

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.