Server/MarqueeLabel.cs
author sl
Sun, 17 Aug 2014 22:30:30 +0200
changeset 34 59bfa4ebcbbb
parent 33 1363bda20171
child 35 f3893924a6eb
permissions -rw-r--r--
Adding text field support to our tree view.
Trying to fix our messy text alignment issue causing loop problems.
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@15
    14
    [System.ComponentModel.DesignerCategory("Code")]
sl@17
    15
    public class MarqueeLabel : Label
sl@0
    16
    {
sl@2
    17
        private bool iOwnTimer;
sl@5
    18
        private StringFormat iStringFormat;
sl@5
    19
        private SolidBrush iBrush;
sl@6
    20
        private SizeF iTextSize;
sl@8
    21
        private SizeF iSeparatorSize;
sl@34
    22
        private SizeF iScrollSize;
sl@34
    23
        //private ContentAlignment iRequestedContentAlignment;
sl@8
    24
sl@8
    25
        [Category("Appearance")]
sl@8
    26
        [Description("Separator in our scrolling loop.")]
sl@8
    27
        [DefaultValue(" | ")]
sl@8
    28
        [Browsable(true), EditorBrowsable(EditorBrowsableState.Always)]
sl@11
    29
        [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)]
sl@8
    30
        public string Separator { get; set; }
sl@0
    31
sl@0
    32
        [Category("Behavior")]
sl@0
    33
        [Description("How fast is our text scrolling, in pixels per second.")]
sl@0
    34
        [DefaultValue(32)]
sl@0
    35
        [Browsable(true), EditorBrowsable(EditorBrowsableState.Always)]
sl@11
    36
        [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)]
sl@0
    37
        public int PixelsPerSecond { get; set; }
sl@0
    38
sl@2
    39
        [Category("Behavior")]
sl@2
    40
        [Description("Use an internal or an external timer.")]
sl@2
    41
        [DefaultValue(true)]
sl@2
    42
        [Browsable(true), EditorBrowsable(EditorBrowsableState.Always)]
sl@11
    43
        [DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)]
sl@2
    44
        public bool OwnTimer
sl@2
    45
        {
sl@2
    46
            get
sl@2
    47
            {
sl@2
    48
                return iOwnTimer;
sl@2
    49
            }
sl@2
    50
            set
sl@2
    51
            {
sl@2
    52
                iOwnTimer = value;
sl@2
    53
sl@2
    54
                if (iOwnTimer)
sl@2
    55
                {
sl@2
    56
                    Timer = new Timer();
sl@2
    57
                    Timer.Interval = 10;
sl@2
    58
                    Timer.Tick += new EventHandler(Timer_Tick);
sl@2
    59
                    Timer.Start();
sl@2
    60
                }
sl@2
    61
                else
sl@2
    62
                {
sl@2
    63
                    if (Timer != null)
sl@2
    64
                        Timer.Dispose();
sl@2
    65
                    Timer = null;
sl@2
    66
                }
sl@2
    67
sl@2
    68
            }
sl@2
    69
        }
sl@5
    70
sl@2
    71
        private int CurrentPosition { get; set; }
sl@2
    72
        private Timer Timer { get; set; }
sl@0
    73
        private DateTime LastTickTime { get; set; }
sl@0
    74
        private double PixelsLeft { get; set; }
sl@0
    75
        //DateTime a = new DateTime(2010, 05, 12, 13, 15, 00);
sl@2
    76
        //DateTime b = new DateTime(2010, 05, 12, 13, 45, 00);
sl@2
    77
        //Console.WriteLine(b.Subtract(a).TotalMinutes);
sl@0
    78
sl@0
    79
        public MarqueeLabel()
sl@0
    80
        {
sl@0
    81
            UseCompatibleTextRendering = true;
sl@0
    82
            //PixelsPerSecond = 32;
sl@0
    83
            LastTickTime = DateTime.Now;
sl@0
    84
            PixelsLeft = 0;
sl@33
    85
            CurrentPosition = 0;
sl@5
    86
            iBrush = new SolidBrush(ForeColor);
sl@34
    87
            //iRequestedContentAlignment = TextAlign;
sl@0
    88
        }
sl@0
    89
sl@2
    90
        public void UpdateAnimation(DateTime aLastTickTime, DateTime aNewTickTime)
