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

Referência

Definição

Namespace:: Microsoft.Office.Tools.Word

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

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Altera o texto do erro de validação exibido para um usuário para um controle XMLNode e força o Microsoft Office Word a relatar um nó como inválido.

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)

Parâmetros

Status: WdXMLValidationStatus

Um dos valores WdXMLValidationStatus que especifica se é necessário definir o texto do erro do status de validação (wdXMLValidationStatusCustom) ou limpar o texto do erro do status de validação (wdXMLValidationStatusOK).

ErrorText: Object

O texto exibido para o usuário. Deixe em branco quando o Status parâmetro estiver definido como wdXMLValidationStatusOK.

ClearedAutomatically: Boolean

true para limpar automaticamente a mensagem de erro assim que o próximo evento de validação ocorrer no nó especificado. false para exigir a execução do SetValidationError(WdXMLValidationStatus, Object, Boolean) método com um Status parâmetro de wdXMLValidationStatusOK para limpar o texto de erro personalizado.

Exemplos

O exemplo de código a seguir usa o SetValidationError método para definir uma mensagem de erro de validação personalizada para um XMLNode. Um manipulador de eventos para o ValidationError evento exibirá a mensagem de erro de validação personalizada se o XMLNode não validar. Este exemplo pressupõe que o documento atual contém dois XMLNode objetos chamados e CustomerZipNode que são mapeados CustomerAddress1Node para elementos de esquema com um tipo de dados inteiro.

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

Comentários

Para definir o texto de erro personalizado, use a wdXMLValidationStatusCustom constante .

Parâmetros Opcionais

Para obter informações sobre parâmetros opcionais, consulte Parâmetros opcionais em soluções do Office.

Aplica-se a

Compartilhar via