XMLNode.SetValidationError(WdXMLValidationStatus, Object, Boolean) Methode

Referenz

Definition

Namespace:: Microsoft.Office.Tools.Word

Assembly:: Microsoft.Office.Tools.Word.dll

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

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

public void SetValidationError (Microsoft.Office.Interop.Word.WdXMLValidationStatus Status, ref object ErrorText, bool ClearedAutomatically = true);

abstract member SetValidationError : Microsoft.Office.Interop.Word.WdXMLValidationStatus * obj * bool -> unit

Public Sub SetValidationError (Status As WdXMLValidationStatus, Optional ByRef ErrorText As Object, Optional ClearedAutomatically As Boolean = true)

Parameter

Status: WdXMLValidationStatus

Einer der WdXMLValidationStatus-Werte, der angibt, ob der Text für Validierungsstatusfehler festgelegt (wdXMLValidationStatusCustom) oder gelöscht wird (wdXMLValidationStatusOK).

ErrorText: Object

Der angezeigte Text. Lassen Sie leer, wenn der Status Parameter auf wdXMLValidationStatusOKfestgelegt ist.

ClearedAutomatically: Boolean

true, wenn die Fehlermeldung automatisch gelöscht werden soll, sobald das nächste Validierungsereignis auf dem angegebenen Knoten auftritt. false , um die Ausführung der SetValidationError(WdXMLValidationStatus, Object, Boolean) Methode mit einem Status Parameter von wdXMLValidationStatusOK erforderlich zu machen, um den benutzerdefinierten Fehlertext zu löschen.

Beispiele

Im folgenden Codebeispiel wird die SetValidationError -Methode verwendet, um eine benutzerdefinierte Überprüfungsfehlermeldung für einen XMLNodefestzulegen. Ein Ereignishandler für das ValidationError Ereignis zeigt die benutzerdefinierte Validierungsfehlermeldung an, wenn die XMLNode nicht überprüft wird. In diesem Beispiel wird davon ausgegangen, dass das aktuelle Dokument zwei XMLNode Objekte mit dem Namen CustomerAddress1Node enthält und CustomerZipNode Schemaelementen mit einem ganzzahligen Datentyp zugeordnet ist.

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]);
}

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

Hinweise

Verwenden Sie die wdXMLValidationStatusCustom Konstante, um benutzerdefinierten Fehlertext festzulegen.

Optionale Parameter

Informationen zu optionalen Parametern finden Sie unter Optionale Parameter in Office-Projektmappen.

Gilt für:

Freigeben über