Interface IPropertyNotifySink

public interface IPropertyNotifySink extends IUnknown
{
  // Fields
  public static final _Guid iid;

  // Methods
  public void OnChanged(int dispID);
  public void OnRequestEdit(int dispID);
}

This interface provides methods that allow a sink object to receive notifications about property changes from another object. The notifying object must support IPropertyNotifySink as an outgoing interface. The client that needs to receive notifications creates a sink with this interface and connects it to the connectable object by using the connection point mechanism.

The notifying object is required to call the methods of IPropertyNotifySink when it changes a property marked with the bindable attribute or when it is about to change a property marked with the requestedit attribute. There is one exception: no notifications are sent to the sink object as a result of an object's initialization or loading procedures. Therefore, notifications to the IPropertyNotifySink interface are meaningful only in the context of a fully loaded and initialized object.

The sink object throws a ComException object (either a ComFailException or a ComSuccessException) to signal that it does not want a requestedit property to be changed. The notifying object must honor the sink object's request not to change the property.

This interface wraps the Component Object Model (COM) IPropertyNotifySink interface.

IUnknown
  |
  +--IPropertyNotifySink

Methods

OnChanged

public void OnChanged(int dispID);

Notifies a sink object that a bindable property has changed.

Return Value:

No return value.

Parameter	Description
dispID	The identifier of the object that is notified.

OnRequestEdit

public void OnRequestEdit(int dispID);

Notifies a sink object that a requestedit property is about to change.

Return Value:

No return value.

Parameter	Description
dispID	The identifier of the object that is notified.

Remarks:

On return from a call to this method, the notifying object must honor the action specified by the sink object. For example, if the sink object does not allow the property change, the notifying object cannot make the change.

Fields

iid

The interface identifier.