Timer.SynchronizingObject Свойство

Определение

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

System.Timers

Сборка:

System.ComponentModel.TypeConverter.dll

Исходный код:

Timer.cs

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

public:
 property System::ComponentModel::ISynchronizeInvoke ^ SynchronizingObject { System::ComponentModel::ISynchronizeInvoke ^ get(); void set(System::ComponentModel::ISynchronizeInvoke ^ value); };

public System.ComponentModel.ISynchronizeInvoke? SynchronizingObject { get; set; }

member this.SynchronizingObject : System.ComponentModel.ISynchronizeInvoke with get, set

Public Property SynchronizingObject As ISynchronizeInvoke

Значение свойства

ISynchronizeInvoke

ISynchronizeInvoke, представляющий объект, используемый для маршалинга вызовов обработчика событий, осуществленных после истечения интервала времени. Значение по умолчанию — null.

Примеры

В следующем примере показано приложение Windows Forms, которое служит очень простым редактором текстовых файлов. Если текст в текстовом поле не был сохранен, приложение с интервалом в одну минуту запрашивает у пользователя, нужно ли сохранить содержимое текстового поля. Для этого свойству Interval присваивается значение одной минуты (60 000 миллисекунд), а свойству SynchronizingObject присваивается Form объект .

using System;
using System.IO;
using  Timers = System.Timers;
using System.Windows.Forms;
public partial class Form1 : Form
{
    Timers.Timer timer = null;
    StreamWriter sw = null;
    bool hasChanged = false;
    bool dialogIsOpen = false;
    int elapsedMinutes = 0;
    // Cache the text box cache internally without saving it.
    String txt = "";

    public Form1()
    {
        InitializeComponent();

        this.Text = "Quick Text Editor";
        button1.Text = "Save";
        textBox1.Multiline = true;

        // Configure the SaveFile dialog
        saveFileDialog1.Filter = "txt files (*.txt)|*.txt|All files (*.*)|*.*";
        saveFileDialog1.RestoreDirectory = true;

        // Create a timer with a 1-minute interval
        timer = new Timers.Timer(60000);
        // Define the event handler
        timer.Elapsed += this.PromptForSave;
        // Synchronize the timer with the text box
        timer.SynchronizingObject = this;
        // Start the timer
        timer.AutoReset = true;
    }

    private void PromptForSave(Object source, Timers.ElapsedEventArgs e)
    {
        if (hasChanged & (!dialogIsOpen)) {
            elapsedMinutes++;
            dialogIsOpen = true;
            if (MessageBox.Show(String.Format("{0} minutes have elapsed since the text was saved. Save it now? ",
                elapsedMinutes), "Save Text",
                MessageBoxButtons.YesNoCancel, MessageBoxIcon.Question) == DialogResult.Yes)
            {
                button1_Click(this, EventArgs.Empty);
                dialogIsOpen = false;
            }
        }
    }

    private void button1_Click(Object sender, EventArgs e)
    {
        if (String.IsNullOrEmpty(saveFileDialog1.FileName)) {
            if (saveFileDialog1.ShowDialog() == DialogResult.OK)
                sw = new StreamWriter(saveFileDialog1.FileName, false);
        }
        txt = textBox1.Text;
        hasChanged = false;
        timer.Stop();
    }

    private void form1_FormClosing(Object sender, FormClosingEventArgs e)
    {
        if (sw != null) {
            sw.Write(txt);
            sw.Close();
        }
    }

    private void textBox1_TextChanged(Object sender, EventArgs e)
    {
        hasChanged = true;
        timer.Start();
    }
}

Imports System.IO
Imports System.Timers

