ImageLibrary Class

Visual Studio 2015

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

Inheritance Hierarchy

System::Object
Microsoft.VisualStudio.PlatformUI::DisposableObject
Microsoft.VisualStudio.Imaging::ImageLibrary

Syntax

C++

[GuidAttribute("8fa80f44-0b82-4a81-9264-ca9e36fa70e4")]
public ref class ImageLibrary : DisposableObject

Constructors

	Name	Description
	ImageLibrary(Boolean, ITracer^)	Initializes a new instance of an ImageLibrary object.

Properties

	Name	Description
	AlternateDebugColor	Gets the alternate color of the border rendered in debug mode.
	CachedImageCount	Gets the number of images that are being stored in the image cache.
	DebugColor	Gets the color of the border rendered in debug mode’
	DebugMode	Determines whether or not images should be rendered in debug mode, which adds a colored border.
	Default	Gets the default instance of ImageLibrary.
	IsCaching	Indicates whether the library is caching its contents.
	IsDisposed	This API supports the product infrastructure and is not intended to be used directly from your code. Returns whether the object has been disposed once, which protects against double disposal.(Inherited from DisposableObject.)
	Tracer	Gets the tracer for the library.

Methods

	Name	Description
	AddCustomCompositeImage(Int16Size, array<ImageCompositionLayer>^)	Creates a custom image that is composed of multiple other images, and adds that image to the library.
	AddCustomImage(ImageSource^, Boolean)	Adds a custom image to the library, directly via an already-created ImageSource.
	AddCustomImageList(array<ImageMoniker>^)	Adds a custom image list to the library.
	Deserialize(Stream^, Boolean, ITracer^, IStreamStorage<String^>^)	Deserializes an image library from stream.
	Dispose()	This API supports the product infrastructure and is not intended to be used directly from your code. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.(Inherited from DisposableObject.)
	Dispose(Boolean)	This API supports the product infrastructure and is not intended to be used directly from your code. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Standard virtual overload for IDisposable pattern.(Inherited from DisposableObject.)
	DisposeManagedResources()	Disposes the managed resources.(Overrides DisposableObject::DisposeManagedResources().)
	DisposeNativeResources()	This API supports the product infrastructure and is not intended to be used directly from your code. Allows derived classes to provide custom dispose handling for native resources.(Inherited from DisposableObject.)
	Equals(Object^)	(Inherited from Object.)
	Finalize()	This API supports the product infrastructure and is not intended to be used directly from your code. Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from DisposableObject.)
	GetCacheSize(Int64, Int64)	Get the number bytes are actually used by the cache.
	GetHashCode()	(Inherited from Object.)
	GetImage(ImageMoniker, ImageAttributes)	Returns an image conforming to attributes from the library.
	GetImageCount()	The total number of images in the library. Determining the count may be expensive for custom images, which are stored weakly.
	GetImageListCount()	The total number of image lists in the library. Determining the count may be expensive for custom images, which are stored weakly.
	GetImageListMonikers()	Gets the monikers of all the image lists in the library.
	GetImageListMonikers(ImageMoniker)	Gets the monikers of all the image lists in the library.
	GetImageMonikers()	Gets the monikers of all of the images in the library.
	GetImageMonikerType(ImageMoniker)	Determines whether the ImageMoniker was added as a custom image, loaded from manifest, or neither, meaning we don't have an image with that moniker.
	GetType()	(Inherited from Object.)
	Load(IEnumerable<String^>^, Boolean, ITracer^, IStreamStorage<String^>^)	Loads an ImageLibrary from a collection of manifests.
	Load(String^, Boolean, ITracer^, IStreamStorage<String^>^)	Loads an ImageLibrary from a manifest.
	MemberwiseClone()	(Inherited from Object.)
	RemoveCustomImage(IImageHandle^)	Removes a custom image from the library. The image must have been added by AddCustomImage.
	RemoveCustomImageList(IImageHandle^)	Removes a custom image list from the library. The image must have been added by AddCustomImageList.
	Serialize(Stream^)	Serializes the image library to stream.
	ThrowIfDisposed()	This API supports the product infrastructure and is not intended to be used directly from your code. Throws an ObjectDisposedException if this object has been disposed.(Inherited from DisposableObject.)
	ToString()	(Inherited from Object.)
	TryGetMonikerForExtension(String^, Boolean, ImageMoniker)	Attempts to get the moniker for the image to use for files whose extension matches extension. If we haven't already identified the image to use, we'll attempt to identify it using the DefaultIcon property of the registered ProgID for the extension.
	TryGetMonikerForProgId(String^, Boolean, ImageMoniker)	Attempts to get the moniker for the image to use for files matching progId. If we haven't already identified the image to use, we'll attempt to identify it using the DefaultIcon property of progId.

Fields

	Name	Description
	BeforeImageRealized	Raised before an image is realized from it source. If the image is realized by retrieving it from the cache, this event is not raised.
	DefaultGrayscaleBiasColor	The default color for biasing grayscale images (#40FFFFFF). This produces a 75% translucent effect.
	HighContrastGrayscaleBiasColor	The color for biasing grayscale images when in high-contrast mode.
	InvalidImageMoniker	The invalid image moniker. Images using this moniker cannot be loaded from an image manifest.
	NeutralSize	The size to use when specifying a size-neutral image in a call to AddCustomImage. The size-neutral image is the image that is scaled to the requested size when an image of the requested size is not available.

Events

	Name	Description
	BuildLibraryCache	Raised when the library cache is built.
	Disposing	This API supports the product infrastructure and is not intended to be used directly from your code. Raised when the event is being disposed, that is, while it is still accessible.(Inherited from DisposableObject.)
	ImageLibraryCreated	Raised when the ImageLibrary is created.
	ImageLibraryDisposed	Raised when the ImageLibrary is disposed.
	ProcessManifest	Raised when there is a process manifest.

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.