XMLNode.ValidationErrorText Property

Reference

Definition

Namespace:: Microsoft.Office.Tools.Word

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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a string that represents the description for a validation error on an XMLNode control.

public:
 property Microsoft::Office::Tools::Word::XMLNode_ValidationErrorTextType ^ ValidationErrorText { Microsoft::Office::Tools::Word::XMLNode_ValidationErrorTextType ^ get(); };

public Microsoft.Office.Tools.Word.XMLNode_ValidationErrorTextType ValidationErrorText { get; }

member this.ValidationErrorText : Microsoft.Office.Tools.Word.XMLNode_ValidationErrorTextType

Public ReadOnly Property ValidationErrorText As XMLNode_ValidationErrorTextType

Property Value

XMLNode_ValidationErrorTextType

A string that represents the description for a validation error on an XMLNode control.

Examples

The following code example sets the text value of an XMLNode and validates the node by using the Validate method. The example then uses the ValidationStatus property to determine whether the node validated. If the node did not validate, then the example uses the ValidationErrorText property to display the validation error message. This example assumes that the current document contains an XMLNode named CustomerAddress1Node. If CustomerAddress1Node maps to a schema element that has an integer data type, then the validation will fail.

private void ValidateNode()
{
    this.CustomerAddress1Node.NodeText = "Nineteen Hundred";
    this.CustomerAddress1Node.Validate();

    if (this.CustomerAddress1Node.ValidationStatus ==
        Word.WdXMLValidationStatus.wdXMLValidationStatusOK)
    {
        MessageBox.Show("'" + this.CustomerAddress1Node.BaseName +
            "' validates.");
    }
    else
    {
        MessageBox.Show("'" + this.CustomerAddress1Node.BaseName +
            "': " + this.CustomerAddress1Node.ValidationErrorText[false]);
    }
}

Private Sub ValidateNode()
    Me.CustomerAddress1Node.NodeText = "Nineteen Hundred"
    Me.CustomerAddress1Node.Validate()

    If Me.CustomerAddress1Node.ValidationStatus = _
        Word.WdXMLValidationStatus.wdXMLValidationStatusOK Then
        MsgBox("'" & Me.CustomerAddress1Node.BaseName & "' validates.")
    Else
        MsgBox("'" & Me.CustomerAddress1Node.BaseName & _
            "': " & Me.CustomerAddress1Node.ValidationErrorText(False))
    End If
End Sub

Remarks

The ValidationErrorText property is intended to be used with the following parameter.

Parameter	Description
`Advanced`	`true` to display the advanced version of the validation error description, which comes from the MSXML 5.0 component included with Microsoft Office Word; otherwise, `false`.

If you use the ValidationErrorText property without specifying a parameter, it returns a XMLNode_ValidationErrorTextType object that not intended to be used directly from your code.

Optional Parameters

For information on optional parameters, see Optional Parameters in Office Solutions.

Applies to