XMLNode.SetValidationError(WdXMLValidationStatus, Object, Boolean) Метод

Определение

Пространство имен:

Microsoft.Office.Tools.Word

Сборка:

Microsoft.Office.Tools.Word.dll

Изменяет текст выдаваемого пользователю сообщения об ошибке для элемента управления XMLNode и принудительно указывает приложению Microsoft Office Word, что узел является недопустимым.

public void SetValidationError (Microsoft.Office.Interop.Word.WdXMLValidationStatus Status, ref object ErrorText, bool ClearedAutomatically = true);

abstract member SetValidationError : Microsoft.Office.Interop.Word.WdXMLValidationStatus * obj * bool -> unit

Public Sub SetValidationError (Status As WdXMLValidationStatus, Optional ByRef ErrorText As Object, Optional ClearedAutomatically As Boolean = true)

Параметры

Status

WdXMLValidationStatus

Одно из значений WdXMLValidationStatus, указывающих, следует ли задавать текст сообщения об ошибке состояния проверки (wdXMLValidationStatusCustom) либо очистить текст сообщения об ошибке состояния проверки (wdXMLValidationStatusOK).

ErrorText

Object

Отображаемый для пользователя текст. Оставьте пустым, Status если параметр имеет значение wdXMLValidationStatusOK.

ClearedAutomatically

Boolean

Значение true, чтобы автоматически очистить сообщение об ошибке, как только в указанном узле произойдет очередное событие проверки. false значение , чтобы требовать выполнения SetValidationError(WdXMLValidationStatus, Object, Boolean) метода с параметром Status , wdXMLValidationStatusOK чтобы очистить текст пользовательской ошибки.

Примеры

В следующем примере кода метод используется SetValidationError для задания пользовательского сообщения об ошибке XMLNodeпроверки для . Обработчик событий для ValidationError события отображает пользовательское сообщение об ошибке проверки, XMLNode если не выполняет проверку. В этом примере предполагается, что текущий документ содержит два XMLNode объекта с именем CustomerAddress1Node и CustomerZipNode , сопоставленные с элементами схемы с целочисленным типом данных.

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

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

Комментарии

Чтобы задать пользовательский текст ошибки, используйте константу wdXMLValidationStatusCustom .

Необязательные параметры

Сведения о необязательных параметрах см. в разделе Необязательные параметры в решениях Office.