Timer.SynchronizingObject Propriedade

Definição

Namespace:

System.Timers

Assembly:

System.ComponentModel.TypeConverter.dll

Origem:

Timer.cs

Obtém ou define o objeto usado para realizar marshaling das chamadas do manipulador de eventos emitidas ao término de um intervalo.

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

Valor da propriedade

ISynchronizeInvoke

O ISynchronizeInvoke que representa o objeto usado para realizar marshaling das chamadas do manipulador de eventos emitidas ao término de um intervalo. O padrão é null.

Exemplos

O exemplo a seguir é um aplicativo Windows Forms que serve como um editor de arquivos de texto muito simples. Quando o texto na caixa de texto não tiver sido salvo, o aplicativo perguntará ao usuário em intervalos de um minuto se ele deseja salvar o conteúdo da caixa de texto. Para fazer isso, a Interval propriedade é definida como um minuto (60.000 milissegundos) e a SynchronizingObject propriedade é definida como o Form objeto .

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

O exemplo exige que você adicione os seguintes controles ao formulário:

• Um TextBox controle chamado TextBox1 (seu nome padrão).

• Um Button controle chamado Button1 (seu nome padrão).

• Um SaveFileDialog controle chamado SaveSaveFileDialog1 (seu nome padrão) .

Comentários

Quando SynchronizingObject é null, o método que manipula o Elapsed evento é chamado em um thread do pool de threads do sistema. Para obter mais informações sobre pools de threads do sistema, consulte ThreadPool.

Quando o Elapsed evento é manipulado por um componente visual Windows Forms, como um botão, acessar o componente por meio do pool de threads do sistema pode resultar em uma exceção ou simplesmente não funcionar. Evite esse efeito definindo SynchronizingObject como um componente Windows Forms, o que faz com que o método que manipula o Elapsed evento seja chamado no mesmo thread no qual o componente foi criado.

Observação

Mesmo se a SynchronizingObject propriedade não nullfor , Elapsed os eventos poderão ocorrer depois que o Dispose método ou Stop tiver sido chamado ou depois que a Enabled propriedade tiver sido definida falsecomo , porque o sinal para acionar o Elapsed evento sempre será enfileirado para execução em um thread do pool de threads. Uma maneira de resolve essa condição de corrida é definir um sinalizador que informa ao manipulador de eventos para que o Elapsed evento ignore os eventos subsequentes.

Se o for usado dentro do Timer Visual Studio em um designer de Windows Forms, SynchronizingObject será definido automaticamente como o controle que contém o Timer. Por exemplo, se você colocar um em um Timer designer para Form1 (que herda de Form), a SynchronizingObject propriedade de Timer será definida como a instância de Form1.

Confira também

• Form
• ISynchronizeInvoke
• ThreadPool
• Elapsed