RichTextBox target

Log text a Rich Text Box control in an existing or new form. 

Configuration Syntax

Parameters

• General Options
• name - Name of the target.
• Layout Options
• layout - Layout used to format log messages.Layout Required. Default: ${longdate}|${level:uppercase=true}|${logger}|${message}
• Form Options
• 
  height - Initial height of the form with rich text box.Integer
  This parameter is ignored when logging to existing form control.

  This parameter is not supported in:

  • NLog v1.0 for .NET Framework 1.0
  • NLog v1.0 for .NET Framework 1.1
  • NLog v1.0 for .NET Framework 2.0
• 
  autoScroll - Indicates whether scroll bar will be moved automatically to show most recent log entries.Boolean

  This parameter is not supported in:

  • NLog v1.0 for .NET Framework 1.0
  • NLog v1.0 for .NET Framework 1.1
  • NLog v1.0 for .NET Framework 2.0
• 
  maxLines - Maximum number of lines the rich text box will store (or 0 to disable this feature).Integer
  After exceeding the maximum number, first line will be deleted.

  This parameter is not supported in:

  • NLog v1.0 for .NET Framework 1.0
  • NLog v1.0 for .NET Framework 1.1
  • NLog v1.0 for .NET Framework 2.0
• 
  showMinimized - Indicates whether the created form will be initially minimized.Boolean
  This parameter is ignored when logging to existing form control.

  This parameter is not supported in:

  • NLog v1.0 for .NET Framework 1.0
  • NLog v1.0 for .NET Framework 1.1
  • NLog v1.0 for .NET Framework 2.0
• 
  toolWindow - Indicates whether the created window will be a tool window.Boolean Default: True
  This parameter is ignored when logging to existing form control. Tool windows have thin border, and do not show up in the task bar.

  This parameter is not supported in:

  • NLog v1.0 for .NET Framework 1.0
  • NLog v1.0 for .NET Framework 1.1
  • NLog v1.0 for .NET Framework 2.0
• controlName - Name of RichTextBox to which Nlog will write.
• formName - Name of the Form on which the control is located. If there is no open form of a specified name than NLog will create a new one.
• 
  width - Initial width of the form with rich text box.Integer
  This parameter is ignored when logging to existing form control.

  This parameter is not supported in:

  • NLog v1.0 for .NET Framework 1.0
  • NLog v1.0 for .NET Framework 1.1
  • NLog v1.0 for .NET Framework 2.0
• Highlighting Options
• wordColoringRules - The word highlighting rules.Collection
  Each collection item is represented by <word-coloring /> element with the following attributes:
  • backgroundColor - Background color. Names are identical with KnownColor enum extended with Empty value which means that background color won't be changed. Default: Empty
  • fontColor - Font color. Names are identical with KnownColor enum extended with Empty value which means that font color won't be changed. Default: Empty
  • ignoreCase - Indicates whether to ignore case when comparing texts.Boolean Default: False
  • regex - Regular expression to be matched. You must specify either text or regex.
  • style - Font style of matched text. Possible values are the same as in FontStyle enum in System.Drawing.
    Possible values:
    • Bold -
    • Italic -
    • Regular -
    • Strikeout -
    • Underline -
  • text - Text to be matched. You must specify either text or regex.
  • wholeWords - Indicates whether to match whole words only.Boolean Default: False
• useDefaultRowColoringRules - Indicates whether to use default coloring rules.Boolean Default: False
• rowColoringRules - The row coloring rules.Collection
  Each collection item is represented by <row-coloring /> element with the following attributes:
  • backgroundColor - Background color. Default: Empty
    Names are identical with KnownColor enum extended with Empty value which means that background color won't be changed.
  • condition - Condition that must be met in order to set the specified font color.Condition Required.
  • fontColor - Font color. Default: Empty
    Names are identical with KnownColor enum extended with Empty value which means that background color won't be changed.
  • style - Font style of matched text.
    Possible values:
    • Bold -
    • Italic -
    • Regular -
    • Strikeout -
    • Underline -
    Possible values are the same as in FontStyle enum in System.Drawing