MarqueeLabel.cs
author sl
Tue, 08 Jul 2014 18:59:07 +0200
changeset 8 5129c03ab7ba
parent 6 70b26a1ae93b
child 11 de55741d90f0
permissions -rw-r--r--
Adding persistent settings and marquee separator.
sl@0
     1
using System;
sl@0
     2
using System.Collections.Generic;
sl@0
     3
using System.ComponentModel;
sl@0
     4
using System.Diagnostics;
sl@0
     5
using System.Linq;
sl@0
     6
using System.Text;
sl@0
     7
using System.Threading.Tasks;
sl@0
     8
//using System.Timers;
sl@0
     9
using System.Windows.Forms;
sl@0
    10
using System.Drawing;
sl@0
    11
sl@0
    12
namespace SharpDisplayManager
sl@0
    13
{
sl@0
    14
    class MarqueeLabel : Label
sl@0
    15
    {
sl@2
    16
        private bool iOwnTimer;
sl@5
    17
        private StringFormat iStringFormat;
sl@5
    18
        private SolidBrush iBrush;
sl@6
    19
        private SizeF iTextSize;
sl@8
    20
        private SizeF iSeparatorSize;
sl@8
    21
sl@8
    22
        [Category("Appearance")]
sl@8
    23
        [Description("Separator in our scrolling loop.")]
sl@8
    24
        [DefaultValue(" | ")]
sl@8
    25
        [Browsable(true), EditorBrowsable(EditorBrowsableState.Always)]
sl@8
    26
        public string Separator { get; set; }
sl@0
    27
sl@0
    28
        [Category("Behavior")]
sl@0
    29
        [Description("How fast is our text scrolling, in pixels per second.")]
sl@0
    30
        [DefaultValue(32)]
sl@0
    31
        [Browsable(true), EditorBrowsable(EditorBrowsableState.Always)]
sl@0
    32
        public int PixelsPerSecond { get; set; }
sl@0
    33
sl@2
    34
        [Category("Behavior")]
sl@2
    35
        [Description("Use an internal or an external timer.")]
sl@2
    36
        [DefaultValue(true)]
sl@2
    37
        [Browsable(true), EditorBrowsable(EditorBrowsableState.Always)]
sl@2
    38
        public bool OwnTimer
sl@2
    39
        {
sl@2
    40
            get
sl@2
    41
            {
sl@2
    42
                return iOwnTimer;
sl@2
    43
            }
sl@2
    44
            set
sl@2
    45
            {
sl@2
    46
                iOwnTimer = value;
sl@2
    47
sl@2
    48
                if (iOwnTimer)
sl@2
    49
                {
sl@2
    50
                    Timer = new Timer();
sl@2
    51
                    Timer.Interval = 10;
sl@2
    52
                    Timer.Tick += new EventHandler(Timer_Tick);
sl@2
    53
                    Timer.Start();
sl@2
    54
                }
sl@2
    55
                else
sl@2
    56
                {
sl@2
    57
                    if (Timer != null)
sl@2
    58
                        Timer.Dispose();
sl@2
    59
                    Timer = null;
sl@2
    60
                }
sl@2
    61
sl@2
    62
            }
sl@2
    63
        }
sl@5
    64
sl@2
    65
        private int CurrentPosition { get; set; }
sl@2
    66
        private Timer Timer { get; set; }
sl@0
    67
        private DateTime LastTickTime { get; set; }
sl@0
    68
        private double PixelsLeft { get; set; }
sl@0
    69
        //DateTime a = new DateTime(2010, 05, 12, 13, 15, 00);
sl@2
    70
        //DateTime b = new DateTime(2010, 05, 12, 13, 45, 00);
sl@2
    71
        //Console.WriteLine(b.Subtract(a).TotalMinutes);
sl@0
    72
sl@0
    73
        public MarqueeLabel()
sl@0
    74
        {
sl@0
    75
            UseCompatibleTextRendering = true;
sl@0
    76
            //PixelsPerSecond = 32;
sl@0
    77
            LastTickTime = DateTime.Now;
sl@0
    78
            PixelsLeft = 0;
sl@5
    79
            iBrush = new SolidBrush(ForeColor);
sl@0
    80
        }
sl@0
    81
sl@2
    82
        public void UpdateAnimation(DateTime aLastTickTime, DateTime aNewTickTime)
sl@0
    83
        {
sl@6
    84
            if (!NeedToScroll())
sl@0
    85
            {
sl@6
    86
                CurrentPosition = 0;
sl@6
    87
                return;
sl@6
    88
            }
sl@6
    89
sl@8
    90
            while (CurrentPosition > (iTextSize.Width + iSeparatorSize.Width))
sl@6
    91
            {
sl@8
    92
                CurrentPosition -= ((int)(iTextSize.Width + iSeparatorSize.Width));
sl@0
    93
            }
sl@0
    94
sl@2
    95
            PixelsLeft += aNewTickTime.Subtract(aLastTickTime).TotalSeconds * PixelsPerSecond;
sl@0
    96
sl@0
    97
            //Keep track of our pixels left over
sl@0
    98
            //PixelsLeft = offset - Math.Truncate(offset);
sl@0
    99
            double offset = Math.Truncate(PixelsLeft);
sl@0
   100
            PixelsLeft -= offset;
sl@0
   101
sl@0
   102
            CurrentPosition += Convert.ToInt32(offset);
sl@0
   103
sl@0
   104
            /*
sl@0
   105
            if (offset > 1.0)
sl@0
   106
            {
sl@0
   107
                BackColor = Color.Red;
sl@0
   108
            }
sl@0
   109
            else if (offset==1.0)
sl@0
   110
            {
sl@0
   111
                if (BackColor != Color.White)
sl@0
   112
                {
sl@0
   113
                    BackColor = Color.White;
sl@0
   114
                }
sl@0
   115
sl@0
   116
            }
sl@0
   117
            else
sl@0
   118
            {
sl@0
   119
                //Too slow
sl@0
   120
                //BackColor = Color.Green;
sl@0
   121
            }*/
sl@0
   122
sl@0
   123
            //Only redraw if something has changed
sl@0
   124
            if (offset != 0)
sl@0
   125
            {
sl@0
   126
                Invalidate();
sl@0
   127
            }
sl@2
   128
        }
sl@0
   129
sl@2
   130
        void Timer_Tick(object sender, EventArgs e)
sl@2
   131
        {
sl@5
   132
            DateTime NewTickTime = DateTime.Now;
sl@2
   133
            //
sl@2
   134
            UpdateAnimation(LastTickTime, NewTickTime);
sl@2
   135
            //
sl@2
   136
            LastTickTime = NewTickTime;
sl@0
   137
        }
sl@0
   138
sl@5
   139
        private StringFormat GetStringFormatFromContentAllignment(ContentAlignment ca)
sl@5
   140
        {
sl@5
   141
            StringFormat format = new StringFormat();
sl@5
   142
            switch (ca)
sl@5
   143
            {
sl@5
   144
                case ContentAlignment.TopCenter:
sl@5
   145
                    format.Alignment = StringAlignment.Near;
sl@5
   146
                    format.LineAlignment = StringAlignment.Center;
sl@5
   147
                    break;
sl@5
   148
                case ContentAlignment.TopLeft:
sl@5
   149
                    format.Alignment = StringAlignment.Near;
sl@5
   150
                    format.LineAlignment = StringAlignment.Near;
sl@5
   151
                    break;
sl@5
   152
                case ContentAlignment.TopRight:
sl@5
   153
                    format.Alignment = StringAlignment.Near;
sl@5
   154
                    format.LineAlignment = StringAlignment.Far;
sl@5
   155
                    break;
sl@5
   156
                case ContentAlignment.MiddleCenter:
sl@5
   157
                    format.Alignment = StringAlignment.Center;
sl@5
   158
                    format.LineAlignment = StringAlignment.Center;
sl@5
   159
                    break;
sl@5
   160
                case ContentAlignment.MiddleLeft:
sl@5
   161
                    format.Alignment = StringAlignment.Center;
sl@5
   162
                    format.LineAlignment = StringAlignment.Near;
sl@5
   163
                    break;
sl@5
   164
                case ContentAlignment.MiddleRight:
sl@5
   165
                    format.Alignment = StringAlignment.Center;
sl@5
   166
                    format.LineAlignment = StringAlignment.Far;
sl@5
   167
                    break;
sl@5
   168
                case ContentAlignment.BottomCenter:
sl@5
   169
                    format.Alignment = StringAlignment.Far;
sl@5
   170
                    format.LineAlignment = StringAlignment.Center;
sl@5
   171
                    break;
sl@5
   172
                case ContentAlignment.BottomLeft:
sl@5
   173
                    format.Alignment = StringAlignment.Far;
sl@5
   174
                    format.LineAlignment = StringAlignment.Near;
sl@5
   175
                    break;
sl@5
   176
                case ContentAlignment.BottomRight:
sl@5
   177
                    format.Alignment = StringAlignment.Far;
sl@5
   178
                    format.LineAlignment = StringAlignment.Far;
sl@5
   179
                    break;
sl@5
   180
            }
sl@5
   181
sl@5
   182
            format.FormatFlags |= StringFormatFlags.NoWrap;
sl@5
   183
            format.FormatFlags |= StringFormatFlags.NoClip;
sl@5
   184
            format.Trimming = StringTrimming.None;
sl@5
   185
sl@5
   186
            return format;
sl@5
   187
        }
sl@5
   188
sl@5
   189
        protected override void OnForeColorChanged(EventArgs e)
sl@5
   190
        {
sl@6
   191
            //Color has changed recreate our brush
sl@5
   192
            iBrush = new SolidBrush(ForeColor);
sl@5
   193
sl@5
   194
            base.OnForeColorChanged(e);
sl@5
   195
        }
sl@5
   196
sl@6
   197
sl@6
   198
        private void HandleTextSizeChange()
sl@6
   199
        {
sl@6
   200
            //Update text size according to text and font
sl@6
   201
            Graphics g = this.CreateGraphics();
sl@6
   202
            g.TextRenderingHint = System.Drawing.Text.TextRenderingHint.SingleBitPerPixelGridFit;
sl@6
   203
            iTextSize = g.MeasureString(Text, Font);
sl@8
   204
            iSeparatorSize = g.MeasureString(Separator, Font);
sl@6
   205
            iStringFormat = GetStringFormatFromContentAllignment(TextAlign);
sl@6
   206
sl@6
   207
            if (NeedToScroll())
sl@6
   208
            {
sl@6
   209
                //Always align left when scrolling
sl@6
   210
                iStringFormat.Alignment = StringAlignment.Near;
sl@6
   211
            }
sl@6
   212
        }
sl@6
   213
sl@6
   214
        protected override void OnTextChanged(EventArgs e)
sl@6
   215
        {
sl@6
   216
            HandleTextSizeChange();
sl@6
   217
sl@6
   218
            base.OnTextChanged(e);
sl@6
   219
        }
sl@6
   220
sl@6
   221
        protected override void OnFontChanged(EventArgs e)
sl@6
   222
        {
sl@6
   223
            HandleTextSizeChange();
sl@6
   224
sl@6
   225
            base.OnFontChanged(e);
sl@6
   226
        }
sl@6
   227
sl@5
   228
        protected override void OnTextAlignChanged(EventArgs e)
sl@5
   229
        {
sl@5
   230
            iStringFormat = GetStringFormatFromContentAllignment(TextAlign);
sl@5
   231
sl@5
   232
            base.OnTextAlignChanged(e);
sl@5
   233
sl@5
   234
        }
sl@5
   235
sl@0
   236
        protected override void OnPaint(PaintEventArgs e)
sl@0
   237
        {
sl@0
   238
            //Disable anti-aliasing
sl@0
   239
            e.Graphics.TextRenderingHint = System.Drawing.Text.TextRenderingHint.SingleBitPerPixelGridFit;
sl@6
   240
            if (NeedToScroll())
sl@6
   241
            {
sl@6
   242
                //Draw the first one
sl@6
   243
                e.Graphics.TranslateTransform(-(float)CurrentPosition, 0);
sl@6
   244
                e.Graphics.DrawString(Text, Font, iBrush, ClientRectangle, iStringFormat);
sl@8
   245
                //Draw separator
sl@8
   246
                e.Graphics.TranslateTransform(iTextSize.Width, 0);
sl@8
   247
                e.Graphics.DrawString(Separator, Font, iBrush, ClientRectangle, iStringFormat);
sl@6
   248
                //Draw the last one
sl@8
   249
                e.Graphics.TranslateTransform(iSeparatorSize.Width, 0);
sl@6
   250
                e.Graphics.DrawString(Text, Font, iBrush, ClientRectangle, iStringFormat);
sl@6
   251
            }
sl@6
   252
            else
sl@6
   253
            {
sl@6
   254
                e.Graphics.DrawString(Text, Font, iBrush, ClientRectangle, iStringFormat);
sl@6
   255
            }
sl@6
   256
sl@6
   257
sl@5
   258
sl@5
   259
            //DrawText is not working without anti-aliasing. See: stackoverflow.com/questions/8283631/graphics-drawstring-vs-textrenderer-drawtextwhich-can-deliver-better-quality
sl@5
   260
            //TextRenderer.DrawText(e.Graphics, Text, Font, ClientRectangle, ForeColor, BackColor, iTextFormatFlags);
sl@5
   261
sl@5
   262
            //base.OnPaint(e);
sl@0
   263
        }
sl@0
   264
sl@6
   265
        public bool NeedToScroll()
sl@6
   266
        {
sl@6
   267
            //if (Width < e.Graphics.MeasureString(Text, Font).Width)
sl@6
   268
            if (Width < iTextSize.Width)
sl@6
   269
            {
sl@6
   270
                return true;
sl@6
   271
            }
sl@6
   272
            return false;
sl@6
   273
        }
sl@6
   274
sl@0
   275
        protected override void Dispose(bool disposing)
sl@0
   276
        {
sl@0
   277
            if (disposing)
sl@0
   278
            {
sl@0
   279
                if (Timer != null)
sl@0
   280
                    Timer.Dispose();
sl@0
   281
            }
sl@0
   282
            Timer = null;
sl@0
   283
        }
sl@0
   284
    }
sl@0
   285
}