IVsUIShell.RefreshPropertyBrowser(Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Makes it possible for a project (or any other selected object being browsed by the Properties window) to keep the Properties window in sync with property changes without implementing IConnectionPointContainer and firing OnChanged(Int32) events.

public:
 int RefreshPropertyBrowser(int dispid);

public:
 int RefreshPropertyBrowser(int dispid);

int RefreshPropertyBrowser(int dispid);

public int RefreshPropertyBrowser (int dispid);

abstract member RefreshPropertyBrowser : int -> int

Public Function RefreshPropertyBrowser (dispid As Integer) As Integer

Parameters

dispid: Int32

[in] Dispatch ID of the property that has changed. Pass DISPID_UNKNOWN to refresh all properties.

Returns

Int32

S_OK if the method succeeds, otherwise a failure code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsUIShell::RefreshPropertyBrowser(  
   [in]DISPID dispid  
);

Implementing IConnectionPointContainer on the selectable objects of a hierarchy is more work than is required. When the properties of an object changes, the object can call IVsUIShell.RefreshPropertyBrowser to tell the Properties window to update (at the same point the object would otherwise have been expected to fire OnChanged).

Applies to