SynchronizingObject Property

Gets or sets the object used to marshal event-handler calls when they are raised.

[Visual Basic]
<DescriptionAttribute("Gets or sets the object used to marshal event-handler calls when they are raised.")>
Public Property SynchronizingObject As ISynchronizeInvoke

[C#]
[DescriptionAttribute("Gets or sets the object used to marshal event-handler calls when they are raised.")]
public ISynchronizeInvoke SynchronizingObject {get; set;}

[C++]
[DescriptionAttribute("Gets or sets the object used to marshal event-handler calls when they are raised.")]
public: __property ISynchronizeInvoke* get_SynchronizingObject();
public: __property void set_SynchronizingObject( 
   ISynchronizeInvoke* value
);

[C++/CLI]
[DescriptionAttribute("Gets or sets the object used to marshal event-handler calls when they are raised.")]
public:
property ISynchronizeInvoke^ SynchronizingObject {
   ISynchronizeInvoke^ get();
   void set (ISynchronizeInvoke^ value);
}

Return Type

The user interface object being used for thread synchronization. This property may be set at design-time in the IDE.

Remarks

Network data is received and processed on an IO completion thread, but many Windows forms applications need to marshal data to the UI thread before updating UI controls with data. By setting this property to any UI control or form in your application, the library will utilize that object to raise all events on the UI thread. In this way you will be able to update UI controls without being concerned with thread safety.

If you do not set this property to a UI control, then all events are raised on a system IO completion thread and you are responsible for thread-safety and marshalling data to the UI thread when updating UI controls.

This property should not be set when used in ASP.NET applications.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows ME, Windows 2000, Windows XP, Windows Server 2003, Windows Vista

See Also

Validator Class  | Validator Members