IVsTextManagerEvents.OnUserPreferencesChanged Method

Fires when the user's global preferences are changed.

Namespace:  Microsoft.VisualStudio.TextManager.Interop
Assembly:  Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

'Declaration
Sub OnUserPreferencesChanged ( _
    pViewPrefs As VIEWPREFERENCES(), _
    pFramePrefs As FRAMEPREFERENCES(), _
    pLangPrefs As LANGPREFERENCES(), _
    pColorPrefs As FONTCOLORPREFERENCES() _
)

void OnUserPreferencesChanged(
    VIEWPREFERENCES[] pViewPrefs,
    FRAMEPREFERENCES[] pFramePrefs,
    LANGPREFERENCES[] pLangPrefs,
    FONTCOLORPREFERENCES[] pColorPrefs
)

void OnUserPreferencesChanged(
    [InAttribute] array<VIEWPREFERENCES>^ pViewPrefs, 
    [InAttribute] array<FRAMEPREFERENCES>^ pFramePrefs, 
    [InAttribute] array<LANGPREFERENCES>^ pLangPrefs, 
    [InAttribute] array<FONTCOLORPREFERENCES>^ pColorPrefs
)

abstract OnUserPreferencesChanged : 
        pViewPrefs:VIEWPREFERENCES[] * 
        pFramePrefs:FRAMEPREFERENCES[] * 
        pLangPrefs:LANGPREFERENCES[] * 
        pColorPrefs:FONTCOLORPREFERENCES[] -> unit 

function OnUserPreferencesChanged(
    pViewPrefs : VIEWPREFERENCES[], 
    pFramePrefs : FRAMEPREFERENCES[], 
    pLangPrefs : LANGPREFERENCES[], 
    pColorPrefs : FONTCOLORPREFERENCES[]
)

Parameters

• pViewPrefs
  Type: array<Microsoft.VisualStudio.TextManager.Interop.VIEWPREFERENCES[]
  [in] Pointer to the VIEWPREFERENCES structure. This structure provides the current settings for the view. If this is non-nulla null reference (Nothing in Visual Basic), preferences that specifically affect text view behavior have changed.

• pFramePrefs
  Type: array<Microsoft.VisualStudio.TextManager.Interop.FRAMEPREFERENCES[]
  [in] Pointer to the FRAMEPREFERENCES structure, which allows the frame to control whether the view shows horizontal or vertical scroll bars. If this is non-NULL, preferences that specifically affect code windows have changed.

• pLangPrefs
  Type: array<Microsoft.VisualStudio.TextManager.Interop.LANGPREFERENCES[]
  [in] Pointer to the relevant language as specified by the szFileType and guidLang members of the LANGPREFERENCES structure. If this is non-nulla null reference (Nothing in Visual Basic), preferences that affect a specific language's common settings have changed.

• pColorPrefs
  Type: array<Microsoft.VisualStudio.TextManager.Interop.FONTCOLORPREFERENCES[]
  [in] Specifies color preferences. If non-nulla null reference (Nothing in Visual Basic), the pguidColorService member of the FONTCOLORPREFERENCES structure indicates which colorable item provider is associated with the pColorTable member. If this is non-nulla null reference (Nothing in Visual Basic), preferences that affect the colors or font used by a text view have changed.

Remarks

COM Signature

From textmgr.idl:

HRESULT IVsTextManagerEvents::OnUserPreferencesChanged(
   [in] const VIEWPREFERENCES * pViewPrefs,
   [in] const FRAMEPREFERENCES * pFramePrefs,
   [in] const LANGPREFERENCES * pLangPrefs,
   [in] const FONTCOLORPREFERENCES * pColorPrefs
);

Use this method to modify your application in response to changes in user preferences. When the user changes global preferences, either due to changing settings from the Options command in the Tools menu or due to invoking a command, such as hitting the Insert key, this event is fired.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IVsTextManagerEvents Interface

Microsoft.VisualStudio.TextManager.Interop Namespace