XMLNode.SetValidationError (Método)
Cambia el texto del error de validación mostrado a un usuario para un control XMLNode y obliga a Microsoft Office Word a que informe de que un nodo no es válido.
Espacio de nombres: Microsoft.Office.Tools.Word
Ensamblado: Microsoft.Office.Tools.Word (en Microsoft.Office.Tools.Word.dll)
Sintaxis
'Declaración
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
Uno de los valores WdXMLValidationStatus que especifica si se debe establecer el texto del error de estado de validación (wdXMLValidationStatusCustom) o borrarlo (wdXMLValidationStatusOK).
- ErrorText
Tipo: System.Object%
Texto mostrado al usuario.Déjelo en blanco cuando el parámetro Status se establezca en wdXMLValidationStatusOK.
- ClearedAutomatically
Tipo: System.Boolean
true para borrar el mensaje de error automáticamente en cuanto el siguiente evento de validación aparezca en el nodo especificado.false para requerir la ejecución del método SetValidationError con un parámetro Status de wdXMLValidationStatusOK para borrar el texto de error personalizado.
Comentarios
Para establecer el texto de error personalizado, utilice la constante wdXMLValidationStatusCustom.
Parámetros opcionales
Para obtener información sobre parámetros opcionales, vea Parámetros opcionales en las soluciones de Office.
Ejemplos
En el siguiente ejemplo de código se utiliza el método SetValidationError para establecer un mensaje de error de validación personalizado para XMLNode. Un controlador de eventos para el evento ValidationError muestra el mensaje de error de validación personalizado si no se valida XMLNode. En este ejemplo se supone que el documento actual contiene dos objetos XMLNode denominados CustomerAddress1Node y CustomerZipNode que se asignan a los elementos del esquema con un tipo de datos entero.
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]);
}
Seguridad de .NET Framework
- Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.