XMLNode.SetValidationError - метод

Статья
05/19/2013

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

Пространство имен: Microsoft.Office.Tools.Word
Сборка: Microsoft.Office.Tools.Word (в Microsoft.Office.Tools.Word.dll)

Синтаксис

'Декларация
Sub SetValidationError ( _
    Status As WdXMLValidationStatus, _
    ByRef ErrorText As Object, _
    ClearedAutomatically As Boolean _
)

void SetValidationError(
    WdXMLValidationStatus Status,
    ref Object ErrorText,
    bool ClearedAutomatically
)

Параметры

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

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

ClearedAutomatically
Тип: System.Boolean
Значение true, чтобы автоматически очистить сообщение об ошибке, как только в указанном узле произойдет очередное событие проверки.Значение false, чтобы требовать выполнения метода SetValidationError с параметром Status равным wdXMLValidationStatusOK для удаления пользовательского текста ошибки.

Заметки

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

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

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

Примеры

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

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

Безопасность платформы .NET Framework

Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.

См. также

Ссылки

XMLNode Интерфейс

Microsoft.Office.Tools.Word - пространство имен

Поделиться через