IVsFontAndColorDefaults.GetBaseCategory(Guid) 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.

IVsFontAndColorDefaults::GetBaseCategory allows a VSPackage that manages fonts and colors to change the behavior of the Use Defaults button of the Fonts and Colors properties page.

public:
 int GetBaseCategory([Runtime::InteropServices::Out] Guid % pguidBase);

public int GetBaseCategory (out Guid pguidBase);

abstract member GetBaseCategory : Guid -> int

Public Function GetBaseCategory (ByRef pguidBase As Guid) As Integer

Parameters

pguidBase: Guid

[out] Pointer to a GUID specifying the base category for a client.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsFontAndColorDefaults::GetBaseCategory(  
   [out] GUID *pguidBase  
);

If the Use Defaults button of the Fonts and Colors properties page is selected, settings are not automatically returning to their original default values (defined as the Category's implementation of the IVsFontAndColorDefaults interface).

Instead, users are prompted to choose the defaults defined for the original Category, or those defined for the Category returned by this method.

An example of this can be found in the Printer Category. A user selecting Use Defaults can choose to use the original defaults of the Printer Category or use the Text Editor Category as a default setting.

Applies to