Public Class Form1
   ' Create the timer to fire at a 60-second interval.
   Dim WithEvents timer As New System.Timers.Timer(60000)
   Dim sw As StreamWriter
   Dim hasChanged As Boolean
   Dim dialogIsOpen As Boolean = False
   Dim elapsedMinutes As Integer = 0
   ' Cache the text box internally without saving it.
   Dim txt As String = ""

   Public Sub Form1_Load(sender As Object, e As EventArgs) Handles Me.Load
      Me.Text = "Quick Text Editor"
      Button1.Text = "Save"
      TextBox1.Multiline = True

      ' Configure the SaveFile dialog
      SaveFileDialog1.Filter = "txt files (*.txt)|*.txt|All files (*.*)|*.*"
      SaveFileDialog1.RestoreDirectory = True

      ' Create a timer with a 1-minute interval
      timer = New Timer(2000)
      ' Synchronize the timer with the text box
      timer.SynchronizingObject = Me
      ' Start the timer
      timer.AutoReset = True
   End Sub

    Private Sub TextBox1_TextChanged(sender As Object, e As EventArgs) Handles TextBox1.TextChanged
      hasChanged = True
      timer.Start()
   End Sub
   Friend Sub PromptForSave(sender As Object, e As ElapsedEventArgs) _
      Handles timer.Elapsed
      If hasChanged And Not dialogIsOpen Then
         elapsedMinutes += 1
         dialogIsOpen = True
         If MsgBox(String.Format("{0} minutes have elapsed since the text was saved. Save it now? ",
                                 elapsedMinutes), MsgBoxStyle.YesNoCancel Or MsgBoxStyle.Question,
                   "Save Text") = MsgBoxResult.Yes Then
            If dialogIsOpen Then
               Button1_Click(Me, EventArgs.Empty)
               dialogIsOpen = False
            End If
         End If
      End If
   End Sub

   Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click
      If String.IsNullOrEmpty(SaveFileDialog1.FileName) Then
         If SaveFileDialog1.ShowDialog() = DialogResult.OK Then
            sw = New StreamWriter(SaveFileDialog1.FileName, False)
         End If
      End If
      txt = TextBox1.Text
      hasChanged = False
      elapsedMinutes = 0
      timer.Stop()
   End Sub

   Private Sub Form1_FormClosing(sender As Object, e As FormClosingEventArgs) Handles Me.FormClosing
      If sw IsNot Nothing Then
         sw.Write(txt)
         sw.Close()
      End If
   End Sub
End Class

В этом примере необходимо добавить следующие элементы управления в форму:

• Элемент TextBox управления с именем TextBox1 (имя по умолчанию).

• Элемент Button управления с именем Button1 (имя по умолчанию).

• Элемент SaveFileDialog управления с именем SaveSaveFileDialog1 (имя по умолчанию).

Комментарии

Если SynchronizingObject имеет значение null, метод, обрабатывающий Elapsed событие, вызывается в потоке из пула системных потоков. Дополнительные сведения о пулах системных потоков см. в разделе ThreadPool.

Elapsed Если событие обрабатывается компонентом визуального Windows Forms, например кнопкой, доступ к компоненту через пул системных потоков может привести к исключению или просто не работать. Избегайте этого эффекта, задав SynchronizingObject для Windows Forms компонент, что приводит к вызову метода, обрабатывающего Elapsed событие, в том же потоке, в котором был создан компонент.

Примечание

Даже если SynchronizingObject свойство не nullравно , Elapsed события могут возникать после Dispose вызова метода или Stop после того, как свойству Enabled присвоено значение false, так как сигнал для вызова события всегда помещается в Elapsed очередь для выполнения в потоке пула потоков. Одним из способов устранения этого состояния гонки является установка флага, который сообщает обработчику событий о необходимости игнорировать последующие Elapsed события.

Timer Если используется внутри Visual Studio в конструкторе Windows Forms, SynchronizingObject автоматически устанавливается элемент управления , содержащий Timer. Например, если поместить Timer в конструктор для Form1 (который наследуется от Form), свойству SynchronizingObjectTimer присваивается экземпляр Form1.

См. также раздел

• Form
• ISynchronizeInvoke
• ThreadPool
• Elapsed