DocumentEvents2_XMLBeforeDeleteEventHandler delegate
TOC
Collapse the table of content
Expand the table of content

DocumentEvents2_XMLBeforeDeleteEventHandler delegate

A Delegate type used to add an event handler for the XMLBeforeDelete event. The XMLBeforeDelete event occurs when a user deletes an XML element from a document.

Namespace:  Microsoft.Office.Interop.Word
Assembly:  Microsoft.Office.Interop.Word (in Microsoft.Office.Interop.Word.dll)

[ComVisibleAttribute(false)]
public delegate void DocumentEvents2_XMLBeforeDeleteEventHandler(
	Range DeletedRange,
	XMLNode OldXMLNode,
	bool InUndoRedo
)

Parameters

DeletedRange
Type: Microsoft.Office.Interop.Word.Range

Range object. The contents of the XML element being deleted. If only an element is deleted and not associated text, the DeletedRange parameter will not exist and will, therefore, be set to Nothing.

OldXMLNode
Type: Microsoft.Office.Interop.Word.XMLNode

XMLNode object. The node that is being deleted.

InUndoRedo
Type: System.Boolean

Boolean. True indicates the action was performed using the Undo or Redo feature in Microsoft Word.

If the InUndoRedo parameter is True, never change the XML in a document while the XMLAfterInsert and XMLBeforeDelete events are running.

If the InUndoRedo parameter is False, you can insert and delete the XML in the document— but be careful that the XMLAfterInsert and XMLBeforeDelete events will not try to cancel each other out, causing an infinite loop. You can prevent infinite loops by using a global Boolean variable and check for that at the beginning of the error handler.

Show:
© 2016 Microsoft