sl@0
    91
        {
sl@6
    92
            if (!NeedToScroll())
sl@0
    93
            {
sl@6
    94
                CurrentPosition = 0;
sl@6
    95
                return;
sl@6
    96
            }
sl@6
    97
sl@34
    98
            /*
sl@8
    99
            while (CurrentPosition > (iTextSize.Width + iSeparatorSize.Width))
sl@6
   100
            {
sl@8
   101
                CurrentPosition -= ((int)(iTextSize.Width + iSeparatorSize.Width));
sl@0
   102
            }
sl@34
   103
             */
sl@34
   104
sl@34
   105
            while (CurrentPosition > iScrollSize.Width)
sl@34
   106
            {
sl@34
   107
                CurrentPosition -= (int)iScrollSize.Width;
sl@34
   108
            }
sl@34
   109
sl@0
   110
sl@2
   111
            PixelsLeft += aNewTickTime.Subtract(aLastTickTime).TotalSeconds * PixelsPerSecond;
sl@0
   112
sl@0
   113
            //Keep track of our pixels left over
sl@0
   114
            //PixelsLeft = offset - Math.Truncate(offset);
sl@0
   115
            double offset = Math.Truncate(PixelsLeft);
sl@0
   116
            PixelsLeft -= offset;
sl@0
   117
sl@0
   118
            CurrentPosition += Convert.ToInt32(offset);
sl@0
   119
sl@0
   120
            /*
sl@0
   121
            if (offset > 1.0)
sl@0
   122
            {
sl@0
   123
                BackColor = Color.Red;
sl@0
   124
            }
sl@0
   125
            else if (offset==1.0)
sl@0
   126
            {
sl@0
   127
                if (BackColor != Color.White)
sl@0
   128
                {
sl@0
   129
                    BackColor = Color.White;
sl@0
   130
                }
sl@0
   131
sl@0
   132
            }
sl@0
   133
            else
sl@0
   134
            {
sl@0
   135
                //Too slow
sl@0
   136
                //BackColor = Color.Green;
sl@0
   137
            }*/
sl@0
   138
sl@0
   139
            //Only redraw if something has changed
sl@0
   140
            if (offset != 0)
sl@0
   141
            {
sl@0
   142
                Invalidate();
sl@0
   143
            }
sl@2
   144
        }
sl@0
   145
sl@2
   146
        void Timer_Tick(object sender, EventArgs e)
sl@2
   147
        {
sl@5
   148
            DateTime NewTickTime = DateTime.Now;
sl@2
   149
            //
sl@2
   150
            UpdateAnimation(LastTickTime, NewTickTime);
sl@2
   151
            //
sl@2
   152
            LastTickTime = NewTickTime;
sl@0
   153
        }
sl@0
   154
sl@5
   155
        private StringFormat GetStringFormatFromContentAllignment(ContentAlignment ca)
sl@5
   156
        {
sl@5
   157
            StringFormat format = new StringFormat();
sl@11
   158
            format = StringFormat.GenericTypographic;
sl@5
   159
            switch (ca)
sl@5
   160
            {
sl@5
   161
                case ContentAlignment.TopCenter:
sl@34
   162
                    format.Alignment = StringAlignment.Center;
sl@34
   163
                    format.LineAlignment = StringAlignment.Near;
sl@5
   164
                    break;
sl@5
   165
                case ContentAlignment.TopLeft:
sl@5
   166
                    format.Alignment = StringAlignment.Near;
sl@5
   167
                    format.LineAlignment = StringAlignment.Near;
sl@5
   168
                    break;
sl@5
   169
                case ContentAlignment.TopRight:
sl@34
   170
                    format.Alignment = StringAlignment.Far;
sl@34
   171
                    format.LineAlignment = StringAlignment.Near;
sl@5
   172
                    break;
sl@5
   173
                case ContentAlignment.MiddleCenter:
sl@5
   174
                    format.Alignment = StringAlignment.Center;
sl@5
   175
                    format.LineAlignment = StringAlignment.Center;
sl@5
   176
                    break;
sl@5
   177
                case ContentAlignment.MiddleLeft:
sl@34
   178
                    format.Alignment = StringAlignment.Near;
sl@34
   179
                    format.LineAlignment = StringAlignment.Center;
sl@5
   180
                    break;
sl@5
   181
                case ContentAlignment.MiddleRight:
sl@34
   182
                    format.Alignment = StringAlignment.Far;
sl@34
   183
                    format.LineAlignment = StringAlignment.Center;
sl@34
   184
                    break;
sl@34
   185
                case ContentAlignment.BottomCenter:
sl@5
   186
                    format.Alignment = StringAlignment.Center;
sl@5
   187
                    format.LineAlignment = StringAlignment.Far;
sl@5
   188
                    break;
sl@5
   189
                case ContentAlignment.BottomLeft:
sl@34
   190
                    format.Alignment = StringAlignment.Near;
sl@34
   191
                    format.LineAlignment = StringAlignment.Far;
sl@5
   192
                    break;
sl@5
   193
                case ContentAlignment.BottomRight:
sl@5
   194
                    format.Alignment = StringAlignment.Far;
sl@5
   195
                    format.LineAlignment = StringAlignment.Far;
sl@5
   196
                    break;
sl@5
   197
            }
sl@5
   198
sl@5
   199
            format.FormatFlags |= StringFormatFlags.NoWrap;
sl@5
   200
            format.FormatFlags |= StringFormatFlags.NoClip;
sl@11
   201
            format.FormatFlags |= StringFormatFlags.MeasureTrailingSpaces;
sl@5
   202
            format.Trimming = StringTrimming.None;
sl@5
   203
sl@5
   204
            return format;
sl@5
   205
        }
