CommonImageSourceProvider Class
Provides IntelliPrompt with a common Image that is included in the SyntaxEditor assembly as a resource.
public class CommonImageSourceProvider : IImageSourceProvider
- Inheritance:
- object object
- Implements:
- IImageSourceProvider
Constructors
CommonImageSourceProvider(CommonImageKind)
Provides IntelliPrompt with a common Image that is included in the SyntaxEditor assembly as a resource.
public CommonImageSourceProvider(CommonImageKind imageKind)
| Parameter | Type | Description |
|---|---|---|
| imageKind | CommonImageKind | The CommonImageKind indicating the common image type. |
Properties
DefaultImageSet
The CommonImageSet indicating the set of images from which to pull.
public static CommonImageSet DefaultImageSet { get; set; }
Property Value
- CommonImageSet:
The default value is MetroLight.
ImageKind
The CommonImageKind indicating the kind of common image.
RasterScaleFactor
The default scale factor to apply to raster images.
public static SizeF RasterScaleFactor { get; set; }
Property Value
Methods
GetImageSource()
Returns the Image to use in an IntelliPrompt user interface element based on the default image set;
GetImageSource(CommonImageSet)
Returns the Image to use in an IntelliPrompt user interface element based on the specified image set.
public virtual Image GetImageSource(CommonImageSet imageSet)
| Parameter | Type | Description |
|---|---|---|
| imageSet | CommonImageSet |
Returns
GetImageSource(Color?)
Returns the Image to use in an IntelliPrompt user interface element, using the specified background color hint to select a color set, and falling back to DefaultImageSet as needed.
public Image GetImageSource(Color? backgroundColorHint)
| Parameter | Type | Description |
|---|---|---|
| backgroundColorHint | Color? | A background color that can provide a hint about the most appropriate color set (e.g,. light images for light backgrounds). |
Returns
Inherited Members
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()