Timer.SynchronizingObject Vlastnost

Definice

Obor názvů:

System.Timers

Sestavení:

netstandard.dll, System.ComponentModel.TypeConverter.dll

Zdroj:

Timer.cs

Získá nebo nastaví objekt použitý k zařazování volání obslužné rutiny události, které jsou vydány při uplynutí intervalu.

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

Hodnota vlastnosti

ISynchronizeInvoke

Reprezentace ISynchronizeInvoke objektu použitého k zařazování volání obslužné rutiny události, které jsou vydány při uplynutí intervalu. Výchozí hodnota je null.

Příklady

Následující příklad je aplikace Windows Forms, která slouží jako velmi jednoduchý textový editor souborů. Pokud text v textovém poli nebyl uložen, aplikace požádá uživatele v minutových intervalech, jestli chce uložit obsah textového pole. K tomu Interval je vlastnost nastavena na jednu minutu (60 000 milisekund) a SynchronizingObject vlastnost je nastavena na Form objekt.

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

Příklad vyžaduje, abyste do formuláře přidali následující ovládací prvky:

• Ovládací TextBox prvek s názvem TextBox1 (výchozí název).

• Ovládací Button prvek s názvem Button1 (výchozí název).

• Ovládací SaveFileDialog prvek s názvem SaveSaveFileDialog1 (výchozí název) .

Poznámky

Kdy SynchronizingObject je nullmetoda, která zpracovává Elapsed událost, je volána ve vlákně z fondu systém-vlákno. Další informace o fondech systémových vláken naleznete v tématu ThreadPool.

Elapsed Když je událost zpracována vizuální komponentou Modelu Windows Forms, například tlačítkem, může přístup ke komponentě prostřednictvím fondu systémových vláken vést k výjimce nebo nemusí fungovat. Vyhněte se tomuto efektu nastavením SynchronizingObject komponenty Windows Forms, která způsobí, že metoda, která zpracovává Elapsed událost, bude volána ve stejném vlákně, ve kterém byla komponenta vytvořena.

Poznámka:

I v případě SynchronizingObject , že vlastnost není null, Elapsed události mohou nastat po Dispose volání nebo metody byla Stop volána nebo po Enabled vlastnosti nastavena na false, protože signál pro vyvolání Elapsed události je vždy zařazen do fronty pro spuštění ve vlákně fondu vláken. Jedním ze způsobů, jak tento stav časování vyřešit, je nastavit příznak, který obslužné rutině Elapsed události říká, aby událost ignorovala následné události.

Timer Pokud se používá uvnitř sady Visual Studio v návrháři Windows Forms, SynchronizingObject je automaticky nastaven na ovládací prvek, který obsahuje Timer. Pokud například umístíte Timer návrháře ( Form1 který dědí z Form), SynchronizingObject vlastnost Timer je nastavena na instanci Form1.

Viz také

• Form
• ISynchronizeInvoke
• ThreadPool
• Elapsed