sl@5
   206
sl@5
   207
        protected override void OnForeColorChanged(EventArgs e)
sl@5
   208
        {
sl@6
   209
            //Color has changed recreate our brush
sl@5
   210
            iBrush = new SolidBrush(ForeColor);
sl@5
   211
sl@5
   212
            base.OnForeColorChanged(e);
sl@5
   213
        }
sl@5
   214
sl@6
   215
sl@6
   216
        private void HandleTextSizeChange()
sl@6
   217
        {
sl@33
   218
            //Reset our timer whenever our text changes
sl@30
   219
            CurrentPosition = 0;
sl@33
   220
            LastTickTime = DateTime.Now;
sl@33
   221
            PixelsLeft = 0;
sl@34
   222
            //Reset text align
sl@34
   223
            //TextAlign = iRequestedContentAlignment;
sl@33
   224
sl@11
   225
            //For all string measurements and drawing issues refer to the following article:
sl@11
   226
            // http://stackoverflow.com/questions/1203087/why-is-graphics-measurestring-returning-a-higher-than-expected-number
sl@6
   227
            //Update text size according to text and font
sl@6
   228
            Graphics g = this.CreateGraphics();
sl@6
   229
            g.TextRenderingHint = System.Drawing.Text.TextRenderingHint.SingleBitPerPixelGridFit;
sl@6
   230
            iStringFormat = GetStringFormatFromContentAllignment(TextAlign);
sl@11
   231
            iTextSize = g.MeasureString(Text, Font, Int32.MaxValue, iStringFormat);
sl@11
   232
            iSeparatorSize = g.MeasureString(Separator, Font, Int32.MaxValue, iStringFormat);
sl@34
   233
            //Scroll width is the width of our text and our separator without taking kerning into account since
sl@34
   234
            //both text and separator are drawn independently from each other.
sl@34
   235
            iScrollSize.Width = iSeparatorSize.Width + iTextSize.Width;
sl@34
   236
            iScrollSize.Height = Math.Max(iSeparatorSize.Height, iTextSize.Height); //Not relevant for now
sl@34
   237
            //We don't want scroll with to take kerning into account so we don't use the following
sl@34
   238
            //iScrollSize = g.MeasureString(Text + Separator, Font, Int32.MaxValue, iStringFormat);
sl@6
   239
sl@6
   240
            if (NeedToScroll())
sl@6
   241
            {
sl@6
   242
                //Always align left when scrolling
sl@34
   243
                //Somehow draw string still takes into our control alignment so we need to set it too
sl@34
   244
                //ContentAlignment original = TextAlign;
sl@34
   245
                TextAlign = ContentAlignment.MiddleLeft;
sl@34
   246
                //Make sure our original text alignment remain the same even though we override it when scrolling
sl@34
   247
                //iRequestedContentAlignment = original; 
sl@34
   248
                //iStringFormat will get updated in OnTextAlignChanged
sl@34
   249
                //iStringFormat.Alignment = StringAlignment.Near;
sl@6
   250
            }
sl@6
   251
        }
