XMLNode.SetValidationError(WdXMLValidationStatus, Object, Boolean) Méthode

Référence

Définition

Espace de noms:: Microsoft.Office.Tools.Word

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

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Modifie le texte d'erreur de validation affiché à un utilisateur pour un contrôle XMLNode et force Microsoft Office Word à signaler qu'un nœud n'est pas valide.

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)

Paramètres

Status: WdXMLValidationStatus

Une des valeurs de WdXMLValidationStatus qui spécifient si le texte d'erreur de validation est défini (wdXMLValidationStatusCustom) ou effacé (wdXMLValidationStatusOK).

ErrorText: Object

Texte affiché à l'utilisateur. Laissez vide lorsque le Status paramètre est défini sur wdXMLValidationStatusOK.

ClearedAutomatically: Boolean

true pour effacer automatiquement le message d'erreur dès que l'événement de validation suivant se produit sur le nœud spécifié. false pour exiger l’exécution de la SetValidationError(WdXMLValidationStatus, Object, Boolean) méthode avec un Status paramètre de wdXMLValidationStatusOK pour effacer le texte d’erreur personnalisé.

Exemples

L’exemple de code suivant utilise la SetValidationError méthode pour définir un message d’erreur de validation personnalisé pour un XMLNode. Un gestionnaire d’événements pour l’événement ValidationError affiche le message d’erreur de validation personnalisé si le XMLNode ne valide pas. Cet exemple part du principe que le document actif contient deux XMLNode objets nommés CustomerAddress1Node et CustomerZipNode qui sont mappés à des éléments de schéma avec un type de données entier.

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

Remarques

Pour définir le texte d’erreur personnalisé, utilisez la wdXMLValidationStatusCustom constante.

Paramètres facultatifs

Pour plus d’informations sur les paramètres facultatifs, consultez Paramètres facultatifs dans les solutions Office.

S’applique à

Partager via