DocumentListEventArgs Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Provides data for the DeletingDocument and DocumentActivated events.

Namespace:  Microsoft.WindowsCE.Forms
Assembly:  Microsoft.WindowsCE.Forms (in Microsoft.WindowsCE.Forms.dll)

Syntax

'Declaration
Public Class DocumentListEventArgs _
    Inherits EventArgs
'Usage
Dim instance As DocumentListEventArgs

public class DocumentListEventArgs : EventArgs

public ref class DocumentListEventArgs : public EventArgs

type DocumentListEventArgs =  
    class
        inherit EventArgs
    end

Remarks

This event data contains the path to the file that was either deleted or activated, so you can program your application to close or open the file.

Examples

The following code example defines a method that handles the DeletingDocument event. It uses the Path property of the DocumentListEventArgs to get the path to the deleted file. This code example is part of a larger example provided for the DocumentList class.

' Handle the DeletingDocument 
' event with code to close the file.
 Private Sub DocList_DeletingDocument(ByVal sender As Object, _
 ByVal docevent As Microsoft.WindowsCE.Forms.DocumentListEventArgs) _
 Handles DocumentList1.DeletingDocument

     StatusBar1.Text = "Deleted: " & docevent.Path
     ' Add code to close any instances of the file.
 End Sub

private void OnDelDoc(object obj, DocumentListEventArgs docg)
{
    statusBar1.Text += "Deleted: " + docg.Path;

    // Add code to close any instances of the file.
}

Inheritance Hierarchy

System.Object
  System.EventArgs
    Microsoft.WindowsCE.Forms.DocumentListEventArgs

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Windows Mobile for Pocket PC

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Compact Framework

Supported in: 3.5, 2.0

See Also

Reference

DocumentListEventArgs Members

Microsoft.WindowsCE.Forms Namespace

Other Resources

How to: Use a DocumentList Control