XMLNode.SetValidationError-Methode

Artikel
08/10/2011

Ändert den für ein XMLNode-Steuerelement angezeigten Text für Validierungsfehler und zwingt Microsoft Office Word, einen Knoten als ungültig zu melden.

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

Syntax

'Declaration
Sub SetValidationError ( _
    Status As WdXMLValidationStatus, _
    ByRef ErrorText As Object, _
    ClearedAutomatically As Boolean _
)

void SetValidationError(
    WdXMLValidationStatus Status,
    ref Object ErrorText,
    bool ClearedAutomatically
)

Parameter

Status
Typ: Microsoft.Office.Interop.Word.WdXMLValidationStatus
Einer der WdXMLValidationStatus-Werte, der angibt, ob der Text für Validierungsstatusfehler festgelegt (wdXMLValidationStatusCustom) oder gelöscht wird (wdXMLValidationStatusOK).

ErrorText
Typ: System.Object%
Der angezeigte Text.Lassen Sie diesen Parameter leer, wenn der Status-Parameter auf wdXMLValidationStatusOK festgelegt ist.

ClearedAutomatically
Typ: System.Boolean
true, wenn die Fehlermeldung automatisch gelöscht werden soll, sobald das nächste Validierungsereignis auf dem angegebenen Knoten auftritt.Bei false muss die SetValidationError-Methode mit dem Status-Parameter wdXMLValidationStatusOK ausgeführt werden, um den benutzerdefinierten Fehlertext zu löschen.

Hinweise

Legen Sie den benutzerdefinierten Fehlertext mithilfe der wdXMLValidationStatusCustom-Konstante fest.

Optionale Parameter

Informationen zu optionalen Parametern finden Sie unter Optionale Parameter in Office-Lösungen.

Beispiele

Im folgenden Codebeispiel wird mithilfe der SetValidationError-Methode eine benutzerdefinierte Validierungsfehlermeldung für einen XMLNode festgelegt. Ein Ereignishandler für das ValidationError-Ereignis zeigt die benutzerdefinierte Validierungsfehlermeldung an, wenn die Validierung von XMLNode nicht erfolgreich ist. In diesem Beispiel wird davon ausgegangen, dass das aktuelle Dokument zwei XMLNode-Objekte mit dem Namen CustomerAddress1Node und CustomerZipNode enthält, die Schemaelementen mit einem Ganzzahldatentyp zugeordnet sind.

Private Sub XMLNodeValidationError()

    ' Set custom error message for Address1 element.
    Dim errorText As String = Me.CustomerAddress1Node.BaseName & _
        " element must be an integer."
    Dim objErrorText As Object = CType(errorText, Object)
    Me.CustomerAddress1Node.SetValidationError( _
        Word.WdXMLValidationStatus.wdXMLValidationStatusCustom, _
        objErrorText, False)

    ' This does not raise a validation error.
    Dim val As Integer = 22222
    Me.CustomerZipNode.NodeText = val.ToString()

    ' This raises a validation error.
    Me.CustomerAddress1Node.NodeText = "Seventeen Hundred Twenty One"
End Sub

Private Sub CustomerNode_ValidationError(ByVal sender As Object, _
    ByVal e As EventArgs) Handles CustomerZipNode.ValidationError, _
    CustomerAddress1Node.ValidationError

    Dim tempNode As Microsoft.Office.Tools.Word.XMLNode = CType(sender,  _
        Microsoft.Office.Tools.Word.XMLNode)
    MsgBox("Error: " & tempNode.ValidationErrorText(False))
End Sub

private void XMLNodeValidationError()
{
    // Set custom error message for Address1 element.
    string errorText = this.CustomerAddress1Node.BaseName + 
        " element must be an integer.";
    object objErrorText = (object)errorText;
    this.CustomerAddress1Node.SetValidationError(
        Word.WdXMLValidationStatus.wdXMLValidationStatusCustom,
        ref objErrorText, false);

    // Attach validation event handlers.
    this.CustomerZipNode.ValidationError +=
        new EventHandler(CustomerNode_ValidationError);
    this.CustomerAddress1Node.ValidationError +=
        new EventHandler(CustomerNode_ValidationError);

    // This does not raise a validation error.
    int val = 22222;
    this.CustomerZipNode.NodeText = val.ToString();

    // This raises a validation error.
    this.CustomerAddress1Node.NodeText = 
        "Seventeen Hundred Twenty One";
}

void CustomerNode_ValidationError(object sender, EventArgs e)
{
    Microsoft.Office.Tools.Word.XMLNode tempNode = 
        (Microsoft.Office.Tools.Word.XMLNode)sender;

    MessageBox.Show("Error: " + tempNode.ValidationErrorText[false]);
}

.NET Framework-Sicherheit

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.

Siehe auch

Referenz

XMLNode Schnittstelle

Microsoft.Office.Tools.Word-Namespace

Freigeben über