|
//------------------------------------------------------------------------------
// <copyright file="TrackBarRenderer.cs" company="Microsoft">
// Copyright (c) Microsoft Corporation. All rights reserved.
// </copyright>
//------------------------------------------------------------------------------
namespace System.Windows.Forms {
using System;
using System.Drawing;
using System.Diagnostics.CodeAnalysis;
using System.Windows.Forms.VisualStyles;
using Microsoft.Win32;
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer"]/*' />
/// <devdoc>
/// <para>
/// This is a rendering class for the TrackBar control.
/// </para>
/// </devdoc>
public sealed class TrackBarRenderer {
//Make this per-thread, so that different threads can safely use these methods.
[ThreadStatic]
private static VisualStyleRenderer visualStyleRenderer = null;
const int lineWidth = 2;
//cannot instantiate
private TrackBarRenderer() {
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.IsSupported"]/*' />
/// <devdoc>
/// <para>
/// Returns true if this class is supported for the current OS and user/application settings,
/// otherwise returns false.
/// </para>
/// </devdoc>
public static bool IsSupported {
get {
return VisualStyleRenderer.IsSupported; // no downlevel support
}
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.DrawHorizontalTrack"]/*' />
/// <devdoc>
/// <para>
/// Renders a horizontal track.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static void DrawHorizontalTrack(Graphics g, Rectangle bounds) {
InitializeRenderer(VisualStyleElement.TrackBar.Track.Normal, 1);
visualStyleRenderer.DrawBackground(g, bounds);
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.DrawVerticalTrack"]/*' />
/// <devdoc>
/// <para>
/// Renders a vertical track.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static void DrawVerticalTrack(Graphics g, Rectangle bounds) {
InitializeRenderer(VisualStyleElement.TrackBar.TrackVertical.Normal, 1);
visualStyleRenderer.DrawBackground(g, bounds);
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.DrawHorizontalThumb"]/*' />
/// <devdoc>
/// <para>
/// Renders a horizontal thumb.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static void DrawHorizontalThumb(Graphics g, Rectangle bounds, TrackBarThumbState state) {
InitializeRenderer(VisualStyleElement.TrackBar.Thumb.Normal, (int)state);
visualStyleRenderer.DrawBackground(g, bounds);
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.DrawVerticalThumb"]/*' />
/// <devdoc>
/// <para>
/// Renders a vertical thumb.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static void DrawVerticalThumb(Graphics g, Rectangle bounds, TrackBarThumbState state) {
InitializeRenderer(VisualStyleElement.TrackBar.ThumbVertical.Normal, (int)state);
visualStyleRenderer.DrawBackground(g, bounds);
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.DrawLeftPointingThumb"]/*' />
/// <devdoc>
/// <para>
/// Renders a constant size left pointing thumb centered in the given bounds.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static void DrawLeftPointingThumb(Graphics g, Rectangle bounds, TrackBarThumbState state) {
InitializeRenderer(VisualStyleElement.TrackBar.ThumbLeft.Normal, (int)state);
visualStyleRenderer.DrawBackground(g, bounds);
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.DrawRightPointingThumb"]/*' />
/// <devdoc>
/// <para>
/// Renders a constant size right pointing thumb centered in the given bounds.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static void DrawRightPointingThumb(Graphics g, Rectangle bounds, TrackBarThumbState state) {
InitializeRenderer(VisualStyleElement.TrackBar.ThumbRight.Normal, (int)state);
visualStyleRenderer.DrawBackground(g, bounds);
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.DrawTopPointingThumb"]/*' />
/// <devdoc>
/// <para>
/// Renders a constant size top pointing thumb centered in the given bounds.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static void DrawTopPointingThumb(Graphics g, Rectangle bounds, TrackBarThumbState state) {
InitializeRenderer(VisualStyleElement.TrackBar.ThumbTop.Normal, (int)state);
visualStyleRenderer.DrawBackground(g, bounds);
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.DrawBottomPointingThumb"]/*' />
/// <devdoc>
/// <para>
/// Renders a constant size bottom pointing thumb centered in the given bounds.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static void DrawBottomPointingThumb(Graphics g, Rectangle bounds, TrackBarThumbState state) {
InitializeRenderer(VisualStyleElement.TrackBar.ThumbBottom.Normal, (int)state);
visualStyleRenderer.DrawBackground(g, bounds);
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.DrawHorizontalTick"]/*' />
/// <devdoc>
/// <para>
/// Renders a horizontal tick.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly")] // PM team has reviewed and decided on naming changes already
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static void DrawHorizontalTicks(Graphics g, Rectangle bounds, int numTicks, EdgeStyle edgeStyle) {
if (numTicks <= 0 || bounds.Height <= 0 || bounds.Width <= 0 || g == null) {
return;
}
InitializeRenderer(VisualStyleElement.TrackBar.Ticks.Normal, 1);
//trivial case -- avoid calcs
if (numTicks == 1) {
visualStyleRenderer.DrawEdge(g, new Rectangle(bounds.X, bounds.Y, lineWidth, bounds.Height), Edges.Left, edgeStyle, EdgeEffects.None);
return;
}
float inc = ((float)bounds.Width - lineWidth) / ((float)numTicks - 1);
while (numTicks > 0) {
//draw the nth tick
float x = bounds.X + ((float)(numTicks - 1)) * inc;
visualStyleRenderer.DrawEdge(g, new Rectangle((int)Math.Round(x), bounds.Y, lineWidth, bounds.Height), Edges.Left, edgeStyle, EdgeEffects.None);
numTicks--;
}
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.DrawVerticalTick"]/*' />
/// <devdoc>
/// <para>
/// Renders a vertical tick.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly")] // PM team has reviewed and decided on naming changes already
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static void DrawVerticalTicks(Graphics g, Rectangle bounds, int numTicks, EdgeStyle edgeStyle) {
if (numTicks<=0 || bounds.Height <= 0 || bounds.Width<=0 || g == null ) {
return;
}
InitializeRenderer(VisualStyleElement.TrackBar.TicksVertical.Normal, 1);
//trivial case
if (numTicks == 1) {
visualStyleRenderer.DrawEdge(g, new Rectangle(bounds.X, bounds.Y, bounds.Width, lineWidth), Edges.Top, edgeStyle, EdgeEffects.None);
return;
}
float inc = ((float)bounds.Height - lineWidth) / ((float)numTicks - 1);
while (numTicks > 0) {
//draw the nth tick
float y = bounds.Y + ((float)(numTicks - 1)) * inc;
visualStyleRenderer.DrawEdge(g, new Rectangle(bounds.X, (int)Math.Round(y), bounds.Width, lineWidth), Edges.Top, edgeStyle, EdgeEffects.None);
numTicks--;
}
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.GetLeftPointingThumbSize"]/*' />
/// <devdoc>
/// <para>
/// Returns the size of a left pointing thumb.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static Size GetLeftPointingThumbSize(Graphics g, TrackBarThumbState state) {
InitializeRenderer(VisualStyleElement.TrackBar.ThumbLeft.Normal, (int)state);
return (visualStyleRenderer.GetPartSize(g, ThemeSizeType.True));
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.GetRightPointingThumbSize"]/*' />
/// <devdoc>
/// <para>
/// Returns the size of a right pointing thumb.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static Size GetRightPointingThumbSize(Graphics g, TrackBarThumbState state) {
InitializeRenderer(VisualStyleElement.TrackBar.ThumbRight.Normal, (int)state);
return (visualStyleRenderer.GetPartSize(g, ThemeSizeType.True));
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.GetTopPointingThumbSize"]/*' />
/// <devdoc>
/// <para>
/// Returns the size of a top pointing thumb.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static Size GetTopPointingThumbSize(Graphics g, TrackBarThumbState state) {
InitializeRenderer(VisualStyleElement.TrackBar.ThumbTop.Normal, (int)state);
return (visualStyleRenderer.GetPartSize(g, ThemeSizeType.True));
}
/// <include file='doc\TrackBarRenderer.uex' path='docs/doc[@for="TrackBarRenderer.GetBottomPointingThumbSize"]/*' />
/// <devdoc>
/// <para>
/// Returns the size of a bottom pointing thumb.
/// </para>
/// </devdoc>
[SuppressMessage("Microsoft.Design", "CA1011:ConsiderPassingBaseTypesAsParameters")] // Using Graphics instead of IDeviceContext intentionally
public static Size GetBottomPointingThumbSize(Graphics g, TrackBarThumbState state) {
InitializeRenderer(VisualStyleElement.TrackBar.ThumbBottom.Normal, (int)state);
return (visualStyleRenderer.GetPartSize(g, ThemeSizeType.True));
}
private static void InitializeRenderer(VisualStyleElement element, int state) {
if (visualStyleRenderer == null) {
visualStyleRenderer = new VisualStyleRenderer(element.ClassName, element.Part, state);
}
else {
visualStyleRenderer.SetParameters(element.ClassName, element.Part, state);
}
}
}
}
|