SaveEventArgs Interface

  • Reference

Definition

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

Provides data for the BeforeSave event.

public interface class SaveEventArgs
[System.Runtime.InteropServices.Guid("06c7ed15-2df8-4a5c-acf4-10cdd5a6a510")]
public interface SaveEventArgs
[<System.Runtime.InteropServices.Guid("06c7ed15-2df8-4a5c-acf4-10cdd5a6a510")>]
type SaveEventArgs = interface
Public Interface SaveEventArgs
Attributes
GuidAttribute

Examples

The following code example demonstrates an event handler for the BeforeSave event. When you save the document, the event handler prompts you to cancel or continue with the save operation.

This example is for a document-level customization.

private void DocumentBeforeSave()
{
    this.BeforeSave += new Microsoft.Office.Tools.Word.SaveEventHandler(ThisDocument_BeforeSave);
}

void ThisDocument_BeforeSave(object sender, Microsoft.Office.Tools.Word.SaveEventArgs e)
{
    if (MessageBox.Show("Do you want to save the document?", "BeforeSave",
        MessageBoxButtons.YesNo) == DialogResult.No)
    {
        e.Cancel = true;
    }
}

Private Sub DocumentBeforeSave()
    AddHandler Me.BeforeSave, AddressOf ThisDocument_BeforeSave
End Sub

Private Sub ThisDocument_BeforeSave(ByVal sender As Object, ByVal e As Microsoft.Office.Tools.Word.SaveEventArgs)
    If MessageBox.Show("Do you want to save the document?", "BeforeSave", _
        MessageBoxButtons.YesNo) = DialogResult.No Then
        e.Cancel = True
    End If
End Sub

Properties

Cancel

Gets or sets a value indicating whether to cancel the save operation.
ShowSaveAsDialog

Gets or sets a value indicating whether to display the Save As dialog box.

Applies to