Share via


SharePointProjectItemIconAttribute Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Specifies the icon to display in Solution Explorer for a custom project item type.

Inheritance Hierarchy

System.Object
  System.Attribute
    Microsoft.VisualStudio.SharePoint.SharePointProjectItemIconAttribute

Namespace:  Microsoft.VisualStudio.SharePoint
Assembly:  Microsoft.VisualStudio.SharePoint (in Microsoft.VisualStudio.SharePoint.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, Inherited := False, AllowMultiple := True)> _
<MetadataAttributeAttribute> _
Public NotInheritable Class SharePointProjectItemIconAttribute _
    Inherits Attribute
[AttributeUsageAttribute(AttributeTargets.Class, Inherited = false, AllowMultiple = true)]
[MetadataAttributeAttribute]
public sealed class SharePointProjectItemIconAttribute : Attribute

The SharePointProjectItemIconAttribute type exposes the following members.

Constructors

  Name Description
Public method SharePointProjectItemIconAttribute Initializes a new instance of the SharePointProjectItemIconAttribute class.

Top

Properties

  Name Description
Public property IconResourceName Gets or sets the namespace qualified name of an embedded .bmp or .ico resource to use as the icon for a custom project item type.
Public property TypeId When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

  Name Description
Public method Equals Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from Attribute.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsDefaultAttribute When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
Public method Match When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method _Attribute.GetIDsOfNames Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfo Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.GetTypeInfoCount Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
Explicit interface implemetationPrivate method _Attribute.Invoke Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

Remarks

Apply this attribute to an implementation of the ISharePointProjectItemTypeProvider interface to specify the icon to display for the project item type. For more information, see How to: Define a SharePoint Project Item Type.

Use an embedded 24-bit .bmp or .ico resource for the icon, with magenta (255,0,255) as the transparent color. The recommended size for icons is 16 pixels wide by 16 pixels high.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.SharePoint Namespace