Método XMLNode.SetValidationError

Artigo
08/01/2011

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

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

Sintaxe

'Declaração
Sub SetValidationError ( _
    Status As WdXMLValidationStatus, _
    ByRef ErrorText As Object, _
    ClearedAutomatically As Boolean _
)

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

Parâmetros

Status
Tipo: Microsoft.Office.Interop.Word.WdXMLValidationStatus
Dentre as WdXMLValidationStatus os valores que especifica se deve definir o texto de erro de status de validação (wdXMLValidationStatusCustom) ou para limpar o texto de erro de status de validação (wdXMLValidationStatusOK).

ErrorText
Tipo: System.Object%
O texto exibido para o usuário.Deixe em branco quando o Status parâmetro for definido como wdXMLValidationStatusOK.

ClearedAutomatically
Tipo: System.Boolean
true para automaticamente limpar a mensagem de erro assim que o próximo o evento de validação ocorre no nó especificado.falsepara exigir a execução de SetValidationError método com um Status parâmetro do wdXMLValidationStatusOK para limpar o texto de erro personalizadas.

Comentários

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

Optional Parameters

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

Exemplos

O seguinte exemplo de código usa a SetValidationError método para definir uma mensagem de erro de validação personalizada para um XMLNode. Um manipulador de eventos para o ValidationError evento exibe a mensagem de erro de validação personalizada, se a XMLNode não valida. Este exemplo assume que o documento atual contém dois XMLNode objetos nomeados CustomerAddress1Node e CustomerZipNode que mapeiam para elementos de esquema com um tipo de dados inteiro.

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

Segurança do .NET Framework

Confiança total para o chamador imediato. O membro não pode ser usado por código parcialmente confiável. Para obter mais informações, consulte Usando bibliotecas de código parcialmente confiáveis.

Consulte também

Referência

XMLNode Interface

Namespace Microsoft.Office.Tools.Word

Partilhar via