sl@6
   252
sl@6
   253
        protected override void OnTextChanged(EventArgs e)
sl@6
   254
        {
sl@6
   255
            HandleTextSizeChange();
sl@6
   256
sl@6
   257
            base.OnTextChanged(e);
sl@6
   258
        }
sl@6
   259
sl@6
   260
        protected override void OnFontChanged(EventArgs e)
sl@6
   261
        {
sl@6
   262
            HandleTextSizeChange();
sl@6
   263
sl@6
   264
            base.OnFontChanged(e);
sl@6
   265
        }
sl@6
   266
sl@5
   267
        protected override void OnTextAlignChanged(EventArgs e)
sl@5
   268
        {
sl@5
   269
            iStringFormat = GetStringFormatFromContentAllignment(TextAlign);
sl@34
   270
            //iRequestedContentAlignment = TextAlign;
sl@5
   271
            base.OnTextAlignChanged(e);
sl@5
   272
sl@5
   273
        }
sl@5
   274
sl@0
   275
        protected override void OnPaint(PaintEventArgs e)
sl@0
   276
        {
sl@0
   277
            //Disable anti-aliasing
sl@0
   278
            e.Graphics.TextRenderingHint = System.Drawing.Text.TextRenderingHint.SingleBitPerPixelGridFit;
sl@6
   279
            if (NeedToScroll())
sl@6
   280
            {
sl@34
   281
                //Draw it all in a single call would take kerning into account
sl@34
   282
                //e.Graphics.TranslateTransform(-(float)CurrentPosition, 0);
sl@34
   283
                //e.Graphics.DrawString(Text + Separator + Text, Font, iBrush, ClientRectangle, iStringFormat);
sl@34
   284
sl@34
   285
                //Doing separate draw operation allows us not to take kerning into account between separator and string
sl@34
   286
                //Draw the first one
sl@33
   287
                e.Graphics.TranslateTransform(-(float)CurrentPosition, 0);
sl@34
   288
                e.Graphics.DrawString(Text, Font, iBrush, ClientRectangle, iStringFormat);
sl@8
   289
                //Draw separator
sl@34
   290
                e.Graphics.TranslateTransform(iTextSize.Width, 0);
sl@34
   291
                e.Graphics.DrawString(Separator, Font, iBrush, ClientRectangle, iStringFormat);
sl@6
   292
                //Draw the last one
sl@34
   293
                e.Graphics.TranslateTransform(iSeparatorSize.Width, 0);
sl@34
   294
                e.Graphics.DrawString(Text, Font, iBrush, ClientRectangle, iStringFormat);
sl@6
   295
            }
sl@6
   296
            else
sl@6
   297
            {
sl@6
   298
                e.Graphics.DrawString(Text, Font, iBrush, ClientRectangle, iStringFormat);
sl@6
   299
            }
sl@6
   300
sl@6
   301
sl@5
   302
sl@5
   303
            //DrawText is not working without anti-aliasing. See: stackoverflow.com/questions/8283631/graphics-drawstring-vs-textrenderer-drawtextwhich-can-deliver-better-quality
sl@5
   304
            //TextRenderer.DrawText(e.Graphics, Text, Font, ClientRectangle, ForeColor, BackColor, iTextFormatFlags);
sl@5
   305
sl@5
   306
            //base.OnPaint(e);
sl@0
   307
        }
sl@0
   308
sl@6
   309
        public bool NeedToScroll()
sl@6
   310
        {
sl@6
   311
            //if (Width < e.Graphics.MeasureString(Text, Font).Width)
sl@6
   312
            if (Width < iTextSize.Width)
sl@6
   313
            {
sl@6
   314
                return true;
sl@6
   315
            }
sl@6
   316
            return false;
sl@6
   317
        }
sl@6
   318
sl@0
   319
        protected override void Dispose(bool disposing)
sl@0
   320
        {
sl@0
   321
            if (disposing)
sl@0
   322
            {
sl@0
   323
                if (Timer != null)
sl@0
   324
                    Timer.Dispose();
sl@0
   325
            }
sl@0
   326
            Timer = null;
sl@0
   327
        }
sl@0
   328
    }
sl@0
   329
}