XMLNode.ValidationStatus 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 value that specifies whether an element or attribute is valid according to the attached schema.

public:
 property Microsoft::Office::Interop::Word::WdXMLValidationStatus ValidationStatus { Microsoft::Office::Interop::Word::WdXMLValidationStatus get(); };

public Microsoft.Office.Interop.Word.WdXMLValidationStatus ValidationStatus { get; }

member this.ValidationStatus : Microsoft.Office.Interop.Word.WdXMLValidationStatus

Public ReadOnly Property ValidationStatus As WdXMLValidationStatus

Property Value

WdXMLValidationStatus

One of the WdXMLValidationStatus values.

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 ValidationStatus property can be one of the following WdXMLValidationStatus values:

wdXMLValidationStatusCustom indicates that the SetValidationError method was used to set the ValidationErrorText[] property to a custom text string.
wdXMLValidationStatusOK indicates an XML element or attribute is valid according to the attached schema.

While these are the only two named constants the ValidationStatus property allows, there are many more unnamed values that come from the MSXML 5.0 component included with Microsoft Office Word.

Applies to

Share via