mcs/class/Managed.Windows.Forms/System.Windows.Forms/RichTextBox.cs

   1 // Permission is hereby granted, free of charge, to any person obtaining
   2 // a copy of this software and associated documentation files (the
   3 // "Software"), to deal in the Software without restriction, including
   4 // without limitation the rights to use, copy, modify, merge, publish,
   5 // distribute, sublicense, and/or sell copies of the Software, and to
   6 // permit persons to whom the Software is furnished to do so, subject to
   7 // the following conditions:
   8 //
   9 // The above copyright notice and this permission notice shall be
  10 // included in all copies or substantial portions of the Software.
  11 //
  12 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  13 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  14 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  15 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  16 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  17 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  18 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  19 //
  20 // Copyright (c) 2005-2006 Novell, Inc. (http://www.novell.com)
  21 //
  22 // Authors:
  23 //      Peter Bartok    <pbartok@novell.com>
  24 //
  25 //
  26
  27 // #define DEBUG
  28
  29 using System;
  30 using System.Collections;
  31 using System.ComponentModel;
  32 using System.Drawing;
  33 using System.Drawing.Imaging;
  34 using System.IO;
  35 using System.Text;
  36 using System.Runtime.InteropServices;
  37 using RTF=System.Windows.Forms.RTF;
  38
  39 namespace System.Windows.Forms {
  40 #if NET_2_0
  41         [ClassInterface (ClassInterfaceType.AutoDispatch)]
  42         [Docking (DockingBehavior.Ask)]
  43         [ComVisible (true)]
  44         [Designer ("System.Windows.Forms.Design.RichTextBoxDesigner, " + Consts.AssemblySystem_Design, "System.ComponentModel.Design.IDesigner")]
  45 #endif
  46         public class RichTextBox : TextBoxBase {
  47                 #region Local Variables
  48                 internal bool           auto_word_select;
  49                 internal int            bullet_indent;
  50                 internal bool           detect_urls;
  51                 internal int            margin_right;
  52                 internal float          zoom;
  53                 private StringBuilder   rtf_line;
  54
  55                 private RtfSectionStyle rtf_style;      // Replaces individual style
  56                                                         // properties so we can revert
  57                 private Stack           rtf_section_stack;
  58
  59                 private RTF.TextMap rtf_text_map;
  60                 private int rtf_skip_width;
  61                 private int rtf_skip_count;
  62                 private int             rtf_cursor_x;
  63                 private int             rtf_cursor_y;
  64                 private int             rtf_chars;
  65
  66 #if NET_2_0
  67                 private bool            enable_auto_drag_drop;
  68                 private RichTextBoxLanguageOptions language_option;
  69                 private bool            rich_text_shortcuts_enabled;
  70                 private Color           selection_back_color;
  71 #endif
  72                 #endregion      // Local Variables
  73
  74                 #region Public Constructors
  75                 public RichTextBox() {
  76                         accepts_return = true;
  77                         auto_word_select = false;
  78                         bullet_indent = 0;
  79                         max_length = Int32.MaxValue;
  80                         margin_right = 0;
  81                         zoom = 1;
  82                         base.Multiline = true;
  83                         document.CRLFSize = 1;
  84                         shortcuts_enabled = true;
  85                         base.EnableLinks = true;
  86                         richtext = true;
  87
  88                         rtf_style = new RtfSectionStyle ();
  89                         rtf_section_stack = null;
  90
  91                         scrollbars = RichTextBoxScrollBars.Both;
  92                         alignment = HorizontalAlignment.Left;
  93                         LostFocus += new EventHandler(RichTextBox_LostFocus);
  94                         GotFocus += new EventHandler(RichTextBox_GotFocus);
  95                         BackColor = ThemeEngine.Current.ColorWindow;
  96 #if NET_2_0
  97                         backcolor_set = false;
  98                         language_option = RichTextBoxLanguageOptions.AutoFontSizeAdjust;
  99                         rich_text_shortcuts_enabled = true;
 100                         selection_back_color = DefaultBackColor;
 101 #endif
 102                         ForeColor = ThemeEngine.Current.ColorWindowText;
 103
 104                         base.HScrolled += new EventHandler(RichTextBox_HScrolled);
 105                         base.VScrolled += new EventHandler(RichTextBox_VScrolled);
 106
 107 #if NET_2_0
 108                         SetStyle (ControlStyles.StandardDoubleClick, false);
 109 #endif
 110                 }
 111                 #endregion      // Public Constructors
 112
 113                 #region Private & Internal Methods
 114
 115                 internal override void HandleLinkClicked (LinkRectangle link)
 116                 {
 117                         OnLinkClicked (new LinkClickedEventArgs (link.LinkTag.LinkText));
 118                 }
 119
 120                 internal override Color ChangeBackColor (Color backColor)
 121                 {
 122                         if (backColor == Color.Empty) {
 123 #if NET_2_0
 124                                 backcolor_set = false;
 125                                 if (!ReadOnly) {
 126                                         backColor = SystemColors.Window;
 127                                 }
 128 #else
 129                                 backColor = SystemColors.Window;
 130 #endif
 131                         }
 132                         return backColor;
 133                 }
 134
 135                 private void RichTextBox_LostFocus(object sender, EventArgs e) {
 136                         Invalidate();
 137                 }
 138
 139                 private void RichTextBox_GotFocus(object sender, EventArgs e) {
 140                         Invalidate();
 141                 }
 142                 #endregion      // Private & Internal Methods
 143
 144                 #region Public Instance Properties
 145 #if NET_2_0
 146                 [Browsable (false)]
 147 #endif
 148                 public override bool AllowDrop {
 149                         get {
 150                                 return base.AllowDrop;
 151                         }
 152
 153                         set {
 154                                 base.AllowDrop = value;
 155                         }
 156                 }
 157
 158                 [DefaultValue(false)]
 159 #if NET_2_0
 160                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Visible)]
 161                 [RefreshProperties (RefreshProperties.Repaint)]
 162                 [EditorBrowsable (EditorBrowsableState.Never)]
 163                 [Browsable (false)]
 164 #else
 165                 [Localizable(true)]
 166 #endif
 167                 public override bool AutoSize {
 168                         get {
 169                                 return auto_size;
 170                         }
 171
 172                         set {
 173                                 base.AutoSize = value;
 174                         }
 175                 }
 176
 177                 [MonoTODO ("Value not respected, always true")]
 178                 [DefaultValue(false)]
 179                 public bool AutoWordSelection {
 180                         get { return auto_word_select; }
 181                         set { auto_word_select = value; }
 182                 }
 183
 184                 [Browsable(false)]
 185                 [EditorBrowsable(EditorBrowsableState.Never)]
 186                 public override System.Drawing.Image BackgroundImage {
 187                         get { return base.BackgroundImage; }
 188                         set { base.BackgroundImage = value; }
 189                 }
 190
 191 #if NET_2_0
 192                 [Browsable (false)]
 193                 [EditorBrowsable (EditorBrowsableState.Never)]
 194                 public override ImageLayout BackgroundImageLayout {
 195                         get { return base.BackgroundImageLayout; }
 196                         set { base.BackgroundImageLayout = value; }
 197                 }
 198 #endif
 199
 200                 [DefaultValue(0)]
 201                 [Localizable(true)]
 202                 public int BulletIndent {
 203                         get {
 204                                 return bullet_indent;
 205                         }
 206
 207                         set {
 208                                 bullet_indent = value;
 209                         }
 210                 }
 211
 212                 [Browsable(false)]
 213                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 214                 public bool CanRedo {
 215                         get {
 216                                 return document.undo.CanRedo;
 217                         }
 218                 }
 219
 220                 [DefaultValue(true)]
 221                 public bool DetectUrls {
 222                         get { return base.EnableLinks; }
 223                         set { base.EnableLinks = value; }
 224                 }
 225
 226 #if NET_2_0
 227                 [MonoTODO ("Stub")]
 228                 [DefaultValue (false)]
 229                 public bool EnableAutoDragDrop {
 230                         get { return enable_auto_drag_drop; }
 231                         set { enable_auto_drag_drop = value; }
 232                 }
 233 #endif
 234
 235                 public override Font Font {
 236                         get {
 237                                 return base.Font;
 238                         }
 239
 240                         set {
 241                                 if (font != value) {
 242                                         Line    start;
 243                                         Line    end;
 244
 245                                         if (auto_size) {
 246                                                 if (PreferredHeight != Height) {
 247                                                         Height = PreferredHeight;
 248                                                 }
 249                                         }
 250
 251                                         base.Font = value;
 252
 253                                         // Font changes always set the whole doc to that font
 254                                         start = document.GetLine(1);
 255                                         end = document.GetLine(document.Lines);
 256                                         document.FormatText(start, 1, end, end.text.Length + 1, base.Font, Color.Empty, Color.Empty, FormatSpecified.Font);
 257                                 }
 258                         }
 259                 }
 260
 261                 public override Color ForeColor {
 262                         get {
 263                                 return base.ForeColor;
 264                         }
 265
 266                         set {
 267                                 base.ForeColor = value;
 268                         }
 269                 }
 270
 271 #if NET_2_0
 272                 [MonoTODO ("Stub")]
 273                 [Browsable (false)]
 274                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
 275                 public RichTextBoxLanguageOptions LanguageOption {
 276                         get { return language_option; }
 277                         set { language_option = value; }
 278                 }
 279 #endif
 280
 281                 [DefaultValue(Int32.MaxValue)]
 282                 public override int MaxLength {
 283                         get {
 284                                 return base.max_length;
 285                         }
 286
 287                         set {
 288                                 base.max_length = value;
 289                         }
 290                 }
 291
 292                 [DefaultValue(true)]
 293                 public override bool Multiline {
 294                         get {
 295                                 return base.Multiline;
 296                         }
 297
 298                         set {
 299                                 base.Multiline = value;
 300                         }
 301                 }
 302
 303                 [Browsable(false)]
 304                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 305                 [MonoTODO]
 306                 public string RedoActionName {
 307                         get {
 308                                 return document.undo.RedoActionName;
 309                         }
 310                 }
 311
 312 #if NET_2_0
 313                 [MonoTODO ("Stub")]
 314                 [Browsable (false)]
 315                 [DefaultValue (true)]
 316                 [EditorBrowsable (EditorBrowsableState.Never)]
 317                 public bool RichTextShortcutsEnabled {
 318                         get { return rich_text_shortcuts_enabled; }
 319                         set { rich_text_shortcuts_enabled = value; }
 320                 }
 321 #endif
 322
 323                 [DefaultValue(0)]
 324                 [Localizable(true)]
 325                 [MonoTODO("Teach TextControl.RecalculateLine to consider the right margin as well")]
 326                 public int RightMargin {
 327                         get {
 328                                 return margin_right;
 329                         }
 330
 331                         set {
 332                                 margin_right = value;
 333                         }
 334                 }
 335
 336                 [Browsable(false)]
 337                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 338 #if NET_2_0
 339                 [RefreshProperties (RefreshProperties.All)]
 340 #else
 341                 [DefaultValue("")]
 342 #endif
 343                 public string Rtf {
 344                         get {
 345                                 Line            start_line;
 346                                 Line            end_line;
 347
 348                                 start_line = document.GetLine(1);
 349                                 end_line = document.GetLine(document.Lines);
 350                                 return GenerateRTF(start_line, 0, end_line, end_line.text.Length).ToString();
 351                         }
 352
 353                         set {
 354                                 MemoryStream    data;
 355
 356                                 document.Empty();
 357                                 data = new MemoryStream(Encoding.ASCII.GetBytes(value), false);
 358
 359                                 InsertRTFFromStream(data, 0, 1);
 360
 361                                 data.Close();
 362
 363                                 Invalidate();
 364                         }
 365                 }
 366
 367                 [DefaultValue(RichTextBoxScrollBars.Both)]
 368                 [Localizable(true)]
 369                 public RichTextBoxScrollBars ScrollBars {
 370                         get {
 371                                 return scrollbars;
 372                         }
 373
 374                         set {
 375                                 if (!Enum.IsDefined (typeof (RichTextBoxScrollBars), value))
 376                                         throw new InvalidEnumArgumentException ("value", (int) value,
 377                                                 typeof (RichTextBoxScrollBars));
 378
 379                                 if (value != scrollbars) {
 380                                         scrollbars = value;
 381                                         CalculateDocument ();
 382                                 }
 383                         }
 384                 }
 385
 386                 [Browsable(false)]
 387                 [DefaultValue("")]
 388                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 389                 public string SelectedRtf {
 390                         get {
 391                                 return GenerateRTF(document.selection_start.line, document.selection_start.pos, document.selection_end.line, document.selection_end.pos).ToString();
 392                         }
 393
 394                         set {
 395                                 MemoryStream    data;
 396                                 int             x;
 397                                 int             y;
 398                                 int             sel_start;
 399                                 int             chars;
 400                                 Line            line;
 401                                 LineTag         tag;
 402
 403                                 if (document.selection_visible) {
 404                                         document.ReplaceSelection("", false);
 405                                 }
 406
 407                                 sel_start = document.LineTagToCharIndex(document.selection_start.line, document.selection_start.pos);
 408
 409                                 data = new MemoryStream(Encoding.ASCII.GetBytes(value), false);
 410                                 InsertRTFFromStream(data, document.selection_start.pos, document.selection_start.line.line_no, out x, out y, out chars);
 411                                 data.Close();
 412
 413                                 document.CharIndexToLineTag(sel_start + chars + (y - document.selection_start.line.line_no) * 2, out line, out tag, out sel_start);
 414                                 document.SetSelection(line, sel_start);
 415                                 document.PositionCaret(line, sel_start);
 416                                 document.DisplayCaret();
 417                                 ScrollToCaret();
 418                                 OnTextChanged(EventArgs.Empty);
 419                         }
 420                 }
 421
 422                 [Browsable(false)]
 423                 [DefaultValue("")]
 424                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 425                 public override string SelectedText {
 426                         get {
 427                                 return base.SelectedText;
 428                         }
 429
 430                         set {
 431                                 base.SelectedText = value;
 432                         }
 433                 }
 434
 435                 [Browsable(false)]
 436                 [DefaultValue(HorizontalAlignment.Left)]
 437                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 438                 public HorizontalAlignment SelectionAlignment {
 439                         get {
 440                                 HorizontalAlignment     align;
 441                                 Line                    start;
 442                                 Line                    end;
 443                                 Line                    line;
 444
 445                                 start = document.ParagraphStart(document.selection_start.line);
 446                                 align = start.alignment;
 447
 448                                 end = document.ParagraphEnd(document.selection_end.line);
 449
 450                                 line = start;
 451
 452                                 while (true) {
 453                                         if (line.alignment != align) {
 454                                                 return HorizontalAlignment.Left;
 455                                         }
 456
 457                                         if (line == end) {
 458                                                 break;
 459                                         }
 460                                         line = document.GetLine(line.line_no + 1);
 461                                 }
 462
 463                                 return align;
 464                         }
 465
 466                         set {
 467                                 Line                    start;
 468                                 Line                    end;
 469                                 Line                    line;
 470
 471                                 start = document.ParagraphStart(document.selection_start.line);
 472
 473                                 end = document.ParagraphEnd(document.selection_end.line);
 474
 475                                 line = start;
 476
 477                                 while (true) {
 478                                         line.alignment = value;
 479
 480                                         if (line == end) {
 481                                                 break;
 482                                         }
 483                                         line = document.GetLine(line.line_no + 1);
 484                                 }
 485                                 this.CalculateDocument();
 486                         }
 487                 }
 488
 489 #if NET_2_0
 490                 [MonoTODO ("Stub")]
 491                 [Browsable (false)]
 492                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
 493                 public Color SelectionBackColor {
 494                         get { return selection_back_color; }
 495                         set { selection_back_color = value; }
 496                 }
 497 #endif
 498
 499                 [Browsable(false)]
 500                 [DefaultValue(false)]
 501                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 502                 [MonoTODO]
 503                 public bool SelectionBullet {
 504                         get {
 505                                 return false;
 506                         }
 507
 508                         set {
 509                         }
 510                 }
 511
 512                 [Browsable(false)]
 513                 [DefaultValue(0)]
 514                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 515                 [MonoTODO]
 516                 public int SelectionCharOffset {
 517                         get {
 518                                 return 0;
 519                         }
 520
 521                         set {
 522                         }
 523                 }
 524
 525                 [Browsable(false)]
 526                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 527                 public Color SelectionColor {
 528                         get {
 529                                 Color   color;
 530                                 LineTag start;
 531                                 LineTag end;
 532                                 LineTag tag;
 533
 534                                 if (selection_length > 0) {
 535                                         start = document.selection_start.line.FindTag (document.selection_start.pos + 1);
 536                                         end = document.selection_start.line.FindTag (document.selection_end.pos);
 537                                 } else {
 538                                         start = document.selection_start.line.FindTag (document.selection_start.pos);
 539                                         end = start;
 540                                 }
 541
 542                                 color = start.Color;
 543
 544                                 tag = start;
 545                                 while (tag != null) {
 546
 547                                         if (!color.Equals (tag.Color))
 548                                                 return Color.Empty;
 549
 550                                         if (tag == end)
 551                                                 break;
 552
 553                                         tag = document.NextTag (tag);
 554                                 }
 555
 556                                 return color;
 557                         }
 558
 559                         set {
 560                                 if (value == Color.Empty)
 561                                         value = DefaultForeColor;
 562
 563                                 int sel_start;
 564                                 int sel_end;
 565
 566                                 sel_start = document.LineTagToCharIndex(document.selection_start.line, document.selection_start.pos);
 567                                 sel_end = document.LineTagToCharIndex(document.selection_end.line, document.selection_end.pos);
 568
 569                                 document.FormatText (document.selection_start.line, document.selection_start.pos + 1,
 570                                                 document.selection_end.line, document.selection_end.pos + 1, null,
 571                                                 value, Color.Empty, FormatSpecified.Color);
 572
 573                                 document.CharIndexToLineTag(sel_start, out document.selection_start.line, out document.selection_start.tag, out document.selection_start.pos);
 574                                 document.CharIndexToLineTag(sel_end, out document.selection_end.line, out document.selection_end.tag, out document.selection_end.pos);
 575
 576                                 document.UpdateView(document.selection_start.line, 0);
 577
 578                                 //Re-Align the caret in case its changed size or position
 579                                 //probably not necessary here
 580                                 document.AlignCaret(false);
 581                         }
 582                 }
 583
 584                 [Browsable(false)]
 585                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 586                 public Font SelectionFont {
 587                         get {
 588                                 Font    font;
 589                                 LineTag start;
 590                                 LineTag end;
 591                                 LineTag tag;
 592
 593                                 if (selection_length > 0) {
 594                                         start = document.selection_start.line.FindTag (document.selection_start.pos + 1);
 595                                         end = document.selection_start.line.FindTag (document.selection_end.pos);
 596                                 } else {
 597                                         start = document.selection_start.line.FindTag (document.selection_start.pos);
 598                                         end = start;
 599                                 }
 600
 601                                 font = start.Font;
 602
 603                                 if (selection_length > 1) {
 604                                         tag = start;
 605                                         while (tag != null) {
 606
 607                                                 if (!font.Equals(tag.Font))
 608                                                         return null;
 609
 610                                                 if (tag == end)
 611                                                         break;
 612
 613                                                 tag = document.NextTag (tag);
 614                                         }
 615                                 }
 616
 617                                 return font;
 618                         }
 619
 620                         set {
 621                                 int             sel_start;
 622                                 int             sel_end;
 623
 624                                 sel_start = document.LineTagToCharIndex(document.selection_start.line, document.selection_start.pos);
 625                                 sel_end = document.LineTagToCharIndex(document.selection_end.line, document.selection_end.pos);
 626
 627                                 document.FormatText (document.selection_start.line, document.selection_start.pos + 1,
 628                                                 document.selection_end.line, document.selection_end.pos + 1, value,
 629                                                 Color.Empty, Color.Empty, FormatSpecified.Font);
 630
 631                                 document.CharIndexToLineTag(sel_start, out document.selection_start.line, out document.selection_start.tag, out document.selection_start.pos);
 632                                 document.CharIndexToLineTag(sel_end, out document.selection_end.line, out document.selection_end.tag, out document.selection_end.pos);
 633
 634                                 document.UpdateView(document.selection_start.line, 0);
 635                                 //Re-Align the caret in case its changed size or position
 636                                 Document.AlignCaret (false);
 637
 638                         }
 639                 }
 640
 641                 [Browsable(false)]
 642                 [DefaultValue(0)]
 643                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 644                 [MonoTODO]
 645                 public int SelectionHangingIndent {
 646                         get {
 647                                 return 0;
 648                         }
 649
 650                         set {
 651                         }
 652                 }
 653
 654                 [Browsable(false)]
 655                 [DefaultValue(0)]
 656                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 657                 [MonoTODO]
 658                 public int SelectionIndent {
 659                         get {
 660                                 return 0;
 661                         }
 662
 663                         set {
 664                         }
 665                 }
 666
 667                 [Browsable(false)]
 668                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 669                 public override int SelectionLength {
 670                         get {
 671                                 return base.SelectionLength;
 672                         }
 673
 674                         set {
 675                                 base.SelectionLength = value;
 676                         }
 677                 }
 678
 679                 [Browsable(false)]
 680                 [DefaultValue(false)]
 681                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 682                 [MonoTODO]
 683                 public bool SelectionProtected {
 684                         get {
 685                                 return false;
 686                         }
 687
 688                         set {
 689                         }
 690                 }
 691
 692                 [Browsable(false)]
 693                 [DefaultValue(0)]
 694                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 695                 [MonoTODO]
 696                 public int SelectionRightIndent {
 697                         get {
 698                                 return 0;
 699                         }
 700
 701                         set {
 702                         }
 703                 }
 704
 705                 [Browsable(false)]
 706                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 707                 [MonoTODO]
 708                 public int[] SelectionTabs {
 709                         get {
 710                                 return new int[0];
 711                         }
 712
 713                         set {
 714                         }
 715                 }
 716
 717                 [Browsable(false)]
 718                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 719                 public RichTextBoxSelectionTypes SelectionType {
 720                         get {
 721                                 if (document.selection_start == document.selection_end) {
 722                                         return RichTextBoxSelectionTypes.Empty;
 723                                 }
 724
 725                                 // Lazy, but works
 726                                 if (SelectedText.Length > 1) {
 727                                         return RichTextBoxSelectionTypes.MultiChar | RichTextBoxSelectionTypes.Text;
 728                                 }
 729
 730                                 return RichTextBoxSelectionTypes.Text;
 731                         }
 732                 }
 733
 734                 [DefaultValue(false)]
 735                 [MonoTODO]
 736                 public bool ShowSelectionMargin {
 737                         get {
 738                                 return false;
 739                         }
 740
 741                         set {
 742                         }
 743                 }
 744
 745                 [Localizable(true)]
 746 #if NET_2_0
 747                 [RefreshProperties (RefreshProperties.All)]
 748 #endif
 749                 public override string Text {
 750                         get {
 751                                 return base.Text;
 752                         }
 753
 754                         set {
 755                                 base.Text = value;
 756                         }
 757                 }
 758
 759                 [Browsable(false)]
 760                 public override int TextLength {
 761                         get {
 762                                 return base.TextLength;
 763                         }
 764                 }
 765
 766                 [Browsable(false)]
 767                 [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
 768                 public string UndoActionName {
 769                         get {
 770                                 return document.undo.UndoActionName;
 771                         }
 772                 }
 773
 774                 [Localizable(true)]
 775                 [DefaultValue(1)]
 776                 public float ZoomFactor {
 777                         get {
 778                                 return zoom;
 779                         }
 780
 781                         set {
 782                                 zoom = value;
 783                         }
 784                 }
 785                 #endregion      // Public Instance Properties
 786
 787                 #region Protected Instance Properties
 788                 protected override CreateParams CreateParams {
 789                         get {
 790                                 return base.CreateParams;
 791                         }
 792                 }
 793
 794                 protected override Size DefaultSize {
 795                         get {
 796                                 return new Size(100, 96);
 797                         }
 798                 }
 799                 #endregion      // Protected Instance Properties
 800
 801                 #region Public Instance Methods
 802                 public bool CanPaste(DataFormats.Format clipFormat) {
 803                         if ((clipFormat.Name == DataFormats.Rtf) ||
 804                                 (clipFormat.Name == DataFormats.Text) ||
 805                                 (clipFormat.Name == DataFormats.UnicodeText)) {
 806                                         return true;
 807                         }
 808                         return false;
 809                 }
 810
 811                 public int Find(char[] characterSet) {
 812                         return Find(characterSet, -1, -1);
 813                 }
 814
 815                 public int Find(char[] characterSet, int start) {
 816                         return Find(characterSet, start, -1);
 817                 }
 818
 819                 public int Find(char[] characterSet, int start, int end) {
 820                         Document.Marker start_mark;
 821                         Document.Marker end_mark;
 822                         Document.Marker result;
 823
 824                         if (start == -1) {
 825                                 document.GetMarker(out start_mark, true);
 826                         } else {
 827                                 Line line;
 828                                 LineTag tag;
 829                                 int pos;
 830
 831                                 start_mark = new Document.Marker();
 832
 833                                 document.CharIndexToLineTag(start, out line, out tag, out pos);
 834                                 start_mark.line = line;
 835                                 start_mark.tag = tag;
 836                                 start_mark.pos = pos;
 837                         }
 838
 839                         if (end == -1) {
 840                                 document.GetMarker(out end_mark, false);
 841                         } else {
 842                                 Line line;
 843                                 LineTag tag;
 844                                 int pos;
 845
 846                                 end_mark = new Document.Marker();
 847
 848                                 document.CharIndexToLineTag(end, out line, out tag, out pos);
 849                                 end_mark.line = line;
 850                                 end_mark.tag = tag;
 851                                 end_mark.pos = pos;
 852                         }
 853
 854                         if (document.FindChars(characterSet, start_mark, end_mark, out result)) {
 855                                 return document.LineTagToCharIndex(result.line, result.pos);
 856                         }
 857
 858                         return -1;
 859                 }
 860
 861                 public int Find(string str) {
 862                         return Find(str, -1, -1, RichTextBoxFinds.None);
 863                 }
 864
 865                 public int Find(string str, int start, int end, RichTextBoxFinds options) {
 866                         Document.Marker start_mark;
 867                         Document.Marker end_mark;
 868                         Document.Marker result;
 869
 870                         if (start == -1) {
 871                                 document.GetMarker(out start_mark, true);
 872                         } else {
 873                                 Line line;
 874                                 LineTag tag;
 875                                 int pos;
 876
 877                                 start_mark = new Document.Marker();
 878
 879                                 document.CharIndexToLineTag(start, out line, out tag, out pos);
 880
 881                                 start_mark.line = line;
 882                                 start_mark.tag = tag;
 883                                 start_mark.pos = pos;
 884                         }
 885
 886                         if (end == -1) {
 887                                 document.GetMarker(out end_mark, false);
 888                         } else {
 889                                 Line line;
 890                                 LineTag tag;
 891                                 int pos;
 892
 893                                 end_mark = new Document.Marker();
 894
 895                                 document.CharIndexToLineTag(end, out line, out tag, out pos);
 896
 897                                 end_mark.line = line;
 898                                 end_mark.tag = tag;
 899                                 end_mark.pos = pos;
 900                         }
 901
 902                         if (document.Find(str, start_mark, end_mark, out result, options)) {
 903                                 return document.LineTagToCharIndex(result.line, result.pos);
 904                         }
 905
 906                         return -1;
 907                 }
 908
 909                 public int Find(string str, int start, RichTextBoxFinds options) {
 910                         return Find(str, start, -1, options);
 911                 }
 912
 913                 public int Find(string str, RichTextBoxFinds options) {
 914                         return Find(str, -1, -1, options);
 915                 }
 916
 917
 918 #if !NET_2_0
 919                 public char GetCharFromPosition(Point pt) {
 920                         LineTag tag;
 921                         int     pos;
 922
 923                         PointToTagPos(pt, out tag, out pos);
 924
 925                         if (pos >= tag.Line.text.Length) {
 926                                 return '\n';
 927                         }
 928
 929                         return tag.Line.text[pos];
 930                 }
 931 #else
 932                 internal override char GetCharFromPositionInternal (Point p)
 933                 {
 934                         LineTag tag;
 935                         int pos;
 936
 937                         PointToTagPos (p, out tag, out pos);
 938
 939                         if (pos >= tag.Line.text.Length)
 940                                 return '\n';
 941
 942                         return tag.Line.text[pos];
 943                 }
 944 #endif
 945
 946                 public
 947 #if NET_2_0
 948                 override
 949 #endif
 950                 int GetCharIndexFromPosition(Point pt) {
 951                         LineTag tag;
 952                         int     pos;
 953
 954                         PointToTagPos(pt, out tag, out pos);
 955
 956                         return document.LineTagToCharIndex(tag.Line, pos);
 957                 }
 958
 959                 public
 960 #if NET_2_0
 961                 override
 962 #endif
 963                 int GetLineFromCharIndex(int index) {
 964                         Line    line;
 965                         LineTag tag;
 966                         int     pos;
 967
 968                         document.CharIndexToLineTag(index, out line, out tag, out pos);
 969
 970                         return line.LineNo - 1;
 971                 }
 972
 973                 public
 974 #if NET_2_0
 975                 override
 976 #endif
 977                 Point GetPositionFromCharIndex(int index) {
 978                         Line    line;
 979                         LineTag tag;
 980                         int     pos;
 981
 982                         document.CharIndexToLineTag(index, out line, out tag, out pos);
 983
 984                         return new Point((int)line.widths[pos] + 1, line.Y + 1);
 985                 }
 986
 987                 public void LoadFile(System.IO.Stream data, RichTextBoxStreamType fileType) {
 988                         document.Empty();
 989
 990
 991                         // FIXME - ignoring unicode
 992                         if (fileType == RichTextBoxStreamType.PlainText) {
 993                                 StringBuilder sb;
 994                                 char[] buffer;
 995
 996                                 try {
 997                                         sb = new StringBuilder ((int) data.Length);
 998                                         buffer = new char [1024];
 999                                 } catch {
1000                                         throw new IOException("Not enough memory to load document");
1001                                 }
1002
1003                                 StreamReader sr = new StreamReader (data, Encoding.Default, true);
1004                                 int charsRead = sr.Read (buffer, 0, buffer.Length);
1005                                 while (charsRead > 0) {
1006                                         sb.Append (buffer, 0, charsRead);
1007                                         charsRead = sr.Read (buffer, 0, buffer.Length);
1008                                 }
1009                                 base.Text = sb.ToString();
1010                                 return;
1011                         }
1012
1013                         InsertRTFFromStream(data, 0, 1);
1014
1015                         document.PositionCaret (document.GetLine (1), 0);
1016                         document.SetSelectionToCaret (true);
1017                         ScrollToCaret ();
1018                 }
1019
1020                 [MonoTODO("Make smarter RTF detection?")]
1021                 public void LoadFile(string path) {
1022                         if (path.EndsWith(".rtf")) {
1023                                 LoadFile(path, RichTextBoxStreamType.RichText);
1024                         } else {
1025                                 LoadFile(path, RichTextBoxStreamType.PlainText);
1026                         }
1027                 }
1028
1029                 public void LoadFile(string path, RichTextBoxStreamType fileType) {
1030                         FileStream      data;
1031
1032                         data = null;
1033
1034
1035                         try {
1036                                 data = new FileStream(path, FileMode.Open, FileAccess.Read, FileShare.Read, 1024);
1037
1038                                 LoadFile(data, fileType);
1039                         }
1040 #if !DEBUG
1041                         catch (Exception ex) {
1042                                 throw new IOException("Could not open file " + path, ex);
1043                         }
1044 #endif
1045                         finally {
1046                                 if (data != null) {
1047                                         data.Close();
1048                                 }
1049                         }
1050                 }
1051
1052                 public void Paste(DataFormats.Format clipFormat) {
1053                         base.Paste(Clipboard.GetDataObject(), clipFormat, false);
1054                 }
1055
1056                 public void Redo()
1057                 {
1058                         document.undo.Redo ();
1059                 }
1060
1061                 public void SaveFile(Stream data, RichTextBoxStreamType fileType) {
1062                         Encoding        encoding;
1063                         int             i;
1064                         Byte[]          bytes;
1065
1066
1067                         if (fileType == RichTextBoxStreamType.UnicodePlainText) {
1068                                 encoding = Encoding.Unicode;
1069                         } else {
1070                                 encoding = Encoding.ASCII;
1071                         }
1072
1073                         switch(fileType) {
1074                                 case RichTextBoxStreamType.PlainText:
1075                                 case RichTextBoxStreamType.TextTextOleObjs:
1076                                 case RichTextBoxStreamType.UnicodePlainText: {
1077                                         if (!Multiline) {
1078                                                 bytes = encoding.GetBytes(document.Root.text.ToString());
1079                                                 data.Write(bytes, 0, bytes.Length);
1080                                                 return;
1081                                         }
1082
1083                                         for (i = 1; i < document.Lines; i++) {
1084                                                 bytes = encoding.GetBytes(document.GetLine(i).text.ToString() + Environment.NewLine);
1085                                                 data.Write(bytes, 0, bytes.Length);
1086                                         }
1087                                         bytes = encoding.GetBytes(document.GetLine(document.Lines).text.ToString());
1088                                         data.Write(bytes, 0, bytes.Length);
1089                                         return;
1090                                 }
1091                         }
1092
1093                         // If we're here we're saving RTF
1094                         Line            start_line;
1095                         Line            end_line;
1096                         StringBuilder   rtf;
1097                         int             current;
1098                         int             total;
1099
1100                         start_line = document.GetLine(1);
1101                         end_line = document.GetLine(document.Lines);
1102                         rtf = GenerateRTF(start_line, 0, end_line, end_line.text.Length);
1103                         total = rtf.Length;
1104                         bytes = new Byte[4096];
1105
1106                         // Let's chunk it so we don't use up all memory...
1107                         for (i = 0; i < total; i += 1024) {
1108                                 if ((i + 1024) < total) {
1109                                         current = encoding.GetBytes(rtf.ToString(i, 1024), 0, 1024, bytes, 0);
1110                                 } else {
1111                                         current = total - i;
1112                                         current = encoding.GetBytes(rtf.ToString(i, current), 0, current, bytes, 0);
1113                                 }
1114                                 data.Write(bytes, 0, current);
1115                         }
1116                 }
1117
1118                 public void SaveFile(string path) {
1119                         if (path.EndsWith(".rtf")) {
1120                                 SaveFile(path, RichTextBoxStreamType.RichText);
1121                         } else {
1122                                 SaveFile(path, RichTextBoxStreamType.PlainText);
1123                         }
1124                 }
1125
1126                 public void SaveFile(string path, RichTextBoxStreamType fileType) {
1127                         FileStream      data;
1128
1129                         data = null;
1130
1131 //                      try {
1132                                 data = new FileStream(path, FileMode.Create, FileAccess.Write, FileShare.None, 1024, false);
1133                                 SaveFile(data, fileType);
1134 //                      }
1135
1136 //                      catch {
1137 //                              throw new IOException("Could not write document to file " + path);
1138 //                      }
1139
1140 //                      finally {
1141                                 if (data != null) {
1142                                         data.Close();
1143                                 }
1144 //                      }
1145                 }
1146
1147 #if NET_2_0
1148                 [EditorBrowsable (EditorBrowsableState.Never)]
1149                 public new void DrawToBitmap (Bitmap bitmap, Rectangle clip)
1150                 {
1151                         Graphics dc = Graphics.FromImage (bitmap);
1152
1153                         if (backcolor_set || (Enabled && !read_only)) {
1154                                 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (BackColor), clip);
1155                         } else {
1156                                 dc.FillRectangle (ThemeEngine.Current.ResPool.GetSolidBrush (ThemeEngine.Current.ColorControl), clip);
1157                         }
1158
1159                         // Draw the viewable document
1160                         document.Draw (dc, clip);
1161                 }
1162 #endif
1163
1164                 #endregion      // Public Instance Methods
1165
1166                 #region Protected Instance Methods
1167                 protected virtual object CreateRichEditOleCallback() {
1168                         throw new NotImplementedException();
1169                 }
1170
1171                 protected override void OnBackColorChanged(EventArgs e) {
1172                         base.OnBackColorChanged (e);
1173                 }
1174
1175                 protected virtual void OnContentsResized(ContentsResizedEventArgs e) {
1176                         ContentsResizedEventHandler eh = (ContentsResizedEventHandler)(Events [ContentsResizedEvent]);
1177                         if (eh != null)
1178                                 eh (this, e);
1179                 }
1180
1181                 protected override void OnContextMenuChanged(EventArgs e) {
1182                         base.OnContextMenuChanged (e);
1183                 }
1184
1185                 protected override void OnHandleCreated(EventArgs e) {
1186                         base.OnHandleCreated (e);
1187                 }
1188
1189                 protected override void OnHandleDestroyed(EventArgs e) {
1190                         base.OnHandleDestroyed (e);
1191                 }
1192
1193                 protected virtual void OnHScroll(EventArgs e) {
1194                         EventHandler eh = (EventHandler)(Events [HScrollEvent]);
1195                         if (eh != null)
1196                                 eh (this, e);
1197                 }
1198
1199                 [MonoTODO("Determine when to call this")]
1200                 protected virtual void OnImeChange(EventArgs e) {
1201                         EventHandler eh = (EventHandler)(Events [ImeChangeEvent]);
1202                         if (eh != null)
1203                                 eh (this, e);
1204                 }
1205
1206                 protected virtual void OnLinkClicked(LinkClickedEventArgs e) {
1207                         LinkClickedEventHandler eh = (LinkClickedEventHandler)(Events [LinkClickedEvent]);
1208                         if (eh != null)
1209                                 eh (this, e);
1210                 }
1211
1212                 protected virtual void OnProtected(EventArgs e) {
1213                         EventHandler eh = (EventHandler)(Events [ProtectedEvent]);
1214                         if (eh != null)
1215                                 eh (this, e);
1216                 }
1217
1218                 protected override void OnRightToLeftChanged(EventArgs e) {
1219                         base.OnRightToLeftChanged (e);
1220                 }
1221
1222                 protected virtual void OnSelectionChanged(EventArgs e) {
1223                         EventHandler eh = (EventHandler)(Events [SelectionChangedEvent]);
1224                         if (eh != null)
1225                                 eh (this, e);
1226                 }
1227
1228 #if !NET_2_0
1229                 protected override void OnSystemColorsChanged(EventArgs e) {
1230                         base.OnSystemColorsChanged (e);
1231                 }
1232
1233                 protected override void OnTextChanged(EventArgs e) {
1234                         base.OnTextChanged (e);
1235                 }
1236 #endif
1237
1238                 protected virtual void OnVScroll(EventArgs e) {
1239                         EventHandler eh = (EventHandler)(Events [VScrollEvent]);
1240                         if (eh != null)
1241                                 eh (this, e);
1242                 }
1243
1244                 protected override void WndProc(ref Message m) {
1245                         base.WndProc (ref m);
1246                 }
1247
1248 #if NET_2_0
1249                 protected override bool ProcessCmdKey (ref Message msg, Keys keyData)
1250                 {
1251                         return base.ProcessCmdKey (ref msg, keyData);
1252                 }
1253 #endif
1254                 #endregion      // Protected Instance Methods
1255
1256                 #region Events
1257                 static object ContentsResizedEvent = new object ();
1258                 static object HScrollEvent = new object ();
1259                 static object ImeChangeEvent = new object ();
1260                 static object LinkClickedEvent = new object ();
1261                 static object ProtectedEvent = new object ();
1262                 static object SelectionChangedEvent = new object ();
1263                 static object VScrollEvent = new object ();
1264
1265                 [Browsable(false)]
1266                 [EditorBrowsable(EditorBrowsableState.Never)]
1267                 public new event EventHandler BackgroundImageChanged {
1268                         add { base.BackgroundImageChanged += value; }
1269                         remove { base.BackgroundImageChanged -= value; }
1270                 }
1271
1272 #if NET_2_0
1273                 [Browsable (false)]
1274                 [EditorBrowsable (EditorBrowsableState.Never)]
1275                 public new event EventHandler BackgroundImageLayoutChanged {
1276                         add { base.BackgroundImageLayoutChanged += value; }
1277                         remove { base.BackgroundImageLayoutChanged -= value; }
1278                 }
1279 #endif
1280
1281                 public event ContentsResizedEventHandler ContentsResized {
1282                         add { Events.AddHandler (ContentsResizedEvent, value); }
1283                         remove { Events.RemoveHandler (ContentsResizedEvent, value); }
1284                 }
1285
1286 #if !NET_2_0
1287                 [Browsable(false)]
1288                 [EditorBrowsable(EditorBrowsableState.Never)]
1289                 public new event EventHandler DoubleClick {
1290                         add { base.DoubleClick += value; }
1291                         remove { base.DoubleClick -= value; }
1292                 }
1293 #endif
1294
1295                 [Browsable(false)]
1296 #if !NET_2_0
1297                 [EditorBrowsable(EditorBrowsableState.Never)]
1298 #endif
1299                 public new event DragEventHandler DragDrop {
1300                         add { base.DragDrop += value; }
1301                         remove { base.DragDrop -= value; }
1302                 }
1303
1304                 [Browsable(false)]
1305 #if !NET_2_0
1306                 [EditorBrowsable(EditorBrowsableState.Never)]
1307 #endif
1308                 public new event DragEventHandler DragEnter {
1309                         add { base.DragEnter += value; }
1310                         remove { base.DragEnter -= value; }
1311                 }
1312
1313                 [Browsable(false)]
1314                 [EditorBrowsable(EditorBrowsableState.Never)]
1315                 public new event EventHandler DragLeave {
1316                         add { base.DragLeave += value; }
1317                         remove { base.DragLeave -= value; }
1318                 }
1319
1320
1321                 [Browsable(false)]
1322                 [EditorBrowsable(EditorBrowsableState.Never)]
1323                 public new event DragEventHandler DragOver {
1324                         add { base.DragOver += value; }
1325                         remove { base.DragOver -= value; }
1326                 }
1327
1328
1329                 [Browsable(false)]
1330                 [EditorBrowsable(EditorBrowsableState.Never)]
1331                 public new event GiveFeedbackEventHandler GiveFeedback {
1332                         add { base.GiveFeedback += value; }
1333                         remove { base.GiveFeedback -= value; }
1334                 }
1335
1336                 public event EventHandler HScroll {
1337                         add { Events.AddHandler (HScrollEvent, value); }
1338                         remove { Events.RemoveHandler (HScrollEvent, value); }
1339                 }
1340
1341                 public event EventHandler ImeChange {
1342                         add { Events.AddHandler (ImeChangeEvent, value); }
1343                         remove { Events.RemoveHandler (ImeChangeEvent, value); }
1344                 }
1345
1346                 public event LinkClickedEventHandler LinkClicked {
1347                         add { Events.AddHandler (LinkClickedEvent, value); }
1348                         remove { Events.RemoveHandler (LinkClickedEvent, value); }
1349                 }
1350
1351                 public event EventHandler Protected {
1352                         add { Events.AddHandler (ProtectedEvent, value); }
1353                         remove { Events.RemoveHandler (ProtectedEvent, value); }
1354                 }
1355
1356                 [Browsable(false)]
1357                 [EditorBrowsable(EditorBrowsableState.Never)]
1358                 public new event QueryContinueDragEventHandler QueryContinueDrag {
1359                         add { base.QueryContinueDrag += value; }
1360                         remove { base.QueryContinueDrag -= value; }
1361                 }
1362
1363                 [MonoTODO("Currently does not ever fire")]
1364                 public event EventHandler SelectionChanged {
1365                         add { Events.AddHandler (SelectionChangedEvent, value); }
1366                         remove { Events.RemoveHandler (SelectionChangedEvent, value); }
1367                 }
1368
1369                 public event EventHandler VScroll {
1370                         add { Events.AddHandler (VScrollEvent, value); }
1371                         remove { Events.RemoveHandler (VScrollEvent, value); }
1372                 }
1373                 #endregion      // Events
1374
1375                 #region Private Methods
1376
1377                 internal override void SelectWord ()
1378                 {
1379                         document.ExpandSelection(CaretSelection.Word, false);
1380                 }
1381
1382                 private class RtfSectionStyle : ICloneable {
1383                         internal Color rtf_color;
1384                         internal RTF.Font rtf_rtffont;
1385                         internal int rtf_rtffont_size;
1386                         internal FontStyle rtf_rtfstyle;
1387                         internal HorizontalAlignment rtf_rtfalign;
1388                         internal int rtf_par_line_left_indent;
1389
1390                         public object Clone ()
1391                         {
1392                                 RtfSectionStyle new_style = new RtfSectionStyle ();
1393
1394                                 new_style.rtf_color = rtf_color;
1395                                 new_style.rtf_par_line_left_indent = rtf_par_line_left_indent;
1396                                 new_style.rtf_rtfalign = rtf_rtfalign;
1397                                 new_style.rtf_rtffont = rtf_rtffont;
1398                                 new_style.rtf_rtffont_size = rtf_rtffont_size;
1399                                 new_style.rtf_rtfstyle = rtf_rtfstyle;
1400
1401                                 return new_style;
1402                         }
1403                 }
1404
1405                 // To allow us to keep track of the sections and revert formatting
1406                 // as we go in and out of sections of the document.
1407                 private void HandleGroup (RTF.RTF rtf)
1408                 {
1409                         //start group - save the current formatting on to a stack
1410                         //end group - go back to the formatting at the current group
1411                         if (rtf_section_stack == null) {
1412                                 rtf_section_stack = new Stack ();
1413                         }
1414
1415                         if (rtf.Major == RTF.Major.BeginGroup) {
1416                                 rtf_section_stack.Push (rtf_style.Clone ());
1417                         } else if (rtf.Major == RTF.Major.EndGroup) {
1418                                 if (rtf_section_stack.Count > 0) {
1419                                         FlushText (rtf, false);
1420
1421                                         rtf_style = (RtfSectionStyle) rtf_section_stack.Pop ();
1422                                 }
1423                         }
1424                 }
1425
1426                 [MonoTODO("Add QuadJust support for justified alignment")]
1427                 private void HandleControl(RTF.RTF rtf) {
1428                         switch(rtf.Major) {
1429                                 case RTF.Major.Unicode: {
1430                                         switch(rtf.Minor) {
1431                                                 case RTF.Minor.UnicodeCharBytes: {
1432                                                         rtf_skip_width = rtf.Param;
1433                                                         break;
1434                                                 }
1435
1436                                                 case RTF.Minor.UnicodeChar: {
1437                                                         rtf_skip_count += rtf_skip_width;
1438                                                         rtf_line.Append((char)rtf.Param);
1439                                                         break;
1440                                                 }
1441                                         }
1442                                         break;
1443                                 }
1444
1445                                 case RTF.Major.Destination: {
1446 //                                      Console.Write("[Got Destination control {0}]", rtf.Minor);
1447                                         rtf.SkipGroup();
1448                                         break;
1449                                 }
1450
1451                                 case RTF.Major.PictAttr:
1452                                         if (rtf.Picture != null && rtf.Picture.IsValid ()) {
1453                                                 Line line = document.GetLine (rtf_cursor_y);
1454                                                 document.InsertPicture (line, 0, rtf.Picture);
1455                                                 rtf_cursor_x++;
1456
1457                                                 FlushText (rtf, true);
1458                                                 rtf.Picture = null;
1459                                         }
1460                                         break;
1461
1462                                 case RTF.Major.CharAttr: {
1463                                         switch(rtf.Minor) {
1464                                                 case RTF.Minor.ForeColor: {
1465                                                         System.Windows.Forms.RTF.Color  color;
1466
1467                                                         color = System.Windows.Forms.RTF.Color.GetColor(rtf, rtf.Param);
1468
1469                                                         if (color != null) {
1470                                                                 FlushText(rtf, false);
1471                                                                 if (color.Red == -1 && color.Green == -1 && color.Blue == -1) {
1472                                                                         this.rtf_style.rtf_color = ForeColor;
1473                                                                 } else {
1474                                                                         this.rtf_style.rtf_color = Color.FromArgb(color.Red, color.Green, color.Blue);
1475                                                                 }
1476                                                                 FlushText (rtf, false);
1477                                                         }
1478                                                         break;
1479                                                 }
1480
1481                                                 case RTF.Minor.FontSize: {
1482                                                         FlushText(rtf, false);
1483                                                         this.rtf_style.rtf_rtffont_size = rtf.Param / 2;
1484                                                         break;
1485                                                 }
1486
1487                                                 case RTF.Minor.FontNum: {
1488                                                         System.Windows.Forms.RTF.Font   font;
1489
1490                                                         font = System.Windows.Forms.RTF.Font.GetFont(rtf, rtf.Param);
1491                                                         if (font != null) {
1492                                                                 FlushText(rtf, false);
1493                                                                 this.rtf_style.rtf_rtffont = font;
1494                                                         }
1495                                                         break;
1496                                                 }
1497
1498                                                 case RTF.Minor.Plain: {
1499                                                         FlushText(rtf, false);
1500                                                         rtf_style.rtf_rtfstyle = FontStyle.Regular;
1501                                                         break;
1502                                                 }
1503
1504                                                 case RTF.Minor.Bold: {
1505                                                         FlushText(rtf, false);
1506                                                         if (rtf.Param == RTF.RTF.NoParam) {
1507                                                                 rtf_style.rtf_rtfstyle |= FontStyle.Bold;
1508                                                         } else {
1509                                                                 rtf_style.rtf_rtfstyle &= ~FontStyle.Bold;
1510                                                         }
1511                                                         break;
1512                                                 }
1513
1514                                                 case RTF.Minor.Italic: {
1515                                                         FlushText(rtf, false);
1516                                                         if (rtf.Param == RTF.RTF.NoParam) {
1517                                                                 rtf_style.rtf_rtfstyle |= FontStyle.Italic;
1518                                                         } else {
1519                                                                 rtf_style.rtf_rtfstyle &= ~FontStyle.Italic;
1520                                                         }
1521                                                         break;
1522                                                 }
1523
1524                                                 case RTF.Minor.StrikeThru: {
1525                                                         FlushText(rtf, false);
1526                                                         if (rtf.Param == RTF.RTF.NoParam) {
1527                                                                 rtf_style.rtf_rtfstyle |= FontStyle.Strikeout;
1528                                                         } else {
1529                                                                 rtf_style.rtf_rtfstyle &= ~FontStyle.Strikeout;
1530                                                         }
1531                                                         break;
1532                                                 }
1533
1534                                                 case RTF.Minor.Underline: {
1535                                                         FlushText(rtf, false);
1536                                                         if (rtf.Param == RTF.RTF.NoParam) {
1537                                                                 rtf_style.rtf_rtfstyle |= FontStyle.Underline;
1538                                                         } else {
1539                                                                 rtf_style.rtf_rtfstyle = rtf_style.rtf_rtfstyle & ~FontStyle.Underline;
1540                                                         }
1541                                                         break;
1542                                                 }
1543
1544                                                 case RTF.Minor.NoUnderline: {
1545                                                         FlushText(rtf, false);
1546                                                         rtf_style.rtf_rtfstyle &= ~FontStyle.Underline;
1547                                                         break;
1548                                                 }
1549                                         }
1550                                         break;
1551                                 }
1552
1553                         case RTF.Major.ParAttr: {
1554                                 switch (rtf.Minor) {
1555
1556                                 case RTF.Minor.ParDef:
1557                                         FlushText (rtf, false);
1558                                         rtf_style.rtf_par_line_left_indent = 0;
1559                                         rtf_style.rtf_rtfalign = HorizontalAlignment.Left;
1560                                         break;
1561
1562                                 case RTF.Minor.LeftIndent:
1563                                         rtf_style.rtf_par_line_left_indent = (int) (((float) rtf.Param / 1440.0F) * CreateGraphics ().DpiX + 0.5F);
1564                                         break;
1565
1566                                 case RTF.Minor.QuadCenter:
1567                                         FlushText (rtf, false);
1568                                         rtf_style.rtf_rtfalign = HorizontalAlignment.Center;
1569                                         break;
1570
1571                                 case RTF.Minor.QuadJust:
1572                                         FlushText (rtf, false);
1573                                         rtf_style.rtf_rtfalign = HorizontalAlignment.Center;
1574                                         break;
1575
1576                                 case RTF.Minor.QuadLeft:
1577                                         FlushText (rtf, false);
1578                                         rtf_style.rtf_rtfalign = HorizontalAlignment.Left;
1579                                         break;
1580
1581                                 case RTF.Minor.QuadRight:
1582                                         FlushText (rtf, false);
1583                                         rtf_style.rtf_rtfalign = HorizontalAlignment.Right;
1584                                         break;
1585                                 }
1586                                 break;
1587                         }
1588
1589                         case RTF.Major.SpecialChar: {
1590                                         //Console.Write("[Got SpecialChar control {0}]", rtf.Minor);
1591                                         SpecialChar (rtf);
1592                                         break;
1593                                 }
1594                         }
1595                 }
1596
1597                 private void SpecialChar(RTF.RTF rtf) {
1598                         switch(rtf.Minor) {
1599                                 case RTF.Minor.Page:
1600                                 case RTF.Minor.Sect:
1601                                 case RTF.Minor.Row:
1602                                 case RTF.Minor.Line:
1603                                 case RTF.Minor.Par: {
1604                                         FlushText(rtf, true);
1605                                         break;
1606                                 }
1607
1608                                 case RTF.Minor.Cell: {
1609                                         Console.Write(" ");
1610                                         break;
1611                                 }
1612
1613                                 case RTF.Minor.NoBrkSpace: {
1614                                         Console.Write(" ");
1615                                         break;
1616                                 }
1617
1618                                 case RTF.Minor.Tab: {
1619                                         rtf_line.Append ("\t");
1620 //                                      FlushText (rtf, false);
1621                                         break;
1622                                 }
1623
1624                                 case RTF.Minor.NoReqHyphen:
1625                                 case RTF.Minor.NoBrkHyphen: {
1626                                         rtf_line.Append ("-");
1627 //                                      FlushText (rtf, false);
1628                                         break;
1629                                 }
1630
1631                                 case RTF.Minor.Bullet: {
1632                                         Console.WriteLine("*");
1633                                         break;
1634                                 }
1635
1636                         case RTF.Minor.WidowCtrl:
1637                                 break;
1638
1639                                 case RTF.Minor.EmDash: {
1640                                 rtf_line.Append ("\u2014");
1641                                         break;
1642                                 }
1643
1644                                 case RTF.Minor.EnDash: {
1645                                         rtf_line.Append ("\u2013");
1646                                         break;
1647                                 }
1648 /*
1649                                 case RTF.Minor.LQuote: {
1650                                         Console.Write("\u2018");
1651                                         break;
1652                                 }
1653
1654                                 case RTF.Minor.RQuote: {
1655                                         Console.Write("\u2019");
1656                                         break;
1657                                 }
1658
1659                                 case RTF.Minor.LDblQuote: {
1660                                         Console.Write("\u201C");
1661                                         break;
1662                                 }
1663
1664                                 case RTF.Minor.RDblQuote: {
1665                                         Console.Write("\u201D");
1666                                         break;
1667                                 }
1668 */
1669                                 default: {
1670 //                                      Console.WriteLine ("skipped special char:   {0}", rtf.Minor);
1671 //                                      rtf.SkipGroup();
1672                                         break;
1673                                 }
1674                         }
1675                 }
1676
1677                 private void HandleText(RTF.RTF rtf) {
1678                         if (rtf_skip_count > 0) {
1679                                 rtf_skip_count--;
1680                                 return;
1681                         }
1682
1683                         /*
1684                         if ((RTF.StandardCharCode)rtf.Minor != RTF.StandardCharCode.nothing) {
1685                                 rtf_line.Append(rtf_text_map[(RTF.StandardCharCode)rtf.Minor]);
1686                         } else {
1687                                 if ((int)rtf.Major > 31 && (int)rtf.Major < 128) {
1688                                         rtf_line.Append((char)rtf.Major);
1689                                 } else {
1690                                         //rtf_line.Append((char)rtf.Major);
1691                                         Console.Write("[Literal:0x{0:X2}]", (int)rtf.Major);
1692                                 }
1693                         }
1694                         */
1695                         rtf_line.Append (rtf.EncodedText);
1696                 }
1697
1698                 private void FlushText(RTF.RTF rtf, bool newline) {
1699                         int             length;
1700                         Font            font;
1701
1702                         length = rtf_line.Length;
1703                         if (!newline && (length == 0)) {
1704                                 return;
1705                         }
1706
1707                         if (rtf_style.rtf_rtffont == null) {
1708                                 // First font in table is default
1709                                 rtf_style.rtf_rtffont = System.Windows.Forms.RTF.Font.GetFont (rtf, 0);
1710                         }
1711
1712                         font = new Font (rtf_style.rtf_rtffont.Name, rtf_style.rtf_rtffont_size, rtf_style.rtf_rtfstyle);
1713
1714                         if (rtf_style.rtf_color == Color.Empty) {
1715                                 System.Windows.Forms.RTF.Color color;
1716
1717                                 // First color in table is default
1718                                 color = System.Windows.Forms.RTF.Color.GetColor (rtf, 0);
1719
1720                                 if ((color == null) || (color.Red == -1 && color.Green == -1 && color.Blue == -1)) {
1721                                         rtf_style.rtf_color = ForeColor;
1722                                 } else {
1723                                         rtf_style.rtf_color = Color.FromArgb (color.Red, color.Green, color.Blue);
1724                                 }
1725
1726                         }
1727
1728                         rtf_chars += rtf_line.Length;
1729
1730
1731
1732                         if (rtf_cursor_x == 0) {
1733                                 if (newline && rtf_line.ToString ().EndsWith ("\n") == false)
1734                                         rtf_line.Append ("\n");
1735
1736                                 document.Add (rtf_cursor_y, rtf_line.ToString (), rtf_style.rtf_rtfalign, font, rtf_style.rtf_color,
1737                                                                 newline ? LineEnding.Rich : LineEnding.Wrap);
1738                                 if (rtf_style.rtf_par_line_left_indent != 0) {
1739                                         Line line = document.GetLine (rtf_cursor_y);
1740                                         line.indent = rtf_style.rtf_par_line_left_indent;
1741                                 }
1742                         } else {
1743                                 Line line;
1744
1745                                 line = document.GetLine (rtf_cursor_y);
1746                                 line.indent = rtf_style.rtf_par_line_left_indent;
1747                                 if (rtf_line.Length > 0) {
1748                                         document.InsertString (line, rtf_cursor_x, rtf_line.ToString ());
1749                                         document.FormatText (line, rtf_cursor_x + 1, line, rtf_cursor_x + 1 + length,
1750                             font, rtf_style.rtf_color, Color.Empty,
1751                                                         FormatSpecified.Font | FormatSpecified.Color);
1752                                 }
1753                                 if (newline) {
1754                                         document.Split (line, rtf_cursor_x + length);
1755                                         line = document.GetLine (rtf_cursor_y);
1756                                         line.ending = LineEnding.Rich;
1757
1758                                         if (line.Text.EndsWith ("\n") == false)
1759                                                 line.Text += "\n";
1760                                 }
1761                         }
1762
1763                         if (newline) {
1764                                 rtf_cursor_x = 0;
1765                                 rtf_cursor_y++;
1766                         } else {
1767                                 rtf_cursor_x += length;
1768                         }
1769                         rtf_line.Length = 0;    // Empty line
1770                 }
1771
1772                 private void InsertRTFFromStream(Stream data, int cursor_x, int cursor_y) {
1773                         int     x;
1774                         int     y;
1775                         int     chars;
1776
1777                         InsertRTFFromStream(data, cursor_x, cursor_y, out x, out y, out chars);
1778                 }
1779
1780                 private void InsertRTFFromStream(Stream data, int cursor_x, int cursor_y, out int to_x, out int to_y, out int chars) {
1781                         RTF.RTF         rtf;
1782
1783                         rtf = new RTF.RTF(data);
1784
1785                         // Prepare
1786                         rtf.ClassCallback[RTF.TokenClass.Text] = new RTF.ClassDelegate(HandleText);
1787                         rtf.ClassCallback[RTF.TokenClass.Control] = new RTF.ClassDelegate(HandleControl);
1788                         rtf.ClassCallback[RTF.TokenClass.Group] = new RTF.ClassDelegate(HandleGroup);
1789
1790                         rtf_skip_width = 0;
1791                         rtf_skip_count = 0;
1792                         rtf_line = new StringBuilder();
1793                         rtf_style.rtf_color = Color.Empty;
1794                         rtf_style.rtf_rtffont_size = (int)this.Font.Size;
1795                         rtf_style.rtf_rtfalign = HorizontalAlignment.Left;
1796                         rtf_style.rtf_rtfstyle = FontStyle.Regular;
1797                         rtf_style.rtf_rtffont = null;
1798                         rtf_cursor_x = cursor_x;
1799                         rtf_cursor_y = cursor_y;
1800                         rtf_chars = 0;
1801                         rtf.DefaultFont(this.Font.Name);
1802
1803                         rtf_text_map = new RTF.TextMap();
1804                         RTF.TextMap.SetupStandardTable(rtf_text_map.Table);
1805
1806                         document.SuspendRecalc ();
1807
1808                         try {
1809                                 rtf.Read();     // That's it
1810                                 FlushText(rtf, false);
1811
1812                         }
1813
1814
1815                         catch (RTF.RTFException e) {
1816 #if DEBUG
1817                                 throw e;
1818 #endif
1819                                 // Seems to be plain text or broken RTF
1820                                 Console.WriteLine("RTF Parsing failure: {0}", e.Message);
1821                         }
1822
1823                         to_x = rtf_cursor_x;
1824                         to_y = rtf_cursor_y;
1825                         chars = rtf_chars;
1826
1827                         // clear the section stack if it was used
1828                         if (rtf_section_stack != null)
1829                                 rtf_section_stack.Clear();
1830
1831                         document.RecalculateDocument(CreateGraphicsInternal(), cursor_y, document.Lines, false);
1832                         document.ResumeRecalc (true);
1833
1834                         document.Invalidate (document.GetLine(cursor_y), 0, document.GetLine(document.Lines), -1);
1835                 }
1836
1837                 private void RichTextBox_HScrolled(object sender, EventArgs e) {
1838                         OnHScroll(e);
1839                 }
1840
1841                 private void RichTextBox_VScrolled(object sender, EventArgs e) {
1842                         OnVScroll(e);
1843                 }
1844
1845                 private void PointToTagPos(Point pt, out LineTag tag, out int pos) {
1846                         Point p;
1847
1848                         p = pt;
1849
1850                         if (p.X >= document.ViewPortWidth) {
1851                                 p.X = document.ViewPortWidth - 1;
1852                         } else if (p.X < 0) {
1853                                 p.X = 0;
1854                         }
1855
1856                         if (p.Y >= document.ViewPortHeight) {
1857                                 p.Y = document.ViewPortHeight - 1;
1858                         } else if (p.Y < 0) {
1859                                 p.Y = 0;
1860                         }
1861
1862                         tag = document.FindCursor(p.X + document.ViewPortX, p.Y + document.ViewPortY, out pos);
1863                 }
1864
1865                 private void EmitRTFFontProperties(StringBuilder rtf, int prev_index, int font_index, Font prev_font, Font font) {
1866                         if (prev_index != font_index) {
1867                                 rtf.Append(String.Format("\\f{0}", font_index));        // Font table entry
1868                         }
1869
1870                         if ((prev_font == null) || (prev_font.Size != font.Size)) {
1871                                 rtf.Append(String.Format("\\fs{0}", (int)(font.Size * 2)));             // Font size
1872                         }
1873
1874                         if ((prev_font == null) || (font.Bold != prev_font.Bold)) {
1875                                 if (font.Bold) {
1876                                         rtf.Append("\\b");
1877                                 } else {
1878                                         if (prev_font != null) {
1879                                                 rtf.Append("\\b0");
1880                                         }
1881                                 }
1882                         }
1883
1884                         if ((prev_font == null) || (font.Italic != prev_font.Italic)) {
1885                                 if (font.Italic) {
1886                                         rtf.Append("\\i");
1887                                 } else {
1888                                         if (prev_font != null) {
1889                                                 rtf.Append("\\i0");
1890                                         }
1891                                 }
1892                         }
1893
1894                         if ((prev_font == null) || (font.Strikeout != prev_font.Strikeout)) {
1895                                 if (font.Strikeout) {
1896                                         rtf.Append("\\strike");
1897                                 } else {
1898                                         if (prev_font != null) {
1899                                                 rtf.Append("\\strike0");
1900                                         }
1901                                 }
1902                         }
1903
1904                         if ((prev_font == null) || (font.Underline != prev_font.Underline)) {
1905                                 if (font.Underline) {
1906                                         rtf.Append("\\ul");
1907                                 } else {
1908                                         if (prev_font != null) {
1909                                                 rtf.Append("\\ul0");
1910                                         }
1911                                 }
1912                         }
1913                 }
1914
1915                 [MonoTODO("Emit unicode and other special characters properly")]
1916                 private void EmitRTFText(StringBuilder rtf, string text) {
1917                         rtf.Append(text);
1918                 }
1919
1920                 // start_pos and end_pos are 0-based
1921                 private StringBuilder GenerateRTF(Line start_line, int start_pos, Line end_line, int end_pos) {
1922                         StringBuilder   sb;
1923                         ArrayList       fonts;
1924                         ArrayList       colors;
1925                         Color           color;
1926                         Font            font;
1927                         Line            line;
1928                         LineTag         tag;
1929                         int             pos;
1930                         int             line_no;
1931                         int             line_len;
1932                         int             i;
1933                         int             length;
1934
1935                         sb = new StringBuilder();
1936                         fonts = new ArrayList(10);
1937                         colors = new ArrayList(10);
1938
1939                         // Two runs, first we parse to determine tables;
1940                         // and unlike most of our processing here we work on tags
1941
1942                         line = start_line;
1943                         line_no = start_line.line_no;
1944                         pos = start_pos;
1945
1946                         // Add default font and color; to optimize document content we don't
1947                         // use this.Font and this.ForeColor but the font/color from the first tag
1948                         tag = LineTag.FindTag(start_line, pos);
1949                         font = tag.Font;
1950                         color = tag.Color;
1951                         fonts.Add(font.Name);
1952                         colors.Add(color);
1953
1954                         while (line_no <= end_line.line_no) {
1955                                 line = document.GetLine(line_no);
1956                                 tag = LineTag.FindTag(line, pos);
1957
1958                                 if (line_no != end_line.line_no) {
1959                                         line_len = line.text.Length;
1960                                 } else {
1961                                         line_len = end_pos;
1962                                 }
1963
1964                                 while (pos < line_len) {
1965                                         if (tag.Font.Name != font.Name) {
1966                                                 font = tag.Font;
1967                                                 if (!fonts.Contains(font.Name)) {
1968                                                         fonts.Add(font.Name);
1969                                                 }
1970                                         }
1971
1972                                         if (tag.Color != color) {
1973                                                 color = tag.Color;
1974                                                 if (!colors.Contains(color)) {
1975                                                         colors.Add(color);
1976                                                 }
1977                                         }
1978
1979                                         pos = tag.Start + tag.Length - 1;
1980                                         tag = tag.Next;
1981                                 }
1982                                 pos = 0;
1983                                 line_no++;
1984                         }
1985
1986                         // We have the tables, emit the header
1987                         sb.Append("{\\rtf1\\ansi");
1988                         sb.Append("\\ansicpg1252");     // FIXME - is this correct?
1989
1990                         // Default Font
1991                         sb.Append(String.Format("\\deff{0}", fonts.IndexOf(this.Font.Name)));
1992
1993                         // Default Language
1994                         sb.Append("\\deflang1033\n");   // FIXME - always 1033?
1995
1996                         // Emit the font table
1997                         sb.Append("{\\fonttbl");
1998                         for (i = 0; i < fonts.Count; i++) {
1999                                 sb.Append(String.Format("{{\\f{0}", i));        // {Font
2000                                 sb.Append("\\fnil");                    // Family
2001                                 sb.Append("\\fcharset0 ");              // Charset ANSI<space>
2002                                 sb.Append((string)fonts[i]);            // Font name
2003                                 sb.Append(";}");                        // }
2004                         }
2005                         sb.Append("}\n");
2006
2007                         // Emit the color table (if needed)
2008                         if ((colors.Count > 1) || ((((Color)colors[0]).R != this.ForeColor.R) || (((Color)colors[0]).G != this.ForeColor.G) || (((Color)colors[0]).B != this.ForeColor.B))) {
2009                                 sb.Append("{\\colortbl ");                      // Header and NO! default color
2010                                 for (i = 0; i < colors.Count; i++) {
2011                                         sb.Append(String.Format("\\red{0}", ((Color)colors[i]).R));
2012                                         sb.Append(String.Format("\\green{0}", ((Color)colors[i]).G));
2013                                         sb.Append(String.Format("\\blue{0}", ((Color)colors[i]).B));
2014                                         sb.Append(";");
2015                                 }
2016                                 sb.Append("}\n");
2017                         }
2018
2019                         sb.Append("{\\*\\generator Mono RichTextBox;}");
2020                         // Emit initial paragraph settings
2021                         tag = LineTag.FindTag(start_line, start_pos);
2022                         sb.Append("\\pard");    // Reset to default paragraph properties
2023                         EmitRTFFontProperties(sb, -1, fonts.IndexOf(tag.Font.Name), null, tag.Font);    // Font properties
2024                         sb.Append(" ");         // Space separator
2025
2026                         font = tag.Font;
2027                         color = (Color)colors[0];
2028                         line = start_line;
2029                         line_no = start_line.line_no;
2030                         pos = start_pos;
2031
2032                         while (line_no <= end_line.line_no) {
2033                                 line = document.GetLine(line_no);
2034                                 tag = LineTag.FindTag(line, pos);
2035
2036                                 if (line_no != end_line.line_no) {
2037                                         line_len = line.text.Length;
2038                                 } else {
2039                                         line_len = end_pos;
2040                                 }
2041
2042                                 while (pos < line_len) {
2043                                         length = sb.Length;
2044
2045                                         if (tag.Font != font) {
2046                                                 EmitRTFFontProperties(sb, fonts.IndexOf(font.Name), fonts.IndexOf(tag.Font.Name), font, tag.Font);
2047                                                 font = tag.Font;
2048                                         }
2049
2050                                         if (tag.Color != color) {
2051                                                 color = tag.Color;
2052                                                 sb.Append(String.Format("\\cf{0}", colors.IndexOf(color)));
2053                                         }
2054                                         if (length != sb.Length) {
2055                                                 sb.Append(" "); // Emit space to separate keywords from text
2056                                         }
2057
2058                                         // Emit the string itself
2059                                         if (line_no != end_line.line_no) {
2060                                                 EmitRTFText(sb, tag.Line.text.ToString(pos, tag.Start + tag.Length - pos - 1));
2061                                         } else {
2062                                                 if (end_pos < (tag.Start + tag.Length - 1)) {
2063                                                         // Emit partial tag only, end_pos is inside this tag
2064                                                         EmitRTFText(sb, tag.Line.text.ToString(pos, end_pos - pos));
2065                                                 } else {
2066                                                         EmitRTFText(sb, tag.Line.text.ToString(pos, tag.Start + tag.Length - pos - 1));
2067                                                 }
2068                                         }
2069
2070                                         pos = tag.Start + tag.Length - 1;
2071                                         tag = tag.Next;
2072                                 }
2073                                 if (pos >= line.text.Length) {
2074                                         if (line.ending != LineEnding.Wrap) {
2075                                                 sb.Append("\\par\n");
2076                                         }
2077                                 }
2078                                 pos = 0;
2079                                 line_no++;
2080                         }
2081
2082                         sb.Append("}\n");
2083
2084                         return sb;
2085                 }
2086                 #endregion      // Private Methods
2087         }
2088 }