Condividi tramite


ColorableItem.GetDefaultColors(COLORINDEX[], COLORINDEX[]) Method

Definition

Returns the foreground and background color for this colorable item.

public:
 virtual int GetDefaultColors(cli::array <Microsoft::VisualStudio::TextManager::Interop::COLORINDEX> ^ foreColor, cli::array <Microsoft::VisualStudio::TextManager::Interop::COLORINDEX> ^ backColor);
public:
 virtual int GetDefaultColors(Platform::Array <Microsoft::VisualStudio::TextManager::Interop::COLORINDEX> ^ foreColor, Platform::Array <Microsoft::VisualStudio::TextManager::Interop::COLORINDEX> ^ backColor);
 virtual int GetDefaultColors(std::Array <Microsoft::VisualStudio::TextManager::Interop::COLORINDEX> const & foreColor, std::Array <Microsoft::VisualStudio::TextManager::Interop::COLORINDEX> const & backColor);
public virtual int GetDefaultColors (Microsoft.VisualStudio.TextManager.Interop.COLORINDEX[] foreColor, Microsoft.VisualStudio.TextManager.Interop.COLORINDEX[] backColor);
abstract member GetDefaultColors : Microsoft.VisualStudio.TextManager.Interop.COLORINDEX[] * Microsoft.VisualStudio.TextManager.Interop.COLORINDEX[] -> int
override this.GetDefaultColors : Microsoft.VisualStudio.TextManager.Interop.COLORINDEX[] * Microsoft.VisualStudio.TextManager.Interop.COLORINDEX[] -> int
Public Overridable Function GetDefaultColors (foreColor As COLORINDEX(), backColor As COLORINDEX()) As Integer

Parameters

foreColor
COLORINDEX[]

[in, out] If not null, this is where the COLORINDEX value for the text's foreground color is returned.

backColor
COLORINDEX[]

[in, out] If not null, this is where the COLORINDEX value for the text's background color is returned.

Returns

If successful, returns S_OK; otherwise, returns an error code.

Implements

Remarks

The colors returned as the ones passed to the constructor.

The base method always returns S_OK. The base method is tolerant of a null value for foreColor and backColor so only one of the colors can be retrieved as desired.

Applies to