IVsColorableItem 接口

2015-05-17

为自定义可着色项提供默认字体颜色、字体样式和项目名称信息。

命名空间： Microsoft.VisualStudio.TextManager.Interop
程序集： Microsoft.VisualStudio.TextManager.Interop（在 Microsoft.VisualStudio.TextManager.Interop.dll 中）

语法

声明
<InterfaceTypeAttribute()> _
<GuidAttribute("56694A40-78D0-45DD-AB15-681BC207579C")> _
Public Interface IVsColorableItem

[InterfaceTypeAttribute()]
[GuidAttribute("56694A40-78D0-45DD-AB15-681BC207579C")]
public interface IVsColorableItem

[InterfaceTypeAttribute()]
[GuidAttribute(L"56694A40-78D0-45DD-AB15-681BC207579C")]
public interface class IVsColorableItem

[<InterfaceTypeAttribute()>]
[<GuidAttribute("56694A40-78D0-45DD-AB15-681BC207579C")>]
type IVsColorableItem =  interface end

public interface IVsColorableItem

IVsColorableItem 类型公开以下成员。

方法

	名称	说明
	GetDefaultColors	定义自定义可着色项的默认值前景色和背景色。
	GetDefaultFontFlags	返回一个自定义可着色项的默认字体标志。
	GetDisplayName	获取一个自定义可着色项的显示名称。

页首

备注

应本地化显示名称对自定义可着色项。

从该接口返回的颜色值是预定义的颜色。深颜色 (24 位) 值可以通过 IVsHiColorItem 接口返回。有关示例参见 IVsHiColorItem 接口。

如何实现自定义可着色项在自定义可着色项所述。

对实现者的说明

实现此接口提供有关从语言服务返回的自定义可着色项的字体和名称信息。

如果要支持的颜色值，则必须实现在同一对象的 IVsHiColorItem 接口实现 IVsColorableItem 接口。

对调用者的说明

IVsColorableItem 对象可以调用 IVsProvideColorableItems 接口的 GetColorableItem 方法获取。

示例

此示例是从语言服务。

using Microsoft.VisualStudio.TextManager.Interop;

namespace MyNamespace
{
    internal class MyColorItem : IVsColorableItem
    {
        //==========================================================
        // Private fields.
        private COLORINDEX foreColor;
        private COLORINDEX backColor;
        private FONTFLAGS fontFlags;
        private string name;
        private string displayName;

        //==========================================================
        // Public constructor.

        public MyColorItem(string name,
                           string displayName,
                           COLORINDEX foreColor,
                           COLORINDEX backColor,
                           FONTFLAGS fontFlags)
        {
            this.name = name;
            this.displayName = displayName;
            this.foreColor = foreColor;
            this.backColor = backColor;
            this.fontFlags = fontFlags;
        }


        //==========================================================
        // IVsColorableItem methods.
        #region IVsColorableItem Members

        int IVsColorableItem.GetDefaultColors(COLORINDEX[] piForeground,
                                              COLORINDEX[] piBackground)
        {
            int retval = VSConstants.E_POINTER;
            if (piForeground != null)
            {
                piForeground[0] = this.foreColor;
                retval = VSConstants.S_OK;
            }
            if (piBackground != null)
            {
                piBackground[0] = this.backColor;
            }
            return retval;
        }

        int IVsColorableItem.GetDefaultFontFlags(out uint pdwFontFlags)
        {
            pdwFontFlags = (uint)this.fontFlags;
            return VSConstants.S_OK;
        }

        int IVsColorableItem.GetDisplayName(out string pbstrName)
        {
            pbstrName = this.displayName;
            return VSConstants.S_OK;
        }

        #endregion
    }


    //==============================================================
    // Example of how to instantiate the MyColorItem class.

    public class MyLanguageService
    {
        private ColorableItem[] colorableItemsList;

        public MyLanguageService()
        {
            colorableItemsList = {
                new MyColorableItem("MyLanguage- Text",
                                    "MyLanguage- Text",
                                    COLORINDEX.CI_SYSPLAINTEXT_FG,
                                    COLORINDEX.CI_SYSPLAINTEXT_BK,
                                    FONTFLAGS.FF_BOLD),

                new MyColorableItem("MyLanguage- Keyword",
                                    "MyLanguage- Keyword",
                                    COLORINDEX.CI_MAROON,
                                    COLORINDEX.CI_SYSPLAINTEXT_BK,
                                    FONTFLAGS.FF_BOLD),

                new MyColorableItem("MyLanguage- Operator",
                                    "MyLanguage- Operator",
                                    COLORINDEX.CI_DARKBLUE,
                                    COLORINDEX.CI_BLUE,
                                    FONTFLAGS.FF_PLAIN)
            };
        }
    }
}

通过

IVsColorableItem 接口

语法

方法

备注

示例

请参阅

参考

其他资源

其他资源