WindowEventHandler Delegate

Reference

Definition

Namespace:: Microsoft.Office.Tools.Word

Assemblies:: Microsoft.Office.Tools.Word.dll, Microsoft.Office.Tools.Word.v4.0.Utilities.dll

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.

Represents the method that will handle the ActivateEvent, Deactivate, and WindowSize events.

public delegate void WindowEventHandler(System::Object ^ sender, WindowEventArgs ^ e);

public delegate void WindowEventHandler(object sender, WindowEventArgs e);

type WindowEventHandler = delegate of obj * WindowEventArgs -> unit

Public Delegate Sub WindowEventHandler(sender As Object, e As WindowEventArgs)

Parameters

sender: Object

The source of the event.

e: WindowEventArgs

A SaveEventArgs that contains the event data.

Examples

The following code example creates an event handler for the WindowSize event. The event handler displays in the window caption the number of times that the window has been resized.

This example is for a document-level customization.

int resizeCount = 0;
private void DocumentWindowSize()
{
    this.WindowSize +=
        new Microsoft.Office.Tools.Word.WindowEventHandler(
        ThisDocument_WindowSize);
}

void ThisDocument_WindowSize(object sender,
    Microsoft.Office.Tools.Word.WindowEventArgs e)
{
    resizeCount++;
    e.Window.Caption = "Window resized " +
        resizeCount.ToString() + " times.";
}

Private resizeCount As Integer = 0
Private Sub DocumentWindowSize()
    AddHandler Me.WindowSize, AddressOf ThisDocument_WindowSize
End Sub

Private Sub ThisDocument_WindowSize(ByVal sender As Object, ByVal e As Microsoft.Office.Tools.Word.WindowEventArgs)
    resizeCount += 1
    e.Window.Caption = "Window resized " & resizeCount.ToString() & " times."
End Sub

Remarks

When you create a WindowEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, until you remove the delegate.

Applies to

Share via