XMLNode.SetValidationError(WdXMLValidationStatus, Object, Boolean) Metoda

Definicja

Przestrzeń nazw:

Microsoft.Office.Tools.Word

Zestaw:

Microsoft.Office.Tools.Word.dll

Zmienia tekst błędu walidacji wyświetlany użytkownikowi na potrzeby XMLNode kontroli i wymusza, aby pakiet Microsoft Office Word zgłosił węzeł jako nieprawidłowy.

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)

Parametry

Status

WdXMLValidationStatus

WdXMLValidationStatus Jedną z wartości określających, czy ustawić tekst błędu stanu weryfikacji (wdXMLValidationStatusCustom) lub wyczyścić tekst błędu stanu weryfikacji (wdXMLValidationStatusOK).

ErrorText

Object

Tekst wyświetlany użytkownikowi. Pozostaw wartość pustą Status , gdy parametr jest ustawiony na wdXMLValidationStatusOKwartość .

ClearedAutomatically

Boolean

true aby automatycznie wyczyścić komunikat o błędzie zaraz po wystąpieniu następnego zdarzenia weryfikacji w określonym węźle. false aby wymagać uruchomienia SetValidationError(WdXMLValidationStatus, Object, Boolean) metody z parametrem StatuswdXMLValidationStatusOK w celu wyczyszczenia niestandardowego tekstu błędu.

Przykłady

Poniższy przykład kodu używa metody w SetValidationError celu ustawienia niestandardowego komunikatu o błędzie weryfikacji dla elementu XMLNode. Procedura obsługi zdarzeń ValidationError dla zdarzenia wyświetla niestandardowy komunikat o błędzie weryfikacji, jeśli XMLNode nie zostanie zweryfikowany. W tym przykładzie przyjęto założenie, że bieżący dokument zawiera dwa XMLNode obiekty o nazwie CustomerAddress1Node i CustomerZipNode mapuje na elementy schematu z typem danych całkowitych.

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

Uwagi

Aby ustawić niestandardowy tekst błędu, użyj stałej wdXMLValidationStatusCustom .

Parametry opcjonalne

Aby uzyskać informacje na temat parametrów opcjonalnych, zobacz Parametry opcjonalne w rozwiązaniach pakietu Office.