ContentControlBase.StoreUpdating Event

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.

Occurs just before Microsoft Office Word updates data in a custom XML part that is bound to the content control (that is, after the text in the content control changes).

public:
 event Microsoft::Office::Tools::Word::ContentControlStoreUpdatingEventHandler ^ StoreUpdating;

event Microsoft.Office.Tools.Word.ContentControlStoreUpdatingEventHandler StoreUpdating;

member this.StoreUpdating : Microsoft.Office.Tools.Word.ContentControlStoreUpdatingEventHandler

Event StoreUpdating As ContentControlStoreUpdatingEventHandler

Event Type

ContentControlStoreUpdatingEventHandler

Examples

The following code example demonstrates event handlers for the StoreUpdating and ContentUpdating events. This example assumes that the document contains a PlainTextContentControl named plainTextContentControl1 that is bound to an element in a custom XML part. For a code example that demonstrates how to bind a content control to an element in a custom XML part, see Walkthrough: Binding Content Controls to Custom XML Parts.

To use this code, paste it into the ThisDocument class in your project. For C#, you must also attach the event handlers to the StoreUpdating and ContentUpdating events of plainTextContentControl1.

void plainTextContentControl1_StoreUpdating(object sender, 
    Microsoft.Office.Tools.Word.ContentControlStoreUpdatingEventArgs e)
{
    MessageBox.Show("The control was changed to the following value: \n\n" +
        e.Content + "\n\nThis value is about to be written to the node that is bound to this control.");
}

void plainTextContentControl1_ContentUpdating(object sender, 
    Microsoft.Office.Tools.Word.ContentControlContentUpdatingEventArgs e)
{
    MessageBox.Show("The node that is bound to this control was changed to the following value: \n\n" +
        e.Content + "\n\nThis value is about to be written to this control.");
}

Private Sub plainTextContentControl1_StoreUpdating(ByVal sender As Object, _
    ByVal e As Microsoft.Office.Tools.Word.ContentControlStoreUpdatingEventArgs) _
    Handles PlainTextContentControl1.StoreUpdating

    MessageBox.Show("The control was changed to the following value: " & vbCrLf & _
        e.Content & vbCrLf & "This value is about to be written to the node that is bound to this control.")
End Sub

Private Sub plainTextContentControl1_ContentUpdating(ByVal sender As Object, _
    ByVal e As Microsoft.Office.Tools.Word.ContentControlContentUpdatingEventArgs) _
    Handles PlainTextContentControl1.ContentUpdating

    MessageBox.Show("The node that is bound to this control was changed to the following value: " & vbCrLf & _
        e.Content & vbCrLf & "This value is about to be written to this control.")
End Sub

Remarks

You can bind content controls to an element in a piece of XML (also named custom XML part) that is embedded in the document. For more information, see Content Controls and Custom XML Parts Overview.

The StoreUpdating event is raised when the text in a content control changes, and the content control is bound to an element in a custom XML part.

Applies to

Share via