Método XMLNode.SetValidationError

Artigo
05/21/2013

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

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
Um dos valores de WdXMLValidationStatus que especifica se definir o status de erro de validação texto (wdXMLValidationStatusCustom) ou desmarque o texto de erro de status de validaçãowdXMLValidationStatusOK().

ErrorText
Tipo: System.Object%
O texto exibido para o usuário.Deixe a placa quando o parâmetro de Status é definido como wdXMLValidationStatusOK.

ClearedAutomatically
Tipo: System.Boolean
true automaticamente claro a mensagem de erro para o próximo evento de validação ocorrer no nó especificado. false para exigir executar o método de SetValidationError com um parâmetro de Status de wdXMLValidationStatusOK para limpar o texto de erro personalizada.

Comentários

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

Parâmetros Opcionais

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

Exemplos

O exemplo de código a seguir usa o método de SetValidationError para definir uma mensagem de erro de validação personalizada para XMLNode.Um manipulador de eventos para o evento de ValidationError exibe a mensagem de erro de validação personalizada se XMLNode não valida.Este exemplo assume que o documento atual contém dois objetos de XMLNode 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

Compartilhar via