Subversion Repositories SoapBoxCore

Compare Revisions

Ignore whitespace Rev 10 → Rev 11

/trunk/NLog/src/NLog/NLog.xml
4,280 → 4,11
<name>NLog</name>
</assembly>
<members>
<member name="T:NLog.Win32.Targets.PerfCounterTarget">
<member name="T:NLog.Win32.LayoutRenderers.RegistryLayoutRenderer">
<summary>
Increments specified performance counter on each write.
A value from the Registry.
</summary>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/PerfCounter/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/PerfCounter/Simple/Example.cs" />
</example>
<remarks>
TODO:
1. Unable to create a category allowing multiple counter instances (.Net 2.0 API only, probably)
2. Is there any way of adding new counters without deleting the whole category?
3. There should be some mechanism of resetting the counter (e.g every day starts from 0), or auto-switching to
another counter instance (with dynamic creation of new instance). This could be done with layouts.
</remarks>
</member>
<member name="T:NLog.Target">
<summary>
Represents logging target.
</summary>
</member>
<member name="M:NLog.Target.#ctor">
<summary>
Creates a new instance of the logging target and initializes
default layout.
</summary>
<remarks>
The default value of the layout is: <code>${longdate}|${level:uppercase=true}|${logger}|${message}</code>
</remarks>
</member>
<member name="M:NLog.Target.GetLayouts">
<summary>
Gets the collection of <see cref="T:NLog.Layout"/> objects that are used
by this target.
</summary>
<returns>A <see cref="T:NLog.LayoutCollection"/> object which is a typed collection
of <see cref="T:NLog.Layout"/> objects. The collection is cached and accumulated
by calling <see cref="M:NLog.Target.PopulateLayouts(NLog.LayoutCollection)"/>.</returns>
</member>
<member name="M:NLog.Target.InvalidateLayouts">
<summary>
Invalidates the collection of layouts cached by <see cref="M:NLog.Target.GetLayouts"/>.
</summary>
</member>
<member name="M:NLog.Target.Write(NLog.LogEventInfo)">
<summary>
Writes logging event to the log target. Must be overridden in inheriting
classes.
</summary>
<param name="logEvent">Logging event to be written out.</param>
</member>
<member name="M:NLog.Target.Write(NLog.LogEventInfo[])">
<summary>
Writes an array of logging events to the log target. By default it iterates on all
events and passes them to "Append" method. Inheriting classes can use this method to
optimize batch writes.
</summary>
<param name="logEvents">Logging events to be written out.</param>
</member>
<member name="M:NLog.Target.NeedsStackTrace">
<summary>
Determines whether stack trace information should be gathered
during log event processing. By default it calls <see cref="M:NLog.Layout.NeedsStackTrace"/> on
the result of <see cref="M:NLog.Target.GetLayouts"/>.
</summary>
<returns>0 - don't include stack trace<br/>1 - include stack trace without source file information<br/>2 - include full stack trace</returns>
</member>
<member name="M:NLog.Target.ToString">
<summary>
Returns the text representation of the object. Used for diagnostics.
</summary>
<returns>A string that describes the target.</returns>
</member>
<member name="M:NLog.Target.Flush">
<summary>
Flush any pending log messages (in case of asynchronous targets).
</summary>
</member>
<member name="M:NLog.Target.Flush(System.TimeSpan)">
<summary>
Flush any pending log messages (in case of asynchronous targets).
</summary>
<param name="timeout">Maximum time to allow for the flush. Any messages after that time will be discarded.</param>
</member>
<member name="M:NLog.Target.Flush(System.Int32)">
<summary>
Flush any pending log messages (in case of asynchronous targets).
</summary>
<param name="timeoutMilliseconds">Maximum time to allow for the flush. Any messages after that time will be discarded.</param>
</member>
<member name="M:NLog.Target.Close">
<summary>
Closes the target and releases any unmanaged resources.
</summary>
</member>
<member name="M:NLog.Target.PrecalculateVolatileLayouts(NLog.LogEventInfo)">
<summary>
Calls the <see cref="M:NLog.Layout.Precalculate(NLog.LogEventInfo)"/> on each volatile layout
used by this target.
</summary>
<param name="logEvent">The log event.</param>
<remarks>
A layout is volatile if it contains at least one <see cref="T:NLog.Layout"/> for
which <see cref="M:NLog.LayoutRenderer.IsVolatile"/> returns true.
</remarks>
</member>
<member name="M:NLog.Target.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Adds all layouts used by this target to the specified collection.
</summary>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.Target.Initialize">
<summary>
Initializes the target. Can be used by inheriting classes
to initialize logging.
</summary>
</member>
<member name="P:NLog.Target.Name">
<summary>
The name of the target.
</summary>
</member>
<member name="M:NLog.Win32.Targets.PerfCounterTarget.#ctor">
<summary>
Creates a new instance of <see cref="T:NLog.Win32.Targets.PerfCounterTarget"/>.
</summary>
</member>
<member name="M:NLog.Win32.Targets.PerfCounterTarget.Write(NLog.LogEventInfo)">
<summary>
Increments the configured performance counter.
</summary>
<param name="logEvent">log event</param>
</member>
<member name="P:NLog.Win32.Targets.PerfCounterTarget.AutoCreate">
<summary>
Whether performance counter should be automatically created.
</summary>
</member>
<member name="P:NLog.Win32.Targets.PerfCounterTarget.CategoryName">
<summary>
Performance counter category.
</summary>
</member>
<member name="P:NLog.Win32.Targets.PerfCounterTarget.CounterName">
<summary>
Name of the performance counter.
</summary>
</member>
<member name="P:NLog.Win32.Targets.PerfCounterTarget.InstanceName">
<summary>
Instance name.
</summary>
</member>
<member name="P:NLog.Win32.Targets.PerfCounterTarget.CounterType">
<summary>
Performance counter type.
</summary>
</member>
<member name="T:NLog.Targets.DebugTarget">
<summary>
Counts logging messages but does not output them anywhere. Provides
the counter of logged messages and remembers the latest one.
</summary>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/Debug/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/Debug/Simple/Example.cs" />
</example>
</member>
<member name="T:NLog.TargetWithLayout">
<summary>
Represents target that supports string formatting using layouts.
</summary>
</member>
<member name="M:NLog.TargetWithLayout.#ctor">
<summary>
Creates a new instance of <see cref="T:NLog.TargetWithLayout"/>
</summary>
</member>
<member name="M:NLog.TargetWithLayout.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Adds all layouts used by this target to the specified collection.
</summary>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.TargetWithLayout.Initialize">
<summary>
Initializes the target.
</summary>
</member>
<member name="P:NLog.TargetWithLayout.Layout">
<summary>
The text to be rendered.
</summary>
</member>
<member name="P:NLog.TargetWithLayout.CompiledLayout">
<summary>
The compiled layout, can be an instance of <see cref="P:NLog.TargetWithLayout.Layout"/> or other layout type.
</summary>
</member>
<member name="M:NLog.Targets.DebugTarget.Write(NLog.LogEventInfo)">
<summary>
Increases the number of messages.
</summary>
<param name="logEvent">The logging event.</param>
</member>
<member name="P:NLog.Targets.DebugTarget.Counter">
<summary>
The number of times this target has been called.
</summary>
</member>
<member name="P:NLog.Targets.DebugTarget.LastMessage">
<summary>
The last message rendered by this target.
</summary>
</member>
<member name="T:NLog.TargetAttribute">
<summary>
Marks class as a logging target and assigns a name to it.
</summary>
</member>
<member name="M:NLog.TargetAttribute.#ctor(System.String)">
<summary>
Creates a new instance of the TargetAttribute class and sets the name.
</summary>
<param name="name"></param>
</member>
<member name="P:NLog.TargetAttribute.Name">
<summary>
The name of the logging target.
</summary>
</member>
<member name="P:NLog.TargetAttribute.IgnoresLayout">
<summary>
Determines whether the target ignores layout specification.
</summary>
</member>
<member name="P:NLog.TargetAttribute.IsWrapper">
<summary>
Marks the target as 'wrapper' target (used to generate the target summary documentation page);
</summary>
</member>
<member name="P:NLog.TargetAttribute.IsCompound">
<summary>
Marks the target as 'compound' target (used to generate the target summary documentation page);
</summary>
</member>
<member name="T:NLog.LayoutRenderers.NLogDirLayoutRenderer">
<summary>
The directory where NLog.dll is located.
</summary>
</member>
<member name="T:NLog.LayoutRenderer">
<summary>
Render environmental information related to logging events.
416,7 → 147,7
The <see cref="T:System.Globalization.CultureInfo"/> to be used for rendering.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.NLogDirLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="M:NLog.Win32.LayoutRenderers.RegistryLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
424,809 → 155,655
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
This function always returns 32.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.NLogDirLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.Win32.LayoutRenderers.RegistryLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Renders the directory where NLog is located and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Reads the specified registry key and value and appends it to
the passed <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
<param name="logEvent">Logging event. Ignored.</param>
</member>
<member name="M:NLog.LayoutRenderers.NLogDirLayoutRenderer.IsAppDomainFixed">
<member name="P:NLog.Win32.LayoutRenderers.RegistryLayoutRenderer.Value">
<summary>
Determines whether the value produced by the layout renderer
is fixed per current app-domain.
Registry value.
</summary>
<returns><see langword="true"/></returns>
</member>
<member name="P:NLog.LayoutRenderers.NLogDirLayoutRenderer.File">
<member name="P:NLog.Win32.LayoutRenderers.RegistryLayoutRenderer.DefaultValue">
<summary>
The name of the file to be Path.Combine()'d with the directory name.
The value to be output when the specified registry key or value is not found.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.NLogDirLayoutRenderer.Dir">
<member name="P:NLog.Win32.LayoutRenderers.RegistryLayoutRenderer.Key">
<summary>
The name of the directory to be Path.Combine()'d with the directory name.
Registry key.
</summary>
</member>
<member name="T:NLog.LayoutRenderers.LongDateLayoutRenderer">
<summary>
The date and time in a long, sortable format yyyy-MM-dd HH:mm:ss.mmm
</summary>
</member>
<member name="M:NLog.LayoutRenderers.LongDateLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
Must have one of the forms:
<ul>
<li>HKLM\Key\Full\Name</li>
<li>HKEY_LOCAL_MACHINE\Key\Full\Name</li>
<li>HKCU\Key\Full\Name</li>
<li>HKEY_CURRENT_USER\Key\Full\Name</li>
</ul>
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.LongDateLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="T:NLog.Targets.DebugTarget">
<summary>
Renders the date in the long format (yyyy-MM-dd HH:mm:ss.mmm) and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Counts logging messages but does not output them anywhere. Provides
the counter of logged messages and remembers the latest one.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/Debug/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/Debug/Simple/Example.cs" />
</example>
</member>
<member name="T:NLog.LayoutRenderers.ExceptionLayoutRenderer">
<member name="T:NLog.TargetWithLayout">
<summary>
Exception information provided through
a call to one of the Logger.*Exception() methods.
Represents target that supports string formatting using layouts.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.ExceptionLayoutRenderer.#ctor">
<member name="T:NLog.Target">
<summary>
Initializes a new instance of <see cref="T:NLog.LayoutRenderers.ExceptionLayoutRenderer"/>.
Represents logging target.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.ExceptionLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="M:NLog.Target.#ctor">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
Creates a new instance of the logging target and initializes
default layout.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
The default value of the layout is: <code>${longdate}|${level:uppercase=true}|${logger}|${message}</code>
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.ExceptionLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.Target.GetLayouts">
<summary>
Renders the specified exception information and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Gets the collection of <see cref="T:NLog.Layout"/> objects that are used
by this target.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
<returns>A <see cref="T:NLog.LayoutCollection"/> object which is a typed collection
of <see cref="T:NLog.Layout"/> objects. The collection is cached and accumulated
by calling <see cref="M:NLog.Target.PopulateLayouts(NLog.LayoutCollection)"/>.</returns>
</member>
<member name="P:NLog.LayoutRenderers.ExceptionLayoutRenderer.Format">
<member name="M:NLog.Target.InvalidateLayouts">
<summary>
The format of the output. Must be a comma-separated list of exception
properties: Message, Type, ShortType, ToString, Method, StackTrace.
This parameter value is case-insensitive.
Invalidates the collection of layouts cached by <see cref="M:NLog.Target.GetLayouts"/>.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.ExceptionLayoutRenderer.Separator">
<member name="M:NLog.Target.Write(NLog.LogEventInfo)">
<summary>
The separator used to concatenate parts specified in the Format.
Writes logging event to the log target. Must be overridden in inheriting
classes.
</summary>
<param name="logEvent">Logging event to be written out.</param>
</member>
<member name="T:NLog.LayoutRenderers.ASPNETRequestValueLayoutRenderer">
<member name="M:NLog.Target.Write(NLog.LogEventInfo[])">
<summary>
ASP.NET Request variable
Writes an array of logging events to the log target. By default it iterates on all
events and passes them to "Append" method. Inheriting classes can use this method to
optimize batch writes.
</summary>
<remarks>
Use this layout renderer to insert the value of the specified parameter of the
ASP.NET Request object.
</remarks>
<example>
<para>Example usage of ${aspnet-request}:</para>
<code lang="NLog Layout Renderer">
${aspnet-request:item=v}
${aspnet-request:querystring=v}
${aspnet-request:form=v}
${aspnet-request:cookie=v}
${aspnet-request:serverVariable=v}
</code>
</example>
<param name="logEvents">Logging events to be written out.</param>
</member>
<member name="M:NLog.LayoutRenderers.ASPNETRequestValueLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="M:NLog.Target.NeedsStackTrace">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
Determines whether stack trace information should be gathered
during log event processing. By default it calls <see cref="M:NLog.Layout.NeedsStackTrace"/> on
the result of <see cref="M:NLog.Target.GetLayouts"/>.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
<returns>0 - don't include stack trace<br/>1 - include stack trace without source file information<br/>2 - include full stack trace</returns>
</member>
<member name="M:NLog.LayoutRenderers.ASPNETRequestValueLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.Target.ToString">
<summary>
Renders the specified ASP.NET Request variable and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Returns the text representation of the object. Used for diagnostics.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
<returns>A string that describes the target.</returns>
</member>
<member name="P:NLog.LayoutRenderers.ASPNETRequestValueLayoutRenderer.Item">
<member name="M:NLog.Target.Flush">
<summary>
The item name. The QueryString, Form, Cookies, or ServerVariables collection variables having the specified name are rendered.
Flush any pending log messages (in case of asynchronous targets).
</summary>
</member>
<member name="P:NLog.LayoutRenderers.ASPNETRequestValueLayoutRenderer.QueryString">
<member name="M:NLog.Target.Flush(System.TimeSpan)">
<summary>
The QueryString variable to be rendered.
Flush any pending log messages (in case of asynchronous targets).
</summary>
<param name="timeout">Maximum time to allow for the flush. Any messages after that time will be discarded.</param>
</member>
<member name="P:NLog.LayoutRenderers.ASPNETRequestValueLayoutRenderer.Form">
<member name="M:NLog.Target.Flush(System.Int32)">
<summary>
The form variable to be rendered.
Flush any pending log messages (in case of asynchronous targets).
</summary>
<param name="timeoutMilliseconds">Maximum time to allow for the flush. Any messages after that time will be discarded.</param>
</member>
<member name="P:NLog.LayoutRenderers.ASPNETRequestValueLayoutRenderer.Cookie">
<member name="M:NLog.Target.Close">
<summary>
The cookie to be rendered.
Closes the target and releases any unmanaged resources.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.ASPNETRequestValueLayoutRenderer.ServerVariable">
<member name="M:NLog.Target.PrecalculateVolatileLayouts(NLog.LogEventInfo)">
<summary>
The ServerVariables item to be rendered.
Calls the <see cref="M:NLog.Layout.Precalculate(NLog.LogEventInfo)"/> on each volatile layout
used by this target.
</summary>
<param name="logEvent">The log event.</param>
<remarks>
A layout is volatile if it contains at least one <see cref="T:NLog.Layout"/> for
which <see cref="M:NLog.LayoutRenderer.IsVolatile"/> returns true.
</remarks>
</member>
<member name="T:NLog.FilterCollection">
<member name="M:NLog.Target.PopulateLayouts(NLog.LayoutCollection)">
<summary>
A collection of elements of type Filter
Adds all layouts used by this target to the specified collection.
</summary>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.FilterCollection.#ctor">
<member name="M:NLog.Target.Initialize">
<summary>
Initializes a new empty instance of the FilterCollection class.
Initializes the target. Can be used by inheriting classes
to initialize logging.
</summary>
</member>
<member name="M:NLog.FilterCollection.#ctor(NLog.Filter[])">
<member name="P:NLog.Target.Name">
<summary>
Initializes a new instance of the FilterCollection class, containing elements
copied from an array.
The name of the target.
</summary>
<param name="items">
The array whose elements are to be added to the new FilterCollection.
</param>
</member>
<member name="M:NLog.FilterCollection.#ctor(NLog.FilterCollection)">
<member name="M:NLog.TargetWithLayout.#ctor">
<summary>
Initializes a new instance of the FilterCollection class, containing elements
copied from another instance of FilterCollection
Creates a new instance of <see cref="T:NLog.TargetWithLayout"/>
</summary>
<param name="items">
The FilterCollection whose elements are to be added to the new FilterCollection.
</param>
</member>
<member name="M:NLog.FilterCollection.AddRange(NLog.Filter[])">
<member name="M:NLog.TargetWithLayout.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Adds the elements of an array to the end of this FilterCollection.
Adds all layouts used by this target to the specified collection.
</summary>
<param name="items">
The array whose elements are to be added to the end of this FilterCollection.
</param>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.FilterCollection.AddRange(NLog.FilterCollection)">
<member name="M:NLog.TargetWithLayout.Initialize">
<summary>
Adds the elements of another FilterCollection to the end of this FilterCollection.
Initializes the target.
</summary>
<param name="items">
The FilterCollection whose elements are to be added to the end of this FilterCollection.
</param>
</member>
<member name="M:NLog.FilterCollection.Add(NLog.Filter)">
<member name="P:NLog.TargetWithLayout.Layout">
<summary>
Adds an instance of type Filter to the end of this FilterCollection.
The text to be rendered.
</summary>
<param name="value">
The Filter to be added to the end of this FilterCollection.
</param>
</member>
<member name="M:NLog.FilterCollection.Contains(NLog.Filter)">
<member name="P:NLog.TargetWithLayout.CompiledLayout">
<summary>
Determines whether a specfic Filter value is in this FilterCollection.
The compiled layout, can be an instance of <see cref="P:NLog.TargetWithLayout.Layout"/> or other layout type.
</summary>
<param name="value">
The Filter value to locate in this FilterCollection.
</param>
<returns>
true if value is found in this FilterCollection;
false otherwise.
</returns>
</member>
<member name="M:NLog.FilterCollection.IndexOf(NLog.Filter)">
<member name="M:NLog.Targets.DebugTarget.Write(NLog.LogEventInfo)">
<summary>
Return the zero-based index of the first occurrence of a specific value
in this FilterCollection
Increases the number of messages.
</summary>
<param name="value">
The Filter value to locate in the FilterCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
<param name="logEvent">The logging event.</param>
</member>
<member name="M:NLog.FilterCollection.Insert(System.Int32,NLog.Filter)">
<member name="P:NLog.Targets.DebugTarget.Counter">
<summary>
Inserts an element into the FilterCollection at the specified index
The number of times this target has been called.
</summary>
<param name="index">
The index at which the Filter is to be inserted.
</param>
<param name="value">
The Filter to insert.
</param>
</member>
<member name="M:NLog.FilterCollection.Remove(NLog.Filter)">
<member name="P:NLog.Targets.DebugTarget.LastMessage">
<summary>
Removes the first occurrence of a specific Filter from this FilterCollection.
The last message rendered by this target.
</summary>
<param name="value">
The Filter value to remove from this FilterCollection.
</param>
</member>
<member name="M:NLog.FilterCollection.GetEnumerator">
<member name="T:NLog.Config.RuntimeFramework">
<summary>
Returns an enumerator that can iterate through the elements of this FilterCollection.
Supported runtime frameworks.
</summary>
<returns>
An object that implements System.Collections.IEnumerator.
</returns>
<remarks>
If you add anything here, make sure to add the appropriate detection
code to <see cref="T:NLog.Internal.PlatformDetector"/>
</remarks>
</member>
<member name="P:NLog.FilterCollection.Item(System.Int32)">
<member name="F:NLog.Config.RuntimeFramework.Any">
<summary>
Gets or sets the Filter at the given index in this FilterCollection.
Any framework.
</summary>
</member>
<member name="T:NLog.FilterCollection.Enumerator">
<member name="F:NLog.Config.RuntimeFramework.DotNetCompactFramework">
<summary>
Type-specific enumeration class, used by FilterCollection.GetEnumerator.
.NET Compact Framework
</summary>
</member>
<member name="M:NLog.FilterCollection.Enumerator.#ctor(NLog.FilterCollection)">
<member name="F:NLog.Config.RuntimeFramework.DotNetFramework">
<summary>
.NET Framework
</summary>
<param name="collection"></param>
</member>
<member name="M:NLog.FilterCollection.Enumerator.MoveNext">
<member name="F:NLog.Config.RuntimeFramework.Mono">
<summary>
Mono Project
</summary>
<returns></returns>
</member>
<member name="M:NLog.FilterCollection.Enumerator.Reset">
<member name="F:NLog.Config.RuntimeFramework.Unknown">
<summary>
Unknown
</summary>
</member>
<member name="P:NLog.FilterCollection.Enumerator.Current">
<member name="T:NLog.Conditions.ConditionTokenizer">
<summary>
Hand-written tokenizer for conditions.
</summary>
</member>
<member name="P:NLog.FilterCollection.Enumerator.System#Collections#IEnumerator#Current">
<member name="T:NLog.Conditions.ConditionMethodExpression">
<summary>
Condition method invocation expression (represented by <b>method(p1,p2,p3)</b> syntax).
</summary>
</member>
<member name="T:NLog.Conditions.ConditionTokenType">
<member name="T:NLog.Conditions.ConditionExpression">
<summary>
Token types for condition expressions.
Base class for representing nodes in condition expression trees.
</summary>
</member>
<member name="T:NLog.Conditions.ConditionExpressionCollection">
<member name="M:NLog.Conditions.ConditionExpression.Evaluate(NLog.LogEventInfo)">
<summary>
A collection of elements of type ConditionExpression
Evaluates the expression.
</summary>
<param name="context">Evaluation context.</param>
<returns>Expression result.</returns>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.#ctor">
<member name="M:NLog.Conditions.ConditionExpression.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Initializes a new empty instance of the ConditionExpressionCollection class.
Adds all layouts used by this expression to the specified collection.
</summary>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.#ctor(NLog.Conditions.ConditionExpression[])">
<member name="M:NLog.Conditions.ConditionMethodExpression.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Initializes a new instance of the ConditionExpressionCollection class, containing elements
copied from an array.
Adds all layouts used by this expression to the specified collection.
</summary>
<param name="items">
The array whose elements are to be added to the new ConditionExpressionCollection.
</param>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.#ctor(NLog.Conditions.ConditionExpressionCollection)">
<member name="T:NLog.Conditions.ConditionLayoutExpression">
<summary>
Initializes a new instance of the ConditionExpressionCollection class, containing elements
copied from another instance of ConditionExpressionCollection
Condition layout expression (represented by a string literal
with embedded ${})
</summary>
<param name="items">
The ConditionExpressionCollection whose elements are to be added to the new ConditionExpressionCollection.
</param>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.AddRange(NLog.Conditions.ConditionExpression[])">
<member name="M:NLog.Conditions.ConditionLayoutExpression.#ctor(System.String)">
<summary>
Adds the elements of an array to the end of this ConditionExpressionCollection.
Creates a new instance of <see cref="T:NLog.Conditions.ConditionLayoutExpression"/>
and initializes the layout.
</summary>
<param name="items">
The array whose elements are to be added to the end of this ConditionExpressionCollection.
</param>
<param name="layout"></param>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.AddRange(NLog.Conditions.ConditionExpressionCollection)">
<member name="M:NLog.Conditions.ConditionLayoutExpression.Evaluate(NLog.LogEventInfo)">
<summary>
Adds the elements of another ConditionExpressionCollection to the end of this ConditionExpressionCollection.
Evaluates the expression by calculating the value
of the layout in the specified evaluation context.
</summary>
<param name="items">
The ConditionExpressionCollection whose elements are to be added to the end of this ConditionExpressionCollection.
</param>
<param name="context">Evaluation context</param>
<returns>The value of the layout.</returns>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.Add(NLog.Conditions.ConditionExpression)">
<member name="M:NLog.Conditions.ConditionLayoutExpression.ToString">
<summary>
Adds an instance of type ConditionExpression to the end of this ConditionExpressionCollection.
Returns a string representation of this expression.
</summary>
<param name="value">
The ConditionExpression to be added to the end of this ConditionExpressionCollection.
</param>
<returns>String literal in single quotes.</returns>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.Contains(NLog.Conditions.ConditionExpression)">
<member name="M:NLog.Conditions.ConditionLayoutExpression.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Determines whether a specfic ConditionExpression value is in this ConditionExpressionCollection.
Adds all layouts used by this expression to the specified collection.
</summary>
<param name="value">
The ConditionExpression value to locate in this ConditionExpressionCollection.
</param>
<returns>
true if value is found in this ConditionExpressionCollection;
false otherwise.
</returns>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.IndexOf(NLog.Conditions.ConditionExpression)">
<member name="T:NLog.Conditions.ConditionAndExpression">
<summary>
Return the zero-based index of the first occurrence of a specific value
in this ConditionExpressionCollection
Condition <b>and</b> expression.
</summary>
<param name="value">
The ConditionExpression value to locate in the ConditionExpressionCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.Insert(System.Int32,NLog.Conditions.ConditionExpression)">
<member name="F:NLog.Conditions.ConditionAndExpression.Left">
<summary>
Inserts an element into the ConditionExpressionCollection at the specified index
The left hand side of the AND expression.
</summary>
<param name="index">
The index at which the ConditionExpression is to be inserted.
</param>
<param name="value">
The ConditionExpression to insert.
</param>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.Remove(NLog.Conditions.ConditionExpression)">
<member name="F:NLog.Conditions.ConditionAndExpression.Right">
<summary>
Removes the first occurrence of a specific ConditionExpression from this ConditionExpressionCollection.
The right hand side of the AND expression.
</summary>
<param name="value">
The ConditionExpression value to remove from this ConditionExpressionCollection.
</param>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.GetEnumerator">
<member name="M:NLog.Conditions.ConditionAndExpression.#ctor(NLog.Conditions.ConditionExpression,NLog.Conditions.ConditionExpression)">
<summary>
Returns an enumerator that can iterate through the elements of this ConditionExpressionCollection.
Creates a new instance of <see cref="T:NLog.Conditions.ConditionAndExpression"/> and assigns
its Left and Right properties;
</summary>
<returns>
An object that implements System.Collections.IEnumerator.
</returns>
<param name="left">Left hand side of the AND expression.</param>
<param name="right">Right hand side of the AND expression.</param>
</member>
<member name="P:NLog.Conditions.ConditionExpressionCollection.Item(System.Int32)">
<member name="M:NLog.Conditions.ConditionAndExpression.Evaluate(NLog.LogEventInfo)">
<summary>
Gets or sets the ConditionExpression at the given index in this ConditionExpressionCollection.
Evaluates the expression by evaluating <see cref="F:NLog.Conditions.ConditionAndExpression.Left"/> and <see cref="F:NLog.Conditions.ConditionAndExpression.Right"/> recursively.
</summary>
<param name="context">Evaluation context.</param>
<returns>The value of the conjunction operator.</returns>
</member>
<member name="T:NLog.Conditions.ConditionExpressionCollection.Enumerator">
<member name="M:NLog.Conditions.ConditionAndExpression.ToString">
<summary>
Type-specific enumeration class, used by ConditionExpressionCollection.GetEnumerator.
Returns a string representation of this expression.
</summary>
<returns>(Left) or (Right) string</returns>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.Enumerator.#ctor(NLog.Conditions.ConditionExpressionCollection)">
<member name="M:NLog.Conditions.ConditionAndExpression.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Adds all layouts used by this expression to the specified collection.
</summary>
<param name="collection"></param>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.Enumerator.MoveNext">
<member name="T:NLog.ConditionMethodsAttribute">
<summary>
Marks the class as containing condition methods.
</summary>
<returns></returns>
</member>
<member name="M:NLog.Conditions.ConditionExpressionCollection.Enumerator.Reset">
<member name="M:NLog.ConditionMethodsAttribute.#ctor">
<summary>
Creates a new instance of <see cref="T:NLog.ConditionMethodsAttribute"/>.
</summary>
</member>
<member name="P:NLog.Conditions.ConditionExpressionCollection.Enumerator.Current">
<member name="T:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper">
<summary>
A target that buffers log events for the duration of
the ASP.NET Request and sends them down to the wrapped target
as soon as the request ends.
</summary>
</member>
<member name="P:NLog.Conditions.ConditionExpressionCollection.Enumerator.System#Collections#IEnumerator#Current">
<summary>
</summary>
</member>
<member name="T:NLog.ConditionMethodFactory">
<summary>
A factory of condition methods. Retrieves condition MethodInfos based on their names.
</summary>
</member>
<member name="M:NLog.ConditionMethodFactory.Clear">
<summary>
Removes all condition method information from the factory.
</summary>
</member>
<member name="M:NLog.ConditionMethodFactory.AddConditionMethodsFromAssembly(System.Reflection.Assembly,System.String)">
<summary>
Scans the specified assembly for types marked with <see cref="T:NLog.ConditionMethodsAttribute"/> and adds
them to the factory. Optionally it prepends the specified text to layout renderer names to avoid
naming collisions.
</summary>
<param name="theAssembly">The assembly to be scanned for layout renderers.</param>
<param name="prefix">The prefix to be prepended to layout renderer names.</param>
</member>
<member name="M:NLog.ConditionMethodFactory.AddConditionMethod(System.String,System.Reflection.MethodInfo)">
<summary>
Registers the specified condition method under a specified name.
</summary>
<param name="name">Name of the condition method.</param>
<param name="mi"><see cref="T:System.Reflection.MethodInfo"/> of the method to be registered.</param>
</member>
<member name="M:NLog.ConditionMethodFactory.CreateConditionMethod(System.String)">
<summary>
Returns the <see cref="T:System.Reflection.MethodInfo"/> for the specified condition method.
</summary>
<param name="name">Name of the condition method.</param>
<returns><see cref="T:System.Reflection.MethodInfo"/> object that represents the condition method.</returns>
</member>
<member name="T:NLog.Web.NLogHttpModule">
<summary>
ASP.NET HttpModule that enables NLog to hook BeginRequest and EndRequest events easily.
</summary>
</member>
<member name="M:NLog.Web.NLogHttpModule.Init(System.Web.HttpApplication)">
<summary>
Initializes the HttpModule
</summary>
<param name="application">ASP.NET application</param>
</member>
<member name="M:NLog.Web.NLogHttpModule.Dispose">
<summary>
Disposes the module.
</summary>
</member>
<member name="E:NLog.Web.NLogHttpModule.EndRequest">
<summary>
Event to be raised at the end of each HTTP Request.
</summary>
</member>
<member name="E:NLog.Web.NLogHttpModule.BeginRequest">
<summary>
Event to be raised at the beginning of each HTTP Request.
</summary>
</member>
<member name="T:NLog.Targets.FormControlTarget">
<summary>
Log text to Windows.Forms.Control.Text property control of specified Name
</summary>
<remarks>
<p>
Typically this target is used in cooperation with PostFilteringTargetWrapper
to provide verbose logging for failing requests and normal or no logging for
successful requests. We need to make the decision of the final filtering rule
to apply after all logs for a page have been generated.
</p>
<p>
To use this target, you need to add an entry in the httpModules section of
web.config:
</p>
<code lang="XML">
<![CDATA[<?xml version="1.0" ?>
<configuration>
<system.web>
<httpModules>
<add name="NLog" type="NLog.Web.NLogHttpModule, NLog"/>
</httpModules>
</system.web>
</configuration>
]]>
</code>
</remarks>
<example>
<p>To set up the ASP.NET Buffering target wrapper <a href="config.html">configuration file</a>, put
the following in <c>web.nlog</c> file in your web application directory (this assumes
that PostFilteringWrapper is used to provide the filtering and actual logs go to
a file).
</p>
<code lang="XML" src="examples/targets/Configuration File/ASPNetBufferingWrapper/web.nlog" />
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<code lang="XML" src="examples/targets/Configuration File/FormControl/NLog.config" />
<p>
The result is:
To configure the target programmatically, put the following
piece of code in your <c>Application_OnStart()</c> handler in Global.asax.cs
or some other place that gets executed at the very beginning of your code:
</p>
<img src="examples/targets/Screenshots/FormControl/FormControl.gif" />
<code lang="C#" src="examples/targets/Configuration API/ASPNetBufferingWrapper/Global.asax.cs" />
<p>
To set up the log target programmatically similar to above use code like this:
Fully working C# project can be found in the <c>Examples/Targets/Configuration API/ASPNetBufferingWrapper</c>
directory along with usage instructions.
</p>
<code lang="C#" src="examples/targets/Configuration API/FormControl/Form1.cs" />,
</example>
</member>
<member name="M:NLog.Targets.FormControlTarget.Write(NLog.LogEventInfo)">
<member name="T:NLog.Targets.Wrappers.WrapperTargetBase">
<summary>
Log message to control
Base class for targets wrap other (single) targets.
</summary>
<param name="logEvent">The logging event.</param>
</member>
<member name="P:NLog.Targets.FormControlTarget.ControlName">
<member name="M:NLog.Targets.Wrappers.WrapperTargetBase.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Name of control to which Nlog will log
Adds all layouts used by this target to the specified collection.
</summary>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="P:NLog.Targets.FormControlTarget.Append">
<member name="M:NLog.Targets.Wrappers.WrapperTargetBase.Close">
<summary>
Setting to tell to append or overwrite the Text property of control
Closes the target by forwarding the call to the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> object.
</summary>
</member>
<member name="P:NLog.Targets.FormControlTarget.FormName">
<member name="M:NLog.Targets.Wrappers.WrapperTargetBase.NeedsStackTrace">
<summary>
Name of the Form on which the control is located.
Forwards the call to <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/>.NeedsStackTrace().
</summary>
<returns>The value of forwarded call</returns>
</member>
<member name="T:NLog.Layouts.CsvColumn">
<member name="M:NLog.Targets.Wrappers.WrapperTargetBase.Initialize">
<summary>
A column in the CSV
Initializes the target by forwarding the call
to <see cref="M:NLog.Target.Initialize"/> to the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/>.
</summary>
</member>
<member name="M:NLog.Layouts.CsvColumn.#ctor">
<member name="M:NLog.Targets.Wrappers.WrapperTargetBase.ToString">
<summary>
Constructs a new instance of <see cref="T:NLog.Layouts.CsvColumn"/>.
Returns the text representation of the object. Used for diagnostics.
</summary>
<returns>A string that describes the target.</returns>
</member>
<member name="M:NLog.Layouts.CsvColumn.#ctor(System.String,System.String)">
<member name="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget">
<summary>
Constructs a new instance of <see cref="T:NLog.Layouts.CsvColumn"/> and
initializes Name and Layout properties.
The target that this target wraps.
</summary>
</member>
<member name="P:NLog.Layouts.CsvColumn.Name">
<member name="M:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.#ctor">
<summary>
The name of the column.
Creates a new instance of the <see cref="T:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper"/> and initializes <see cref="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.BufferSize"/> to 100.
</summary>
</member>
<member name="P:NLog.Layouts.CsvColumn.Layout">
<member name="M:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.#ctor(NLog.Target)">
<summary>
The layout that should be written in the column.
Creates a new instance of the <see cref="T:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper"/>, initializes <see cref="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.BufferSize"/> to 100 and
sets the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> to the specified value.
</summary>
</member>
<member name="P:NLog.Layouts.CsvColumn.CompiledLayout">
<member name="M:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.#ctor(NLog.Target,System.Int32)">
<summary>
The compiled layout that should be written in the column.
Creates a new instance of the <see cref="T:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper"/>, initializes <see cref="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.BufferSize"/> and
the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> to the specified values.
</summary>
</member>
<member name="T:NLog.LogManager">
<member name="M:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.Initialize">
<summary>
Creates and manages instances of <see cref="T:NLog.Logger" /> objects.
Initializes the target by hooking up the NLogHttpModule BeginRequest and EndRequest events.
</summary>
</member>
<member name="M:NLog.LogManager.GetCurrentClassLogger">
<member name="M:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.Write(NLog.LogEventInfo)">
<summary>
Gets the logger named after the currently-being-initialized class.
Adds the specified log event to the buffer.
</summary>
<returns>The logger.</returns>
<remarks>This is a slow-running method.
Make sure you're not doing this in a loop.</remarks>
<param name="logEvent">The log event.</param>
</member>
<member name="M:NLog.LogManager.GetCurrentClassLogger(System.Type)">
<member name="M:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.Close">
<summary>
Gets the logger named after the currently-being-initialized class.
Closes the target by flushing pending events in the buffer (if any).
</summary>
<param name="loggerType">the logger class. The class must inherit from <see cref="T:NLog.Logger"/></param>
<returns>The logger.</returns>
<remarks>This is a slow-running method.
Make sure you're not doing this in a loop.</remarks>
</member>
<member name="M:NLog.LogManager.CreateNullLogger">
<member name="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.BufferSize">
<summary>
Creates a logger that discards all log messages.
The number of log events to be buffered.
</summary>
<returns></returns>
</member>
<member name="M:NLog.LogManager.GetLogger(System.String)">
<member name="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.GrowBufferAsNeeded">
<summary>
Gets the specified named logger.
Grow the buffer when it gets full.
</summary>
<param name="name">name of the logger</param>
<returns>The logger reference. Multiple calls to <c>GetLogger</c> with the same argument aren't guaranteed to return the same logger reference.</returns>
<remarks>
true causes the buffer to expand until <see cref="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.BufferGrowLimit"/> is hit,
false causes the buffer to never expand and lose the earliest entries in case of overflow.
</remarks>
</member>
<member name="M:NLog.LogManager.GetLogger(System.String,System.Type)">
<member name="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.BufferGrowLimit">
<summary>
Gets the specified named logger.
The maximum number of log events that the buffer can keep.
</summary>
<param name="name">name of the logger</param>
<param name="loggerType">the logger class. The class must inherit from <see cref="T:NLog.Logger"/></param>
<returns>The logger reference. Multiple calls to <c>GetLogger</c> with the same argument aren't guaranteed to return the same logger reference.</returns>
</member>
<member name="M:NLog.LogManager.ReconfigExistingLoggers">
<member name="T:NLog.Targets.RichTextBoxWordColoringRuleCollection">
<summary>
Loops through all loggers previously returned by GetLogger.
and recalculates their target and filter list. Useful after modifying the configuration programmatically
to ensure that all loggers have been properly configured.
A collection of elements of type RichTextBoxWordColoringRule
</summary>
</member>
<member name="M:NLog.LogManager.Flush">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.#ctor">
<summary>
Flush any pending log messages (in case of asynchronous targets).
Initializes a new empty instance of the RichTextBoxWordColoringRuleCollection class.
</summary>
</member>
<member name="M:NLog.LogManager.Flush(System.TimeSpan)">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.#ctor(NLog.Targets.RichTextBoxWordColoringRule[])">
<summary>
Flush any pending log messages (in case of asynchronous targets).
Initializes a new instance of the RichTextBoxWordColoringRuleCollection class, containing elements
copied from an array.
</summary>
<param name="timeout">Maximum time to allow for the flush. Any messages after that time will be discarded.</param>
<param name="items">
The array whose elements are to be added to the new RichTextBoxWordColoringRuleCollection.
</param>
</member>
<member name="M:NLog.LogManager.Flush(System.Int32)">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.#ctor(NLog.Targets.RichTextBoxWordColoringRuleCollection)">
<summary>
Flush any pending log messages (in case of asynchronous targets).
Initializes a new instance of the RichTextBoxWordColoringRuleCollection class, containing elements
copied from another instance of RichTextBoxWordColoringRuleCollection
</summary>
<param name="timeoutMilliseconds">Maximum time to allow for the flush. Any messages after that time will be discarded.</param>
<param name="items">
The RichTextBoxWordColoringRuleCollection whose elements are to be added to the new RichTextBoxWordColoringRuleCollection.
</param>
</member>
<member name="M:NLog.LogManager.DisableLogging">
<summary>Decreases the log enable counter and if it reaches -1
the logs are disabled.</summary>
<remarks>Logging is enabled if the number of <see cref="M:NLog.LogManager.EnableLogging"/> calls is greater
than or equal to <see cref="M:NLog.LogManager.DisableLogging"/> calls.</remarks>
<returns>An object that iplements IDisposable whose Dispose() method
reenables logging. To be used with C# <c>using ()</c> statement.</returns>
</member>
<member name="M:NLog.LogManager.EnableLogging">
<summary>Increases the log enable counter and if it reaches 0 the logs are disabled.</summary>
<remarks>Logging is enabled if the number of <see cref="M:NLog.LogManager.EnableLogging"/> calls is greater
than or equal to <see cref="M:NLog.LogManager.DisableLogging"/> calls.</remarks>
</member>
<member name="M:NLog.LogManager.IsLoggingEnabled">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.AddRange(NLog.Targets.RichTextBoxWordColoringRule[])">
<summary>
Returns <see langword="true"/> if logging is currently enabled.
Adds the elements of an array to the end of this RichTextBoxWordColoringRuleCollection.
</summary>
<returns><see langword="true"/> if logging is currently enabled,
<see langword="false"/> otherwise.</returns>
<remarks>Logging is enabled if the number of <see cref="M:NLog.LogManager.EnableLogging"/> calls is greater
than or equal to <see cref="M:NLog.LogManager.DisableLogging"/> calls.</remarks>
<param name="items">
The array whose elements are to be added to the end of this RichTextBoxWordColoringRuleCollection.
</param>
</member>
<member name="E:NLog.LogManager.ConfigurationChanged">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.AddRange(NLog.Targets.RichTextBoxWordColoringRuleCollection)">
<summary>
Occurs when logging <see cref="P:NLog.LogManager.Configuration"/> changes.
Adds the elements of another RichTextBoxWordColoringRuleCollection to the end of this RichTextBoxWordColoringRuleCollection.
</summary>
<param name="items">
The RichTextBoxWordColoringRuleCollection whose elements are to be added to the end of this RichTextBoxWordColoringRuleCollection.
</param>
</member>
<member name="E:NLog.LogManager.ConfigurationReloaded">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Add(NLog.Targets.RichTextBoxWordColoringRule)">
<summary>
Occurs when logging <see cref="P:NLog.LogManager.Configuration"/> gets reloaded.
Adds an instance of type RichTextBoxWordColoringRule to the end of this RichTextBoxWordColoringRuleCollection.
</summary>
<param name="value">
The RichTextBoxWordColoringRule to be added to the end of this RichTextBoxWordColoringRuleCollection.
</param>
</member>
<member name="P:NLog.LogManager.ThrowExceptions">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Contains(NLog.Targets.RichTextBoxWordColoringRule)">
<summary>
Specified whether NLog should throw exceptions. By default exceptions
are not thrown under any circumstances.
Determines whether a specfic RichTextBoxWordColoringRule value is in this RichTextBoxWordColoringRuleCollection.
</summary>
<param name="value">
The RichTextBoxWordColoringRule value to locate in this RichTextBoxWordColoringRuleCollection.
</param>
<returns>
true if value is found in this RichTextBoxWordColoringRuleCollection;
false otherwise.
</returns>
</member>
<member name="P:NLog.LogManager.Configuration">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.IndexOf(NLog.Targets.RichTextBoxWordColoringRule)">
<summary>
Gets or sets the current logging configuration.
Return the zero-based index of the first occurrence of a specific value
in this RichTextBoxWordColoringRuleCollection
</summary>
<param name="value">
The RichTextBoxWordColoringRule value to locate in the RichTextBoxWordColoringRuleCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="P:NLog.LogManager.GlobalThreshold">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Insert(System.Int32,NLog.Targets.RichTextBoxWordColoringRule)">
<summary>
Global log threshold. Log events below this threshold are not logged.
Inserts an element into the RichTextBoxWordColoringRuleCollection at the specified index
</summary>
<param name="index">
The index at which the RichTextBoxWordColoringRule is to be inserted.
</param>
<param name="value">
The RichTextBoxWordColoringRule to insert.
</param>
</member>
<member name="T:NLog.LayoutRenderers.ThreadNameLayoutRenderer">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Remove(NLog.Targets.RichTextBoxWordColoringRule)">
<summary>
The name of the current thread.
Removes the first occurrence of a specific RichTextBoxWordColoringRule from this RichTextBoxWordColoringRuleCollection.
</summary>
<param name="value">
The RichTextBoxWordColoringRule value to remove from this RichTextBoxWordColoringRuleCollection.
</param>
</member>
<member name="M:NLog.LayoutRenderers.ThreadNameLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.GetEnumerator">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
Returns an enumerator that can iterate through the elements of this RichTextBoxWordColoringRuleCollection.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
<returns>
An object that implements System.Collections.IEnumerator.
</returns>
</member>
<member name="M:NLog.LayoutRenderers.ThreadNameLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="P:NLog.Targets.RichTextBoxWordColoringRuleCollection.Item(System.Int32)">
<summary>
Renders the current thread name and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Gets or sets the RichTextBoxWordColoringRule at the given index in this RichTextBoxWordColoringRuleCollection.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="T:NLog.LayoutRenderers.ProcessTimeLayoutRenderer">
<member name="T:NLog.Targets.RichTextBoxWordColoringRuleCollection.Enumerator">
<summary>
The process time in format HH:mm:ss.mmm
Type-specific enumeration class, used by RichTextBoxWordColoringRuleCollection.GetEnumerator.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.ProcessTimeLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Enumerator.#ctor(NLog.Targets.RichTextBoxWordColoringRuleCollection)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
<param name="collection"></param>
</member>
<member name="M:NLog.LayoutRenderers.ProcessTimeLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Enumerator.MoveNext">
<summary>
Renders the current process running time and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
<returns></returns>
</member>
<member name="T:NLog.LayoutRenderers.IdentityLayoutRenderer">
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Enumerator.Reset">
<summary>
Thread identity information (name and authentication information)
</summary>
</member>
<member name="M:NLog.LayoutRenderers.IdentityLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="P:NLog.Targets.RichTextBoxWordColoringRuleCollection.Enumerator.Current">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.IdentityLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="T:NLog.LayoutRenderers.ProcessIDLayoutRenderer">
<summary>
Renders the specified identity information and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
The identifier of the current process.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="P:NLog.LayoutRenderers.IdentityLayoutRenderer.Separator">
<member name="M:NLog.LayoutRenderers.ProcessIDLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
The separator to be used when concatenating
parts of identity information.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.IdentityLayoutRenderer.Name">
<summary>
Render Thread.CurrentPrincipal.Identity.Name.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.IdentityLayoutRenderer.AuthType">
<summary>
Render Thread.CurrentPrincipal.Identity.AuthenticationType.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.IdentityLayoutRenderer.IsAuthenticated">
<summary>
Render Thread.CurrentPrincipal.Identity.IsAuthenticated.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.IdentityLayoutRenderer.FSNormalize">
<summary>
When true the output of this renderer is modified so it can be used as a part of file path
(illegal characters are replaced with '_')
</summary>
</member>
<member name="T:NLog.LayoutRenderers.GDCLayoutRenderer">
<summary>
Global Diagnostics Context item. Provided for compatibility with log4net.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.GDCLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
1238,30 → 815,27
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.GDCLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.LayoutRenderers.ProcessIDLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Renders the specified Global Diagnostics Context item and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Renders the current process ID.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="P:NLog.LayoutRenderers.GDCLayoutRenderer.Item">
<member name="M:NLog.LayoutRenderers.ProcessIDLayoutRenderer.IsAppDomainFixed">
<summary>
Name of the item.
Determines whether the value produced by the layout renderer
is fixed per current app-domain.
</summary>
<returns><see langword="true"/></returns>
</member>
<member name="T:NLog.LayoutRenderers.BaseDirLayoutRenderer">
<member name="T:NLog.LayoutRenderers.SpecialFolderLayoutRenderer">
<summary>
The current application domain's base directory.
System special folder path (includes My Documents, My Music, Program Files, Desktop, and more)
</summary>
</member>
<member name="M:NLog.LayoutRenderers.BaseDirLayoutRenderer.#ctor">
<member name="M:NLog.LayoutRenderers.SpecialFolderLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Creates a new instance of <see cref="T:NLog.LayoutRenderers.BaseDirLayoutRenderer"/>.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.BaseDirLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
1273,60 → 847,55
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.BaseDirLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.LayoutRenderers.SpecialFolderLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Renders the application base directory and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Renders the directory where NLog is located and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="M:NLog.LayoutRenderers.BaseDirLayoutRenderer.IsAppDomainFixed">
<member name="M:NLog.LayoutRenderers.SpecialFolderLayoutRenderer.IsAppDomainFixed">
<summary>
Determines whether the value produced by the layout renderer
is fixed per current app-domain.
</summary>
<returns><see langword="true"/></returns>
</member>
<member name="P:NLog.LayoutRenderers.BaseDirLayoutRenderer.File">
<member name="P:NLog.LayoutRenderers.SpecialFolderLayoutRenderer.Folder">
<summary>
The name of the file to be Path.Combine()'d with with the base directory.
System special folder.
</summary>
<remarks>
Full list of options is available at <a href="http://msdn2.microsoft.com/en-us/system.environment.specialfolder.aspx">MSDN</a>.
The most common ones are:
<ul>
<li><b>ApplicationData</b> - roaming application data for current user.</li>
<li><b>CommonApplicationData</b> - application data for all users.</li>
<li><b>MyDocuments</b> - My Documents</li>
<li><b>DesktopDirectory</b> - Desktop directory</li>
<li><b>LocalApplicationData</b> - non roaming application data</li>
<li><b>Personal</b> - user profile directory</li>
<li><b>System</b> - System directory</li>
</ul>
</remarks>
</member>
<member name="P:NLog.LayoutRenderers.BaseDirLayoutRenderer.Dir">
<member name="P:NLog.LayoutRenderers.SpecialFolderLayoutRenderer.File">
<summary>
The name of the directory to be Path.Combine()'d with with the base directory.
The name of the file to be Path.Combine()'d with the directory name.
</summary>
</member>
<member name="T:NLog.LayoutRenderers.ASPNETApplicationValueLayoutRenderer">
<member name="P:NLog.LayoutRenderers.SpecialFolderLayoutRenderer.Dir">
<summary>
ASP.NET Application variable.
The name of the directory to be Path.Combine()'d with the directory name.
</summary>
<remarks>
Use this layout renderer to insert the value of the specified variable stored
in the ASP.NET Application dictionary.
</remarks>
<example>
<para>You can set the value of an ASP.NET Application variable by using the following code:</para>
<code lang="C#">
<![CDATA[
HttpContext.Current.Application["myvariable"] = 123;
HttpContext.Current.Application["stringvariable"] = "aaa BBB";
HttpContext.Current.Application["anothervariable"] = DateTime.Now;
]]>
</code>
<para>Example usage of ${aspnet-application}:</para>
<code lang="NLog Layout Renderer">
${aspnet-application:variable=myvariable} - produces "123"
${aspnet-application:variable=anothervariable} - produces "01/01/2006 00:00:00"
${aspnet-application:variable=anothervariable:culture=pl-PL} - produces "2006-01-01 00:00:00"
${aspnet-application:variable=myvariable:padding=5} - produces " 123"
${aspnet-application:variable=myvariable:padding=-5} - produces "123 "
${aspnet-application:variable=stringvariable:upperCase=true} - produces "AAA BBB"
</code>
</example>
</member>
<member name="M:NLog.LayoutRenderers.ASPNETApplicationValueLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="T:NLog.LayoutRenderers.ASPNETSessionIDLayoutRenderer">
<summary>
ASP.NET Session ID.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.ASPNETSessionIDLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
1338,601 → 907,360
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.ASPNETApplicationValueLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.LayoutRenderers.ASPNETSessionIDLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Renders the specified ASP.NET Application variable and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Renders the ASP.NET Session ID appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="P:NLog.LayoutRenderers.ASPNETApplicationValueLayoutRenderer.Variable">
<member name="T:NLog.Internal.InternalLogger">
<summary>
The variable name.
NLog internal logger
</summary>
</member>
<member name="T:NLog.LayoutFactory">
<member name="M:NLog.Internal.InternalLogger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.Object[])">
<summary>
A factory for layouts. Creates new layout instances based on their names.
Logs the specified message at the specified level.
</summary>
<param name="level">Log level.</param>
<param name="formatProvider">Format provider to be used for formatting.</param>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="M:NLog.LayoutFactory.Clear">
<member name="M:NLog.Internal.InternalLogger.Log(NLog.LogLevel,System.String,System.Object[])">
<summary>
Removes all layout information from the factory.
Logs the specified message at the specified level.
</summary>
<param name="level">Log level.</param>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="M:NLog.LayoutFactory.AddLayoutsFromAssembly(System.Reflection.Assembly,System.String)">
<member name="M:NLog.Internal.InternalLogger.Log(NLog.LogLevel,System.String)">
<summary>
Scans the specified assembly for types marked with <see cref="T:NLog.LayoutAttribute"/> and adds
them to the factory. Optionally it prepends the specified text to layout names to avoid
naming collisions.
Logs the specified message at the specified level.
</summary>
<param name="theAssembly">The assembly to be scanned for layouts.</param>
<param name="prefix">The prefix to be prepended to layout names.</param>
<param name="level">Log level.</param>
<param name="message">Log message.</param>
</member>
<member name="M:NLog.LayoutFactory.AddLayout(System.String,System.Type)">
<member name="M:NLog.Internal.InternalLogger.Trace(System.IFormatProvider,System.String,System.Object[])">
<summary>
Registers the specified layout type to the factory under a specified name.
Logs the specified message at the Trace level.
</summary>
<param name="name">The name of the layout (e.g. <code>XML</code>, <code>CSV</code> or <code>HTML</code>)</param>
<param name="t">The type of the new layout</param>
<remarks>
The name specified in the name parameter can then be used
to reference layouts.
</remarks>
<param name="formatProvider">Format provider to be used for formatting.</param>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="M:NLog.LayoutFactory.CreateLayout(System.String)">
<member name="M:NLog.Internal.InternalLogger.Trace(System.String,System.Object[])">
<summary>
Creates the layout renderer object based on its layout renderer name and sets its properties from parameters string.
Logs the specified message at the Trace level.
</summary>
<param name="name">The name of the layout renderer (e.g. <code>message</code> or <code>aspnet-request</code>)</param>
<returns>A new instance of the <see cref="T:NLog.ILayout"/> object.</returns>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="P:NLog.LayoutFactory.LayoutTypes">
<member name="M:NLog.Internal.InternalLogger.Trace(System.String)">
<summary>
Collection of layout types added to the factory.
Logs the specified message at the Trace level.
</summary>
<param name="message">Log message.</param>
</member>
<member name="T:NLog.TargetWithLayoutHeaderAndFooter">
<member name="M:NLog.Internal.InternalLogger.Debug(System.IFormatProvider,System.String,System.Object[])">
<summary>
Represents target that supports string formatting using layouts.
Logs the specified message at the Debug level.
</summary>
<param name="formatProvider">Format provider to be used for formatting.</param>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="M:NLog.TargetWithLayoutHeaderAndFooter.#ctor">
<member name="M:NLog.Internal.InternalLogger.Debug(System.String,System.Object[])">
<summary>
Creates a new instance of <see cref="T:NLog.TargetWithLayout"/>
Logs the specified message at the Debug level.
</summary>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="M:NLog.TargetWithLayoutHeaderAndFooter.PopulateLayouts(NLog.LayoutCollection)">
<member name="M:NLog.Internal.InternalLogger.Debug(System.String)">
<summary>
Adds all layouts used by this target to the specified collection.
Logs the specified message at the Debug level.
</summary>
<param name="layouts">The collection to add layouts to.</param>
<param name="message">Log message.</param>
</member>
<member name="M:NLog.TargetWithLayoutHeaderAndFooter.Initialize">
<member name="M:NLog.Internal.InternalLogger.Info(System.IFormatProvider,System.String,System.Object[])">
<summary>
Initializes the target.
Logs the specified message at the Info level.
</summary>
<param name="formatProvider">Format provider to be used for formatting.</param>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="P:NLog.TargetWithLayoutHeaderAndFooter.Layout">
<member name="M:NLog.Internal.InternalLogger.Info(System.String,System.Object[])">
<summary>
The text to be rendered.
Logs the specified message at the Info level.
</summary>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="P:NLog.TargetWithLayoutHeaderAndFooter.Header">
<member name="M:NLog.Internal.InternalLogger.Info(System.String)">
<summary>
Header
Logs the specified message at the Info level.
</summary>
<param name="message">Log message.</param>
</member>
<member name="P:NLog.TargetWithLayoutHeaderAndFooter.Footer">
<member name="M:NLog.Internal.InternalLogger.Warn(System.IFormatProvider,System.String,System.Object[])">
<summary>
Footer
Logs the specified message at the Warn level.
</summary>
<param name="formatProvider">Format provider to be used for formatting.</param>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="P:NLog.TargetWithLayoutHeaderAndFooter.CompiledHeader">
<member name="M:NLog.Internal.InternalLogger.Warn(System.String,System.Object[])">
<summary>
Compiled header.
Logs the specified message at the Warn level.
</summary>
<value>The compiled header.</value>
<remarks>
The header can be of any layout type.
</remarks>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="P:NLog.TargetWithLayoutHeaderAndFooter.CompiledFooter">
<member name="M:NLog.Internal.InternalLogger.Warn(System.String)">
<summary>
Compiled footer.
Logs the specified message at the Warn level.
</summary>
<value>The compiled footer.</value>
<remarks>
The header can be of any layout type.
</remarks>
<param name="message">Log message.</param>
</member>
<member name="P:NLog.TargetWithLayoutHeaderAndFooter.CompiledLayoutWithHeaderAndFooter">
<member name="M:NLog.Internal.InternalLogger.Error(System.IFormatProvider,System.String,System.Object[])">
<summary>
Gets the compiled layout with header and footer.
Logs the specified message at the Error level.
</summary>
<value>The compiled layout with header and footer.</value>
<param name="formatProvider">Format provider to be used for formatting.</param>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="T:NLog.Config.RequiredParameterAttribute">
<member name="M:NLog.Internal.InternalLogger.Error(System.String,System.Object[])">
<summary>
Attribute used to mark the required parameters for targets,
layout targets and filters.
Logs the specified message at the Error level.
</summary>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="M:NLog.Config.RequiredParameterAttribute.#ctor">
<member name="M:NLog.Internal.InternalLogger.Error(System.String)">
<summary>
Creates a new RequiredParameterAttribute object.
Logs the specified message at the Error level.
</summary>
<param name="message">Log message.</param>
</member>
<member name="T:NLog.Targets.Wrappers.BufferingTargetWrapper">
<member name="M:NLog.Internal.InternalLogger.Fatal(System.IFormatProvider,System.String,System.Object[])">
<summary>
A target that buffers log events and sends them in batches to the wrapped target.
Logs the specified message at the Fatal level.
</summary>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/BufferingWrapper/NLog.config" />
<p>
The above examples assume just one target and a single rule. See below for
a programmatic configuration that's equivalent to the above config file:
</p>
<code lang="C#" src="examples/targets/Configuration API/BufferingWrapper/Simple/Example.cs" />
</example>
<param name="formatProvider">Format provider to be used for formatting.</param>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="T:NLog.Targets.Wrappers.WrapperTargetBase">
<member name="M:NLog.Internal.InternalLogger.Fatal(System.String,System.Object[])">
<summary>
Base class for targets wrap other (single) targets.
Logs the specified message at the Fatal level.
</summary>
<param name="message">Message which may include positional parameters.</param>
<param name="args">Arguments.</param>
</member>
<member name="M:NLog.Targets.Wrappers.WrapperTargetBase.PopulateLayouts(NLog.LayoutCollection)">
<member name="M:NLog.Internal.InternalLogger.Fatal(System.String)">
<summary>
Adds all layouts used by this target to the specified collection.
Logs the specified message at the Fatal level.
</summary>
<param name="layouts">The collection to add layouts to.</param>
<param name="message">Log message.</param>
</member>
<member name="M:NLog.Targets.Wrappers.WrapperTargetBase.Close">
<member name="P:NLog.Internal.InternalLogger.LogLevel">
<summary>
Closes the target by forwarding the call to the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> object.
Internal log level.
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.WrapperTargetBase.NeedsStackTrace">
<member name="P:NLog.Internal.InternalLogger.LogToConsole">
<summary>
Forwards the call to <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/>.NeedsStackTrace().
Log internal messages to the console.
</summary>
<returns>The value of forwarded call</returns>
</member>
<member name="M:NLog.Targets.Wrappers.WrapperTargetBase.Initialize">
<member name="P:NLog.Internal.InternalLogger.LogToConsoleError">
<summary>
Initializes the target by forwarding the call
to <see cref="M:NLog.Target.Initialize"/> to the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/>.
Log internal messages to the console error stream.
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.WrapperTargetBase.ToString">
<member name="P:NLog.Internal.InternalLogger.LogFile">
<summary>
Returns the text representation of the object. Used for diagnostics.
The name of the internal log file.
</summary>
<returns>A string that describes the target.</returns>
<remarks><see langword="null" /> value disables internal logging to a file.</remarks>
</member>
<member name="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget">
<member name="P:NLog.Internal.InternalLogger.IsTraceEnabled">
<summary>
The target that this target wraps.
Returns true when internal log level includes Trace messages
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.BufferingTargetWrapper.#ctor">
<member name="P:NLog.Internal.InternalLogger.IsDebugEnabled">
<summary>
Creates a new instance of the <see cref="T:NLog.Targets.Wrappers.BufferingTargetWrapper"/> and initializes <see cref="P:NLog.Targets.Wrappers.BufferingTargetWrapper.BufferSize"/> to 100.
Returns true when internal log level includes Debug messages
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.BufferingTargetWrapper.#ctor(NLog.Target)">
<member name="P:NLog.Internal.InternalLogger.IsInfoEnabled">
<summary>
Creates a new instance of the <see cref="T:NLog.Targets.Wrappers.BufferingTargetWrapper"/>, initializes <see cref="P:NLog.Targets.Wrappers.BufferingTargetWrapper.BufferSize"/> to 100 and
sets the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> to the specified value.
Returns true when internal log level includes Info messages
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.BufferingTargetWrapper.#ctor(NLog.Target,System.Int32)">
<member name="P:NLog.Internal.InternalLogger.IsWarnEnabled">
<summary>
Creates a new instance of the <see cref="T:NLog.Targets.Wrappers.BufferingTargetWrapper"/>, initializes <see cref="P:NLog.Targets.Wrappers.BufferingTargetWrapper.BufferSize"/> and
the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> to the specified values.
Returns true when internal log level includes Warn messages
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.BufferingTargetWrapper.#ctor(NLog.Target,System.Int32,System.Int32)">
<member name="P:NLog.Internal.InternalLogger.IsErrorEnabled">
<summary>
Creates a new instance of the <see cref="T:NLog.Targets.Wrappers.BufferingTargetWrapper"/>,
initializes <see cref="P:NLog.Targets.Wrappers.BufferingTargetWrapper.BufferSize"/>, <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/>
and <see cref="P:NLog.Targets.Wrappers.BufferingTargetWrapper.FlushTimeout"/> to the specified values.
Returns true when internal log level includes Error messages
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.BufferingTargetWrapper.Initialize">
<member name="P:NLog.Internal.InternalLogger.IsFatalEnabled">
<summary>
Initializes the target.
Returns true when internal log level includes Fatal messages
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.BufferingTargetWrapper.Write(NLog.LogEventInfo)">
<member name="T:NLog.Internal.FormHelper">
<summary>
Adds the specified log event to the buffer and flushes
the buffer in case the buffer gets full.
Form helper
</summary>
<param name="logEvent">The log event.</param>
</member>
<member name="M:NLog.Targets.Wrappers.BufferingTargetWrapper.Flush(System.TimeSpan)">
<member name="M:NLog.Internal.FormHelper.FindControl(System.String,System.Windows.Forms.Control)">
<summary>
Flushes pending events in the buffer (if any).
Finds control embended on searchControl
</summary>
<param name="name">name of Control</param>
<param name="searchControl">Control in which we're searching for control</param>
<returns>null if no control has been found</returns>
</member>
<member name="M:NLog.Targets.Wrappers.BufferingTargetWrapper.Close">
<member name="M:NLog.Internal.FormHelper.FindControl(System.String,System.Windows.Forms.Control,System.Type)">
<summary>
Closes the target by flushing pending events in the buffer (if any).
Finds control of specified type embended on searchControl
</summary>
<param name="name">name of Control</param>
<param name="searchControl">Control in which we're searching for control</param>
<param name="controlType">Type of control to search</param>
<returns>null if no control has been found</returns>
</member>
<member name="P:NLog.Targets.Wrappers.BufferingTargetWrapper.BufferSize">
<member name="M:NLog.Internal.FormHelper.CreateForm(System.String,System.Int32,System.Int32,System.Boolean)">
<summary>
Number of log events to be buffered.
Creates Form
</summary>
<param name="name">Name of form</param>
<param name="width">Width of form</param>
<param name="height">Height of form</param>
<param name="show">Auto show form</param>
<returns>Created form</returns>
</member>
<member name="P:NLog.Targets.Wrappers.BufferingTargetWrapper.FlushTimeout">
<member name="M:NLog.Internal.FormHelper.CreateRichTextBox(System.String,System.Windows.Forms.Form)">
<summary>
Flush the contents of buffer if there's no write in the specified period of time
(milliseconds). Use -1 to disable timed flushes.
Creates RichTextBox and docks in parentForm
</summary>
<param name="name">Name of RichTextBox</param>
<param name="parentForm">Form to dock RichTextBox</param>
<returns>Created RichTextBox</returns>
</member>
<member name="T:NLog.TargetCollection">
<member name="T:NLog.ILayout">
<summary>
A collection of elements of type Target
Abstract interface that layouts must implement.
</summary>
</member>
<member name="M:NLog.TargetCollection.#ctor">
<member name="M:NLog.ILayout.GetFormattedMessage(NLog.LogEventInfo)">
<summary>
Initializes a new empty instance of the TargetCollection class.
Renders the layout for the specified logging event by invoking layout renderers.
</summary>
<param name="logEvent">The logging event.</param>
<returns>The rendered layout.</returns>
</member>
<member name="M:NLog.TargetCollection.#ctor(NLog.Target[])">
<member name="M:NLog.ILayout.NeedsStackTrace">
<summary>
Initializes a new instance of the TargetCollection class, containing elements
copied from an array.
Returns the value indicating whether a stack trace and/or the source file
information should be gathered during layout processing.
</summary>
<param name="items">
The array whose elements are to be added to the new TargetCollection.
</param>
<returns>0 - don't include stack trace<br/>1 - include stack trace without source file information<br/>2 - include full stack trace</returns>
</member>
<member name="M:NLog.TargetCollection.#ctor(NLog.TargetCollection)">
<member name="M:NLog.ILayout.IsVolatile">
<summary>
Initializes a new instance of the TargetCollection class, containing elements
copied from another instance of TargetCollection
Returns the value indicating whether this layout includes any volatile
layout renderers.
</summary>
<param name="items">
The TargetCollection whose elements are to be added to the new TargetCollection.
</param>
</member>
<member name="M:NLog.TargetCollection.AddRange(NLog.Target[])">
<summary>
Adds the elements of an array to the end of this TargetCollection.
</summary>
<param name="items">
The array whose elements are to be added to the end of this TargetCollection.
</param>
</member>
<member name="M:NLog.TargetCollection.AddRange(NLog.TargetCollection)">
<summary>
Adds the elements of another TargetCollection to the end of this TargetCollection.
</summary>
<param name="items">
The TargetCollection whose elements are to be added to the end of this TargetCollection.
</param>
</member>
<member name="M:NLog.TargetCollection.Add(NLog.Target)">
<summary>
Adds an instance of type Target to the end of this TargetCollection.
</summary>
<param name="value">
The Target to be added to the end of this TargetCollection.
</param>
</member>
<member name="M:NLog.TargetCollection.Contains(NLog.Target)">
<summary>
Determines whether a specfic Target value is in this TargetCollection.
</summary>
<param name="value">
The Target value to locate in this TargetCollection.
</param>
<returns>
true if value is found in this TargetCollection;
false otherwise.
</returns>
</member>
<member name="M:NLog.TargetCollection.IndexOf(NLog.Target)">
<summary>
Return the zero-based index of the first occurrence of a specific value
in this TargetCollection
</summary>
<param name="value">
The Target value to locate in the TargetCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="M:NLog.TargetCollection.Insert(System.Int32,NLog.Target)">
<summary>
Inserts an element into the TargetCollection at the specified index
</summary>
<param name="index">
The index at which the Target is to be inserted.
</param>
<param name="value">
The Target to insert.
</param>
</member>
<member name="M:NLog.TargetCollection.Remove(NLog.Target)">
<summary>
Removes the first occurrence of a specific Target from this TargetCollection.
</summary>
<param name="value">
The Target value to remove from this TargetCollection.
</param>
</member>
<member name="M:NLog.TargetCollection.GetEnumerator">
<summary>
Returns an enumerator that can iterate through the elements of this TargetCollection.
</summary>
<returns>
An object that implements System.Collections.IEnumerator.
</returns>
</member>
<member name="P:NLog.TargetCollection.Item(System.Int32)">
<summary>
Gets or sets the Target at the given index in this TargetCollection.
</summary>
</member>
<member name="T:NLog.TargetCollection.Enumerator">
<summary>
Type-specific enumeration class, used by TargetCollection.GetEnumerator.
</summary>
</member>
<member name="M:NLog.TargetCollection.Enumerator.#ctor(NLog.TargetCollection)">
<summary>
</summary>
<param name="collection"></param>
</member>
<member name="M:NLog.TargetCollection.Enumerator.MoveNext">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:NLog.TargetCollection.Enumerator.Reset">
<summary>
</summary>
</member>
<member name="P:NLog.TargetCollection.Enumerator.Current">
<summary>
</summary>
</member>
<member name="T:NLog.LayoutRenderers.ShortDateLayoutRenderer">
<summary>
The short date in a sortable format yyyy-MM-dd
</summary>
</member>
<member name="M:NLog.LayoutRenderers.ShortDateLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<returns><see langword="true"/> when the layout includes at least
one volatile renderer, <see langword="false"/> otherwise.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
Volatile layout renderers are dependent on information not contained
in <see cref="T:NLog.LogEventInfo"/> (such as thread-specific data, MDC data, NDC data).
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.ShortDateLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.ILayout.Precalculate(NLog.LogEventInfo)">
<summary>
Renders the current short date string (yyyy-MM-dd) and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Precalculates the layout for the specified log event and stores the result
in per-log event cache.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="T:NLog.LayoutRenderers.CallSiteLayoutRenderer">
<summary>
The call site (class name, method name and source information)
</summary>
</member>
<member name="M:NLog.LayoutRenderers.CallSiteLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<param name="logEvent">The log event.</param>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
Calling this method enables you to store the log event in a buffer
and/or potentially evaluate it in another thread even though the
layout may contain thread-dependent renderer.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.CallSiteLayoutRenderer.NeedsStackTrace">
<member name="M:NLog.ILayout.Initialize">
<summary>
Checks whether the stack trace is requested.
Initializes the layout.
</summary>
<returns>2 when the source file information is requested, 1 otherwise.</returns>
</member>
<member name="M:NLog.LayoutRenderers.CallSiteLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.ILayout.Close">
<summary>
Renders the call site and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Closes the layout.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="P:NLog.LayoutRenderers.CallSiteLayoutRenderer.ClassName">
<member name="M:NLog.ILayout.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Render the class name.
Add this layout and all sub-layouts to the specified collection..
</summary>
<param name="layouts">The collection of layouts.</param>
</member>
<member name="P:NLog.LayoutRenderers.CallSiteLayoutRenderer.MethodName">
<member name="T:NLog.LayoutFactory">
<summary>
Render the method name.
A factory for layouts. Creates new layout instances based on their names.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.CallSiteLayoutRenderer.FileName">
<member name="M:NLog.LayoutFactory.Clear">
<summary>
Render the source file name and line number.
Removes all layout information from the factory.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.CallSiteLayoutRenderer.IncludeSourcePath">
<member name="M:NLog.LayoutFactory.AddLayoutsFromAssembly(System.Reflection.Assembly,System.String)">
<summary>
Include source file path.
</summary>
</member>
<member name="T:NLog.LayoutRendererFactory">
<summary>
A factory for layout renderers. Creates new layout renderers based on their names.
</summary>
</member>
<member name="M:NLog.LayoutRendererFactory.Clear">
<summary>
Removes all layout renderer information from the factory.
</summary>
</member>
<member name="M:NLog.LayoutRendererFactory.AddLayoutRenderersFromAssembly(System.Reflection.Assembly,System.String)">
<summary>
Scans the specified assembly for types marked with <see cref="T:NLog.LayoutRendererAttribute"/> and adds
them to the factory. Optionally it prepends the specified text to layout renderer names to avoid
Scans the specified assembly for types marked with <see cref="T:NLog.LayoutAttribute"/> and adds
them to the factory. Optionally it prepends the specified text to layout names to avoid
naming collisions.
</summary>
<param name="theAssembly">The assembly to be scanned for layout renderers.</param>
<param name="prefix">The prefix to be prepended to layout renderer names.</param>
<param name="theAssembly">The assembly to be scanned for layouts.</param>
<param name="prefix">The prefix to be prepended to layout names.</param>
</member>
<member name="M:NLog.LayoutRendererFactory.AddLayoutRenderer(System.String,System.Type)">
<member name="M:NLog.LayoutFactory.AddLayout(System.String,System.Type)">
<summary>
Registers the specified layout renderer type to the factory under a specified name.
Registers the specified layout type to the factory under a specified name.
</summary>
<param name="name">The name of the layout renderer (e.g. <code>logger</code>, <code>message</code> or <code>aspnet-request</code>)</param>
<param name="t">The type of the new layout renderer</param>
<param name="name">The name of the layout (e.g. <code>XML</code>, <code>CSV</code> or <code>HTML</code>)</param>
<param name="t">The type of the new layout</param>
<remarks>
The name specified in the name parameter can then be used
to create layout renderers.
to reference layouts.
</remarks>
</member>
<member name="M:NLog.LayoutRendererFactory.CreateLayoutRenderer(System.String,System.String)">
<member name="M:NLog.LayoutFactory.CreateLayout(System.String)">
<summary>
Creates the layout renderer object based on its layout renderer name and sets its properties from parameters string.
</summary>
<param name="name">The name of the layout renderer (e.g. <code>message</code> or <code>aspnet-request</code>)</param>
<param name="parameters">Parameters to the layout renderer.</param>
<returns>A new instance of the <see cref="T:NLog.LayoutRenderer"/> object.</returns>
<returns>A new instance of the <see cref="T:NLog.ILayout"/> object.</returns>
</member>
<member name="T:NLog.Internal.ThreadIDHelper">
<member name="P:NLog.LayoutFactory.LayoutTypes">
<summary>
Returns details about current process and thread in a portable manner.
Collection of layout types added to the factory.
</summary>
</member>
<member name="F:NLog.Internal.ThreadIDHelper.Instance">
<summary>
Singleton instance.
</summary>
</member>
<member name="P:NLog.Internal.ThreadIDHelper.CurrentUnmanagedThreadID">
<summary>
Returns current unmanaged thread ID.
</summary>
</member>
<member name="P:NLog.Internal.ThreadIDHelper.CurrentThreadID">
<summary>
Returns current thread ID.
</summary>
</member>
<member name="P:NLog.Internal.ThreadIDHelper.CurrentProcessID">
<summary>
Returns current process ID.
</summary>
</member>
<member name="P:NLog.Internal.ThreadIDHelper.CurrentProcessName">
<summary>
Returns current process name.
</summary>
</member>
<member name="P:NLog.Internal.ThreadIDHelper.CurrentProcessBaseName">
<summary>
Returns current process name (excluding filename extension, if any).
</summary>
</member>
<member name="P:NLog.Internal.ThreadIDHelper.CurrentProcessDirectory">
<summary>
Returns the base directory where process EXE file resides.
</summary>
</member>
<member name="T:NLog.ExtensionUtils">
<summary>
A class that loads and manages NLog extension assemblies.
</summary>
</member>
<member name="M:NLog.ExtensionUtils.GetExtensionAssemblies">
<summary>
Gets the list of loaded NLog extension assemblies.
</summary>
<returns>An <see cref="T:System.Collections.ArrayList"/> containing all NLog extension assemblies that have been loaded.</returns>
</member>
<member name="T:NLog.LayoutRenderers.Rot13LayoutRenderer">
<summary>
Decodes text "encrypted" with ROT-13.
</summary>
<remarks>
See <a href="http://en.wikipedia.org/wiki/ROT13">http://en.wikipedia.org/wiki/ROT13</a>.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.Rot13LayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.Rot13LayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Renders the inner message, decrypts it with ROT-13 and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="M:NLog.LayoutRenderers.Rot13LayoutRenderer.NeedsStackTrace">
<summary>
Determines whether stack trace information should be gathered
during log event processing. By default it calls <see cref="M:NLog.Layout.NeedsStackTrace"/> on
<see cref="P:NLog.TargetWithLayout.CompiledLayout"/>.
</summary>
<returns>
0 - don't include stack trace<br/>1 - include stack trace without source file information<br/>2 - include full stack trace
</returns>
</member>
<member name="M:NLog.LayoutRenderers.Rot13LayoutRenderer.DecodeRot13(System.String)">
<summary>
Encodes/Decodes ROT-13-encoded string.
</summary>
<param name="s">The string to be encoded/decoded</param>
<returns>Encoded/Decoded text</returns>
</member>
<member name="P:NLog.LayoutRenderers.Rot13LayoutRenderer.Text">
<summary>
The text to be decoded.
</summary>
</member>
<member name="T:NLog.Config.XmlLoggingConfiguration">
<summary>
A class for configuring NLog through an XML configuration file
(App.config style or App.nlog style)
</summary>
</member>
<member name="T:NLog.Config.LoggingConfiguration">
<summary>
Keeps logging configuration and provides simple API
1999,880 → 1327,797
A collection of file names which should be watched for changes by NLog.
</summary>
</member>
<member name="M:NLog.Config.XmlLoggingConfiguration.#ctor(System.String)">
<member name="T:NLog.Conditions.ConditionRelationalOperator">
<summary>
Constructs a new instance of <see cref="T:NLog.Config.XmlLoggingConfiguration"/>
class and reads the configuration from the specified config file.
Relational operators used in conditions.
</summary>
<param name="fileName">Configuration file to be read.</param>
</member>
<member name="M:NLog.Config.XmlLoggingConfiguration.#ctor(System.String,System.Boolean)">
<member name="F:NLog.Conditions.ConditionRelationalOperator.Equal">
<summary>
Constructs a new instance of <see cref="T:NLog.Config.XmlLoggingConfiguration"/>
class and reads the configuration from the specified config file.
Equality (==)
</summary>
<param name="fileName">Configuration file to be read.</param>
<param name="ignoreErrors">Ignore any errors during configuration.</param>
</member>
<member name="M:NLog.Config.XmlLoggingConfiguration.#ctor(System.Xml.XmlElement,System.String)">
<member name="F:NLog.Conditions.ConditionRelationalOperator.NotEqual">
<summary>
Constructs a new instance of <see cref="T:NLog.Config.XmlLoggingConfiguration"/>
class and reads the configuration from the specified XML element.
Inequality (!=)
</summary>
<param name="configElement"><see cref="T:System.Xml.XmlElement"/> containing the configuration section.</param>
<param name="fileName">Name of the file that contains the element (to be used as a base for including other files).</param>
</member>
<member name="M:NLog.Config.XmlLoggingConfiguration.#ctor(System.Xml.XmlElement,System.String,System.Boolean)">
<member name="F:NLog.Conditions.ConditionRelationalOperator.Less">
<summary>
Constructs a new instance of <see cref="T:NLog.Config.XmlLoggingConfiguration"/>
class and reads the configuration from the specified XML element.
Less than (&lt;)
</summary>
<param name="configElement"><see cref="T:System.Xml.XmlElement"/> containing the configuration section.</param>
<param name="fileName">Name of the file that contains the element (to be used as a base for including other files).</param>
<param name="ignoreErrors">Ignore any errors during configuration.</param>
</member>
<member name="M:NLog.Config.XmlLoggingConfiguration.Reload">
<member name="F:NLog.Conditions.ConditionRelationalOperator.Greater">
<summary>
Re-reads the original configuration file and returns the new <see cref="T:NLog.Config.LoggingConfiguration"/> object.
Greater than (&gt;)
</summary>
<returns>The new <see cref="T:NLog.Config.XmlLoggingConfiguration"/> object.</returns>
</member>
<member name="P:NLog.Config.XmlLoggingConfiguration.AutoReload">
<member name="F:NLog.Conditions.ConditionRelationalOperator.LessOrEqual">
<summary>
Gets or sets the value indicating whether the configuration files
should be watched for changes and reloaded automatically when changed.
Less than or equal (&lt;=)
</summary>
</member>
<member name="P:NLog.Config.XmlLoggingConfiguration.FileNamesToWatch">
<member name="F:NLog.Conditions.ConditionRelationalOperator.GreaterOrEqual">
<summary>
Gets the collection of file names which should be watched for changes by NLog.
This is the list of configuration files processed.
If the <c>autoReload</c> attribute is not set it returns null.
Greater than or equal (&gt;=)
</summary>
</member>
<member name="P:NLog.Config.XmlLoggingConfiguration.AppConfig">
<member name="T:NLog.Win32.LayoutRenderers.ASPRequestValueLayoutRenderer">
<summary>
Gets the default <see cref="T:NLog.Config.LoggingConfiguration"/> object by parsing
the application configuration file (<c>app.exe.config</c>).
ASP Request variable
</summary>
</member>
<member name="T:NLog.Conditions.ConditionTokenizer">
<member name="M:NLog.Win32.LayoutRenderers.ASPRequestValueLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Hand-written tokenizer for conditions.
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
Because ASP target uses COM Interop which is quite expensive, this method always returns 64.
</remarks>
</member>
<member name="T:NLog.ILayoutWithHeaderAndFooter">
<member name="M:NLog.Win32.LayoutRenderers.ASPRequestValueLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Layout with header and footer.
Renders the specified ASP Request variable and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="P:NLog.ILayoutWithHeaderAndFooter.Layout">
<member name="P:NLog.Win32.LayoutRenderers.ASPRequestValueLayoutRenderer.Item">
<summary>
Main layout (can be repeated multiple times)
The item name. The QueryString, Form, Cookies, or ServerVariables collection variables having the specified name are rendered.
</summary>
</member>
<member name="P:NLog.ILayoutWithHeaderAndFooter.Header">
<member name="P:NLog.Win32.LayoutRenderers.ASPRequestValueLayoutRenderer.QueryString">
<summary>
Header
The QueryString variable to be rendered.
</summary>
</member>
<member name="P:NLog.ILayoutWithHeaderAndFooter.Footer">
<member name="P:NLog.Win32.LayoutRenderers.ASPRequestValueLayoutRenderer.Form">
<summary>
Footer
The form variable to be rendered.
</summary>
</member>
<member name="T:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper">
<member name="P:NLog.Win32.LayoutRenderers.ASPRequestValueLayoutRenderer.Cookie">
<summary>
A target that buffers log events for the duration of
the ASP.NET Request and sends them down to the wrapped target
as soon as the request ends.
The cookie to be rendered.
</summary>
<remarks>
<p>
Typically this target is used in cooperation with PostFilteringTargetWrapper
to provide verbose logging for failing requests and normal or no logging for
successful requests. We need to make the decision of the final filtering rule
to apply after all logs for a page have been generated.
</p>
<p>
To use this target, you need to add an entry in the httpModules section of
web.config:
</p>
<code lang="XML">
<![CDATA[<?xml version="1.0" ?>
<configuration>
<system.web>
<httpModules>
<add name="NLog" type="NLog.Web.NLogHttpModule, NLog"/>
</httpModules>
</system.web>
</configuration>
]]>
</code>
</remarks>
<example>
<p>To set up the ASP.NET Buffering target wrapper <a href="config.html">configuration file</a>, put
the following in <c>web.nlog</c> file in your web application directory (this assumes
that PostFilteringWrapper is used to provide the filtering and actual logs go to
a file).
</p>
<code lang="XML" src="examples/targets/Configuration File/ASPNetBufferingWrapper/web.nlog" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To configure the target programmatically, put the following
piece of code in your <c>Application_OnStart()</c> handler in Global.asax.cs
or some other place that gets executed at the very beginning of your code:
</p>
<code lang="C#" src="examples/targets/Configuration API/ASPNetBufferingWrapper/Global.asax.cs" />
<p>
Fully working C# project can be found in the <c>Examples/Targets/Configuration API/ASPNetBufferingWrapper</c>
directory along with usage instructions.
</p>
</example>
</member>
<member name="M:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.#ctor">
<member name="P:NLog.Win32.LayoutRenderers.ASPRequestValueLayoutRenderer.ServerVariable">
<summary>
Creates a new instance of the <see cref="T:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper"/> and initializes <see cref="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.BufferSize"/> to 100.
The ServerVariables item to be rendered.
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.#ctor(NLog.Target)">
<member name="T:NLog.Targets.Wrappers.AsyncTargetWrapperOverflowAction">
<summary>
Creates a new instance of the <see cref="T:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper"/>, initializes <see cref="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.BufferSize"/> to 100 and
sets the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> to the specified value.
The action to be taken when the queue overflows
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.#ctor(NLog.Target,System.Int32)">
<member name="F:NLog.Targets.Wrappers.AsyncTargetWrapperOverflowAction.Grow">
<summary>
Creates a new instance of the <see cref="T:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper"/>, initializes <see cref="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.BufferSize"/> and
the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> to the specified values.
Grow the queue.
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.Initialize">
<member name="F:NLog.Targets.Wrappers.AsyncTargetWrapperOverflowAction.Discard">
<summary>
Initializes the target by hooking up the NLogHttpModule BeginRequest and EndRequest events.
Discard the overflowing item.
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.Write(NLog.LogEventInfo)">
<member name="F:NLog.Targets.Wrappers.AsyncTargetWrapperOverflowAction.Block">
<summary>
Adds the specified log event to the buffer.
Block until there's more room in the queue.
</summary>
<param name="logEvent">The log event.</param>
</member>
<member name="M:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.Close">
<member name="T:NLog.Targets.Wrappers.AsyncTargetWrapper">
<summary>
Closes the target by flushing pending events in the buffer (if any).
A target wrapper that provides asynchronous, buffered execution of target writes.
</summary>
</member>
<member name="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.BufferSize">
<summary>
The number of log events to be buffered.
</summary>
</member>
<member name="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.GrowBufferAsNeeded">
<summary>
Grow the buffer when it gets full.
</summary>
<remarks>
true causes the buffer to expand until <see cref="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.BufferGrowLimit"/> is hit,
false causes the buffer to never expand and lose the earliest entries in case of overflow.
<p>
Asynchronous target wrapper allows the logger code to execute more quickly, by queueing
messages and processing them in a separate thread. You should wrap targets
that spend a non-trivial amount of time in their Write() method with asynchronous
target to speed up logging.
</p>
<p>
Because asynchronous logging is quite a common scenario, NLog supports a
shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to
the &lt;targets/&gt; element in the configuration file.
</p>
<code lang="XML">
<![CDATA[
<targets async="true">
... your targets go here ...
</targets>
]]></code>
</remarks>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/AsyncWrapper/NLog.config" />
<p>
The above examples assume just one target and a single rule. See below for
a programmatic configuration that's equivalent to the above config file:
</p>
<code lang="C#" src="examples/targets/Configuration API/AsyncWrapper/Wrapping File/Example.cs" />
</example>
</member>
<member name="P:NLog.Targets.Wrappers.ASPNetBufferingTargetWrapper.BufferGrowLimit">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.#ctor">
<summary>
The maximum number of log events that the buffer can keep.
Creates a new instance of <see cref="T:NLog.Targets.Wrappers.AsyncTargetWrapper"/>.
</summary>
</member>
<member name="T:NLog.Targets.RichTextBoxWordColoringRuleCollection">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.#ctor(NLog.Target)">
<summary>
A collection of elements of type RichTextBoxWordColoringRule
Creates a new instance of <see cref="T:NLog.Targets.Wrappers.AsyncTargetWrapper"/>
which wraps the specified target.
</summary>
<param name="wrappedTarget">The target to be wrapped.</param>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.#ctor">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.#ctor(NLog.Target,System.Int32,NLog.Targets.Wrappers.AsyncTargetWrapperOverflowAction)">
<summary>
Initializes a new empty instance of the RichTextBoxWordColoringRuleCollection class.
Creates a new instance of <see cref="T:NLog.Targets.Wrappers.AsyncTargetWrapper"/>
which wraps the specified target.
</summary>
<param name="wrappedTarget">The target to be wrapped.</param>
<param name="queueLimit">Maximum number of requests in the queue.</param>
<param name="overflowAction">The action to be taken when the queue overflows.</param>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.#ctor(NLog.Targets.RichTextBoxWordColoringRule[])">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.Initialize">
<summary>
Initializes a new instance of the RichTextBoxWordColoringRuleCollection class, containing elements
copied from an array.
Initializes the target by starting the lazy writer thread.
</summary>
<param name="items">
The array whose elements are to be added to the new RichTextBoxWordColoringRuleCollection.
</param>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.#ctor(NLog.Targets.RichTextBoxWordColoringRuleCollection)">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.Close">
<summary>
Initializes a new instance of the RichTextBoxWordColoringRuleCollection class, containing elements
copied from another instance of RichTextBoxWordColoringRuleCollection
Closes the target by stopping the lazy writer thread.
</summary>
<param name="items">
The RichTextBoxWordColoringRuleCollection whose elements are to be added to the new RichTextBoxWordColoringRuleCollection.
</param>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.AddRange(NLog.Targets.RichTextBoxWordColoringRule[])">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.Write(NLog.LogEventInfo)">
<summary>
Adds the elements of an array to the end of this RichTextBoxWordColoringRuleCollection.
Adds the log event to asynchronous queue to be processed by
the lazy writer thread.
</summary>
<param name="items">
The array whose elements are to be added to the end of this RichTextBoxWordColoringRuleCollection.
</param>
<param name="logEvent">The log event.</param>
<remarks>
The <see cref="M:NLog.Target.PrecalculateVolatileLayouts(NLog.LogEventInfo)"/> is called
to ensure that the log event can be processed in another thread.
</remarks>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.AddRange(NLog.Targets.RichTextBoxWordColoringRuleCollection)">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.StartLazyWriterTimer">
<summary>
Adds the elements of another RichTextBoxWordColoringRuleCollection to the end of this RichTextBoxWordColoringRuleCollection.
Starts the lazy writer thread which periodically writes
queued log messages.
</summary>
<param name="items">
The RichTextBoxWordColoringRuleCollection whose elements are to be added to the end of this RichTextBoxWordColoringRuleCollection.
</param>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Add(NLog.Targets.RichTextBoxWordColoringRule)">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.StopLazyWriterThread">
<summary>
Adds an instance of type RichTextBoxWordColoringRule to the end of this RichTextBoxWordColoringRuleCollection.
Starts the lazy writer thread.
</summary>
<param name="value">
The RichTextBoxWordColoringRule to be added to the end of this RichTextBoxWordColoringRuleCollection.
</param>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Contains(NLog.Targets.RichTextBoxWordColoringRule)">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.Flush(System.TimeSpan)">
<summary>
Determines whether a specfic RichTextBoxWordColoringRule value is in this RichTextBoxWordColoringRuleCollection.
Waits for the lazy writer thread to finish writing messages.
</summary>
<param name="value">
The RichTextBoxWordColoringRule value to locate in this RichTextBoxWordColoringRuleCollection.
</param>
<returns>
true if value is found in this RichTextBoxWordColoringRuleCollection;
false otherwise.
</returns>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.IndexOf(NLog.Targets.RichTextBoxWordColoringRule)">
<member name="P:NLog.Targets.Wrappers.AsyncTargetWrapper.BatchSize">
<summary>
Return the zero-based index of the first occurrence of a specific value
in this RichTextBoxWordColoringRuleCollection
The number of log events that should be processed in a batch
by the lazy writer thread.
</summary>
<param name="value">
The RichTextBoxWordColoringRule value to locate in the RichTextBoxWordColoringRuleCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Insert(System.Int32,NLog.Targets.RichTextBoxWordColoringRule)">
<member name="P:NLog.Targets.Wrappers.AsyncTargetWrapper.TimeToSleepBetweenBatches">
<summary>
Inserts an element into the RichTextBoxWordColoringRuleCollection at the specified index
The time in milliseconds to sleep between batches.
</summary>
<param name="index">
The index at which the RichTextBoxWordColoringRule is to be inserted.
</param>
<param name="value">
The RichTextBoxWordColoringRule to insert.
</param>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Remove(NLog.Targets.RichTextBoxWordColoringRule)">
<member name="P:NLog.Targets.Wrappers.AsyncTargetWrapper.RequestQueue">
<summary>
Removes the first occurrence of a specific RichTextBoxWordColoringRule from this RichTextBoxWordColoringRuleCollection.
The queue of lazy writer thread requests.
</summary>
<param name="value">
The RichTextBoxWordColoringRule value to remove from this RichTextBoxWordColoringRuleCollection.
</param>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.GetEnumerator">
<member name="P:NLog.Targets.Wrappers.AsyncTargetWrapper.OverflowAction">
<summary>
Returns an enumerator that can iterate through the elements of this RichTextBoxWordColoringRuleCollection.
The action to be taken when the lazy writer thread request queue count
exceeds the set limit.
</summary>
<returns>
An object that implements System.Collections.IEnumerator.
</returns>
</member>
<member name="P:NLog.Targets.RichTextBoxWordColoringRuleCollection.Item(System.Int32)">
<member name="P:NLog.Targets.Wrappers.AsyncTargetWrapper.QueueLimit">
<summary>
Gets or sets the RichTextBoxWordColoringRule at the given index in this RichTextBoxWordColoringRuleCollection.
The limit on the number of requests in the lazy writer thread request queue.
</summary>
</member>
<member name="T:NLog.Targets.RichTextBoxWordColoringRuleCollection.Enumerator">
<member name="T:NLog.Targets.Wrappers.AsyncTargetWrapper.AsyncRequestQueue">
<summary>
Type-specific enumeration class, used by RichTextBoxWordColoringRuleCollection.GetEnumerator.
Asynchronous request queue
</summary>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Enumerator.#ctor(NLog.Targets.RichTextBoxWordColoringRuleCollection)">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.AsyncRequestQueue.#ctor(System.Int32,NLog.Targets.Wrappers.AsyncTargetWrapperOverflowAction)">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.Wrappers.AsyncTargetWrapper.AsyncRequestQueue"/> and
sets the request limit and overflow action.
</summary>
<param name="collection"></param>
<param name="requestLimit">Request limit.</param>
<param name="overflowAction">The overflow action.</param>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Enumerator.MoveNext">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.AsyncRequestQueue.Enqueue(System.Object)">
<summary>
Enqueues another item. If the queue is overflown the appropriate
action is taken as specified by <see cref="P:NLog.Targets.Wrappers.AsyncTargetWrapper.AsyncRequestQueue.OnOverflow"/>.
</summary>
<returns></returns>
<param name="o">The item to be queued.</param>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRuleCollection.Enumerator.Reset">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.AsyncRequestQueue.DequeueBatch(System.Int32)">
<summary>
Dequeues a maximum of <c>count</c> items from the queue
and adds returns the <see cref="T:System.Collections.ArrayList"/> containing them.
</summary>
<param name="count">Maximum number of items to be dequeued.</param>
</member>
<member name="P:NLog.Targets.RichTextBoxWordColoringRuleCollection.Enumerator.Current">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.AsyncRequestQueue.BatchProcessed(System.Collections.ArrayList)">
<summary>
Notifies the queue that the request batch has been processed.
</summary>
<param name="batch">The batch.</param>
</member>
<member name="T:NLog.Targets.MethodCallParameter">
<member name="M:NLog.Targets.Wrappers.AsyncTargetWrapper.AsyncRequestQueue.Clear">
<summary>
A parameter to MethodCall.
Clears the queue.
</summary>
</member>
<member name="M:NLog.Targets.MethodCallParameter.#ctor">
<member name="P:NLog.Targets.Wrappers.AsyncTargetWrapper.AsyncRequestQueue.RequestLimit">
<summary>
Constructs a new instance of <see cref="T:NLog.Targets.MethodCallParameter"/> and sets
the type to String.
The request limit.
</summary>
</member>
<member name="M:NLog.Targets.MethodCallParameter.#ctor(System.String)">
<member name="P:NLog.Targets.Wrappers.AsyncTargetWrapper.AsyncRequestQueue.OnOverflow">
<summary>
Constructs a new instance of <see cref="T:NLog.Targets.MethodCallParameter"/>, sets
the type to String and initializes the Layout property.
Action to be taken when there's no more room in
the queue and another request is enqueued.
</summary>
</member>
<member name="M:NLog.Targets.MethodCallParameter.#ctor(System.String,System.String)">
<member name="P:NLog.Targets.Wrappers.AsyncTargetWrapper.AsyncRequestQueue.RequestCount">
<summary>
Constructs a new instance of <see cref="T:NLog.Targets.MethodCallParameter"/>, sets
the type to String and initializes the Name and Layout properties.
Number of requests currently in the queue.
</summary>
</member>
<member name="M:NLog.Targets.MethodCallParameter.#ctor(System.String,System.Type,System.String)">
<member name="P:NLog.Targets.Wrappers.AsyncTargetWrapper.AsyncRequestQueue.UnprocessedRequestCount">
<summary>
Constructs a new instance of <see cref="T:NLog.Targets.MethodCallParameter"/>, sets
the type to String and initializes the Name, Layout and Type properties.
Number of requests currently being processed (in the queue + batched)
</summary>
</member>
<member name="P:NLog.Targets.MethodCallParameter.Name">
<member name="T:NLog.Targets.NetworkTarget">
<summary>
The name of the parameter.
Sends logging messages over the network.
</summary>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/Network/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/Network/Simple/Example.cs" />
<p>
To print the results, use any application that's able to receive messages over
TCP or UDP. <a href="http://m.nu/program/util/netcat/netcat.html">NetCat</a> is
a simple but very powerful command-line tool that can be used for that. This image
demonstrates the NetCat tool receiving log messages from Network target.
</p>
<img src="examples/targets/Screenshots/Network/Output.gif" />
<p>
NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol
or you'll get TCP timeouts and your application will crawl.
Either switch to UDP transport or use <a href="target.AsyncWrapper.html">AsyncWrapper</a> target
so that your application threads will not be blocked by the timing-out connection attempts.
</p>
<p>
There are two specialized versions of the Network target: <a href="target.Chainsaw.html">Chainsaw</a>
and <a href="target.NLogViewer.html">NLogViewer</a> which write to instances of Chainsaw log4j viewer
or NLogViewer application respectively.
</p>
</example>
</member>
<member name="P:NLog.Targets.MethodCallParameter.Type">
<member name="M:NLog.Targets.NetworkTarget.NetworkSend(System.String,System.Byte[])">
<summary>
The type of the parameter.
Sends the provided text to the specified address.
</summary>
<param name="address">The address. Can be tcp://host:port, udp://host:port, http://host:port</param>
<param name="bytes">The bytes to be sent.</param>
</member>
<member name="P:NLog.Targets.MethodCallParameter.Layout">
<member name="M:NLog.Targets.NetworkTarget.Flush(System.TimeSpan)">
<summary>
The layout that should be use to calcuate the value for the parameter.
Flushes any buffers.
</summary>
<param name="timeout">Flush timeout.</param>
</member>
<member name="P:NLog.Targets.MethodCallParameter.CompiledLayout">
<member name="M:NLog.Targets.NetworkTarget.Close">
<summary>
The compiled layout that should be use to calcuate the value for the parameter.
Closes the target.
</summary>
</member>
<member name="T:NLog.Targets.DatabaseTarget">
<member name="M:NLog.Targets.NetworkTarget.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Writes logging messages to the database using an ADO.NET provider.
</summary>
<example>
<para>
The configuration is dependent on the database type, because
there are differnet methods of specifying connection string, SQL
command and command parameters.
</para>
<para>MS SQL Server using System.Data.SqlClient:</para>
<code lang="XML" src="examples/targets/Configuration File/Database/MSSQL/NLog.config" height="450" />
<para>Oracle using System.Data.OracleClient:</para>
<code lang="XML" src="examples/targets/Configuration File/Database/Oracle.Native/NLog.config" height="350" />
<para>Oracle using System.Data.OleDbClient:</para>
<code lang="XML" src="examples/targets/Configuration File/Database/Oracle.OleDb/NLog.config" height="350" />
<para>To set up the log target programmatically use code like this (an equivalent of MSSQL configuration):</para>
<code lang="C#" src="examples/targets/Configuration API/Database/MSSQL/Example.cs" height="630" />
</example>
</member>
<member name="M:NLog.Targets.DatabaseTarget.#ctor">
<summary>
Creates a new instance of the <see cref="T:NLog.Targets.DatabaseTarget"/> object and sets
the default values of some properties;
</summary>
</member>
<member name="M:NLog.Targets.DatabaseTarget.Write(NLog.LogEventInfo)">
<summary>
Writes the specified logging event to the database. It creates
a new database command, prepares parameters for it by calculating
layouts and executes the command.
</summary>
<param name="logEvent">The logging event.</param>
</member>
<member name="M:NLog.Targets.DatabaseTarget.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Adds all layouts used by this target to the specified collection.
</summary>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="P:NLog.Targets.DatabaseTarget.DBProvider">
<member name="M:NLog.Targets.NetworkTarget.Write(NLog.LogEventInfo)">
<summary>
The name of the database provider. It can be:
<c>sqlserver, mssql, microsoft, msde</c> (all for MSSQL database), <c>oledb, odbc</c> or other name in which case
it's treated as a fully qualified type name of the data provider *Connection class.
Sends the
rendered logging event over the network optionally concatenating it with a newline character.
</summary>
<param name="logEvent">The logging event.</param>
</member>
<member name="P:NLog.Targets.DatabaseTarget.ConnectionString">
<member name="M:NLog.Targets.NetworkTarget.GetBytesToWrite(NLog.LogEventInfo)">
<summary>
The connection string. When provided, it overrides the values
specified in DBHost, DBUserName, DBPassword, DBDatabase.
Gets the bytes to be written.
</summary>
<param name="logEvent">Log event</param>
<returns>Byte array.</returns>
</member>
<member name="P:NLog.Targets.DatabaseTarget.KeepConnection">
<member name="P:NLog.Targets.NetworkTarget.Address">
<summary>
Keep the database connection open between the log events.
The network address. Can be tcp://host:port or udp://host:port
</summary>
<remarks>
For HTTP Support use the WebService target.
</remarks>
</member>
<member name="P:NLog.Targets.DatabaseTarget.UseTransactions">
<member name="P:NLog.Targets.NetworkTarget.AddressLayout">
<summary>
Use database transactions. Some data providers require this.
The network address. Can be tcp://host:port, udp://host:port, http://host:port or https://host:port
</summary>
</member>
<member name="P:NLog.Targets.DatabaseTarget.DBHost">
<member name="P:NLog.Targets.NetworkTarget.KeepConnection">
<summary>
The database host name. If the ConnectionString is not provided
this value will be used to construct the "Server=" part of the
connection string.
Keep connection open whenever possible.
</summary>
</member>
<member name="P:NLog.Targets.DatabaseTarget.DBHostLayout">
<member name="P:NLog.Targets.NetworkTarget.NewLine">
<summary>
The database host name. If the ConnectionString is not provided
this value will be used to construct the "Server=" part of the
connection string.
Append newline at the end of log message.
</summary>
</member>
<member name="P:NLog.Targets.DatabaseTarget.DBUserName">
<member name="P:NLog.Targets.NetworkTarget.MaxMessageSize">
<summary>
The database user name. If the ConnectionString is not provided
this value will be used to construct the "User ID=" part of the
connection string.
Maximum message size in bytes.
</summary>
</member>
<member name="P:NLog.Targets.DatabaseTarget.DBUserNameLayout">
<member name="P:NLog.Targets.NetworkTarget.OnOverflow">
<summary>
The database user name. If the ConnectionString is not provided
this value will be used to construct the "User ID=" part of the
connection string.
Action that should be taken if the message is larger than
maxMessageSize
</summary>
</member>
<member name="P:NLog.Targets.DatabaseTarget.DBPassword">
<member name="P:NLog.Targets.NetworkTarget.Encoding">
<summary>
The database password. If the ConnectionString is not provided
this value will be used to construct the "Password=" part of the
connection string.
Encoding
</summary>
<remarks>
Can be any encoding name supported by System.Text.Encoding.GetEncoding() e.g. <c>windows-1252</c>, <c>iso-8859-2</c>.
</remarks>
</member>
<member name="P:NLog.Targets.DatabaseTarget.DBPasswordLayout">
<member name="T:NLog.Targets.NetworkTarget.OverflowAction">
<summary>
The database password. If the ConnectionString is not provided
this value will be used to construct the "Password=" part of the
connection string.
Action that should be taken if the message overflows.
</summary>
</member>
<member name="P:NLog.Targets.DatabaseTarget.DBDatabase">
<member name="F:NLog.Targets.NetworkTarget.OverflowAction.Error">
<summary>
The database name. If the ConnectionString is not provided
this value will be used to construct the "Database=" part of the
connection string.
Report an error.
</summary>
</member>
<member name="P:NLog.Targets.DatabaseTarget.DBDatabaseLayout">
<member name="F:NLog.Targets.NetworkTarget.OverflowAction.Split">
<summary>
The database name. If the ConnectionString is not provided
this value will be used to construct the "Database=" part of the
connection string.
Split the message into smaller pieces.
</summary>
</member>
<member name="P:NLog.Targets.DatabaseTarget.CommandText">
<member name="F:NLog.Targets.NetworkTarget.OverflowAction.Discard">
<summary>
The text of the SQL command to be run on each log level.
Discard the entire message
</summary>
<remarks>
Typically this is a SQL INSERT statement or a stored procedure call.
It should use the database-specific parameters (marked as <c>@parameter</c>
for SQL server or <c>:parameter</c> for Oracle, other data providers
have their own notation) and not the layout renderers,
because the latter is prone to SQL injection attacks.
The layout renderers should be specified as &lt;parameters />&gt; instead.
</remarks>
</member>
<member name="P:NLog.Targets.DatabaseTarget.CommandTextLayout">
<member name="T:NLog.Targets.DatabaseParameterInfoCollection">
<summary>
The text of the SQL command to be run on each log level.
A collection of elements of type DatabaseParameterInfo
</summary>
<remarks>
Typically this is a SQL INSERT statement or a stored procedure call.
It should use the database-specific parameters (marked as <c>@parameter</c>
for SQL server or <c>:parameter</c> for Oracle, other data providers
have their own notation) and not the layout renderers,
because the latter is prone to SQL injection attacks.
The layout renderers should be specified as &lt;parameters />&lt; instead.
</remarks>
</member>
<member name="P:NLog.Targets.DatabaseTarget.Parameters">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.#ctor">
<summary>
The collection of paramters. Each parameter contains a mapping
between NLog layout and a database named or positional parameter.
Initializes a new empty instance of the DatabaseParameterInfoCollection class.
</summary>
</member>
<member name="T:NLog.Layouts.CsvColumnCollection">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.#ctor(NLog.Targets.DatabaseParameterInfo[])">
<summary>
A collection of elements of type CsvFileColumn
</summary>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.#ctor">
<summary>
Initializes a new empty instance of the CsvFileColumnCollection class.
</summary>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.#ctor(NLog.Layouts.CsvColumn[])">
<summary>
Initializes a new instance of the CsvFileColumnCollection class, containing elements
Initializes a new instance of the DatabaseParameterInfoCollection class, containing elements
copied from an array.
</summary>
<param name="items">
The array whose elements are to be added to the new CsvFileColumnCollection.
The array whose elements are to be added to the new DatabaseParameterInfoCollection.
</param>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.#ctor(NLog.Layouts.CsvColumnCollection)">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.#ctor(NLog.Targets.DatabaseParameterInfoCollection)">
<summary>
Initializes a new instance of the CsvFileColumnCollection class, containing elements
copied from another instance of CsvFileColumnCollection
Initializes a new instance of the DatabaseParameterInfoCollection class, containing elements
copied from another instance of DatabaseParameterInfoCollection
</summary>
<param name="items">
The CsvFileColumnCollection whose elements are to be added to the new CsvFileColumnCollection.
The DatabaseParameterInfoCollection whose elements are to be added to the new DatabaseParameterInfoCollection.
</param>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.AddRange(NLog.Layouts.CsvColumn[])">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.AddRange(NLog.Targets.DatabaseParameterInfo[])">
<summary>
Adds the elements of an array to the end of this CsvFileColumnCollection.
Adds the elements of an array to the end of this DatabaseParameterInfoCollection.
</summary>
<param name="items">
The array whose elements are to be added to the end of this CsvFileColumnCollection.
The array whose elements are to be added to the end of this DatabaseParameterInfoCollection.
</param>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.AddRange(NLog.Layouts.CsvColumnCollection)">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.AddRange(NLog.Targets.DatabaseParameterInfoCollection)">
<summary>
Adds the elements of another CsvFileColumnCollection to the end of this CsvFileColumnCollection.
Adds the elements of another DatabaseParameterInfoCollection to the end of this DatabaseParameterInfoCollection.
</summary>
<param name="items">
The CsvFileColumnCollection whose elements are to be added to the end of this CsvFileColumnCollection.
The DatabaseParameterInfoCollection whose elements are to be added to the end of this DatabaseParameterInfoCollection.
</param>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.Add(NLog.Layouts.CsvColumn)">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Add(NLog.Targets.DatabaseParameterInfo)">
<summary>
Adds an instance of type CsvFileColumn to the end of this CsvFileColumnCollection.
Adds an instance of type DatabaseParameterInfo to the end of this DatabaseParameterInfoCollection.
</summary>
<param name="value">
The CsvFileColumn to be added to the end of this CsvFileColumnCollection.
The DatabaseParameterInfo to be added to the end of this DatabaseParameterInfoCollection.
</param>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.Contains(NLog.Layouts.CsvColumn)">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Contains(NLog.Targets.DatabaseParameterInfo)">
<summary>
Determines whether a specfic CsvFileColumn value is in this CsvFileColumnCollection.
Determines whether a specfic DatabaseParameterInfo value is in this DatabaseParameterInfoCollection.
</summary>
<param name="value">
The CsvFileColumn value to locate in this CsvFileColumnCollection.
The DatabaseParameterInfo value to locate in this DatabaseParameterInfoCollection.
</param>
<returns>
true if value is found in this CsvFileColumnCollection;
true if value is found in this DatabaseParameterInfoCollection;
false otherwise.
</returns>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.IndexOf(NLog.Layouts.CsvColumn)">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.IndexOf(NLog.Targets.DatabaseParameterInfo)">
<summary>
Return the zero-based index of the first occurrence of a specific value
in this CsvFileColumnCollection
in this DatabaseParameterInfoCollection
</summary>
<param name="value">
The CsvFileColumn value to locate in the CsvFileColumnCollection.
The DatabaseParameterInfo value to locate in the DatabaseParameterInfoCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.Insert(System.Int32,NLog.Layouts.CsvColumn)">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Insert(System.Int32,NLog.Targets.DatabaseParameterInfo)">
<summary>
Inserts an element into the CsvFileColumnCollection at the specified index
Inserts an element into the DatabaseParameterInfoCollection at the specified index
</summary>
<param name="index">
The index at which the CsvFileColumn is to be inserted.
The index at which the DatabaseParameterInfo is to be inserted.
</param>
<param name="value">
The CsvFileColumn to insert.
The DatabaseParameterInfo to insert.
</param>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.Remove(NLog.Layouts.CsvColumn)">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Remove(NLog.Targets.DatabaseParameterInfo)">
<summary>
Removes the first occurrence of a specific CsvFileColumn from this CsvFileColumnCollection.
Removes the first occurrence of a specific DatabaseParameterInfo from this DatabaseParameterInfoCollection.
</summary>
<param name="value">
The CsvFileColumn value to remove from this CsvFileColumnCollection.
The DatabaseParameterInfo value to remove from this DatabaseParameterInfoCollection.
</param>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.GetEnumerator">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.GetEnumerator">
<summary>
Returns an enumerator that can iterate through the elements of this CsvFileColumnCollection.
Returns an enumerator that can iterate through the elements of this DatabaseParameterInfoCollection.
</summary>
<returns>
An object that implements System.Collections.IEnumerator.
</returns>
</member>
<member name="P:NLog.Layouts.CsvColumnCollection.Item(System.Int32)">
<member name="P:NLog.Targets.DatabaseParameterInfoCollection.Item(System.Int32)">
<summary>
Gets or sets the CsvFileColumn at the given index in this CsvFileColumnCollection.
Gets or sets the DatabaseParameterInfo at the given index in this DatabaseParameterInfoCollection.
</summary>
</member>
<member name="T:NLog.Layouts.CsvColumnCollection.Enumerator">
<member name="T:NLog.Targets.DatabaseParameterInfoCollection.Enumerator">
<summary>
Type-specific enumeration class, used by CsvFileColumnCollection.GetEnumerator.
Type-specific enumeration class, used by DatabaseParameterInfoCollection.GetEnumerator.
</summary>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.Enumerator.#ctor(NLog.Layouts.CsvColumnCollection)">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Enumerator.#ctor(NLog.Targets.DatabaseParameterInfoCollection)">
<summary>
</summary>
<param name="collection"></param>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.Enumerator.MoveNext">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Enumerator.MoveNext">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:NLog.Layouts.CsvColumnCollection.Enumerator.Reset">
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Enumerator.Reset">
<summary>
</summary>
</member>
<member name="P:NLog.Layouts.CsvColumnCollection.Enumerator.Current">
<member name="P:NLog.Targets.DatabaseParameterInfoCollection.Enumerator.Current">
<summary>
</summary>
</member>
<member name="P:NLog.Layouts.CsvColumnCollection.Enumerator.System#Collections#IEnumerator#Current">
<member name="P:NLog.Targets.DatabaseParameterInfoCollection.Enumerator.System#Collections#IEnumerator#Current">
<summary>
</summary>
</member>
<member name="T:NLog.NDC">
<member name="T:NLog.LayoutRenderers.ASPNETApplicationValueLayoutRenderer">
<summary>
Nested Diagnostics Context - a thread-local structure that keeps a stack
of strings and provides methods to output them in layouts
Mostly for compatibility with log4net.
ASP.NET Application variable.
</summary>
<remarks>
Use this layout renderer to insert the value of the specified variable stored
in the ASP.NET Application dictionary.
</remarks>
<example>
<para>You can set the value of an ASP.NET Application variable by using the following code:</para>
<code lang="C#">
<![CDATA[
HttpContext.Current.Application["myvariable"] = 123;
HttpContext.Current.Application["stringvariable"] = "aaa BBB";
HttpContext.Current.Application["anothervariable"] = DateTime.Now;
]]>
</code>
<para>Example usage of ${aspnet-application}:</para>
<code lang="NLog Layout Renderer">
${aspnet-application:variable=myvariable} - produces "123"
${aspnet-application:variable=anothervariable} - produces "01/01/2006 00:00:00"
${aspnet-application:variable=anothervariable:culture=pl-PL} - produces "2006-01-01 00:00:00"
${aspnet-application:variable=myvariable:padding=5} - produces " 123"
${aspnet-application:variable=myvariable:padding=-5} - produces "123 "
${aspnet-application:variable=stringvariable:upperCase=true} - produces "AAA BBB"
</code>
</example>
</member>
<member name="M:NLog.NDC.Push(System.String)">
<member name="M:NLog.LayoutRenderers.ASPNETApplicationValueLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Pushes the specified text on current thread NDC.
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
<param name="text">The text to be pushed.</param>
<returns>An instance of the object that implements IDisposable that returns the stack to the previous level when IDisposable.Dispose() is called. To be used with C# using() statement.</returns>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.NDC.Pop">
<member name="M:NLog.LayoutRenderers.ASPNETApplicationValueLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Pops the top message off the NDC stack.
Renders the specified ASP.NET Application variable and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<returns>The top message which is no longer on the stack.</returns>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="M:NLog.NDC.GetTopMessage">
<member name="P:NLog.LayoutRenderers.ASPNETApplicationValueLayoutRenderer.Variable">
<summary>
Gets the top NDC message but doesn't remove it.
The variable name.
</summary>
<returns>The top message. </returns>
</member>
<member name="M:NLog.NDC.Clear">
<member name="T:NLog.LayoutRendererAttribute">
<summary>
Clears current thread NDC stack.
Marks class as a layout renderer and assigns a format string to it.
</summary>
</member>
<member name="M:NLog.NDC.GetAllMessages(System.String)">
<member name="M:NLog.LayoutRendererAttribute.#ctor(System.String)">
<summary>
Gets all messages on the stack separated by the specified separator.
Creates a new instance of <see cref="T:NLog.LayoutRendererAttribute"/>
and assigns the <see cref="P:NLog.LayoutRendererAttribute.FormatString"/> to the specified value.
</summary>
<param name="separator">The separator.</param>
<returns>Messages on the stack concatenated using the specified separator.</returns>
<param name="formatString"></param>
</member>
<member name="M:NLog.NDC.GetBottomMessages(System.Int32,System.String)">
<member name="P:NLog.LayoutRendererAttribute.FormatString">
<summary>
Calculates the string representing <c>count</c> bottommost messages using the specified separator.
The format string that can be used to invoke the layout renderer.
</summary>
<param name="count">Number of bottom messages to be returned</param>
<param name="separator">The separator</param>
<returns>A string representing <c>count</c> bottommost messages using the specified separator.</returns>
</member>
<member name="M:NLog.NDC.GetTopMessages(System.Int32,System.String)">
<member name="P:NLog.LayoutRendererAttribute.IgnoresPadding">
<summary>
Calculates the string representing <c>count</c> topmost messages using the specified separator.
Marks the specified layout renderer as ignoring padding (used mostly for
documentation generation).
</summary>
<param name="count">Number of topmost messages to be returned</param>
<param name="separator">The separator</param>
<returns>A string representing <c>count</c> topmost messages using the specified separator.</returns>
</member>
<member name="T:NLog.Layouts.Log4JXmlEventLayout">
<member name="P:NLog.LayoutRendererAttribute.UsingLogEventInfo">
<summary>
A specialized layout that renders Log4j-compatible XML events.
Marks the specified layout renderer as relying purely on the contents
of <see cref="T:NLog.LogEventInfo"/> only and not on any other information (such as thread-
</summary>
</member>
<member name="T:NLog.ILayout">
<member name="T:NLog.LayoutCollection">
<summary>
Abstract interface that layouts must implement.
A collection of elements of type ILayout
</summary>
</member>
<member name="M:NLog.ILayout.GetFormattedMessage(NLog.LogEventInfo)">
<member name="M:NLog.LayoutCollection.#ctor">
<summary>
Renders the layout for the specified logging event by invoking layout renderers.
Initializes a new empty instance of the LayoutCollection class.
</summary>
<param name="logEvent">The logging event.</param>
<returns>The rendered layout.</returns>
</member>
<member name="M:NLog.ILayout.NeedsStackTrace">
<member name="M:NLog.LayoutCollection.#ctor(NLog.ILayout[])">
<summary>
Returns the value indicating whether a stack trace and/or the source file
information should be gathered during layout processing.
Initializes a new instance of the LayoutCollection class, containing elements
copied from an array.
</summary>
<returns>0 - don't include stack trace<br/>1 - include stack trace without source file information<br/>2 - include full stack trace</returns>
<param name="items">
The array whose elements are to be added to the new LayoutCollection.
</param>
</member>
<member name="M:NLog.ILayout.IsVolatile">
<member name="M:NLog.LayoutCollection.#ctor(NLog.LayoutCollection)">
<summary>
Returns the value indicating whether this layout includes any volatile
layout renderers.
Initializes a new instance of the LayoutCollection class, containing elements
copied from another instance of LayoutCollection
</summary>
<returns><see langword="true"/> when the layout includes at least
one volatile renderer, <see langword="false"/> otherwise.</returns>
<remarks>
Volatile layout renderers are dependent on information not contained
in <see cref="T:NLog.LogEventInfo"/> (such as thread-specific data, MDC data, NDC data).
</remarks>
<param name="items">
The LayoutCollection whose elements are to be added to the new LayoutCollection.
</param>
</member>
<member name="M:NLog.ILayout.Precalculate(NLog.LogEventInfo)">
<member name="M:NLog.LayoutCollection.AddRange(NLog.ILayout[])">
<summary>
Precalculates the layout for the specified log event and stores the result
in per-log event cache.
Adds the elements of an array to the end of this LayoutCollection.
</summary>
<param name="logEvent">The log event.</param>
<remarks>
Calling this method enables you to store the log event in a buffer
and/or potentially evaluate it in another thread even though the
layout may contain thread-dependent renderer.
</remarks>
<param name="items">
The array whose elements are to be added to the end of this LayoutCollection.
</param>
</member>
<member name="M:NLog.ILayout.Initialize">
<member name="M:NLog.LayoutCollection.AddRange(NLog.LayoutCollection)">
<summary>
Initializes the layout.
Adds the elements of another LayoutCollection to the end of this LayoutCollection.
</summary>
<param name="items">
The LayoutCollection whose elements are to be added to the end of this LayoutCollection.
</param>
</member>
<member name="M:NLog.ILayout.Close">
<member name="M:NLog.LayoutCollection.Add(NLog.ILayout)">
<summary>
Closes the layout.
Adds an instance of type ILayout to the end of this LayoutCollection.
</summary>
<param name="value">
The ILayout to be added to the end of this LayoutCollection.
</param>
</member>
<member name="M:NLog.ILayout.PopulateLayouts(NLog.LayoutCollection)">
<member name="M:NLog.LayoutCollection.Contains(NLog.ILayout)">
<summary>
Add this layout and all sub-layouts to the specified collection..
Determines whether a specfic ILayout value is in this LayoutCollection.
</summary>
<param name="layouts">The collection of layouts.</param>
<param name="value">
The ILayout value to locate in this LayoutCollection.
</param>
<returns>
true if value is found in this LayoutCollection;
false otherwise.
</returns>
</member>
<member name="M:NLog.Layouts.Log4JXmlEventLayout.GetFormattedMessage(NLog.LogEventInfo)">
<member name="M:NLog.LayoutCollection.IndexOf(NLog.ILayout)">
<summary>
Renders the layout for the specified logging event by invoking layout renderers.
Return the zero-based index of the first occurrence of a specific value
in this LayoutCollection
</summary>
<param name="logEvent">The logging event.</param>
<returns>The rendered layout.</returns>
<param name="value">
The ILayout value to locate in the LayoutCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="M:NLog.Layouts.Log4JXmlEventLayout.NeedsStackTrace">
<member name="M:NLog.LayoutCollection.Insert(System.Int32,NLog.ILayout)">
<summary>
Returns the value indicating whether a stack trace and/or the source file
information should be gathered during layout processing.
Inserts an element into the LayoutCollection at the specified index
</summary>
<returns>0 - don't include stack trace<br/>1 - include stack trace without source file information<br/>2 - include full stack trace</returns>
<param name="index">
The index at which the ILayout is to be inserted.
</param>
<param name="value">
The ILayout to insert.
</param>
</member>
<member name="M:NLog.Layouts.Log4JXmlEventLayout.IsVolatile">
<member name="M:NLog.LayoutCollection.Remove(NLog.ILayout)">
<summary>
Returns the value indicating whether this layout includes any volatile
layout renderers.
Removes the first occurrence of a specific ILayout from this LayoutCollection.
</summary>
<returns><see langword="true"/> when the layout includes at least
one volatile renderer, <see langword="false"/> otherwise.</returns>
<remarks>
Volatile layout renderers are dependent on information not contained
in <see cref="T:NLog.LogEventInfo"/> (such as thread-specific data, MDC data, NDC data).
</remarks>
<param name="value">
The ILayout value to remove from this LayoutCollection.
</param>
</member>
<member name="M:NLog.Layouts.Log4JXmlEventLayout.Precalculate(NLog.LogEventInfo)">
<member name="M:NLog.LayoutCollection.GetEnumerator">
<summary>
Precalculates the layout for the specified log event and stores the result
in per-log event cache.
Returns an enumerator that can iterate through the elements of this LayoutCollection.
</summary>
<param name="logEvent">The log event.</param>
<remarks>
Calling this method enables you to store the log event in a buffer
and/or potentially evaluate it in another thread even though the
layout may contain thread-dependent renderer.
</remarks>
<returns>
An object that implements System.Collections.IEnumerator.
</returns>
</member>
<member name="M:NLog.Layouts.Log4JXmlEventLayout.Initialize">
<member name="P:NLog.LayoutCollection.Item(System.Int32)">
<summary>
Initializes the layout.
Gets or sets the ILayout at the given index in this LayoutCollection.
</summary>
</member>
<member name="M:NLog.Layouts.Log4JXmlEventLayout.Close">
<member name="T:NLog.LayoutCollection.Enumerator">
<summary>
Closes the layout.
Type-specific enumeration class, used by LayoutCollection.GetEnumerator.
</summary>
</member>
<member name="M:NLog.Layouts.Log4JXmlEventLayout.PopulateLayouts(NLog.LayoutCollection)">
<member name="M:NLog.LayoutCollection.Enumerator.#ctor(NLog.LayoutCollection)">
<summary>
Add this layout and all sub-layouts to the specified collection..
</summary>
<param name="layouts">The collection of layouts.</param>
<param name="collection"></param>
</member>
<member name="P:NLog.Layouts.Log4JXmlEventLayout.Renderer">
<member name="M:NLog.LayoutCollection.Enumerator.MoveNext">
<summary>
Returns the <see cref="T:NLog.LayoutRenderers.Log4JXmlEventLayoutRenderer"/> instance that renders log events.
</summary>
<returns></returns>
</member>
<member name="T:NLog.LayoutRenderers.LevelLayoutRenderer">
<member name="M:NLog.LayoutCollection.Enumerator.Reset">
<summary>
The log level.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.LevelLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="P:NLog.LayoutCollection.Enumerator.Current">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.LevelLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="P:NLog.LayoutCollection.Enumerator.System#Collections#IEnumerator#Current">
<summary>
Renders the current log level and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="T:NLog.LayoutRenderers.GuidLayoutRenderer">
<member name="T:NLog.LayoutRenderers.FileContentsLayoutRenderer">
<summary>
Globally-unique identifier (GUID).
Contents of the specified file.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.GuidLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="M:NLog.LayoutRenderers.FileContentsLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
2885,374 → 2130,399
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.GuidLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.LayoutRenderers.FileContentsLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Renders a newly generated GUID string and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Renders the contents of the specified file and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="P:NLog.LayoutRenderers.GuidLayoutRenderer.Format">
<member name="P:NLog.LayoutRenderers.FileContentsLayoutRenderer.FileName">
<summary>
The GUID format as accepted by Guid.ToString() method.
Name of the file.
</summary>
</member>
<member name="T:NLog.LayoutRenderers.SpecialFolderLayoutRenderer">
<member name="P:NLog.LayoutRenderers.FileContentsLayoutRenderer.Encoding">
<summary>
System special folder path (includes My Documents, My Music, Program Files, Desktop, and more)
File encoding.
</summary>
<value>The encoding.</value>
</member>
<member name="M:NLog.LayoutRenderers.SpecialFolderLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="T:NLog.Config.SupportedRuntimeAttributeBase">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
Marks classes and properties as supporting particular runtime framework
and operating system.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.SpecialFolderLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.Config.SupportedRuntimeAttributeBase.#ctor">
<summary>
Renders the directory where NLog is located and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Creates a new instance of <see cref="T:NLog.Config.SupportedRuntimeAttributeBase"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="M:NLog.LayoutRenderers.SpecialFolderLayoutRenderer.IsAppDomainFixed">
<member name="P:NLog.Config.SupportedRuntimeAttributeBase.Framework">
<summary>
Determines whether the value produced by the layout renderer
is fixed per current app-domain.
Supported runtime framework.
</summary>
<returns><see langword="true"/></returns>
</member>
<member name="P:NLog.LayoutRenderers.SpecialFolderLayoutRenderer.Folder">
<member name="P:NLog.Config.SupportedRuntimeAttributeBase.OS">
<summary>
System special folder.
Supported operating system.
</summary>
<remarks>
Full list of options is available at <a href="http://msdn2.microsoft.com/en-us/system.environment.specialfolder.aspx">MSDN</a>.
The most common ones are:
<ul>
<li><b>ApplicationData</b> - roaming application data for current user.</li>
<li><b>CommonApplicationData</b> - application data for all users.</li>
<li><b>MyDocuments</b> - My Documents</li>
<li><b>DesktopDirectory</b> - Desktop directory</li>
<li><b>LocalApplicationData</b> - non roaming application data</li>
<li><b>Personal</b> - user profile directory</li>
<li><b>System</b> - System directory</li>
</ul>
</remarks>
</member>
<member name="P:NLog.LayoutRenderers.SpecialFolderLayoutRenderer.File">
<member name="P:NLog.Config.SupportedRuntimeAttributeBase.MinRuntimeVersion">
<summary>
The name of the file to be Path.Combine()'d with the directory name.
Minimum runtime version supported.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.SpecialFolderLayoutRenderer.Dir">
<member name="P:NLog.Config.SupportedRuntimeAttributeBase.MaxRuntimeVersion">
<summary>
The name of the directory to be Path.Combine()'d with the directory name.
Maximum runtime version supported.
</summary>
</member>
<member name="T:NLog.LayoutRenderers.GCLayoutRenderer">
<member name="P:NLog.Config.SupportedRuntimeAttributeBase.MinOSVersion">
<summary>
The information about the garbage collector.
Minimum operating system version supported.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.GCLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="P:NLog.Config.SupportedRuntimeAttributeBase.MaxOSVersion">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
Maximum operating system version supported.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.GCLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="T:NLog.Config.RequiredParameterAttribute">
<summary>
Renders the selected process information.
Attribute used to mark the required parameters for targets,
layout targets and filters.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="P:NLog.LayoutRenderers.GCLayoutRenderer.Property">
<member name="M:NLog.Config.RequiredParameterAttribute.#ctor">
<summary>
The property to retrieve.
Creates a new RequiredParameterAttribute object.
</summary>
</member>
<member name="T:NLog.LayoutRenderers.GCLayoutRenderer.GCProperty">
<member name="T:NLog.Conditions.ConditionExpressionCollection">
<summary>
The property of System.GC to retrieve
A collection of elements of type ConditionExpression
</summary>
</member>
<member name="F:NLog.LayoutRenderers.GCLayoutRenderer.GCProperty.TotalMemory">
<member name="M:NLog.Conditions.ConditionExpressionCollection.#ctor">
<summary>
Total memory allocated
Initializes a new empty instance of the ConditionExpressionCollection class.
</summary>
</member>
<member name="F:NLog.LayoutRenderers.GCLayoutRenderer.GCProperty.TotalMemoryForceCollection">
<member name="M:NLog.Conditions.ConditionExpressionCollection.#ctor(NLog.Conditions.ConditionExpression[])">
<summary>
Total memory allocated (perform full garbage collection first)
Initializes a new instance of the ConditionExpressionCollection class, containing elements
copied from an array.
</summary>
<param name="items">
The array whose elements are to be added to the new ConditionExpressionCollection.
</param>
</member>
<member name="F:NLog.LayoutRenderers.GCLayoutRenderer.GCProperty.CollectionCount0">
<member name="M:NLog.Conditions.ConditionExpressionCollection.#ctor(NLog.Conditions.ConditionExpressionCollection)">
<summary>
Number of Gen0 collections.
Initializes a new instance of the ConditionExpressionCollection class, containing elements
copied from another instance of ConditionExpressionCollection
</summary>
<param name="items">
The ConditionExpressionCollection whose elements are to be added to the new ConditionExpressionCollection.
</param>
</member>
<member name="F:NLog.LayoutRenderers.GCLayoutRenderer.GCProperty.CollectionCount1">
<member name="M:NLog.Conditions.ConditionExpressionCollection.AddRange(NLog.Conditions.ConditionExpression[])">
<summary>
Number of Gen1 collections.
Adds the elements of an array to the end of this ConditionExpressionCollection.
</summary>
<param name="items">
The array whose elements are to be added to the end of this ConditionExpressionCollection.
</param>
</member>
<member name="F:NLog.LayoutRenderers.GCLayoutRenderer.GCProperty.CollectionCount2">
<member name="M:NLog.Conditions.ConditionExpressionCollection.AddRange(NLog.Conditions.ConditionExpressionCollection)">
<summary>
Number of Gen2 collections.
Adds the elements of another ConditionExpressionCollection to the end of this ConditionExpressionCollection.
</summary>
<param name="items">
The ConditionExpressionCollection whose elements are to be added to the end of this ConditionExpressionCollection.
</param>
</member>
<member name="F:NLog.LayoutRenderers.GCLayoutRenderer.GCProperty.MaxGeneration">
<member name="M:NLog.Conditions.ConditionExpressionCollection.Add(NLog.Conditions.ConditionExpression)">
<summary>
Maximum generation number supported by GC.
Adds an instance of type ConditionExpression to the end of this ConditionExpressionCollection.
</summary>
<param name="value">
The ConditionExpression to be added to the end of this ConditionExpressionCollection.
</param>
</member>
<member name="T:NLog.Filters.WhenEqualFilter">
<member name="M:NLog.Conditions.ConditionExpressionCollection.Contains(NLog.Conditions.ConditionExpression)">
<summary>
Matches when the calculated layout is equal to the specified substring.
This filter is deprecated in favour of <c>&lt;when /&gt;</c> which is based on <a href="conditions.html">contitions</a>
Determines whether a specfic ConditionExpression value is in this ConditionExpressionCollection.
</summary>
<param name="value">
The ConditionExpression value to locate in this ConditionExpressionCollection.
</param>
<returns>
true if value is found in this ConditionExpressionCollection;
false otherwise.
</returns>
</member>
<member name="T:NLog.Filters.LayoutBasedFilter">
<member name="M:NLog.Conditions.ConditionExpressionCollection.IndexOf(NLog.Conditions.ConditionExpression)">
<summary>
A base class for filters that are based on comparing a value to a layout.
Return the zero-based index of the first occurrence of a specific value
in this ConditionExpressionCollection
</summary>
<param name="value">
The ConditionExpression value to locate in the ConditionExpressionCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="T:NLog.Filter">
<member name="M:NLog.Conditions.ConditionExpressionCollection.Insert(System.Int32,NLog.Conditions.ConditionExpression)">
<summary>
An abstract filter class. Provides a way to eliminate log messages
based on properties other than logger name and log level.
Inserts an element into the ConditionExpressionCollection at the specified index
</summary>
<param name="index">
The index at which the ConditionExpression is to be inserted.
</param>
<param name="value">
The ConditionExpression to insert.
</param>
</member>
<member name="M:NLog.Filter.#ctor">
<member name="M:NLog.Conditions.ConditionExpressionCollection.Remove(NLog.Conditions.ConditionExpression)">
<summary>
Removes the first occurrence of a specific ConditionExpression from this ConditionExpressionCollection.
</summary>
<param name="value">
The ConditionExpression value to remove from this ConditionExpressionCollection.
</param>
</member>
<member name="M:NLog.Filter.Check(NLog.LogEventInfo)">
<member name="M:NLog.Conditions.ConditionExpressionCollection.GetEnumerator">
<summary>
Checks whether log event should be logged or not.
Returns an enumerator that can iterate through the elements of this ConditionExpressionCollection.
</summary>
<param name="logEvent">Log event.</param>
<returns>
<see cref="F:NLog.FilterResult.Ignore"/> - if the log event should be ignored<br/>
<see cref="F:NLog.FilterResult.Neutral"/> - if the filter doesn't want to decide<br/>
<see cref="F:NLog.FilterResult.Log"/> - if the log event should be logged<br/>
</returns>
An object that implements System.Collections.IEnumerator.
</returns>
</member>
<member name="M:NLog.Filter.NeedsStackTrace">
<member name="P:NLog.Conditions.ConditionExpressionCollection.Item(System.Int32)">
<summary>
Determines whether stack trace information should be gathered
during log event processing.
Gets or sets the ConditionExpression at the given index in this ConditionExpressionCollection.
</summary>
<returns>0 - don't include stack trace<br/>1 - include stack trace without source file information<br/>2 - include full stack trace</returns>
</member>
<member name="P:NLog.Filter.Result">
<member name="T:NLog.Conditions.ConditionExpressionCollection.Enumerator">
<summary>
The <see cref="T:NLog.FilterResult"/> value that should be returned
when this filter matches.
Type-specific enumeration class, used by ConditionExpressionCollection.GetEnumerator.
</summary>
</member>
<member name="P:NLog.Filter.Action">
<member name="M:NLog.Conditions.ConditionExpressionCollection.Enumerator.#ctor(NLog.Conditions.ConditionExpressionCollection)">
<summary>
User-requested action to be taken when filter matches.
</summary>
<remarks>
Allowed values are <c>log</c>, <c>ignore</c>, <c>neutral</c>.
</remarks>
<param name="collection"></param>
</member>
<member name="M:NLog.Filters.LayoutBasedFilter.#ctor">
<member name="M:NLog.Conditions.ConditionExpressionCollection.Enumerator.MoveNext">
<summary>
Initializes a new instance of <see cref="T:NLog.Filters.LayoutBasedFilter"/>.
</summary>
<returns></returns>
</member>
<member name="M:NLog.Filters.LayoutBasedFilter.NeedsStackTrace">
<member name="M:NLog.Conditions.ConditionExpressionCollection.Enumerator.Reset">
<summary>
Determines whether stack trace information should be gathered
during log event processing. By default it calls <see cref="M:NLog.Layout.NeedsStackTrace"/> on
<see cref="P:NLog.TargetWithLayout.CompiledLayout"/>.
</summary>
<returns>0 - don't include stack trace<br/>1 - include stack trace without source file information<br/>2 - include full stack trace</returns>
</member>
<member name="P:NLog.Filters.LayoutBasedFilter.Layout">
<member name="P:NLog.Conditions.ConditionExpressionCollection.Enumerator.Current">
<summary>
The layout text;
</summary>
</member>
<member name="P:NLog.Filters.LayoutBasedFilter.CompiledLayout">
<member name="P:NLog.Conditions.ConditionExpressionCollection.Enumerator.System#Collections#IEnumerator#Current">
<summary>
Compiled layout.
</summary>
</member>
<member name="M:NLog.Filters.WhenEqualFilter.#ctor">
<member name="T:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection">
<summary>
Initializes a new instance of the filter object.
A collection of elements of type ConsoleRowHighlightingRule
</summary>
</member>
<member name="M:NLog.Filters.WhenEqualFilter.Check(NLog.LogEventInfo)">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.#ctor">
<summary>
Checks whether log event should be logged or not.
Initializes a new empty instance of the ConsoleRowHighlightingRuleCollection class.
</summary>
<param name="logEvent">Log event.</param>
<returns>
<see cref="F:NLog.FilterResult.Ignore"/> - if the log event should be ignored<br/>
<see cref="F:NLog.FilterResult.Neutral"/> - if the filter doesn't want to decide<br/>
<see cref="F:NLog.FilterResult.Log"/> - if the log event should be logged<br/>
</returns>
</member>
<member name="P:NLog.Filters.WhenEqualFilter.IgnoreCase">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.#ctor(NLog.Win32.Targets.ConsoleRowHighlightingRule[])">
<summary>
Ignore case when comparing strings.
Initializes a new instance of the ConsoleRowHighlightingRuleCollection class, containing elements
copied from an array.
</summary>
<param name="items">
The array whose elements are to be added to the new ConsoleRowHighlightingRuleCollection.
</param>
</member>
<member name="P:NLog.Filters.WhenEqualFilter.CompareTo">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.#ctor(NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection)">
<summary>
String to compare the layout to.
Initializes a new instance of the ConsoleRowHighlightingRuleCollection class, containing elements
copied from another instance of ConsoleRowHighlightingRuleCollection
</summary>
<param name="items">
The ConsoleRowHighlightingRuleCollection whose elements are to be added to the new ConsoleRowHighlightingRuleCollection.
</param>
</member>
<member name="T:NLog.FilterResult">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.AddRange(NLog.Win32.Targets.ConsoleRowHighlightingRule[])">
<summary>
Filter result.
Adds the elements of an array to the end of this ConsoleRowHighlightingRuleCollection.
</summary>
<param name="items">
The array whose elements are to be added to the end of this ConsoleRowHighlightingRuleCollection.
</param>
</member>
<member name="F:NLog.FilterResult.Neutral">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.AddRange(NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection)">
<summary>
The filter doesn't want to decide whether to log or discard the message.
Adds the elements of another ConsoleRowHighlightingRuleCollection to the end of this ConsoleRowHighlightingRuleCollection.
</summary>
<param name="items">
The ConsoleRowHighlightingRuleCollection whose elements are to be added to the end of this ConsoleRowHighlightingRuleCollection.
</param>
</member>
<member name="F:NLog.FilterResult.Log">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.Add(NLog.Win32.Targets.ConsoleRowHighlightingRule)">
<summary>
The message should be logged.
Adds an instance of type ConsoleRowHighlightingRule to the end of this ConsoleRowHighlightingRuleCollection.
</summary>
<param name="value">
The ConsoleRowHighlightingRule to be added to the end of this ConsoleRowHighlightingRuleCollection.
</param>
</member>
<member name="F:NLog.FilterResult.Ignore">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.Contains(NLog.Win32.Targets.ConsoleRowHighlightingRule)">
<summary>
The message should not be logged.
Determines whether a specfic ConsoleRowHighlightingRule value is in this ConsoleRowHighlightingRuleCollection.
</summary>
<param name="value">
The ConsoleRowHighlightingRule value to locate in this ConsoleRowHighlightingRuleCollection.
</param>
<returns>
true if value is found in this ConsoleRowHighlightingRuleCollection;
false otherwise.
</returns>
</member>
<member name="F:NLog.FilterResult.LogFinal">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.IndexOf(NLog.Win32.Targets.ConsoleRowHighlightingRule)">
<summary>
The message should be logged and processing should be finished.
Return the zero-based index of the first occurrence of a specific value
in this ConsoleRowHighlightingRuleCollection
</summary>
<param name="value">
The ConsoleRowHighlightingRule value to locate in the ConsoleRowHighlightingRuleCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="F:NLog.FilterResult.IgnoreFinal">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.Insert(System.Int32,NLog.Win32.Targets.ConsoleRowHighlightingRule)">
<summary>
The message should not be logged and processing should be finished.
Inserts an element into the ConsoleRowHighlightingRuleCollection at the specified index
</summary>
<param name="index">
The index at which the ConsoleRowHighlightingRule is to be inserted.
</param>
<param name="value">
The ConsoleRowHighlightingRule to insert.
</param>
</member>
<member name="T:NLog.FilterAttribute">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.Remove(NLog.Win32.Targets.ConsoleRowHighlightingRule)">
<summary>
Marks class as a layout renderer and assigns a name to it
Removes the first occurrence of a specific ConsoleRowHighlightingRule from this ConsoleRowHighlightingRuleCollection.
</summary>
<param name="value">
The ConsoleRowHighlightingRule value to remove from this ConsoleRowHighlightingRuleCollection.
</param>
</member>
<member name="M:NLog.FilterAttribute.#ctor(System.String)">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.GetEnumerator">
<summary>
Creates a new instance of <see cref="T:NLog.FilterAttribute"/> and assigns
a name to it.
Returns an enumerator that can iterate through the elements of this ConsoleRowHighlightingRuleCollection.
</summary>
<param name="name"></param>
<returns>
An object that implements System.Collections.IEnumerator.
</returns>
</member>
<member name="P:NLog.FilterAttribute.Name">
<member name="P:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.Item(System.Int32)">
<summary>
The name of the filter.
Gets or sets the ConsoleRowHighlightingRule at the given index in this ConsoleRowHighlightingRuleCollection.
</summary>
</member>
<member name="T:NLog.Conditions.ConditionNotExpression">
<member name="T:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.Enumerator">
<summary>
Condition <b>not</b> expression.
Type-specific enumeration class, used by ConsoleRowHighlightingRuleCollection.GetEnumerator.
</summary>
</member>
<member name="T:NLog.Conditions.ConditionExpression">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.Enumerator.#ctor(NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection)">
<summary>
Base class for representing nodes in condition expression trees.
</summary>
<param name="collection"></param>
</member>
<member name="M:NLog.Conditions.ConditionExpression.Evaluate(NLog.LogEventInfo)">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.Enumerator.MoveNext">
<summary>
Evaluates the expression.
</summary>
<param name="context">Evaluation context.</param>
<returns>Expression result.</returns>
<returns></returns>
</member>
<member name="M:NLog.Conditions.ConditionExpression.PopulateLayouts(NLog.LayoutCollection)">
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.Enumerator.Reset">
<summary>
Adds all layouts used by this expression to the specified collection.
</summary>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.Conditions.ConditionNotExpression.PopulateLayouts(NLog.LayoutCollection)">
<member name="P:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.Enumerator.Current">
<summary>
Adds all layouts used by this expression to the specified collection.
</summary>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="T:NLog.Conditions.ConditionLayoutExpression">
<member name="T:NLog.Targets.Wrappers.RepeatingTargetWrapper">
<summary>
Condition layout expression (represented by a string literal
with embedded ${})
A target wrapper that repeats each log event the specified number of times.
</summary>
<example>
<p>This example causes each log message to be repeated 3 times.</p>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/RepeatingWrapper/NLog.config" />
<p>
The above examples assume just one target and a single rule. See below for
a programmatic configuration that's equivalent to the above config file:
</p>
<code lang="C#" src="examples/targets/Configuration API/RepeatingWrapper/Simple/Example.cs" />
</example>
</member>
<member name="M:NLog.Conditions.ConditionLayoutExpression.#ctor(System.String)">
<member name="M:NLog.Targets.Wrappers.RepeatingTargetWrapper.#ctor">
<summary>
Creates a new instance of <see cref="T:NLog.Conditions.ConditionLayoutExpression"/>
and initializes the layout.
Creates a new instance of <see cref="T:NLog.Targets.Wrappers.RepeatingTargetWrapper"/>.
</summary>
<param name="layout"></param>
</member>
<member name="M:NLog.Conditions.ConditionLayoutExpression.Evaluate(NLog.LogEventInfo)">
<member name="M:NLog.Targets.Wrappers.RepeatingTargetWrapper.#ctor(NLog.Target,System.Int32)">
<summary>
Evaluates the expression by calculating the value
of the layout in the specified evaluation context.
Creates a new instance of <see cref="T:NLog.Targets.Wrappers.RepeatingTargetWrapper"/>,
initializes the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> to the specified <see cref="T:NLog.Target"/> value and
sets the <see cref="P:NLog.Targets.Wrappers.RepeatingTargetWrapper.RepeatCount"/>,
</summary>
<param name="context">Evaluation context</param>
<returns>The value of the layout.</returns>
</member>
<member name="M:NLog.Conditions.ConditionLayoutExpression.ToString">
<member name="M:NLog.Targets.Wrappers.RepeatingTargetWrapper.Write(NLog.LogEventInfo)">
<summary>
Returns a string representation of this expression.
Forwards the log message to the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> by calling the <see cref="M:NLog.Target.Write(NLog.LogEventInfo)"/> method <see cref="P:NLog.Targets.Wrappers.RepeatingTargetWrapper.RepeatCount"/> times.
</summary>
<returns>String literal in single quotes.</returns>
<param name="logEvent">The log event.</param>
</member>
<member name="M:NLog.Conditions.ConditionLayoutExpression.PopulateLayouts(NLog.LayoutCollection)">
<member name="M:NLog.Targets.Wrappers.RepeatingTargetWrapper.Write(NLog.LogEventInfo[])">
<summary>
Adds all layouts used by this expression to the specified collection.
Forwards the array of log events to the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> by calling the <see cref="M:NLog.Target.Write(NLog.LogEventInfo[])"/> method <see cref="P:NLog.Targets.Wrappers.RepeatingTargetWrapper.RepeatCount"/> times.
</summary>
<param name="layouts">The collection to add layouts to.</param>
<param name="logEvents">The array of log events.</param>
</member>
<member name="T:NLog.Targets.MethodCallTarget">
<member name="P:NLog.Targets.Wrappers.RepeatingTargetWrapper.RepeatCount">
<summary>
Calls the specified static method on each logging message and passes contextual parameters to it.
The number of times to repeat each log message.
</summary>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/MethodCall/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/MethodCall/Simple/Example.cs" />
</example>
</member>
<member name="T:NLog.Targets.MethodCallTargetBase">
<summary>
3283,1041 → 2553,775
Array of parameters to be passed.
</summary>
</member>
<member name="M:NLog.Targets.MethodCallTarget.DoInvoke(System.Object[])">
<member name="T:NLog.Targets.Compound.FallbackTarget">
<summary>
Calls the specified Method.
A compound target that provides fallback-on-error functionality.
</summary>
<param name="parameters">Method parameters.</param>
</member>
<member name="P:NLog.Targets.MethodCallTarget.ClassName">
<summary>
The class name.
</summary>
</member>
<member name="P:NLog.Targets.MethodCallTarget.MethodName">
<summary>
The method name. The method must be public and static.
</summary>
</member>
<member name="T:NLog.Targets.MessageBoxTarget">
<summary>
Pops up logging messages as message boxes.
</summary>
<example>
<p>This example causes the messages to be written to server1,
and if it fails, messages go to server2.</p>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/MessageBox/NLog.config" />
<code lang="XML" src="examples/targets/Configuration File/FallbackGroup/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
The result is a message box:
</p>
<img src="examples/targets/Screenshots/MessageBox/MessageBoxTarget.gif" />
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/MessageBox/Simple/Example.cs" />
</example>
</member>
<member name="M:NLog.Targets.MessageBoxTarget.#ctor">
<summary>
Creates a new instance of the <see cref="T:NLog.Targets.MessageBoxTarget"/>.
</summary>
</member>
<member name="M:NLog.Targets.MessageBoxTarget.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Adds all layouts used by this target to the specified collection.
</summary>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.Targets.MessageBoxTarget.Write(NLog.LogEventInfo)">
<summary>
Displays the message box with the log message and caption specified in the Caption
parameter.
</summary>
<param name="logEvent">The logging event.</param>
</member>
<member name="M:NLog.Targets.MessageBoxTarget.Write(NLog.LogEventInfo[])">
<summary>
Displays the message box with the array of rendered logs messages and caption specified in the Caption
parameter.
</summary>
<param name="logEvents">The array of logging events.</param>
</member>
<member name="P:NLog.Targets.MessageBoxTarget.Caption">
<summary>
Message box title.
</summary>
</member>
<member name="T:NLog.Targets.FileTarget">
<summary>
Writes logging messages to one or more files.
</summary>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/File/Simple/NLog.config" />
<p>
You can use a single target to write to multiple files. The following
example writes each log message to a file named after its log level, so
it will create:
<c>Trace.log</c>, <c>Debug.log</c>, <c>Info.log</c>, <c>Warn.log</c>,
<c>Error.log</c>, <c>Fatal.log</c>
</p>
<code lang="XML" src="examples/targets/Configuration File/File/Multiple/NLog.config" />
<p>
The file names can be quite complex for the most demanding scenarios. This
example shows a way to create separate files for each day, user and log level.
As you can see, the possibilities are endless.
</p>
<code lang="XML" src="examples/targets/Configuration File/File/Multiple2/NLog.config" />
<p>
Depending on your usage scenario it may be useful to add an <a href="target.AsyncWrapper.html">asynchronous target wrapper</a>
around the file target. This way all your log messages
will be written in a separate thread so your main thread can finish
your work more quickly. Asynchronous logging is recommended
for multi-threaded server applications which run for a long time and
is not recommended for quickly-finishing command line applications.
</p>
<code lang="XML" src="examples/targets/Configuration File/File/Asynchronous/NLog.config" />
<p>
The above examples assume just one target and a single rule. See below for
a programmatic configuration that's equivalent to the above config file:
</p>
<code lang="C#" src="examples/targets/Configuration API/File/Asynchronous/Example.cs" />
<p>
More configuration options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/File/Simple/Example.cs" />
<p>
File target can also do file archiving, meaning that the log file is automatically
moved to another place based on its size and time. This example demonstrates
file archiving based on size. Files after 10000 bytes are moved to a separate folder
and renamed log.00000.txt, log.00001.txt and so on.
</p>
<code lang="C#" src="examples/targets/Configuration API/File/Archive1/Example.cs" />
<p>
File archiving can also be done on date/time changes. For example, to create a new
archive file every minute use this code:
</p>
<code lang="C#" src="examples/targets/Configuration API/File/Archive2/Example.cs" />
<p>
You can combine both methods as demonstrated here:
</p>
<code lang="C#" src="examples/targets/Configuration API/File/Archive3/Example.cs" />
<p>
Note that file archiving works even when you use a single target instance
to write to multiple files, such as putting each log level in a separate place:
</p>
<code lang="C#" src="examples/targets/Configuration API/File/Archive4/Example.cs" />
<p>
You can write texts using alternative layouts, such as CSV (comma-separated values).
This example writes files which are properly CSV-quoted (can handle messages with line breaks
and quotes)
</p>
<code lang="C#" src="examples/targets/Configuration API/File/CSV/Example.cs" />
<para>
This is the configuration file version:
</para>
<code lang="XML" src="examples/targets/Configuration File/File/CSV/NLog.config" />
<code lang="C#" src="examples/targets/Configuration API/FallbackGroup/Simple/Example.cs" />
</example>
</member>
<member name="T:NLog.Internal.FileAppenders.ICreateFileParameters">
<member name="T:NLog.Targets.Compound.CompoundTargetBase">
<summary>
Interface that provides parameters for create file function.
A base class for targets which wrap other (multiple) targets
and provide various forms of target routing.
</summary>
</member>
<member name="M:NLog.Targets.FileTarget.#ctor">
<member name="M:NLog.Targets.Compound.CompoundTargetBase.#ctor">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.FileTarget"/>.
Creates a new instance of <see cref="T:NLog.Targets.Compound.CompoundTargetBase"/>.
</summary>
</member>
<member name="M:NLog.Targets.FileTarget.PopulateLayouts(NLog.LayoutCollection)">
<member name="M:NLog.Targets.Compound.CompoundTargetBase.#ctor(NLog.Target[])">
<summary>
Adds all layouts used by this target to the specified collection.
Creates a new instance of <see cref="T:NLog.Targets.Compound.CompoundTargetBase"/> and
initializes the <see cref="P:NLog.Targets.Compound.CompoundTargetBase.Targets"/> collection to the provided
list of <see cref="T:NLog.Target"/> objects.
</summary>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.Targets.FileTarget.GetFormattedMessage(NLog.LogEventInfo)">
<member name="M:NLog.Targets.Compound.CompoundTargetBase.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Formats the log event for write.
Adds all layouts used by this target and sub-targets.
</summary>
<param name="logEvent">The log event to be formatted.</param>
<returns>A string representation of the log event.</returns>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.Targets.FileTarget.GetBytesToWrite(NLog.LogEventInfo)">
<member name="M:NLog.Targets.Compound.CompoundTargetBase.Initialize">
<summary>
Gets the bytes to be written to the file.
Initializes the target by initializing all sub-targets.
</summary>
<param name="logEvent">log event</param>
<returns>array of bytes that are ready to be written</returns>
</member>
<member name="M:NLog.Targets.FileTarget.Write(NLog.LogEventInfo)">
<member name="M:NLog.Targets.Compound.CompoundTargetBase.Close">
<summary>
Writes the specified logging event to a file specified in the FileName
parameter.
Closes the target by closing all sub-targets.
</summary>
<param name="logEvent">The logging event.</param>
</member>
<member name="M:NLog.Targets.FileTarget.Write(NLog.LogEventInfo[])">
<member name="P:NLog.Targets.Compound.CompoundTargetBase.Targets">
<summary>
Writes the specified array of logging events to a file specified in the FileName
parameter.
A collection of targets managed by this compound target.
</summary>
<param name="logEvents">An array of <see cref="T:NLog.LogEventInfo"/> objects.</param>
<remarks>
This function makes use of the fact that the events are batched by sorting
the requests by filename. This optimizes the number of open/close calls
and can help improve performance.
</remarks>
</member>
<member name="M:NLog.Targets.FileTarget.Initialize">
<member name="M:NLog.Targets.Compound.FallbackTarget.#ctor">
<summary>
Initializes file logging by creating data structures that
enable efficient multi-file logging.
Creates a new instance of <see cref="T:NLog.Targets.Compound.FallbackTarget"/>.
</summary>
</member>
<member name="M:NLog.Targets.FileTarget.TransformBytes(System.Byte[])">
<member name="M:NLog.Targets.Compound.FallbackTarget.#ctor(NLog.Target[])">
<summary>
Modifies the specified byte array before it gets sent to a file.
Creates a new instance of <see cref="T:NLog.Targets.Compound.FallbackTarget"/> and sets
the targets to be used.
</summary>
<param name="bytes">The byte array</param>
<returns>The modified byte array. The function can do the modification in-place.</returns>
</member>
<member name="M:NLog.Targets.FileTarget.CleanupInitializedFiles">
<member name="M:NLog.Targets.Compound.FallbackTarget.Write(NLog.LogEventInfo)">
<summary>
Removes records of initialized files that have not been
accessed in the last two days.
Forwards the log event to the sub-targets until one of them succeeds.
</summary>
<param name="logEvent">The log event.</param>
<remarks>
Files are marked 'initialized' for the purpose of writing footers when the logging finishes.
The method remembers the last-known-successful target
and starts the iteration from it.
If <see cref="P:NLog.Targets.Compound.FallbackTarget.ReturnToFirstOnSuccess"/> is set, the method
resets the target to the first target
stored in <see cref="N:NLog.Targets"/>.
</remarks>
</member>
<member name="M:NLog.Targets.FileTarget.CleanupInitializedFiles(System.DateTime)">
<member name="P:NLog.Targets.Compound.FallbackTarget.ReturnToFirstOnSuccess">
<summary>
Removes records of initialized files that have not been
accessed after the specified date.
Whether to return to the first target after any successful write.
</summary>
<remarks>
Files are marked 'initialized' for the purpose of writing footers when the logging finishes.
</remarks>
</member>
<member name="M:NLog.Targets.FileTarget.Flush(System.TimeSpan)">
<member name="T:NLog.LayoutRenderers.LiteralLayoutRenderer">
<summary>
Flushes all pending file operations.
A string literal.
</summary>
<param name="timeout">The timeout</param>
<remarks>
The timeout parameter is ignored, because file APIs don't provide
the needed functionality.
This is used to escape '${' sequence
as ;${literal:text=${}'
</remarks>
</member>
<member name="M:NLog.Targets.FileTarget.Close">
<member name="M:NLog.LayoutRenderers.LiteralLayoutRenderer.#ctor">
<summary>
Closes the file(s) opened for writing.
Creates a new instance of <see cref="T:NLog.LayoutRenderers.LiteralLayoutRenderer"/>.
</summary>
</member>
<member name="P:NLog.Targets.FileTarget.FileName">
<member name="M:NLog.LayoutRenderers.LiteralLayoutRenderer.#ctor(System.String)">
<summary>
The name of the file to write to.
Initializes a new instance of the <see cref="T:NLog.LayoutRenderers.LiteralLayoutRenderer"/> and sets the
literal text value.
</summary>
<remarks>
This FileName string is a layout which may include instances of layout renderers.
This lets you use a single target to write to multiple files.
</remarks>
<example>
The following value makes NLog write logging events to files based on the log level in the directory where
the application runs.
<code>${basedir}/${level}.log</code>
All <c>Debug</c> messages will go to <c>Debug.log</c>, all <c>Info</c> messages will go to <c>Info.log</c> and so on.
You can combine as many of the layout renderers as you want to produce an arbitrary log file name.
</example>
<param name="txt">The literal text value.</param>
<remarks>This is used by the layout compiler.</remarks>
</member>
<member name="P:NLog.Targets.FileTarget.CreateDirs">
<member name="M:NLog.LayoutRenderers.LiteralLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Create directories if they don't exist.
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
Setting this to false may improve performance a bit, but you'll receive an error
when attempting to write to a directory that's not present.
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="P:NLog.Targets.FileTarget.OpenFileCacheSize">
<member name="M:NLog.LayoutRenderers.LiteralLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
The number of files to be kept open. Setting this to a higher value may improve performance
in a situation where a single File target is writing to many files
(such as splitting by level or by logger).
Renders the specified string literal and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<remarks>
The files are managed on a LRU (least recently used) basis, which flushes
the files that have not been used for the longest period of time should the
cache become full. As a rule of thumb, you shouldn't set this parameter to
a very high value. A number like 10-15 shouldn't be exceeded, because you'd
be keeping a large number of files open which consumes system resources.
</remarks>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="P:NLog.Targets.FileTarget.OpenFileCacheTimeout">
<member name="P:NLog.LayoutRenderers.LiteralLayoutRenderer.Text">
<summary>
Maximum number of seconds that files are kept open. If this number is negative.
Literal text.
</summary>
</member>
<member name="P:NLog.Targets.FileTarget.DeleteOldFileOnStartup">
<member name="T:NLog.GDC">
<summary>
Delete old log file on startup.
Global Diagnostics Context - a dictionary structure to hold per-application-instance values.
</summary>
<remarks>
This option works only when the "fileName" parameter denotes a single file.
</remarks>
</member>
<member name="P:NLog.Targets.FileTarget.ReplaceFileContentsOnEachWrite">
<member name="M:NLog.GDC.Set(System.String,System.String)">
<summary>
Replace file contents on each write instead of appending log message at the end.
Sets the Global Diagnostics Context item to the specified value.
</summary>
<param name="item">Item name.</param>
<param name="value">Item value.</param>
</member>
<member name="P:NLog.Targets.FileTarget.KeepFileOpen">
<member name="M:NLog.GDC.Get(System.String)">
<summary>
Keep log file open instead of opening and closing it on each logging event.
Gets the Global Diagnostics Context named item.
</summary>
<remarks>
Setting this property to <c>True</c> helps improve performance.
</remarks>
<param name="item">Item name.</param>
<returns>The item value of String.Empty if the value is not present.</returns>
</member>
<member name="P:NLog.Targets.FileTarget.EnableFileDelete">
<member name="M:NLog.GDC.Contains(System.String)">
<summary>
Enable log file(s) to be deleted.
Checks whether the specified item exists in the Global Diagnostics Context.
</summary>
<param name="item">Item name.</param>
<returns>A boolean indicating whether the specified item exists in current thread GDC.</returns>
</member>
<member name="P:NLog.Targets.FileTarget.FileAttributes">
<member name="M:NLog.GDC.Remove(System.String)">
<summary>
File attributes (Windows only).
Removes the specified item from the Global Diagnostics Context.
</summary>
<param name="item">Item name.</param>
</member>
<member name="P:NLog.Targets.FileTarget.NewLineChars">
<member name="M:NLog.GDC.Clear">
<summary>
Gets the characters that are appended after each line.
Clears the content of the GDC.
</summary>
</member>
<member name="P:NLog.Targets.FileTarget.LineEnding">
<member name="T:NLog.Filters.ConditionBasedFilter">
<summary>
Line ending mode.
Matches when the specified condition is met.
</summary>
</member>
<member name="P:NLog.Targets.FileTarget.AutoFlush">
<summary>
Automatically flush the file buffers after each log message.
</summary>
</member>
<member name="P:NLog.Targets.FileTarget.BufferSize">
<summary>
Log file buffer size in bytes.
</summary>
</member>
<member name="P:NLog.Targets.FileTarget.Encoding">
<summary>
File encoding.</summary>
<remarks>
Can be any encoding name supported by System.Text.Encoding.GetEncoding() e.g. <c>windows-1252</c>, <c>iso-8859-2</c>.
Conditions are expressed using a simple language
described <a href="conditions.html">here</a>.
</remarks>
</member>
<member name="P:NLog.Targets.FileTarget.ConcurrentWrites">
<member name="T:NLog.Filter">
<summary>
Enables concurrent writes to the log file by multiple processes on the same host.
An abstract filter class. Provides a way to eliminate log messages
based on properties other than logger name and log level.
</summary>
<remarks>
This makes multi-process logging possible. NLog uses a special technique
that lets it keep the files open for writing.
</remarks>
</member>
<member name="P:NLog.Targets.FileTarget.NetworkWrites">
<member name="M:NLog.Filter.#ctor">
<summary>
Disables open-fi
</summary>
</member>
<member name="P:NLog.Targets.FileTarget.ConcurrentWriteAttempts">
<member name="M:NLog.Filter.Check(NLog.LogEventInfo)">
<summary>
The number of times the write is appended on the file before NLog
discards the log message.
Checks whether log event should be logged or not.
</summary>
<param name="logEvent">Log event.</param>
<returns>
<see cref="F:NLog.FilterResult.Ignore"/> - if the log event should be ignored<br/>
<see cref="F:NLog.FilterResult.Neutral"/> - if the filter doesn't want to decide<br/>
<see cref="F:NLog.FilterResult.Log"/> - if the log event should be logged<br/>
</returns>
</member>
<member name="P:NLog.Targets.FileTarget.ArchiveAboveSize">
<member name="M:NLog.Filter.NeedsStackTrace">
<summary>
Automatically archive log files that exceed the specified size in bytes.
Determines whether stack trace information should be gathered
during log event processing.
</summary>
<remarks>
Caution: Enabling this option can considerably slow down your file
logging in multi-process scenarios. If only one process is going to
be writing to the file, consider setting <c>ConcurrentWrites</c>
to <c>false</c> for maximum performance.
</remarks>
<returns>0 - don't include stack trace<br/>1 - include stack trace without source file information<br/>2 - include full stack trace</returns>
</member>
<member name="P:NLog.Targets.FileTarget.ArchiveEvery">
<member name="P:NLog.Filter.Result">
<summary>
Automatically archive log files every time the specified time passes.
Possible options are: <c>year</c>, <c>month</c>, <c>day</c>, <c>hour</c>, <c>minute</c>. Files are
moved to the archive as part of the write operation if the current period of time changes. For example
if the current <c>hour</c> changes from 10 to 11, the first write that will occur
on or after 11:00 will trigger the archiving.
The <see cref="T:NLog.FilterResult"/> value that should be returned
when this filter matches.
</summary>
<remarks>
<p>
Caution: Enabling this option can considerably slow down your file
logging in multi-process scenarios. If only one process is going to
be writing to the file, consider setting <c>ConcurrentWrites</c>
to <c>false</c> for maximum performance.
</p>
</remarks>
</member>
<member name="P:NLog.Targets.FileTarget.ArchiveFileName">
<member name="P:NLog.Filter.Action">
<summary>
The name of the file to be used for an archive.
It may contain a special placeholder {#####}
that will be replaced with a sequence of numbers depending on
the archiving strategy. The number of hash characters used determines
the number of numerical digits to be used for numbering files.
User-requested action to be taken when filter matches.
</summary>
</member>
<member name="P:NLog.Targets.FileTarget.ConcurrentWriteAttemptDelay">
<summary>
The delay in milliseconds to wait before attempting to write to the file again.
</summary>
<remarks>
The actual delay is a random value between 0 and the value specified
in this parameter. On each failed attempt the delay base is doubled
up to <see cref="P:NLog.Targets.FileTarget.ConcurrentWriteAttempts"/> times.
Allowed values are <c>log</c>, <c>ignore</c>, <c>neutral</c>.
</remarks>
<example>
Assuming that ConcurrentWriteAttemptDelay is 10 the time to wait will be:<p/>
a random value between 0 and 10 milliseconds - 1st attempt<br/>
a random value between 0 and 20 milliseconds - 2nd attempt<br/>
a random value between 0 and 40 milliseconds - 3rd attempt<br/>
a random value between 0 and 80 milliseconds - 4th attempt<br/>
...<p/>
and so on.
</example>
</member>
<member name="P:NLog.Targets.FileTarget.MaxArchiveFiles">
<member name="M:NLog.Filters.ConditionBasedFilter.#ctor">
<summary>
Maximum number of archive files that should be kept.
Initializes a new instance of the filter object.
</summary>
</member>
<member name="P:NLog.Targets.FileTarget.ArchiveNumbering">
<member name="M:NLog.Filters.ConditionBasedFilter.Check(NLog.LogEventInfo)">
<summary>
Determines the way file archives are numbered.
Checks whether log event should be logged or not.
</summary>
<param name="logEvent">Log event.</param>
<returns>
<see cref="F:NLog.FilterResult.Ignore"/> - if the log event should be ignored<br/>
<see cref="F:NLog.FilterResult.Neutral"/> - if the filter doesn't want to decide<br/>
<see cref="F:NLog.FilterResult.Log"/> - if the log event should be logged<br/>
</returns>
</member>
<member name="T:NLog.Targets.FileTarget.ArchiveNumberingMode">
<member name="P:NLog.Filters.ConditionBasedFilter.Condition">
<summary>
Specifies the way archive numbering is performed.
The condition expression.
</summary>
</member>
<member name="F:NLog.Targets.FileTarget.ArchiveNumberingMode.Sequence">
<member name="T:NLog.Config.XmlLoggingConfiguration">
<summary>
Sequence style numbering. The most recent archive has the highest number.
A class for configuring NLog through an XML configuration file
(App.config style or App.nlog style)
</summary>
</member>
<member name="F:NLog.Targets.FileTarget.ArchiveNumberingMode.Rolling">
<member name="M:NLog.Config.XmlLoggingConfiguration.#ctor(System.String)">
<summary>
Rolling style numbering (the most recent is always #0 then #1, ..., #N
Constructs a new instance of <see cref="T:NLog.Config.XmlLoggingConfiguration"/>
class and reads the configuration from the specified config file.
</summary>
<param name="fileName">Configuration file to be read.</param>
</member>
<member name="T:NLog.Targets.FileTarget.ArchiveEveryMode">
<member name="M:NLog.Config.XmlLoggingConfiguration.#ctor(System.String,System.Boolean)">
<summary>
Modes of archiving files based on time.
Constructs a new instance of <see cref="T:NLog.Config.XmlLoggingConfiguration"/>
class and reads the configuration from the specified config file.
</summary>
<param name="fileName">Configuration file to be read.</param>
<param name="ignoreErrors">Ignore any errors during configuration.</param>
</member>
<member name="F:NLog.Targets.FileTarget.ArchiveEveryMode.None">
<member name="M:NLog.Config.XmlLoggingConfiguration.#ctor(System.Xml.XmlElement,System.String)">
<summary>
Don't archive based on time.
Constructs a new instance of <see cref="T:NLog.Config.XmlLoggingConfiguration"/>
class and reads the configuration from the specified XML element.
</summary>
<param name="configElement"><see cref="T:System.Xml.XmlElement"/> containing the configuration section.</param>
<param name="fileName">Name of the file that contains the element (to be used as a base for including other files).</param>
</member>
<member name="F:NLog.Targets.FileTarget.ArchiveEveryMode.Year">
<member name="M:NLog.Config.XmlLoggingConfiguration.#ctor(System.Xml.XmlElement,System.String,System.Boolean)">
<summary>
Archive every year.
Constructs a new instance of <see cref="T:NLog.Config.XmlLoggingConfiguration"/>
class and reads the configuration from the specified XML element.
</summary>
<param name="configElement"><see cref="T:System.Xml.XmlElement"/> containing the configuration section.</param>
<param name="fileName">Name of the file that contains the element (to be used as a base for including other files).</param>
<param name="ignoreErrors">Ignore any errors during configuration.</param>
</member>
<member name="F:NLog.Targets.FileTarget.ArchiveEveryMode.Month">
<member name="M:NLog.Config.XmlLoggingConfiguration.Reload">
<summary>
Archive every month.
Re-reads the original configuration file and returns the new <see cref="T:NLog.Config.LoggingConfiguration"/> object.
</summary>
<returns>The new <see cref="T:NLog.Config.XmlLoggingConfiguration"/> object.</returns>
</member>
<member name="F:NLog.Targets.FileTarget.ArchiveEveryMode.Day">
<member name="P:NLog.Config.XmlLoggingConfiguration.AutoReload">
<summary>
Archive daily.
Gets or sets the value indicating whether the configuration files
should be watched for changes and reloaded automatically when changed.
</summary>
</member>
<member name="F:NLog.Targets.FileTarget.ArchiveEveryMode.Hour">
<member name="P:NLog.Config.XmlLoggingConfiguration.FileNamesToWatch">
<summary>
Archive every hour.
Gets the collection of file names which should be watched for changes by NLog.
This is the list of configuration files processed.
If the <c>autoReload</c> attribute is not set it returns null.
</summary>
</member>
<member name="F:NLog.Targets.FileTarget.ArchiveEveryMode.Minute">
<member name="P:NLog.Config.XmlLoggingConfiguration.AppConfig">
<summary>
Archive every minute.
Gets the default <see cref="T:NLog.Config.LoggingConfiguration"/> object by parsing
the application configuration file (<c>app.exe.config</c>).
</summary>
</member>
<member name="T:NLog.Targets.FileTarget.LineEndingMode">
<member name="T:NLog.Config.LoggingRule">
<summary>
Line ending mode.
Represents a logging rule. An equivalent of &lt;logger /&gt; configuration element.
</summary>
</member>
<member name="F:NLog.Targets.FileTarget.LineEndingMode.Default">
<member name="M:NLog.Config.LoggingRule.ToString">
<summary>
Insert platform-dependent end-of-line sequence after each line.
Returns a string representation of <see cref="T:NLog.Config.LoggingRule"/>. Used for debugging.
</summary>
<returns></returns>
</member>
<member name="F:NLog.Targets.FileTarget.LineEndingMode.CRLF">
<member name="M:NLog.Config.LoggingRule.#ctor">
<summary>
Insert CR LF sequence (ASCII 13, ASCII 10) after each line.
Initializes a new instance of <see cref="T:NLog.Config.LoggingRule"/>.
</summary>
</member>
<member name="F:NLog.Targets.FileTarget.LineEndingMode.CR">
<member name="M:NLog.Config.LoggingRule.#ctor(System.String,NLog.LogLevel,NLog.Target)">
<summary>
Insert CR character (ASCII 13) after each line.
Initializes a new instance of <see cref="T:NLog.Config.LoggingRule"/> by
setting the logger name pattern, minimum logging level and
the target to be written to when logger name and log level match.
</summary>
<param name="loggerNamePattern">Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends.</param>
<param name="minLevel">Minimum log level needed to trigger this rule.</param>
<param name="target">Target to be written to when the rule matches.</param>
</member>
<member name="F:NLog.Targets.FileTarget.LineEndingMode.LF">
<member name="M:NLog.Config.LoggingRule.#ctor(System.String,NLog.Target)">
<summary>
Insert LF character (ASCII 10) after each line.
Initializes a new instance of <see cref="T:NLog.Config.LoggingRule"/> by
setting the logger name pattern and
the target to be written to when logger name matches.
</summary>
<param name="loggerNamePattern">Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends.</param>
<param name="target">Target to be written to when the rule matches.</param>
<remarks>By default no logging levels are defined. You should call <see cref="M:NLog.Config.LoggingRule.EnableLoggingForLevel(NLog.LogLevel)"/> and <see cref="M:NLog.Config.LoggingRule.DisableLoggingForLevel(NLog.LogLevel)"/> to set them.</remarks>
</member>
<member name="F:NLog.Targets.FileTarget.LineEndingMode.None">
<member name="M:NLog.Config.LoggingRule.EnableLoggingForLevel(NLog.LogLevel)">
<summary>
Don't insert any line ending.
Enables logging for a particular level.
</summary>
<param name="level">Level to be enabled.</param>
</member>
<member name="T:NLog.MDC">
<member name="M:NLog.Config.LoggingRule.DisableLoggingForLevel(NLog.LogLevel)">
<summary>
Mapped Diagnostics Context - a thread-local structure that keeps a dictionary
of strings and provides methods to output them in layouts.
Mostly for compatibility with log4net.
Disables logging for a particular level.
</summary>
<param name="level">Level to be disabled.</param>
</member>
<member name="M:NLog.MDC.Set(System.String,System.String)">
<member name="M:NLog.Config.LoggingRule.IsLoggingEnabledForLevel(NLog.LogLevel)">
<summary>
Sets the current thread MDC item to the specified value.
Checks whether te particular log level is enabled for this rule.
</summary>
<param name="item">Item name.</param>
<param name="value">Item value.</param>
<param name="level">Level to be checked</param>
<returns><see langword="true"/> when the log level is enabled, <see langword="false" /> otherwise.</returns>
</member>
<member name="M:NLog.MDC.Get(System.String)">
<member name="M:NLog.Config.LoggingRule.NameMatches(System.String)">
<summary>
Gets the current thread MDC named item.
Checks whether given name matches the logger name pattern.
</summary>
<param name="item">Item name.</param>
<returns>The item value of String.Empty if the value is not present.</returns>
<param name="loggerName">String to be matched</param>
<returns><see langword="true"/> when the name matches, <see langword="false" /> otherwise.</returns>
</member>
<member name="M:NLog.MDC.Contains(System.String)">
<member name="P:NLog.Config.LoggingRule.Targets">
<summary>
Checks whether the specified item exists in current thread MDC.
A collection of targets that should be written to when this rule matches.
</summary>
<param name="item">Item name.</param>
<returns>A boolean indicating whether the specified item exists in current thread MDC.</returns>
</member>
<member name="M:NLog.MDC.Remove(System.String)">
<member name="P:NLog.Config.LoggingRule.ChildRules">
<summary>
Removes the specified item from current thread MDC.
A collection of child rules to be evaluated when this rule matches.
</summary>
<param name="item">Item name.</param>
</member>
<member name="M:NLog.MDC.Clear">
<member name="P:NLog.Config.LoggingRule.Filters">
<summary>
Clears the content of current thread MDC.
A collection of filters to be checked before writing to targets.
</summary>
</member>
<member name="T:NLog.LogLevel">
<member name="P:NLog.Config.LoggingRule.Final">
<summary>
Defines available log levels.
Quit processing any further rule when this one matches.
</summary>
</member>
<member name="F:NLog.LogLevel.Trace">
<member name="P:NLog.Config.LoggingRule.LoggerNamePattern">
<summary>
The Trace level.
Logger name pattern.
</summary>
<remarks>
Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends but not anywhere else.
</remarks>
</member>
<member name="F:NLog.LogLevel.Debug">
<member name="T:NLog.Conditions.ConditionMethods">
<summary>
The Debug level.
A bunch of utility methods (mostly predicates) which can be used in
condition expressions. Parially inspired by XPath 1.0.
</summary>
</member>
<member name="F:NLog.LogLevel.Info">
<member name="M:NLog.Conditions.ConditionMethods.Equals2(System.Object,System.Object)">
<summary>
The Info level.
Compares two objects for equality.
</summary>
<param name="o1">The first object</param>
<param name="o2">The second object</param>
<returns><b>true</b> when two objects are equal, <b>false</b> otherwise.</returns>
</member>
<member name="F:NLog.LogLevel.Warn">
<member name="M:NLog.Conditions.ConditionMethods.Contains(System.String,System.String)">
<summary>
The Warn level.
Determines whether the second string is a substring of the first one.
</summary>
<param name="s1">The first string</param>
<param name="s2">The second string</param>
<returns><b>true</b> when the second string is a substring of the first string, <b>false</b> otherwise.</returns>
</member>
<member name="F:NLog.LogLevel.Error">
<member name="M:NLog.Conditions.ConditionMethods.StartsWith(System.String,System.String)">
<summary>
The Error level.
Determines whether the second string is a prefix of the first one.
</summary>
<param name="s1">The first string</param>
<param name="s2">The second string</param>
<returns><b>true</b> when the second string is a prefix of the first string, <b>false</b> otherwise.</returns>
</member>
<member name="F:NLog.LogLevel.Fatal">
<member name="M:NLog.Conditions.ConditionMethods.EndsWith(System.String,System.String)">
<summary>
The Fatal level.
Determines whether the second string is a suffix of the first one.
</summary>
<param name="s1">The first string</param>
<param name="s2">The second string</param>
<returns><b>true</b> when the second string is a prefix of the first string, <b>false</b> otherwise.</returns>
</member>
<member name="F:NLog.LogLevel.Off">
<member name="M:NLog.Conditions.ConditionMethods.Length(System.String)">
<summary>
The Off level.
Returns the length of a string.
</summary>
<param name="s">A string.</param>
<returns>The length of a string.</returns>
</member>
<member name="M:NLog.LogLevel.FromOrdinal(System.Int32)">
<member name="T:NLog.ConditionMethodAttribute">
<summary>
Gets the <see cref="T:NLog.LogLevel"/> that corresponds to the specified ordinal.
Marks class as a log event Condition and assigns a name to it
</summary>
<param name="ordinal">The ordinal.</param>
<returns>The <see cref="T:NLog.LogLevel"/> instance. For 0 it returns <see cref="F:NLog.LogLevel.Debug"/>, 1 gives <see cref="F:NLog.LogLevel.Info"/> and so on</returns>
</member>
<member name="M:NLog.LogLevel.op_LessThanOrEqual(NLog.LogLevel,NLog.LogLevel)">
<member name="M:NLog.ConditionMethodAttribute.#ctor(System.String)">
<summary>
Compares two <see cref="T:NLog.LogLevel"/> objects
and returns a value indicating whether
the first one is less than or equal to the second one.
Creates a new instance of <see cref="T:NLog.ConditionMethodAttribute"/> and assigns
a name to it.
</summary>
<param name="l1">The first level.</param>
<param name="l2">The second level.</param>
<returns>The value of <c>l1.Ordinal &lt;= l2.Ordinal</c></returns>
<param name="name"></param>
</member>
<member name="M:NLog.LogLevel.op_GreaterThanOrEqual(NLog.LogLevel,NLog.LogLevel)">
<member name="P:NLog.ConditionMethodAttribute.Name">
<summary>
Compares two <see cref="T:NLog.LogLevel"/> objects
and returns a value indicating whether
the first one is greater than or equal to the second one.
The name of the condition method.
</summary>
<param name="l1">The first level.</param>
<param name="l2">The second level.</param>
<returns>The value of <c>l1.Ordinal &gt;= l2.Ordinal</c></returns>
</member>
<member name="M:NLog.LogLevel.op_LessThan(NLog.LogLevel,NLog.LogLevel)">
<member name="T:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection">
<summary>
Compares two <see cref="T:NLog.LogLevel"/> objects
and returns a value indicating whether
the first one is less than the second one.
A collection of elements of type ConsoleWordHighlightingRule
</summary>
<param name="l1">The first level.</param>
<param name="l2">The second level.</param>
<returns>The value of <c>l1.Ordinal &lt; l2.Ordinal</c></returns>
</member>
<member name="M:NLog.LogLevel.op_GreaterThan(NLog.LogLevel,NLog.LogLevel)">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.#ctor">
<summary>
Compares two <see cref="T:NLog.LogLevel"/> objects
and returns a value indicating whether
the first one is greater than the second one.
Initializes a new empty instance of the ConsoleWordHighlightingRuleCollection class.
</summary>
<param name="l1">The first level.</param>
<param name="l2">The second level.</param>
<returns>The value of <c>l1.Ordinal &gt; l2.Ordinal</c></returns>
</member>
<member name="M:NLog.LogLevel.FromString(System.String)">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.#ctor(NLog.Win32.Targets.ConsoleWordHighlightingRule[])">
<summary>
Returns the <see cref="T:NLog.LogLevel"/> that corresponds to the supplied <see langword="string" />.
Initializes a new instance of the ConsoleWordHighlightingRuleCollection class, containing elements
copied from an array.
</summary>
<param name="s">the texual representation of the log level</param>
<returns>the enumeration value.</returns>
<param name="items">
The array whose elements are to be added to the new ConsoleWordHighlightingRuleCollection.
</param>
</member>
<member name="M:NLog.LogLevel.ToString">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.#ctor(NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection)">
<summary>
Returns a string representation of the log level.
Initializes a new instance of the ConsoleWordHighlightingRuleCollection class, containing elements
copied from another instance of ConsoleWordHighlightingRuleCollection
</summary>
<returns>Log level name.</returns>
<param name="items">
The ConsoleWordHighlightingRuleCollection whose elements are to be added to the new ConsoleWordHighlightingRuleCollection.
</param>
</member>
<member name="M:NLog.LogLevel.CompareTo(System.Object)">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.AddRange(NLog.Win32.Targets.ConsoleWordHighlightingRule[])">
<summary>
Compares the level to the other <see cref="T:NLog.LogLevel"/> object.
Adds the elements of an array to the end of this ConsoleWordHighlightingRuleCollection.
</summary>
<param name="obj">the object object</param>
<returns>a value less than zero when this logger's <see cref="P:NLog.LogLevel.Ordinal"/> is
less than the other logger's ordinal, 0 when they are equal and
greater than zero when this ordinal is greater than the
other ordinal.</returns>
<param name="items">
The array whose elements are to be added to the end of this ConsoleWordHighlightingRuleCollection.
</param>
</member>
<member name="P:NLog.LogLevel.Name">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.AddRange(NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection)">
<summary>
Gets the name of the log level.
Adds the elements of another ConsoleWordHighlightingRuleCollection to the end of this ConsoleWordHighlightingRuleCollection.
</summary>
<param name="items">
The ConsoleWordHighlightingRuleCollection whose elements are to be added to the end of this ConsoleWordHighlightingRuleCollection.
</param>
</member>
<member name="P:NLog.LogLevel.UppercaseName">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Add(NLog.Win32.Targets.ConsoleWordHighlightingRule)">
<summary>
Gets the name of the logger in upper case.
Adds an instance of type ConsoleWordHighlightingRule to the end of this ConsoleWordHighlightingRuleCollection.
</summary>
<param name="value">
The ConsoleWordHighlightingRule to be added to the end of this ConsoleWordHighlightingRuleCollection.
</param>
</member>
<member name="P:NLog.LogLevel.LowercaseName">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Contains(NLog.Win32.Targets.ConsoleWordHighlightingRule)">
<summary>
Gets the name of the logger in lower case.
Determines whether a specfic ConsoleWordHighlightingRule value is in this ConsoleWordHighlightingRuleCollection.
</summary>
<param name="value">
The ConsoleWordHighlightingRule value to locate in this ConsoleWordHighlightingRuleCollection.
</param>
<returns>
true if value is found in this ConsoleWordHighlightingRuleCollection;
false otherwise.
</returns>
</member>
<member name="T:NLog.LogEventInfo">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.IndexOf(NLog.Win32.Targets.ConsoleWordHighlightingRule)">
<summary>
Represents the logging event.
Return the zero-based index of the first occurrence of a specific value
in this ConsoleWordHighlightingRuleCollection
</summary>
<param name="value">
The ConsoleWordHighlightingRule value to locate in the ConsoleWordHighlightingRuleCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="F:NLog.LogEventInfo.ZeroDate">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Insert(System.Int32,NLog.Win32.Targets.ConsoleWordHighlightingRule)">
<summary>
The date of the first log event created.
Inserts an element into the ConsoleWordHighlightingRuleCollection at the specified index
</summary>
<param name="index">
The index at which the ConsoleWordHighlightingRule is to be inserted.
</param>
<param name="value">
The ConsoleWordHighlightingRule to insert.
</param>
</member>
<member name="M:NLog.LogEventInfo.#ctor">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Remove(NLog.Win32.Targets.ConsoleWordHighlightingRule)">
<summary>
Creates a new instance of <see cref="T:NLog.LogEventInfo"/>.
Removes the first occurrence of a specific ConsoleWordHighlightingRule from this ConsoleWordHighlightingRuleCollection.
</summary>
<param name="value">
The ConsoleWordHighlightingRule value to remove from this ConsoleWordHighlightingRuleCollection.
</param>
</member>
<member name="M:NLog.LogEventInfo.CreateNullEvent">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.GetEnumerator">
<summary>
Creates the null event.
Returns an enumerator that can iterate through the elements of this ConsoleWordHighlightingRuleCollection.
</summary>
<returns></returns>
<returns>
An object that implements System.Collections.IEnumerator.
</returns>
</member>
<member name="M:NLog.LogEventInfo.#ctor(NLog.LogLevel,System.String,System.String)">
<member name="P:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Item(System.Int32)">
<summary>
Creates a new instance of <see cref="T:NLog.LogEventInfo"/> and assigns its fields.
Gets or sets the ConsoleWordHighlightingRule at the given index in this ConsoleWordHighlightingRuleCollection.
</summary>
<param name="level">Log level</param>
<param name="loggerName">Logger name</param>
<param name="message">Log message including parameter placeholders</param>
</member>
<member name="M:NLog.LogEventInfo.#ctor(NLog.LogLevel,System.String,System.IFormatProvider,System.String,System.Object[])">
<member name="T:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Enumerator">
<summary>
Creates a new instance of <see cref="T:NLog.LogEventInfo"/> and assigns its fields.
Type-specific enumeration class, used by ConsoleWordHighlightingRuleCollection.GetEnumerator.
</summary>
<param name="level">Log level</param>
<param name="loggerName">Logger name</param>
<param name="formatProvider"><see cref="T:System.IFormatProvider"/> object</param>
<param name="message">Log message including parameter placeholders</param>
<param name="parameters">Parameter array.</param>
</member>
<member name="M:NLog.LogEventInfo.#ctor(NLog.LogLevel,System.String,System.IFormatProvider,System.String,System.Object[],System.Exception)">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Enumerator.#ctor(NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection)">
<summary>
Creates a new instance of <see cref="T:NLog.LogEventInfo"/> and assigns its fields.
</summary>
<param name="level">Log level</param>
<param name="loggerName">Logger name</param>
<param name="formatProvider"><see cref="T:System.IFormatProvider"/> object</param>
<param name="message">Log message including parameter placeholders</param>
<param name="parameters">Parameter array.</param>
<param name="exception">Exception information.</param>
<param name="collection"></param>
</member>
<member name="P:NLog.LogEventInfo.TimeStamp">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Enumerator.MoveNext">
<summary>
Gets or sets the timestamp of the logging event.
</summary>
<returns></returns>
</member>
<member name="P:NLog.LogEventInfo.Level">
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Enumerator.Reset">
<summary>
Gets or sets the level of the logging event.
</summary>
</member>
<member name="P:NLog.LogEventInfo.HasStackTrace">
<member name="P:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Enumerator.Current">
<summary>
Returns true if stack trace has been set for this event.
</summary>
</member>
<member name="P:NLog.LogEventInfo.UserStackFrame">
<member name="T:NLog.RichTextBoxRowColoringRuleCollection">
<summary>
Gets the stack frame of the method that did the logging.
A collection of elements of type RichTextBoxRowColoringRule
</summary>
</member>
<member name="P:NLog.LogEventInfo.UserStackFrameNumber">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.#ctor">
<summary>
Gets the number index of the stack frame that represents the user
code (not the NLog code)
Initializes a new empty instance of the RichTextBoxRowColoringRuleCollection class.
</summary>
</member>
<member name="P:NLog.LogEventInfo.StackTrace">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.#ctor(NLog.Targets.RichTextBoxRowColoringRule[])">
<summary>
Gets the entire stack trace.
Initializes a new instance of the RichTextBoxRowColoringRuleCollection class, containing elements
copied from an array.
</summary>
<param name="items">
The array whose elements are to be added to the new RichTextBoxRowColoringRuleCollection.
</param>
</member>
<member name="P:NLog.LogEventInfo.Exception">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.#ctor(NLog.RichTextBoxRowColoringRuleCollection)">
<summary>
Gets or sets the exception information.
Initializes a new instance of the RichTextBoxRowColoringRuleCollection class, containing elements
copied from another instance of RichTextBoxRowColoringRuleCollection
</summary>
<param name="items">
The RichTextBoxRowColoringRuleCollection whose elements are to be added to the new RichTextBoxRowColoringRuleCollection.
</param>
</member>
<member name="P:NLog.LogEventInfo.LoggerName">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.AddRange(NLog.Targets.RichTextBoxRowColoringRule[])">
<summary>
Gets or sets the logger name.
Adds the elements of an array to the end of this RichTextBoxRowColoringRuleCollection.
</summary>
<param name="items">
The array whose elements are to be added to the end of this RichTextBoxRowColoringRuleCollection.
</param>
</member>
<member name="P:NLog.LogEventInfo.LoggerShortName">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.AddRange(NLog.RichTextBoxRowColoringRuleCollection)">
<summary>
Gets the logger short name.
Adds the elements of another RichTextBoxRowColoringRuleCollection to the end of this RichTextBoxRowColoringRuleCollection.
</summary>
<param name="items">
The RichTextBoxRowColoringRuleCollection whose elements are to be added to the end of this RichTextBoxRowColoringRuleCollection.
</param>
</member>
<member name="P:NLog.LogEventInfo.Message">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.Add(NLog.Targets.RichTextBoxRowColoringRule)">
<summary>
Gets the raw log message including any parameter placeholders.
Adds an instance of type RichTextBoxWordColoringRule to the end of this RichTextBoxRowColoringRuleCollection.
</summary>
<param name="value">
The RichTextBoxRowColoringRule to be added to the end of this RichTextBoxRowColoringRuleCollection.
</param>
</member>
<member name="P:NLog.LogEventInfo.Parameters">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.Contains(NLog.Targets.RichTextBoxRowColoringRule)">
<summary>
Gets the parameter values or <see langword="null" /> if no parameters have
been specified.
Determines whether a specfic RichTextBoxRowColoringRule value is in this RichTextBoxRowColoringRuleCollection.
</summary>
<param name="value">
The RichTextBoxRowColoringRule value to locate in this RichTextBoxRowColoringRuleCollection.
</param>
<returns>
true if value is found in this RichTextBoxRowColoringRuleCollection;
false otherwise.
</returns>
</member>
<member name="P:NLog.LogEventInfo.FormatProvider">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.IndexOf(NLog.Targets.RichTextBoxRowColoringRule)">
<summary>
Gets the format provider that was provided while logging or <see langword="null" />
when no formatProvider was specified.
Return the zero-based index of the first occurrence of a specific value
in this RichTextBoxRowColoringRuleCollection
</summary>
<param name="value">
The RichTextBoxRowColoringRule value to locate in the RichTextBoxRowColoringRuleCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="P:NLog.LogEventInfo.FormattedMessage">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.Insert(System.Int32,NLog.Targets.RichTextBoxRowColoringRule)">
<summary>
Returns the formatted message.
Inserts an element into the RichTextBoxRowColoringRuleCollection at the specified index
</summary>
<param name="index">
The index at which the RichTextBoxRowColoringRule is to be inserted.
</param>
<param name="value">
The RichTextBoxRowColoringRule to insert.
</param>
</member>
<member name="P:NLog.LogEventInfo.Context">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.Remove(NLog.Targets.RichTextBoxRowColoringRule)">
<summary>
Gets the dictionary of per-event context properties.
Removes the first occurrence of a specific RichTextBoxRowColoringRule from this RichTextBoxRowColoringRuleCollection.
</summary>
<param name="value">
The RichTextBoxRowColoringRule value to remove from this RichTextBoxRowColoringRuleCollection.
</param>
</member>
<member name="P:NLog.LogEventInfo.SequenceID">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.GetEnumerator">
<summary>
The unique identifier of log event which is automatically generated
and monotonously increasing.
Returns an enumerator that can iterate through the elements of this RichTextBoxRowColoringRuleCollection.
</summary>
<returns>
An object that implements System.Collections.IEnumerator.
</returns>
</member>
<member name="T:NLog.Layouts.CsvLayout">
<member name="P:NLog.RichTextBoxRowColoringRuleCollection.Item(System.Int32)">
<summary>
A specialized layout that renders CSV-formatted events.
Gets or sets the RichTextBoxRowColoringRule at the given index in this RichTextBoxRowColoringRuleCollection.
</summary>
</member>
<member name="M:NLog.Layouts.CsvLayout.#ctor">
<member name="T:NLog.RichTextBoxRowColoringRuleCollection.Enumerator">
<summary>
Initializes a new instance of the <see cref="T:NLog.Layouts.CsvLayout"/> class.
Type-specific enumeration class, used by RichTextBoxRowColoringRuleCollection.GetEnumerator.
</summary>
</member>
<member name="M:NLog.Layouts.CsvLayout.GetFormattedMessage(NLog.LogEventInfo)">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.Enumerator.#ctor(NLog.RichTextBoxRowColoringRuleCollection)">
<summary>
Formats the log event for write.
</summary>
<param name="logEvent">The log event to be formatted.</param>
<returns>A string representation of the log event.</returns>
<param name="collection"></param>
</member>
<member name="M:NLog.Layouts.CsvLayout.Initialize">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.Enumerator.MoveNext">
<summary>
Initializes the layout.
</summary>
<returns></returns>
</member>
<member name="M:NLog.Layouts.CsvLayout.NeedsStackTrace">
<member name="M:NLog.RichTextBoxRowColoringRuleCollection.Enumerator.Reset">
<summary>
Returns the value indicating whether a stack trace and/or the source file
information should be gathered during layout processing.
</summary>
<returns>0 - don't include stack trace<br/>1 - include stack trace without source file information<br/>2 - include full stack trace</returns>
</member>
<member name="M:NLog.Layouts.CsvLayout.IsVolatile">
<member name="P:NLog.RichTextBoxRowColoringRuleCollection.Enumerator.Current">
<summary>
Returns the value indicating whether this layout includes any volatile
layout renderers.
</summary>
<returns><see langword="true"/> when the layout includes at least
one volatile renderer, <see langword="false"/> otherwise.</returns>
<remarks>
Volatile layout renderers are dependent on information not contained
in <see cref="T:NLog.LogEventInfo"/> (such as thread-specific data, MDC data, NDC data).
</remarks>
</member>
<member name="M:NLog.Layouts.CsvLayout.Precalculate(NLog.LogEventInfo)">
<member name="T:NLog.Layouts.CsvColumn">
<summary>
Precalculates the layout for the specified log event and stores the result
in per-log event cache.
A column in the CSV
</summary>
<param name="logEvent">The log event.</param>
<remarks>
Calling this method enables you to store the log event in a buffer
and/or potentially evaluate it in another thread even though the
layout may contain thread-dependent renderer.
</remarks>
</member>
<member name="M:NLog.Layouts.CsvLayout.Close">
<member name="M:NLog.Layouts.CsvColumn.#ctor">
<summary>
Closes the layout.
Constructs a new instance of <see cref="T:NLog.Layouts.CsvColumn"/>.
</summary>
</member>
<member name="M:NLog.Layouts.CsvLayout.GetHeader(NLog.LogEventInfo)">
<member name="M:NLog.Layouts.CsvColumn.#ctor(System.String,System.String)">
<summary>
Gets the header.
Constructs a new instance of <see cref="T:NLog.Layouts.CsvColumn"/> and
initializes Name and Layout properties.
</summary>
<param name="logEvent">The log event to be formatted.</param>
<returns>A string representation of the log event.</returns>
</member>
<member name="M:NLog.Layouts.CsvLayout.PopulateLayouts(NLog.LayoutCollection)">
<member name="P:NLog.Layouts.CsvColumn.Name">
<summary>
Add this layout and all sub-layouts to the specified collection..
The name of the column.
</summary>
<param name="layouts">The collection of layouts.</param>
</member>
<member name="P:NLog.Layouts.CsvLayout.Columns">
<member name="P:NLog.Layouts.CsvColumn.Layout">
<summary>
Array of parameters to be passed.
The layout that should be written in the column.
</summary>
</member>
<member name="P:NLog.Layouts.CsvLayout.WithHeader">
<member name="P:NLog.Layouts.CsvColumn.CompiledLayout">
<summary>
Whether CVS should include header.
The compiled layout that should be written in the column.
</summary>
<value><c>true</c> if CVS should include header; otherwise, <c>false</c>.</value>
</member>
<member name="P:NLog.Layouts.CsvLayout.Delimiter">
<member name="T:NLog.LayoutRenderers.MachineNameLayoutRenderer">
<summary>
Column delimiter.
The machine name that the process is running on.
</summary>
</member>
<member name="P:NLog.Layouts.CsvLayout.Quoting">
<member name="M:NLog.LayoutRenderers.MachineNameLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Quoting mode.
</summary>
</member>
<member name="P:NLog.Layouts.CsvLayout.QuoteChar">
<summary>
Quote Character
</summary>
</member>
<member name="P:NLog.Layouts.CsvLayout.CustomColumnDelimiter">
<summary>
Custom column delimiter value (valid when ColumnDelimiter is set to 'Custom')
</summary>
</member>
<member name="P:NLog.Layouts.CsvLayout.Layout">
<summary>
Main layout (can be repeated multiple times)
</summary>
<value></value>
</member>
<member name="P:NLog.Layouts.CsvLayout.Header">
<summary>
Header
</summary>
<value></value>
</member>
<member name="P:NLog.Layouts.CsvLayout.Footer">
<summary>
Footer
</summary>
<remarks>CSV has no footer.</remarks>
</member>
<member name="T:NLog.Layouts.CsvLayout.ColumnDelimiterMode">
<summary>
Specifies allowed column delimiters.
</summary>
</member>
<member name="F:NLog.Layouts.CsvLayout.ColumnDelimiterMode.Auto">
<summary>
Automatically detect from regional settings.
</summary>
</member>
<member name="F:NLog.Layouts.CsvLayout.ColumnDelimiterMode.Comma">
<summary>
Comma (ASCII 44)
</summary>
</member>
<member name="F:NLog.Layouts.CsvLayout.ColumnDelimiterMode.Semicolon">
<summary>
Semicolon (ASCII 59)
</summary>
</member>
<member name="F:NLog.Layouts.CsvLayout.ColumnDelimiterMode.Tab">
<summary>
Tab character (ASCII 9)
</summary>
</member>
<member name="F:NLog.Layouts.CsvLayout.ColumnDelimiterMode.Pipe">
<summary>
Pipe character (ASCII 124)
</summary>
</member>
<member name="F:NLog.Layouts.CsvLayout.ColumnDelimiterMode.Space">
<summary>
Space character (ASCII 32)
</summary>
</member>
<member name="F:NLog.Layouts.CsvLayout.ColumnDelimiterMode.Custom">
<summary>
Custom string, specified by the CustomDelimiter
</summary>
</member>
<member name="M:NLog.Layouts.CsvLayout.CsvHeaderLayout.#ctor(NLog.Layouts.CsvLayout)">
<summary>
Initializes a new instance of the <see cref="T:NLog.Layouts.CsvLayout.CsvHeaderLayout"/> class.
</summary>
<param name="parent">The parent.</param>
</member>
<member name="M:NLog.Layouts.CsvLayout.CsvHeaderLayout.GetFormattedMessage(NLog.LogEventInfo)">
<summary>
Renders the layout for the specified logging event by invoking layout renderers.
</summary>
<param name="logEvent">The logging event.</param>
<returns>The rendered layout.</returns>
</member>
<member name="M:NLog.Layouts.CsvLayout.CsvHeaderLayout.NeedsStackTrace">
<summary>
Returns the value indicating whether a stack trace and/or the source file
information should be gathered during layout processing.
</summary>
<returns>
0 - don't include stack trace<br/>1 - include stack trace without source file information<br/>2 - include full stack trace
</returns>
</member>
<member name="M:NLog.Layouts.CsvLayout.CsvHeaderLayout.IsVolatile">
<summary>
Returns the value indicating whether this layout includes any volatile
layout renderers.
</summary>
<returns>
<see langword="true"/> when the layout includes at least
one volatile renderer, <see langword="false"/> otherwise.
</returns>
<remarks>
Volatile layout renderers are dependent on information not contained
in <see cref="T:NLog.LogEventInfo"/> (such as thread-specific data, MDC data, NDC data).
</remarks>
</member>
<member name="M:NLog.Layouts.CsvLayout.CsvHeaderLayout.Precalculate(NLog.LogEventInfo)">
<summary>
Precalculates the layout for the specified log event and stores the result
in per-log event cache.
</summary>
<param name="logEvent">The log event.</param>
<remarks>
Calling this method enables you to store the log event in a buffer
and/or potentially evaluate it in another thread even though the
layout may contain thread-dependent renderer.
</remarks>
</member>
<member name="M:NLog.Layouts.CsvLayout.CsvHeaderLayout.Initialize">
<summary>
Initializes the layout.
</summary>
</member>
<member name="M:NLog.Layouts.CsvLayout.CsvHeaderLayout.Close">
<summary>
Closes the layout.
</summary>
</member>
<member name="M:NLog.Layouts.CsvLayout.CsvHeaderLayout.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Add this layout and all sub-layouts to the specified collection..
</summary>
<param name="layouts">The collection of layouts.</param>
</member>
<member name="T:NLog.LayoutRenderers.TicksLayoutRenderer">
<summary>
The Ticks value of current date and time.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.TicksLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
4329,20 → 3333,27
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.TicksLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.LayoutRenderers.MachineNameLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Renders the ticks value of current time and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Renders the machine name and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="T:NLog.LayoutRenderers.NewLine">
<member name="M:NLog.LayoutRenderers.MachineNameLayoutRenderer.IsAppDomainFixed">
<summary>
A newline literal.
Determines whether the value produced by the layout renderer
is fixed per current app-domain.
</summary>
<returns><see langword="true"/></returns>
</member>
<member name="M:NLog.LayoutRenderers.NewLine.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="T:NLog.LayoutRenderers.DateLayoutRenderer">
<summary>
A date and time in the specified format.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.DateLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
4354,20 → 3365,25
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.NewLine.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.LayoutRenderers.DateLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Renders the specified string literal and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Renders the current date and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="T:NLog.LayoutRenderers.EnvironmentLayoutRenderer">
<member name="P:NLog.LayoutRenderers.DateLayoutRenderer.Format">
<summary>
The environment variable.
The date format. Can be any argument accepted by DateTime.ToString(format)
</summary>
</member>
<member name="M:NLog.LayoutRenderers.EnvironmentLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="T:NLog.LayoutRenderers.TempDirLayoutRenderer">
<summary>
A temporary directory.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.TempDirLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
4379,25 → 3395,30
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.EnvironmentLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.LayoutRenderers.TempDirLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Renders the specified environment variable and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Renders the directory where NLog is located and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="M:NLog.LayoutRenderers.EnvironmentLayoutRenderer.IsAppDomainFixed">
<member name="M:NLog.LayoutRenderers.TempDirLayoutRenderer.IsAppDomainFixed">
<summary>
Determines whether the value produced by the layout renderer
is fixed per current app-domain.
</summary>
<returns><see langword="true"/></returns>
</member>
<member name="P:NLog.LayoutRenderers.EnvironmentLayoutRenderer.Variable">
<member name="P:NLog.LayoutRenderers.TempDirLayoutRenderer.File">
<summary>
Name of the environment variable.
The name of the file to be Path.Combine()'d with the directory name.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.TempDirLayoutRenderer.Dir">
<summary>
The name of the directory to be Path.Combine()'d with the directory name.
</summary>
</member>
<member name="T:NLog.LayoutRenderers.ASPNETUserAuthTypeLayoutRenderer">
<summary>
ASP.NET User variable
4423,231 → 3444,326
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="T:NLog.Conditions.ConditionParseException">
<member name="T:NLog.Internal.TypeDictionary">
<summary>
Exception during parsing of condition expression
A dictionary with keys of type string and values of type Type
</summary>
</member>
<member name="M:NLog.Conditions.ConditionParseException.#ctor">
<member name="M:NLog.Internal.TypeDictionary.#ctor">
<summary>
Creates a new instance of <see cref="T:NLog.Conditions.ConditionParseException"/>.
Initializes a new empty instance of the TypeDictionary class
</summary>
</member>
<member name="M:NLog.Conditions.ConditionParseException.#ctor(System.String)">
<member name="M:NLog.Internal.TypeDictionary.Add(System.String,System.Type)">
<summary>
Creates a new instance of <see cref="T:NLog.Conditions.ConditionParseException"/>.
Adds an element with the specified key and value to this TypeDictionary.
</summary>
<param name="desc">Error message</param>
<param name="key">
The string key of the element to add.
</param>
<param name="value">
The Type value of the element to add.
</param>
</member>
<member name="M:NLog.Conditions.ConditionParseException.#ctor(System.String,System.Exception)">
<member name="M:NLog.Internal.TypeDictionary.Contains(System.String)">
<summary>
Creates a new instance of <see cref="T:NLog.Conditions.ConditionParseException"/>.
Determines whether this TypeDictionary contains a specific key.
</summary>
<param name="desc">Error message</param>
<param name="inner">Inner exception</param>
<param name="key">
The string key to locate in this TypeDictionary.
</param>
<returns>
true if this TypeDictionary contains an element with the specified key;
otherwise, false.
</returns>
</member>
<member name="M:NLog.Conditions.ConditionParseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<member name="M:NLog.Internal.TypeDictionary.ContainsKey(System.String)">
<summary>
Creates a new instance of <see cref="T:NLog.Conditions.ConditionParseException"/>.
Determines whether this TypeDictionary contains a specific key.
</summary>
<param name="info">Serialization info</param>
<param name="context">Streaming context</param>
<param name="key">
The string key to locate in this TypeDictionary.
</param>
<returns>
true if this TypeDictionary contains an element with the specified key;
otherwise, false.
</returns>
</member>
<member name="T:NLog.Conditions.ConditionMethodExpression">
<member name="M:NLog.Internal.TypeDictionary.ContainsValue(System.Type)">
<summary>
Condition method invocation expression (represented by <b>method(p1,p2,p3)</b> syntax).
Determines whether this TypeDictionary contains a specific value.
</summary>
<param name="value">
The Type value to locate in this TypeDictionary.
</param>
<returns>
true if this TypeDictionary contains an element with the specified value;
otherwise, false.
</returns>
</member>
<member name="M:NLog.Conditions.ConditionMethodExpression.PopulateLayouts(NLog.LayoutCollection)">
<member name="M:NLog.Internal.TypeDictionary.Remove(System.String)">
<summary>
Adds all layouts used by this expression to the specified collection.
Removes the element with the specified key from this TypeDictionary.
</summary>
<param name="layouts">The collection to add layouts to.</param>
<param name="key">
The string key of the element to remove.
</param>
</member>
<member name="T:NLog.Win32.Targets.OutputDebugStringTarget">
<member name="P:NLog.Internal.TypeDictionary.Item(System.String)">
<summary>
Outputs logging messages through the <c>OutputDebugString()</c> Win32 API.
Gets or sets the Type associated with the given string
</summary>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/OutputDebugString/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/OutputDebugString/Simple/Example.cs" />
</example>
<param name="key">
The string whose value to get or set.
</param>
</member>
<member name="M:NLog.Win32.Targets.OutputDebugStringTarget.Write(NLog.LogEventInfo)">
<member name="P:NLog.Internal.TypeDictionary.Keys">
<summary>
Outputs the rendered logging event through the <c>OutputDebugString()</c> Win32 API.
Gets a collection containing the keys in this TypeDictionary.
</summary>
<param name="logEvent">The logging event.</param>
</member>
<member name="M:NLog.Win32.Targets.OutputDebugStringTarget.OutputDebugString(System.String)">
<member name="P:NLog.Internal.TypeDictionary.Values">
<summary>
Stub for OutputDebugString native method
Gets a collection containing the values in this TypeDictionary.
</summary>
<param name="message">the string to output</param>
</member>
<member name="T:NLog.Win32.Targets.ConsoleWordHighlightingRule">
<member name="T:NLog.Config.NotSupportedRuntimeAttribute">
<summary>
Highlighting rule for Win32 colorful console.
Marks classes and properties as NOT supporting particular runtime framework
and operating system.
</summary>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRule.#ctor">
<member name="M:NLog.Config.NotSupportedRuntimeAttribute.#ctor">
<summary>
Creates a new instance of <see cref="T:NLog.Win32.Targets.ConsoleWordHighlightingRule"/>
Creates a new instance of <see cref="T:NLog.Config.SupportedRuntimeAttribute"/>.
</summary>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRule.#ctor(System.String,NLog.Win32.Targets.ConsoleOutputColor,NLog.Win32.Targets.ConsoleOutputColor)">
<member name="T:NLog.Config.DefaultParameterAttribute">
<summary>
Creates a new instance of <see cref="T:NLog.Win32.Targets.ConsoleWordHighlightingRule"/>
and sets Text, BackgroundColor and ForegroundColor properties.
Attribute used to mark the default parameters for layout renderers.
</summary>
</member>
<member name="P:NLog.Win32.Targets.ConsoleWordHighlightingRule.Regex">
<member name="M:NLog.Config.DefaultParameterAttribute.#ctor">
<summary>
The regular expression to be matched. You must specify either <c>text</c> or <c>regex</c>.
Creates a new DefaultParameterAttribute object.
</summary>
</member>
<member name="P:NLog.Win32.Targets.ConsoleWordHighlightingRule.Text">
<member name="T:NLog.Conditions.ConditionParseException">
<summary>
The text to be matched. You must specify either <c>text</c> or <c>regex</c>.
Exception during parsing of condition expression
</summary>
</member>
<member name="P:NLog.Win32.Targets.ConsoleWordHighlightingRule.WholeWords">
<member name="M:NLog.Conditions.ConditionParseException.#ctor">
<summary>
Match whole words only.
Creates a new instance of <see cref="T:NLog.Conditions.ConditionParseException"/>.
</summary>
</member>
<member name="P:NLog.Win32.Targets.ConsoleWordHighlightingRule.IgnoreCase">
<member name="M:NLog.Conditions.ConditionParseException.#ctor(System.String)">
<summary>
Ignore case when comparing texts.
Creates a new instance of <see cref="T:NLog.Conditions.ConditionParseException"/>.
</summary>
<param name="desc">Error message</param>
</member>
<member name="P:NLog.Win32.Targets.ConsoleWordHighlightingRule.CompiledRegex">
<member name="M:NLog.Conditions.ConditionParseException.#ctor(System.String,System.Exception)">
<summary>
Compiled regular expression that matches either Text or Regex property.
Creates a new instance of <see cref="T:NLog.Conditions.ConditionParseException"/>.
</summary>
<param name="desc">Error message</param>
<param name="inner">Inner exception</param>
</member>
<member name="P:NLog.Win32.Targets.ConsoleWordHighlightingRule.ForegroundColor">
<member name="M:NLog.Conditions.ConditionParseException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
The foreground color.
Creates a new instance of <see cref="T:NLog.Conditions.ConditionParseException"/>.
</summary>
<param name="info">Serialization info</param>
<param name="context">Streaming context</param>
</member>
<member name="P:NLog.Win32.Targets.ConsoleWordHighlightingRule.BackgroundColor">
<member name="T:NLog.Conditions.ConditionNotExpression">
<summary>
The background color.
Condition <b>not</b> expression.
</summary>
</member>
<member name="T:NLog.Win32.Targets.ConsoleOutputColor">
<member name="M:NLog.Conditions.ConditionNotExpression.PopulateLayouts(NLog.LayoutCollection)">
<summary>
Colored console output color.
Adds all layouts used by this expression to the specified collection.
</summary>
<remarks>
Note that this enumeration is defined to be binary compatible with
.NET 2.0 System.ConsoleColor + some additions
</remarks>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.Black">
<member name="T:NLog.Win32.Targets.EventLogTarget">
<summary>
Black (#000000)
Writes log message to the Event Log.
</summary>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/EventLog/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/EventLog/Simple/Example.cs" />
</example>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.DarkBlue">
<member name="M:NLog.Win32.Targets.EventLogTarget.#ctor">
<summary>
Dark blue (#000080)
Creates a new instance of <see cref="T:NLog.Win32.Targets.EventLogTarget"/> and
</summary>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.DarkGreen">
<member name="M:NLog.Win32.Targets.EventLogTarget.Write(NLog.LogEventInfo)">
<summary>
Dark green (#008000)
Writes the specified logging event to the event log.
</summary>
<param name="logEvent">The logging event.</param>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.DarkCyan">
<member name="P:NLog.Win32.Targets.EventLogTarget.MachineName">
<summary>
Dark Cyan (#008080)
Machine name on which Event Log service is running.
</summary>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.DarkRed">
<member name="P:NLog.Win32.Targets.EventLogTarget.EventID">
<summary>
Dark Red (#800000)
Layout that renders event ID.
</summary>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.DarkMagenta">
<member name="P:NLog.Win32.Targets.EventLogTarget.Category">
<summary>
Dark Magenta (#800080)
Layout that renders event Category.
</summary>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.DarkYellow">
<member name="P:NLog.Win32.Targets.EventLogTarget.Source">
<summary>
Dark Yellow (#808000)
The value to be used as the event Source.
</summary>
<remarks>
By default this is the friendly name of the current AppDomain.
</remarks>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.Gray">
<member name="P:NLog.Win32.Targets.EventLogTarget.Log">
<summary>
Gray (#C0C0C0)
Name of the Event Log to write to. This can be System, Application or
any user-defined name.
</summary>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.DarkGray">
<member name="T:NLog.Win32.Targets.ASPResponseTarget">
<summary>
Dark Gray (#808080)
Outputs logging messages through the ASP Response object.
</summary>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.Blue">
<member name="M:NLog.Win32.Targets.ASPResponseTarget.Write(NLog.LogEventInfo)">
<summary>
Blue (#0000FF)
Outputs the rendered logging event through the <c>OutputDebugString()</c> Win32 API.
</summary>
<param name="logEvent">The logging event.</param>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.Green">
<member name="P:NLog.Win32.Targets.ASPResponseTarget.AddComments">
<summary>
Green (#00FF00)
Add &lt;!-- --&gt; comments around all written texts.
</summary>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.Cyan">
<member name="T:NLog.Targets.Wrappers.RetryingTargetWrapper">
<summary>
Cyan (#00FFFF)
A target wrapper that causes retries on wrapped target errors.
</summary>
<example>
<p>This example causes each write attempt to be repeated 3 times,
sleeping 1 second between attempts if first one fails.</p>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/RetryingWrapper/NLog.config" />
<p>
The above examples assume just one target and a single rule. See below for
a programmatic configuration that's equivalent to the above config file:
</p>
<code lang="C#" src="examples/targets/Configuration API/RetryingWrapper/Simple/Example.cs" />
</example>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.Red">
<member name="M:NLog.Targets.Wrappers.RetryingTargetWrapper.#ctor">
<summary>
Red (#FF0000)
Creates a new instance of <see cref="T:NLog.Targets.Wrappers.RetryingTargetWrapper"/>.
</summary>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.Magenta">
<member name="M:NLog.Targets.Wrappers.RetryingTargetWrapper.#ctor(NLog.Target,System.Int32,System.Int32)">
<summary>
Magenta (#FF00FF)
Creates a new instance of <see cref="T:NLog.Targets.Wrappers.RetryingTargetWrapper"/> and
initializes the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/>
<see cref="P:NLog.Targets.Wrappers.RetryingTargetWrapper.RetryCount"/> and <see cref="P:NLog.Targets.Wrappers.RetryingTargetWrapper.RetryDelayMilliseconds"/>
properties.
</summary>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.Yellow">
<member name="M:NLog.Targets.Wrappers.RetryingTargetWrapper.Write(NLog.LogEventInfo)">
<summary>
Yellow (#FFFF00)
Writes the specified log event to the wrapped target, retrying and pausing in case of an error.
</summary>
<param name="logEvent">The log event.</param>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.White">
<member name="P:NLog.Targets.Wrappers.RetryingTargetWrapper.RetryCount">
<summary>
White (#FFFFFF)
Number of retries that should be attempted on the wrapped target in case of a failure.
</summary>
</member>
<member name="F:NLog.Win32.Targets.ConsoleOutputColor.NoChange">
<member name="P:NLog.Targets.Wrappers.RetryingTargetWrapper.RetryDelayMilliseconds">
<summary>
Don't change the color.
The time to wait between retries in milliseconds.
</summary>
</member>
<member name="T:NLog.Win32.LayoutRenderers.WindowsIdentityLayoutRenderer">
<member name="T:NLog.Targets.ASPNetTraceTarget">
<summary>
Thread Windows identity information (username)
Writes logging messages to the ASP.NET trace.
</summary>
<example>
<p>To set up the ASP.NET Trace target in the <a href="config.html">configuration file</a>, put
the following in <c>web.nlog</c> file in your web application directory.
</p>
<code lang="XML" src="examples/targets/Configuration File/ASPNetTrace/web.nlog" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To configure the target programmatically, put the following
piece of code in your <c>Application_OnStart()</c> handler in Global.asax.cs
or some other place that gets executed at the very beginning of your code:
</p>
<code lang="C#" src="examples/targets/Configuration API/ASPNetTrace/Global.asax.cs" />
<p>
Fully working C# project can be found in the <c>Examples/Targets/Configuration API/ASPNetTrace</c>
directory along with usage instructions.
</p>
Resulting log entries can be viewed by navigating to http://server/path/Trace.axd.
<br/>
<b>HTTP Request List:</b><br/>
<img src="examples/targets/Screenshots/ASPNetTrace/ASPNetTraceOutput1.gif" />
<p/>
<b>HTTP Request Details:</b>
<br/>
<img src="examples/targets/Screenshots/ASPNetTrace/ASPNetTraceOutput2.gif" />
<p/>
</example>
</member>
<member name="M:NLog.Win32.LayoutRenderers.WindowsIdentityLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="M:NLog.Targets.ASPNetTraceTarget.Write(NLog.LogEventInfo)">
<summary>
Writes the specified logging event to the ASP.NET Trace facility. Log entries
can then be viewed by navigating to http://server/path/Trace.axd
If the log level is greater than or equal to <see cref="F:NLog.LogLevel.Warn"/> it uses the
<see cref="M:System.Web.TraceContext.Warn(System.String,System.String)"/> method, otherwise it uses
<see cref="M:System.Web.TraceContext.Write(System.String,System.String)"/> method.
</summary>
<param name="logEvent">The logging event.</param>
</member>
<member name="T:NLog.LayoutRenderers.MessageLayoutRenderer">
<summary>
The formatted log message.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.MessageLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
4659,744 → 3775,591
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.Win32.LayoutRenderers.WindowsIdentityLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.LayoutRenderers.MessageLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Renders the current thread windows identity information and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Renders the log message including any positional parameters and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="P:NLog.Win32.LayoutRenderers.WindowsIdentityLayoutRenderer.Domain">
<member name="T:NLog.LayoutRenderers.LoggerNameLayoutRenderer">
<summary>
Whether domain name should be included.
The logger name.
</summary>
</member>
<member name="P:NLog.Win32.LayoutRenderers.WindowsIdentityLayoutRenderer.UserName">
<member name="M:NLog.LayoutRenderers.LoggerNameLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Whether username should be included.
</summary>
</member>
<member name="T:NLog.Win32.LayoutRenderers.ASPSessionValueLayoutRenderer">
<summary>
ASP Session variable.
</summary>
</member>
<member name="M:NLog.Win32.LayoutRenderers.ASPSessionValueLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
Because ASP target uses COM Interop which is quite expensive, this method always returns 64.
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.Win32.LayoutRenderers.ASPSessionValueLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.LayoutRenderers.LoggerNameLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Renders the specified ASP Session variable and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Renders the logger name and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="P:NLog.Win32.LayoutRenderers.ASPSessionValueLayoutRenderer.Variable">
<member name="P:NLog.LayoutRenderers.LoggerNameLayoutRenderer.ShortName">
<summary>
Session variable name.
Render short logger name (the part after the trailing dot character).
</summary>
</member>
<member name="T:NLog.Targets.NLogViewerTarget">
<member name="T:NLog.Filters.WhenNotEqualFilter">
<summary>
Sends logging messages to the remote instance of NLog Viewer.
Matches when the calculated layout is NOT equal to the specified substring.
This filter is deprecated in favour of <c>&lt;when /&gt;</c> which is based on <a href="conditions.html">contitions</a>
</summary>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/NLogViewer/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/NLogViewer/Simple/Example.cs" />
<p>
NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol
or you'll get TCP timeouts and your application will crawl.
Either switch to UDP transport or use <a href="target.AsyncWrapper.html">AsyncWrapper</a> target
so that your application threads will not be blocked by the timing-out connection attempts.
</p>
</example>
</member>
<member name="T:NLog.Targets.NetworkTarget">
<member name="T:NLog.Filters.LayoutBasedFilter">
<summary>
Sends logging messages over the network.
A base class for filters that are based on comparing a value to a layout.
</summary>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/Network/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/Network/Simple/Example.cs" />
<p>
To print the results, use any application that's able to receive messages over
TCP or UDP. <a href="http://m.nu/program/util/netcat/netcat.html">NetCat</a> is
a simple but very powerful command-line tool that can be used for that. This image
demonstrates the NetCat tool receiving log messages from Network target.
</p>
<img src="examples/targets/Screenshots/Network/Output.gif" />
<p>
NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol
or you'll get TCP timeouts and your application will crawl.
Either switch to UDP transport or use <a href="target.AsyncWrapper.html">AsyncWrapper</a> target
so that your application threads will not be blocked by the timing-out connection attempts.
</p>
<p>
There are two specialized versions of the Network target: <a href="target.Chainsaw.html">Chainsaw</a>
and <a href="target.NLogViewer.html">NLogViewer</a> which write to instances of Chainsaw log4j viewer
or NLogViewer application respectively.
</p>
</example>
</member>
<member name="M:NLog.Targets.NetworkTarget.NetworkSend(System.String,System.Byte[])">
<member name="M:NLog.Filters.LayoutBasedFilter.#ctor">
<summary>
Sends the provided text to the specified address.
Initializes a new instance of <see cref="T:NLog.Filters.LayoutBasedFilter"/>.
</summary>
<param name="address">The address. Can be tcp://host:port, udp://host:port, http://host:port</param>
<param name="bytes">The bytes to be sent.</param>
</member>
<member name="M:NLog.Targets.NetworkTarget.Flush(System.TimeSpan)">
<member name="M:NLog.Filters.LayoutBasedFilter.NeedsStackTrace">
<summary>
Flushes any buffers.
Determines whether stack trace information should be gathered
during log event processing. By default it calls <see cref="M:NLog.Layout.NeedsStackTrace"/> on
<see cref="P:NLog.TargetWithLayout.CompiledLayout"/>.
</summary>
<param name="timeout">Flush timeout.</param>
<returns>0 - don't include stack trace<br/>1 - include stack trace without source file information<br/>2 - include full stack trace</returns>
</member>
<member name="M:NLog.Targets.NetworkTarget.Close">
<member name="P:NLog.Filters.LayoutBasedFilter.Layout">
<summary>
Closes the target.
The layout text;
</summary>
</member>
<member name="M:NLog.Targets.NetworkTarget.PopulateLayouts(NLog.LayoutCollection)">
<member name="P:NLog.Filters.LayoutBasedFilter.CompiledLayout">
<summary>
Adds all layouts used by this target to the specified collection.
Compiled layout.
</summary>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.Targets.NetworkTarget.Write(NLog.LogEventInfo)">
<member name="M:NLog.Filters.WhenNotEqualFilter.#ctor">
<summary>
Sends the
rendered logging event over the network optionally concatenating it with a newline character.
Initializes a new instance of the filter object.
</summary>
<param name="logEvent">The logging event.</param>
</member>
<member name="M:NLog.Targets.NetworkTarget.GetBytesToWrite(NLog.LogEventInfo)">
<member name="M:NLog.Filters.WhenNotEqualFilter.Check(NLog.LogEventInfo)">
<summary>
Gets the bytes to be written.
Checks whether log event should be logged or not.
</summary>
<param name="logEvent">Log event</param>
<returns>Byte array.</returns>
<param name="logEvent">Log event.</param>
<returns>
<see cref="F:NLog.FilterResult.Ignore"/> - if the log event should be ignored<br/>
<see cref="F:NLog.FilterResult.Neutral"/> - if the filter doesn't want to decide<br/>
<see cref="F:NLog.FilterResult.Log"/> - if the log event should be logged<br/>
</returns>
</member>
<member name="P:NLog.Targets.NetworkTarget.Address">
<member name="P:NLog.Filters.WhenNotEqualFilter.CompareTo">
<summary>
The network address. Can be tcp://host:port or udp://host:port
String to compare the layout to.
</summary>
<remarks>
For HTTP Support use the WebService target.
</remarks>
</member>
<member name="P:NLog.Targets.NetworkTarget.AddressLayout">
<member name="P:NLog.Filters.WhenNotEqualFilter.IgnoreCase">
<summary>
The network address. Can be tcp://host:port, udp://host:port, http://host:port or https://host:port
Ignore case when comparing strings.
</summary>
</member>
<member name="P:NLog.Targets.NetworkTarget.KeepConnection">
<member name="T:NLog.Filters.WhenNotContainsFilter">
<summary>
Keep connection open whenever possible.
Matches when the calculated layout does NOT contain the specified substring.
This filter is deprecated in favour of <c>&lt;when /&gt;</c> which is based on <a href="conditions.html">contitions</a>
</summary>
</member>
<member name="P:NLog.Targets.NetworkTarget.NewLine">
<member name="M:NLog.Filters.WhenNotContainsFilter.#ctor">
<summary>
Append newline at the end of log message.
Initializes a new instance of the filter object.
</summary>
</member>
<member name="P:NLog.Targets.NetworkTarget.MaxMessageSize">
<member name="M:NLog.Filters.WhenNotContainsFilter.Check(NLog.LogEventInfo)">
<summary>
Maximum message size in bytes.
Checks whether log event should be logged or not.
</summary>
<param name="logEvent">Log event.</param>
<returns>
<see cref="F:NLog.FilterResult.Ignore"/> - if the log event should be ignored<br/>
<see cref="F:NLog.FilterResult.Neutral"/> - if the filter doesn't want to decide<br/>
<see cref="F:NLog.FilterResult.Log"/> - if the log event should be logged<br/>
</returns>
</member>
<member name="P:NLog.Targets.NetworkTarget.OnOverflow">
<member name="P:NLog.Filters.WhenNotContainsFilter.Substring">
<summary>
Action that should be taken if the message is larger than
maxMessageSize
Substring to be matched.
</summary>
</member>
<member name="P:NLog.Targets.NetworkTarget.Encoding">
<member name="P:NLog.Filters.WhenNotContainsFilter.IgnoreCase">
<summary>
Encoding
Ignore case when comparing strings.
</summary>
<remarks>
Can be any encoding name supported by System.Text.Encoding.GetEncoding() e.g. <c>windows-1252</c>, <c>iso-8859-2</c>.
</remarks>
</member>
<member name="T:NLog.Targets.NetworkTarget.OverflowAction">
<member name="T:NLog.Filters.WhenEqualFilter">
<summary>
Action that should be taken if the message overflows.
Matches when the calculated layout is equal to the specified substring.
This filter is deprecated in favour of <c>&lt;when /&gt;</c> which is based on <a href="conditions.html">contitions</a>
</summary>
</member>
<member name="F:NLog.Targets.NetworkTarget.OverflowAction.Error">
<member name="M:NLog.Filters.WhenEqualFilter.#ctor">
<summary>
Report an error.
Initializes a new instance of the filter object.
</summary>
</member>
<member name="F:NLog.Targets.NetworkTarget.OverflowAction.Split">
<member name="M:NLog.Filters.WhenEqualFilter.Check(NLog.LogEventInfo)">
<summary>
Split the message into smaller pieces.
Checks whether log event should be logged or not.
</summary>
<param name="logEvent">Log event.</param>
<returns>
<see cref="F:NLog.FilterResult.Ignore"/> - if the log event should be ignored<br/>
<see cref="F:NLog.FilterResult.Neutral"/> - if the filter doesn't want to decide<br/>
<see cref="F:NLog.FilterResult.Log"/> - if the log event should be logged<br/>
</returns>
</member>
<member name="F:NLog.Targets.NetworkTarget.OverflowAction.Discard">
<member name="P:NLog.Filters.WhenEqualFilter.IgnoreCase">
<summary>
Discard the entire message
Ignore case when comparing strings.
</summary>
</member>
<member name="M:NLog.Targets.NLogViewerTarget.#ctor">
<member name="P:NLog.Filters.WhenEqualFilter.CompareTo">
<summary>
Creates a new instance of the <see cref="T:NLog.Targets.NLogViewerTarget"/>
and initializes default property values.
String to compare the layout to.
</summary>
</member>
<member name="M:NLog.Targets.NLogViewerTarget.PopulateLayouts(NLog.LayoutCollection)">
<member name="T:NLog.FilterCollection">
<summary>
Adds all layouts used by this target to the specified collection.
A collection of elements of type Filter
</summary>
<param name="layouts">The collection to add layouts to.</param>
</member>
<member name="M:NLog.Targets.NLogViewerTarget.NeedsStackTrace">
<member name="M:NLog.FilterCollection.#ctor">
<summary>
Returns the value indicating whether call site and/or source information should be gathered.
Initializes a new empty instance of the FilterCollection class.
</summary>
<returns>2 - when IncludeSourceInfo is set, 1 when IncludeCallSite is set, 0 otherwise</returns>
</member>
<member name="P:NLog.Targets.NLogViewerTarget.Layout">
<member name="M:NLog.FilterCollection.#ctor(NLog.Filter[])">
<summary>
An instance of <see cref="T:NLog.Layouts.Log4JXmlEventLayout"/> that is used to format log messages.
</summary>
</member>
<member name="P:NLog.Targets.NLogViewerTarget.IncludeNLogData">
<summary>
Include NLog-specific extensions to log4j schema.
</summary>
</member>
<member name="P:NLog.Targets.NLogViewerTarget.AppInfo">
<summary>
The AppInfo field. By default it's the friendly name of the current AppDomain.
</summary>
</member>
<member name="P:NLog.Targets.NLogViewerTarget.IncludeCallSite">
<summary>
Include call site (class and method name) in the information sent over the network.
</summary>
</member>
<member name="P:NLog.Targets.NLogViewerTarget.IncludeSourceInfo">
<summary>
Include source info (file name and line number) in the information sent over the network.
</summary>
</member>
<member name="P:NLog.Targets.NLogViewerTarget.IncludeMDC">
<summary>
Include MDC dictionary in the information sent over the network.
</summary>
</member>
<member name="P:NLog.Targets.NLogViewerTarget.IncludeNDC">
<summary>
Include NDC stack.
</summary>
</member>
<member name="P:NLog.Targets.NLogViewerTarget.Parameters">
<summary>
The collection of parameters. Each parameter contains a mapping
between NLog layout and a named parameter.
</summary>
</member>
<member name="T:NLog.Targets.DatabaseParameterInfoCollection">
<summary>
A collection of elements of type DatabaseParameterInfo
</summary>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.#ctor">
<summary>
Initializes a new empty instance of the DatabaseParameterInfoCollection class.
</summary>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.#ctor(NLog.Targets.DatabaseParameterInfo[])">
<summary>
Initializes a new instance of the DatabaseParameterInfoCollection class, containing elements
Initializes a new instance of the FilterCollection class, containing elements
copied from an array.
</summary>
<param name="items">
The array whose elements are to be added to the new DatabaseParameterInfoCollection.
The array whose elements are to be added to the new FilterCollection.
</param>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.#ctor(NLog.Targets.DatabaseParameterInfoCollection)">
<member name="M:NLog.FilterCollection.#ctor(NLog.FilterCollection)">
<summary>
Initializes a new instance of the DatabaseParameterInfoCollection class, containing elements
copied from another instance of DatabaseParameterInfoCollection
Initializes a new instance of the FilterCollection class, containing elements
copied from another instance of FilterCollection
</summary>
<param name="items">
The DatabaseParameterInfoCollection whose elements are to be added to the new DatabaseParameterInfoCollection.
The FilterCollection whose elements are to be added to the new FilterCollection.
</param>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.AddRange(NLog.Targets.DatabaseParameterInfo[])">
<member name="M:NLog.FilterCollection.AddRange(NLog.Filter[])">
<summary>
Adds the elements of an array to the end of this DatabaseParameterInfoCollection.
Adds the elements of an array to the end of this FilterCollection.
</summary>
<param name="items">
The array whose elements are to be added to the end of this DatabaseParameterInfoCollection.
The array whose elements are to be added to the end of this FilterCollection.
</param>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.AddRange(NLog.Targets.DatabaseParameterInfoCollection)">
<member name="M:NLog.FilterCollection.AddRange(NLog.FilterCollection)">
<summary>
Adds the elements of another DatabaseParameterInfoCollection to the end of this DatabaseParameterInfoCollection.
Adds the elements of another FilterCollection to the end of this FilterCollection.
</summary>
<param name="items">
The DatabaseParameterInfoCollection whose elements are to be added to the end of this DatabaseParameterInfoCollection.
The FilterCollection whose elements are to be added to the end of this FilterCollection.
</param>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Add(NLog.Targets.DatabaseParameterInfo)">
<member name="M:NLog.FilterCollection.Add(NLog.Filter)">
<summary>
Adds an instance of type DatabaseParameterInfo to the end of this DatabaseParameterInfoCollection.
Adds an instance of type Filter to the end of this FilterCollection.
</summary>
<param name="value">
The DatabaseParameterInfo to be added to the end of this DatabaseParameterInfoCollection.
The Filter to be added to the end of this FilterCollection.
</param>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Contains(NLog.Targets.DatabaseParameterInfo)">
<member name="M:NLog.FilterCollection.Contains(NLog.Filter)">
<summary>
Determines whether a specfic DatabaseParameterInfo value is in this DatabaseParameterInfoCollection.
Determines whether a specfic Filter value is in this FilterCollection.
</summary>
<param name="value">
The DatabaseParameterInfo value to locate in this DatabaseParameterInfoCollection.
The Filter value to locate in this FilterCollection.
</param>
<returns>
true if value is found in this DatabaseParameterInfoCollection;
true if value is found in this FilterCollection;
false otherwise.
</returns>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.IndexOf(NLog.Targets.DatabaseParameterInfo)">
<member name="M:NLog.FilterCollection.IndexOf(NLog.Filter)">
<summary>
Return the zero-based index of the first occurrence of a specific value
in this DatabaseParameterInfoCollection
in this FilterCollection
</summary>
<param name="value">
The DatabaseParameterInfo value to locate in the DatabaseParameterInfoCollection.
The Filter value to locate in the FilterCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Insert(System.Int32,NLog.Targets.DatabaseParameterInfo)">
<member name="M:NLog.FilterCollection.Insert(System.Int32,NLog.Filter)">
<summary>
Inserts an element into the DatabaseParameterInfoCollection at the specified index
Inserts an element into the FilterCollection at the specified index
</summary>
<param name="index">
The index at which the DatabaseParameterInfo is to be inserted.
The index at which the Filter is to be inserted.
</param>
<param name="value">
The DatabaseParameterInfo to insert.
The Filter to insert.
</param>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Remove(NLog.Targets.DatabaseParameterInfo)">
<member name="M:NLog.FilterCollection.Remove(NLog.Filter)">
<summary>
Removes the first occurrence of a specific DatabaseParameterInfo from this DatabaseParameterInfoCollection.
Removes the first occurrence of a specific Filter from this FilterCollection.
</summary>
<param name="value">
The DatabaseParameterInfo value to remove from this DatabaseParameterInfoCollection.
The Filter value to remove from this FilterCollection.
</param>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.GetEnumerator">
<member name="M:NLog.FilterCollection.GetEnumerator">
<summary>
Returns an enumerator that can iterate through the elements of this DatabaseParameterInfoCollection.
Returns an enumerator that can iterate through the elements of this FilterCollection.
</summary>
<returns>
An object that implements System.Collections.IEnumerator.
</returns>
</member>
<member name="P:NLog.Targets.DatabaseParameterInfoCollection.Item(System.Int32)">
<member name="P:NLog.FilterCollection.Item(System.Int32)">
<summary>
Gets or sets the DatabaseParameterInfo at the given index in this DatabaseParameterInfoCollection.
Gets or sets the Filter at the given index in this FilterCollection.
</summary>
</member>
<member name="T:NLog.Targets.DatabaseParameterInfoCollection.Enumerator">
<member name="T:NLog.FilterCollection.Enumerator">
<summary>
Type-specific enumeration class, used by DatabaseParameterInfoCollection.GetEnumerator.
Type-specific enumeration class, used by FilterCollection.GetEnumerator.
</summary>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Enumerator.#ctor(NLog.Targets.DatabaseParameterInfoCollection)">
<member name="M:NLog.FilterCollection.Enumerator.#ctor(NLog.FilterCollection)">
<summary>
</summary>
<param name="collection"></param>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Enumerator.MoveNext">
<member name="M:NLog.FilterCollection.Enumerator.MoveNext">
<summary>
</summary>
<returns></returns>
</member>
<member name="M:NLog.Targets.DatabaseParameterInfoCollection.Enumerator.Reset">
<member name="M:NLog.FilterCollection.Enumerator.Reset">
<summary>
</summary>
</member>
<member name="P:NLog.Targets.DatabaseParameterInfoCollection.Enumerator.Current">
<member name="P:NLog.FilterCollection.Enumerator.Current">
<summary>
</summary>
</member>
<member name="P:NLog.Targets.DatabaseParameterInfoCollection.Enumerator.System#Collections#IEnumerator#Current">
<member name="P:NLog.FilterCollection.Enumerator.System#Collections#IEnumerator#Current">
<summary>
</summary>
</member>
<member name="T:NLog.Targets.Compound.CompoundTargetBase">
<member name="T:NLog.Config.AcceptsLayoutAttribute">
<summary>
A base class for targets which wrap other (multiple) targets
and provide various forms of target routing.
Attribute used to mark string parameters that accept layouts.
</summary>
</member>
<member name="M:NLog.Targets.Compound.CompoundTargetBase.#ctor">
<member name="M:NLog.Config.AcceptsLayoutAttribute.#ctor">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.Compound.CompoundTargetBase"/>.
Creates a new instance of AcceptsLayoutAttribute
</summary>
</member>
<member name="M:NLog.Targets.Compound.CompoundTargetBase.#ctor(NLog.Target[])">
<member name="T:NLog.Targets.WebServiceTarget">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.Compound.CompoundTargetBase"/> and
initializes the <see cref="P:NLog.Targets.Compound.CompoundTargetBase.Targets"/> collection to the provided
list of <see cref="T:NLog.Target"/> objects.
Calls the specified web service on each logging message.
</summary>
<remarks>
The web service must implement a method that accepts a number of string parameters.
</remarks>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/WebService/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/WebService/Simple/Example.cs" />
<p>The example web service that works with this example is shown below</p>
<code lang="C#" src="examples/targets/Configuration API/WebService/Simple/WebService1/Service1.asmx.cs" />
</example>
</member>
<member name="M:NLog.Targets.Compound.CompoundTargetBase.PopulateLayouts(NLog.LayoutCollection)">
<member name="M:NLog.Targets.WebServiceTarget.DoInvoke(System.Object[])">
<summary>
Adds all layouts used by this target and sub-targets.
Invokes the web service method.
</summary>
<param name="layouts">The collection to add layouts to.</param>
<param name="parameters">Parameters to be passed.</param>
</member>
<member name="M:NLog.Targets.Compound.CompoundTargetBase.Initialize">
<member name="P:NLog.Targets.WebServiceTarget.Url">
<summary>
Initializes the target by initializing all sub-targets.
Web service URL.
</summary>
</member>
<member name="M:NLog.Targets.Compound.CompoundTargetBase.Close">
<member name="P:NLog.Targets.WebServiceTarget.MethodName">
<summary>
Closes the target by closing all sub-targets.
Web service method name.
</summary>
</member>
<member name="P:NLog.Targets.Compound.CompoundTargetBase.Targets">
<member name="P:NLog.Targets.WebServiceTarget.Namespace">
<summary>
A collection of targets managed by this compound target.
Web service namespace.
</summary>
</member>
<member name="T:NLog.LayoutRenderers.ProcessNameLayoutRenderer">
<member name="P:NLog.Targets.WebServiceTarget.Protocol">
<summary>
The name of the current process.
The protocol to be used when calling web service.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.ProcessNameLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="T:NLog.Targets.WebServiceTarget.WebServiceProtocol">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
Web service protocol
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.ProcessNameLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="F:NLog.Targets.WebServiceTarget.WebServiceProtocol.Soap11">
<summary>
Renders the current process name (optionally with a full path).
SOAP 1.1
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="M:NLog.LayoutRenderers.ProcessNameLayoutRenderer.IsAppDomainFixed">
<member name="F:NLog.Targets.WebServiceTarget.WebServiceProtocol.Soap12">
<summary>
Determines whether the value produced by the layout renderer
is fixed per current app-domain.
SOAP 1.2
</summary>
<returns><see langword="true"/></returns>
</member>
<member name="P:NLog.LayoutRenderers.ProcessNameLayoutRenderer.FullName">
<member name="F:NLog.Targets.WebServiceTarget.WebServiceProtocol.HttpPost">
<summary>
Write the full path to the process executable.
HTTP POST
</summary>
</member>
<member name="T:NLog.LayoutRenderers.QpcLayoutRenderer">
<member name="F:NLog.Targets.WebServiceTarget.WebServiceProtocol.HttpGet">
<summary>
High precision timer, based on the value returned from QueryPerformanceCounter() optionally converted to seconds.
HTTP GET
</summary>
</member>
<member name="M:NLog.LayoutRenderers.QpcLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="T:NLog.Targets.TraceTarget">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
Sends logging messages through System.Diagnostics.Trace
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/Trace/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/Trace/Simple/Example.cs" />
</example>
</member>
<member name="M:NLog.LayoutRenderers.QpcLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.Targets.TraceTarget.Write(NLog.LogEventInfo)">
<summary>
Renders the ticks value of current time and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Writes the specified logging event to the <see cref="T:System.Diagnostics.Trace"/> facility.
If the log level is greater than or equal to <see cref="F:NLog.LogLevel.Error"/> it uses the
<see cref="M:System.Diagnostics.Trace.Fail(System.String)"/> method, otherwise it uses
<see cref="M:System.Diagnostics.Trace.Write(System.String)"/> method.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
<param name="logEvent">The logging event.</param>
</member>
<member name="P:NLog.LayoutRenderers.QpcLayoutRenderer.Normalize">
<member name="T:NLog.Layouts.CsvQuotingMode">
<summary>
Normalize the result by subtracting it from the result of the
first call (so that it's effectively zero-based).
Specifies allowes CSV quoting modes.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.QpcLayoutRenderer.Difference">
<member name="F:NLog.Layouts.CsvQuotingMode.All">
<summary>
Output the difference between the result of QueryPerformanceCounter
and the previous one.
Quote all column.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.QpcLayoutRenderer.Seconds">
<member name="F:NLog.Layouts.CsvQuotingMode.Nothing">
<summary>
Convert the result to seconds by dividing by the result of QueryPerformanceFrequency().
Quote nothing.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.QpcLayoutRenderer.Precision">
<member name="F:NLog.Layouts.CsvQuotingMode.Auto">
<summary>
Number of decimal digits to be included in output.
Quote only whose values contain the quote symbol or
the separator.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.QpcLayoutRenderer.AlignDecimalPoint">
<member name="T:NLog.TargetCollection">
<summary>
Align decimal point (emit non-significant zeros)
A collection of elements of type Target
</summary>
</member>
<member name="T:NLog.LayoutRenderers.ProcessInfoLayoutRenderer">
<member name="M:NLog.TargetCollection.#ctor">
<summary>
The information about the running process.
Initializes a new empty instance of the TargetCollection class.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="M:NLog.TargetCollection.#ctor(NLog.Target[])">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
Initializes a new instance of the TargetCollection class, containing elements
copied from an array.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
<param name="items">
The array whose elements are to be added to the new TargetCollection.
</param>
</member>
<member name="M:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.TargetCollection.#ctor(NLog.TargetCollection)">
<summary>
Renders the selected process information.
Initializes a new instance of the TargetCollection class, containing elements
copied from another instance of TargetCollection
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
<param name="items">
The TargetCollection whose elements are to be added to the new TargetCollection.
</param>
</member>
<member name="M:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.Initialize">
<member name="M:NLog.TargetCollection.AddRange(NLog.Target[])">
<summary>
Initializes the layout renderer.
Adds the elements of an array to the end of this TargetCollection.
</summary>
<param name="items">
The array whose elements are to be added to the end of this TargetCollection.
</param>
</member>
<member name="M:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.Close">
<member name="M:NLog.TargetCollection.AddRange(NLog.TargetCollection)">
<summary>
Closes the layout renderer.
Adds the elements of another TargetCollection to the end of this TargetCollection.
</summary>
<param name="items">
The TargetCollection whose elements are to be added to the end of this TargetCollection.
</param>
</member>
<member name="P:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.Property">
<member name="M:NLog.TargetCollection.Add(NLog.Target)">
<summary>
The property to retrieve.
Adds an instance of type Target to the end of this TargetCollection.
</summary>
<param name="value">
The Target to be added to the end of this TargetCollection.
</param>
</member>
<member name="T:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty">
<member name="M:NLog.TargetCollection.Contains(NLog.Target)">
<summary>
The property of System.Diagnostics.Process to retrieve
Determines whether a specfic Target value is in this TargetCollection.
</summary>
<param name="value">
The Target value to locate in this TargetCollection.
</param>
<returns>
true if value is found in this TargetCollection;
false otherwise.
</returns>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.BasePriority">
<summary></summary>
<member name="M:NLog.TargetCollection.IndexOf(NLog.Target)">
<summary>
Return the zero-based index of the first occurrence of a specific value
in this TargetCollection
</summary>
<param name="value">
The Target value to locate in the TargetCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.ExitCode">
<summary></summary>
<member name="M:NLog.TargetCollection.Insert(System.Int32,NLog.Target)">
<summary>
Inserts an element into the TargetCollection at the specified index
</summary>
<param name="index">
The index at which the Target is to be inserted.
</param>
<param name="value">
The Target to insert.
</param>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.ExitTime">
<summary></summary>
<member name="M:NLog.TargetCollection.Remove(NLog.Target)">
<summary>
Removes the first occurrence of a specific Target from this TargetCollection.
</summary>
<param name="value">
The Target value to remove from this TargetCollection.
</param>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.Handle">
<summary></summary>
<member name="M:NLog.TargetCollection.GetEnumerator">
<summary>
Returns an enumerator that can iterate through the elements of this TargetCollection.
</summary>
<returns>
An object that implements System.Collections.IEnumerator.
</returns>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.HandleCount">
<summary></summary>
<member name="P:NLog.TargetCollection.Item(System.Int32)">
<summary>
Gets or sets the Target at the given index in this TargetCollection.
</summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.HasExited">
<summary></summary>
<member name="T:NLog.TargetCollection.Enumerator">
<summary>
Type-specific enumeration class, used by TargetCollection.GetEnumerator.
</summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.Id">
<summary></summary>
<member name="M:NLog.TargetCollection.Enumerator.#ctor(NLog.TargetCollection)">
<summary>
</summary>
<param name="collection"></param>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.MachineName">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.MainModule">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.MainWindowHandle">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.MainWindowTitle">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.MaxWorkingSet">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.MinWorkingSet">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.NonpagedSystemMemorySize">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.NonpagedSystemMemorySize64">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PagedMemorySize">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PagedMemorySize64">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PagedSystemMemorySize">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PagedSystemMemorySize64">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PeakPagedMemorySize">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PeakPagedMemorySize64">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PeakVirtualMemorySize">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PeakVirtualMemorySize64">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PeakWorkingSet">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PeakWorkingSet64">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PriorityBoostEnabled">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PriorityClass">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PrivateMemorySize">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PrivateMemorySize64">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.PrivilegedProcessorTime">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.ProcessName">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.Responding">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.SessionId">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.StartTime">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.TotalProcessorTime">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.UserProcessorTime">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.VirtualMemorySize">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.VirtualMemorySize64">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.WorkingSet">
<summary></summary>
</member>
<member name="F:NLog.LayoutRenderers.ProcessInfoLayoutRenderer.ProcessInfoProperty.WorkingSet64">
<summary></summary>
</member>
<member name="T:NLog.Filters.ConditionBasedFilter">
<member name="M:NLog.TargetCollection.Enumerator.MoveNext">
<summary>
Matches when the specified condition is met.
</summary>
<remarks>
Conditions are expressed using a simple language
described <a href="conditions.html">here</a>.
</remarks>
<returns></returns>
</member>
<member name="M:NLog.Filters.ConditionBasedFilter.#ctor">
<member name="M:NLog.TargetCollection.Enumerator.Reset">
<summary>
Initializes a new instance of the filter object.
</summary>
</member>
<member name="M:NLog.Filters.ConditionBasedFilter.Check(NLog.LogEventInfo)">
<member name="P:NLog.TargetCollection.Enumerator.Current">
<summary>
Checks whether log event should be logged or not.
</summary>
<param name="logEvent">Log event.</param>
<returns>
<see cref="F:NLog.FilterResult.Ignore"/> - if the log event should be ignored<br/>
<see cref="F:NLog.FilterResult.Neutral"/> - if the filter doesn't want to decide<br/>
<see cref="F:NLog.FilterResult.Log"/> - if the log event should be logged<br/>
</returns>
</member>
<member name="P:NLog.Filters.ConditionBasedFilter.Condition">
<member name="T:NLog.LayoutRenderers.Log4JXmlEventLayoutRenderer">
<summary>
The condition expression.
XML event description compatible with log4j, Chainsaw and NLogViewer
</summary>
</member>
<member name="T:NLog.LayoutRenderers.FileContentsLayoutRenderer">
<member name="M:NLog.LayoutRenderers.Log4JXmlEventLayoutRenderer.#ctor">
<summary>
Contents of the specified file.
Creates a new instance of <see cref="T:NLog.LayoutRenderers.Log4JXmlEventLayoutRenderer"/> and initializes default values.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.FileContentsLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="M:NLog.LayoutRenderers.Log4JXmlEventLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
5409,254 → 4372,231
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.FileContentsLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.LayoutRenderers.Log4JXmlEventLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Renders the contents of the specified file and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Renders the XML logging event and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="P:NLog.LayoutRenderers.FileContentsLayoutRenderer.FileName">
<member name="P:NLog.LayoutRenderers.Log4JXmlEventLayoutRenderer.IncludeNLogData">
<summary>
Name of the file.
Include NLog-specific extensions to log4j schema.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.FileContentsLayoutRenderer.Encoding">
<member name="P:NLog.LayoutRenderers.Log4JXmlEventLayoutRenderer.IndentXml">
<summary>
File encoding.
Whether the XML should use spaces for indentation.
</summary>
<value>The encoding.</value>
</member>
<member name="T:NLog.Conditions.ConditionParser">
<member name="P:NLog.LayoutRenderers.Log4JXmlEventLayoutRenderer.AppInfo">
<summary>
Condition parser. Turns a string representation of condition expression
into an expression tree.
The AppInfo field. By default it's the friendly name of the current AppDomain.
</summary>
</member>
<member name="M:NLog.Conditions.ConditionParser.ParseExpression(System.String)">
<member name="P:NLog.LayoutRenderers.Log4JXmlEventLayoutRenderer.IncludeCallSite">
<summary>
Parses the specified condition string and turns it into
<see cref="T:NLog.Conditions.ConditionExpression"/> tree.
Include call site (class and method name) in the information sent over the network.
</summary>
<param name="expr">The expression to be parsed.</param>
<returns>The root of the expression syntax tree which can be used to get the value of the condition in a specified context</returns>
</member>
<member name="T:NLog.Targets.Wrappers.RepeatingTargetWrapper">
<member name="P:NLog.LayoutRenderers.Log4JXmlEventLayoutRenderer.IncludeSourceInfo">
<summary>
A target wrapper that repeats each log event the specified number of times.
Include source info (file name and line number) in the information sent over the network.
</summary>
<example>
<p>This example causes each log message to be repeated 3 times.</p>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/RepeatingWrapper/NLog.config" />
<p>
The above examples assume just one target and a single rule. See below for
a programmatic configuration that's equivalent to the above config file:
</p>
<code lang="C#" src="examples/targets/Configuration API/RepeatingWrapper/Simple/Example.cs" />
</example>
</member>
<member name="M:NLog.Targets.Wrappers.RepeatingTargetWrapper.#ctor">
<member name="P:NLog.LayoutRenderers.Log4JXmlEventLayoutRenderer.IncludeMDC">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.Wrappers.RepeatingTargetWrapper"/>.
Include MDC dictionary in the information sent over the network.
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.RepeatingTargetWrapper.#ctor(NLog.Target,System.Int32)">
<member name="P:NLog.LayoutRenderers.Log4JXmlEventLayoutRenderer.IncludeNDC">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.Wrappers.RepeatingTargetWrapper"/>,
initializes the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> to the specified <see cref="T:NLog.Target"/> value and
sets the <see cref="P:NLog.Targets.Wrappers.RepeatingTargetWrapper.RepeatCount"/>,
Include NDC stack.
</summary>
</member>
<member name="M:NLog.Targets.Wrappers.RepeatingTargetWrapper.Write(NLog.LogEventInfo)">
<member name="T:NLog.Internal.MethodInfoDictionary">
<summary>
Forwards the log message to the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> by calling the <see cref="M:NLog.Target.Write(NLog.LogEventInfo)"/> method <see cref="P:NLog.Targets.Wrappers.RepeatingTargetWrapper.RepeatCount"/> times.
A dictionary with keys of type string and values of type MethodInfo
</summary>
<param name="logEvent">The log event.</param>
</member>
<member name="M:NLog.Targets.Wrappers.RepeatingTargetWrapper.Write(NLog.LogEventInfo[])">
<member name="M:NLog.Internal.MethodInfoDictionary.#ctor">
<summary>
Forwards the array of log events to the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> by calling the <see cref="M:NLog.Target.Write(NLog.LogEventInfo[])"/> method <see cref="P:NLog.Targets.Wrappers.RepeatingTargetWrapper.RepeatCount"/> times.
Initializes a new empty instance of the MethodInfoDictionary class
</summary>
<param name="logEvents">The array of log events.</param>
</member>
<member name="P:NLog.Targets.Wrappers.RepeatingTargetWrapper.RepeatCount">
<member name="M:NLog.Internal.MethodInfoDictionary.Add(System.String,System.Reflection.MethodInfo)">
<summary>
The number of times to repeat each log message.
Adds an element with the specified key and value to this MethodInfoDictionary.
</summary>
<param name="key">
The string key of the element to add.
</param>
<param name="value">
The MethodInfo value of the element to add.
</param>
</member>
<member name="T:NLog.Targets.TraceTarget">
<member name="M:NLog.Internal.MethodInfoDictionary.Contains(System.String)">
<summary>
Sends logging messages through System.Diagnostics.Trace
Determines whether this MethodInfoDictionary contains a specific key.
</summary>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/Trace/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/Trace/Simple/Example.cs" />
</example>
<param name="key">
The string key to locate in this MethodInfoDictionary.
</param>
<returns>
true if this MethodInfoDictionary contains an element with the specified key;
otherwise, false.
</returns>
</member>
<member name="M:NLog.Targets.TraceTarget.Write(NLog.LogEventInfo)">
<member name="M:NLog.Internal.MethodInfoDictionary.ContainsKey(System.String)">
<summary>
Writes the specified logging event to the <see cref="T:System.Diagnostics.Trace"/> facility.
If the log level is greater than or equal to <see cref="F:NLog.LogLevel.Error"/> it uses the
<see cref="M:System.Diagnostics.Trace.Fail(System.String)"/> method, otherwise it uses
<see cref="M:System.Diagnostics.Trace.Write(System.String)"/> method.
Determines whether this MethodInfoDictionary contains a specific key.
</summary>
<param name="logEvent">The logging event.</param>
<param name="key">
The string key to locate in this MethodInfoDictionary.
</param>
<returns>
true if this MethodInfoDictionary contains an element with the specified key;
otherwise, false.
</returns>
</member>
<member name="T:NLog.Targets.RichTextBoxWordColoringRule">
<member name="M:NLog.Internal.MethodInfoDictionary.ContainsValue(System.Reflection.MethodInfo)">
<summary>
Highlighting rule for Win32 colorful console.
Determines whether this MethodInfoDictionary contains a specific value.
</summary>
<param name="value">
The MethodInfo value to locate in this MethodInfoDictionary.
</param>
<returns>
true if this MethodInfoDictionary contains an element with the specified value;
otherwise, false.
</returns>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRule.#ctor">
<member name="M:NLog.Internal.MethodInfoDictionary.Remove(System.String)">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.RichTextBoxWordColoringRule"/>
Removes the element with the specified key from this MethodInfoDictionary.
</summary>
<param name="key">
The string key of the element to remove.
</param>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRule.#ctor(System.String,System.String,System.String)">
<member name="P:NLog.Internal.MethodInfoDictionary.Item(System.String)">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.RichTextBoxWordColoringRule"/>
and sets Text, BackgroundColor and ForegroundColor properties.
Gets or sets the MethodInfo associated with the given string
</summary>
<param name="key">
The string whose value to get or set.
</param>
</member>
<member name="M:NLog.Targets.RichTextBoxWordColoringRule.#ctor(System.String,System.String,System.String,System.Drawing.FontStyle)">
<member name="P:NLog.Internal.MethodInfoDictionary.Keys">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.RichTextBoxWordColoringRule"/>
and sets Text, BackgroundColor, FontColor and Style properties.
Gets a collection containing the keys in this MethodInfoDictionary.
</summary>
</member>
<member name="P:NLog.Targets.RichTextBoxWordColoringRule.Regex">
<member name="P:NLog.Internal.MethodInfoDictionary.Values">
<summary>
The regular expression to be matched. You must specify either <c>text</c> or <c>regex</c>.
Gets a collection containing the values in this MethodInfoDictionary.
</summary>
</member>
<member name="P:NLog.Targets.RichTextBoxWordColoringRule.Text">
<member name="T:NLog.Internal.LoggerDictionary">
<summary>
The text to be matched. You must specify either <c>text</c> or <c>regex</c>.
A dictionary with keys of type string and values of type Logger
</summary>
</member>
<member name="P:NLog.Targets.RichTextBoxWordColoringRule.Style">
<member name="M:NLog.Internal.LoggerDictionary.#ctor">
<summary>
Font style of matched text.
Possible values are the same as in <c>FontStyle</c> enum in <c>System.Drawing</c>
Initializes a new empty instance of the LoggerDictionary class
</summary>
</member>
<member name="P:NLog.Targets.RichTextBoxWordColoringRule.WholeWords">
<member name="M:NLog.Internal.LoggerDictionary.Add(System.String,NLog.Logger)">
<summary>
Match whole words only.
Adds an element with the specified key and value to this LoggerDictionary.
</summary>
<param name="key">
The string key of the element to add.
</param>
<param name="value">
The Logger value of the element to add.
</param>
</member>
<member name="P:NLog.Targets.RichTextBoxWordColoringRule.IgnoreCase">
<member name="M:NLog.Internal.LoggerDictionary.Contains(System.String)">
<summary>
Ignore case when comparing texts.
Determines whether this LoggerDictionary contains a specific key.
</summary>
<param name="key">
The string key to locate in this LoggerDictionary.
</param>
<returns>
true if this LoggerDictionary contains an element with the specified key;
otherwise, false.
</returns>
</member>
<member name="P:NLog.Targets.RichTextBoxWordColoringRule.CompiledRegex">
<member name="M:NLog.Internal.LoggerDictionary.ContainsKey(System.String)">
<summary>
Compiled regular expression that matches either Text or Regex property.
Determines whether this LoggerDictionary contains a specific key.
</summary>
<param name="key">
The string key to locate in this LoggerDictionary.
</param>
<returns>
true if this LoggerDictionary contains an element with the specified key;
otherwise, false.
</returns>
</member>
<member name="P:NLog.Targets.RichTextBoxWordColoringRule.FontColor">
<member name="M:NLog.Internal.LoggerDictionary.ContainsValue(NLog.Logger)">
<summary>
The font color.
Names are identical with KnownColor enum extended with Empty value which means that font color won't be changed
Determines whether this LoggerDictionary contains a specific value.
</summary>
<param name="value">
The Logger value to locate in this LoggerDictionary.
</param>
<returns>
true if this LoggerDictionary contains an element with the specified value;
otherwise, false.
</returns>
</member>
<member name="P:NLog.Targets.RichTextBoxWordColoringRule.BackgroundColor">
<member name="M:NLog.Internal.LoggerDictionary.Remove(System.String)">
<summary>
The background color.
Names are identical with KnownColor enum extended with Empty value which means that background color won't be changed
Background color will be set only in .net 2.0
Removes the element with the specified key from this LoggerDictionary.
</summary>
<param name="key">
The string key of the element to remove.
</param>
</member>
<member name="T:NLog.Targets.Compound.RoundRobinTarget">
<member name="P:NLog.Internal.LoggerDictionary.Item(System.String)">
<summary>
A compound target that forwards writes to the sub-targets in a
round-robin fashion.
Gets or sets the Logger associated with the given string
</summary>
<example>
<p>This example causes the messages to be written to either file1.txt or file2.txt.
Each odd message is written to file2.txt, each even message goes to file1.txt.
</p>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/RoundRobinGroup/NLog.config" />
<p>
The above examples assume just one target and a single rule. See below for
a programmatic configuration that's equivalent to the above config file:
</p>
<code lang="C#" src="examples/targets/Configuration API/RoundRobinGroup/Simple/Example.cs" />
</example>
<param name="key">
The string whose value to get or set.
</param>
</member>
<member name="M:NLog.Targets.Compound.RoundRobinTarget.#ctor">
<member name="P:NLog.Internal.LoggerDictionary.Keys">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.Compound.RoundRobinTarget"/>.
Gets a collection containing the keys in this LoggerDictionary.
</summary>
</member>
<member name="M:NLog.Targets.Compound.RoundRobinTarget.#ctor(NLog.Target[])">
<member name="P:NLog.Internal.LoggerDictionary.Values">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.Compound.RoundRobinTarget"/> and initializes
the <see cref="N:NLog.Targets"/> collection to the provided
array of <see cref="T:NLog.Target"/> objects.
Gets a collection containing the values in this LoggerDictionary.
</summary>
</member>
<member name="M:NLog.Targets.Compound.RoundRobinTarget.Write(NLog.LogEventInfo)">
<member name="T:NLog.Config.AcceptsConditionAttribute">
<summary>
Forwards the write to one of the targets from
the <see cref="N:NLog.Targets"/> collection.
Attribute used to mark string parameters that accept conditions.
</summary>
<param name="logEvent">The log event.</param>
<remarks>
The writes are routed in a round-robin fashion.
The first log event goes to the first target, the second
one goes to the second target and so on looping to the
first target when there are no more targets available.
In general request N goes to Targets[N % Targets.Count].
</remarks>
</member>
<member name="T:NLog.LayoutRenderers.StackTraceFormat">
<member name="M:NLog.Config.AcceptsConditionAttribute.#ctor">
<summary>
Format of the ${stacktrace} layout renderer output.
Creates a new instance of AcceptsLayoutAttribute
</summary>
</member>
<member name="F:NLog.LayoutRenderers.StackTraceFormat.Raw">
<member name="T:NLog.LayoutRenderers.EventContextLayoutRenderer">
<summary>
Raw format (multiline - as returned by StackFrame.ToString() method)
Log event context data
</summary>
</member>
<member name="F:NLog.LayoutRenderers.StackTraceFormat.Flat">
<member name="M:NLog.LayoutRenderers.EventContextLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Flat format (class and method names displayed in a single line)
</summary>
</member>
<member name="F:NLog.LayoutRenderers.StackTraceFormat.DetailedFlat">
<summary>
Detailed flat format (method signatures displayed in a single line)
</summary>
</member>
<member name="T:NLog.LayoutRenderers.StackTraceLayoutRenderer">
<summary>
Stack trace renderer.
</summary>
</member>
<member name="M:NLog.LayoutRenderers.StackTraceLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
</summary>
5668,3477 → 4608,3467
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
</member>
<member name="M:NLog.LayoutRenderers.StackTraceLayoutRenderer.NeedsStackTrace">
<member name="M:NLog.LayoutRenderers.EventContextLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Checks whether the stack trace is requested.
Renders the specified log event context item and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<returns>2 when the source file information is requested, 1 otherwise.</returns>
</member>
<member name="M:NLog.LayoutRenderers.StackTraceLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<summary>
Renders the call site and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
</member>
<member name="P:NLog.LayoutRenderers.StackTraceLayoutRenderer.Format">
<member name="P:NLog.LayoutRenderers.EventContextLayoutRenderer.Item">
<summary>
The output format of the stack trace.
Name of the item.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.StackTraceLayoutRenderer.TopFrames">
<member name="T:NLog.Targets.NLogViewerParameterInfo">
<summary>
The number of top stack frames to be rendered.
Represents a parameter to a NLogViewer target.
</summary>
</member>
<member name="P:NLog.LayoutRenderers.StackTraceLayoutRenderer.Separator">
<summary>
Stack frame separator string.
<member name="M:NLog.Targets.NLogViewerParameterInfo.#ctor">
<summary>ba
Creates a new instance of <see cref="T:NLog.Targets.NLogViewerParameterInfo"/>.
</summary>
</member>
<member name="T:NLog.Internal.TypeToPropertyInfoDictionaryAssociation">
<member name="P:NLog.Targets.NLogViewerParameterInfo.Name">
<summary>
A dictionary with keys of type Type and values of type PropertyInfoDictionary
Viewer parameter name.
</summary>
</member>
<member name="M:NLog.Internal.TypeToPropertyInfoDictionaryAssociation.#ctor">
<member name="P:NLog.Targets.NLogViewerParameterInfo.Layout">
<summary>
Initializes a new empty instance of the TypeToPropertyInfoDictionaryAssociation class
The layout that should be use to calcuate the value for the parameter.
</summary>
</member>
<member name="M:NLog.Internal.TypeToPropertyInfoDictionaryAssociation.Add(System.Type,NLog.Internal.PropertyInfoDictionary)">
<member name="P:NLog.Targets.NLogViewerParameterInfo.CompiledLayout">
<summary>
Adds an element with the specified key and value to this TypeToPropertyInfoDictionaryAssociation.
The compiled representation of the Layout property.
</summary>
<param name="key">
The Type key of the element to add.
</param>
<param name="value">
The PropertyInfoDictionary value of the element to add.
</param>
</member>
<member name="M:NLog.Internal.TypeToPropertyInfoDictionaryAssociation.Contains(System.Type)">
<member name="T:NLog.Targets.Compound.RoundRobinTarget">
<summary>
Determines whether this TypeToPropertyInfoDictionaryAssociation contains a specific key.
A compound target that forwards writes to the sub-targets in a
round-robin fashion.
</summary>
<param name="key">
The Type key to locate in this TypeToPropertyInfoDictionaryAssociation.
</param>
<returns>
true if this TypeToPropertyInfoDictionaryAssociation contains an element with the specified key;
otherwise, false.
</returns>
<example>
<p>This example causes the messages to be written to either file1.txt or file2.txt.
Each odd message is written to file2.txt, each even message goes to file1.txt.
</p>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/RoundRobinGroup/NLog.config" />
<p>
The above examples assume just one target and a single rule. See below for
a programmatic configuration that's equivalent to the above config file:
</p>
<code lang="C#" src="examples/targets/Configuration API/RoundRobinGroup/Simple/Example.cs" />
</example>
</member>
<member name="M:NLog.Internal.TypeToPropertyInfoDictionaryAssociation.ContainsKey(System.Type)">
<member name="M:NLog.Targets.Compound.RoundRobinTarget.#ctor">
<summary>
Determines whether this TypeToPropertyInfoDictionaryAssociation contains a specific key.
Creates a new instance of <see cref="T:NLog.Targets.Compound.RoundRobinTarget"/>.
</summary>
<param name="key">
The Type key to locate in this TypeToPropertyInfoDictionaryAssociation.
</param>
<returns>
true if this TypeToPropertyInfoDictionaryAssociation contains an element with the specified key;
otherwise, false.
</returns>
</member>
<member name="M:NLog.Internal.TypeToPropertyInfoDictionaryAssociation.ContainsValue(NLog.Internal.PropertyInfoDictionary)">
<member name="M:NLog.Targets.Compound.RoundRobinTarget.#ctor(NLog.Target[])">
<summary>
Determines whether this TypeToPropertyInfoDictionaryAssociation contains a specific value.
Creates a new instance of <see cref="T:NLog.Targets.Compound.RoundRobinTarget"/> and initializes
the <see cref="N:NLog.Targets"/> collection to the provided
array of <see cref="T:NLog.Target"/> objects.
</summary>
<param name="value">
The PropertyInfoDictionary value to locate in this TypeToPropertyInfoDictionaryAssociation.
</param>
<returns>
true if this TypeToPropertyInfoDictionaryAssociation contains an element with the specified value;
otherwise, false.
</returns>
</member>
<member name="M:NLog.Internal.TypeToPropertyInfoDictionaryAssociation.Remove(System.Type)">
<member name="M:NLog.Targets.Compound.RoundRobinTarget.Write(NLog.LogEventInfo)">
<summary>
Removes the element with the specified key from this TypeToPropertyInfoDictionaryAssociation.
Forwards the write to one of the targets from
the <see cref="N:NLog.Targets"/> collection.
</summary>
<param name="key">
The Type key of the element to remove.
</param>
</member>
<member name="P:NLog.Internal.TypeToPropertyInfoDictionaryAssociation.Item(System.Type)">
<summary>
Gets or sets the PropertyInfoDictionary associated with the given Type
</summary>
<param name="key">
The Type whose value to get or set.
</param>
</member>
<member name="P:NLog.Internal.TypeToPropertyInfoDictionaryAssociation.Keys">
<summary>
Gets a collection containing the keys in this TypeToPropertyInfoDictionaryAssociation.
</summary>
</member>
<member name="P:NLog.Internal.TypeToPropertyInfoDictionaryAssociation.Values">
<summary>
Gets a collection containing the values in this TypeToPropertyInfoDictionaryAssociation.
</summary>
</member>
<member name="T:NLog.Internal.FileAppenders.MutexMultiProcessFileAppender">
<summary>
Provides a multiprocess-safe atomic file appends while
keeping the files open.
</summary>
<param name="logEvent">The log event.</param>
<remarks>
On Unix you can get all the appends to be atomic, even when multiple
processes are trying to write to the same file, because setting the file
pointer to the end of the file and appending can be made one operation.
On Win32 we need to maintain some synchronization between processes
(global named mutex is used for this)
The writes are routed in a round-robin fashion.
The first log event goes to the first target, the second
one goes to the second target and so on looping to the
first target when there are no more targets available.
In general request N goes to Targets[N % Targets.Count].
</remarks>
</member>
<member name="T:NLog.Layouts.LayoutWithHeaderAndFooter">
<member name="T:NLog.TargetFactory">
<summary>
A specialized layout that supports header and footer.
A factory of logging targets. Creates new targets based on their names.
</summary>
</member>
<member name="M:NLog.Layouts.LayoutWithHeaderAndFooter.#ctor">
<member name="M:NLog.TargetFactory.Clear">
<summary>
Initializes a new instance of the <see cref="T:NLog.Layouts.LayoutWithHeaderAndFooter"/> class.
Removes all target information from the factory.
</summary>
</member>
<member name="M:NLog.Layouts.LayoutWithHeaderAndFooter.GetFormattedMessage(NLog.LogEventInfo)">
<member name="M:NLog.TargetFactory.Reset">
<summary>
Renders the layout for the specified logging event by invoking layout renderers.
Removes all targets and reloads them from NLog assembly and default extension assemblies.
</summary>
<param name="logEvent">The logging event.</param>
<returns>The rendered layout.</returns>
</member>
<member name="M:NLog.Layouts.LayoutWithHeaderAndFooter.NeedsStackTrace">
<member name="M:NLog.TargetFactory.AddTargetsFromAssembly(System.Reflection.Assembly,System.String)">
<summary>
Returns the value indicating whether a stack trace and/or the source file
information should be gathered during layout processing.
Scans the specified assembly for types marked with <see cref="T:NLog.TargetAttribute"/> and adds
them to the factory. Optionally it prepends the specified text to the target names to avoid
naming collisions.
</summary>
<returns>
0 - don't include stack trace<br/>1 - include stack trace without source file information<br/>2 - include full stack trace
</returns>
<param name="theAssembly">The assembly to be scanned for targets.</param>
<param name="prefix">The prefix to be prepended to target names.</param>
</member>
<member name="M:NLog.Layouts.LayoutWithHeaderAndFooter.IsVolatile">
<member name="M:NLog.TargetFactory.AddDefaultTargets">
<summary>
Returns the value indicating whether this layout includes any volatile
layout renderers.
Adds default targets from the NLog.dll assembly.
</summary>
<returns>
<see langword="true"/> when the layout includes at least
one volatile renderer, <see langword="false"/> otherwise.
</returns>
<remarks>
Volatile layout renderers are dependent on information not contained
in <see cref="T:NLog.LogEventInfo"/> (such as thread-specific data, MDC data, NDC data).
</remarks>
</member>
<member name="M:NLog.Layouts.LayoutWithHeaderAndFooter.Precalculate(NLog.LogEventInfo)">
<member name="M:NLog.TargetFactory.AddTarget(System.String,System.Type)">
<summary>
Precalculates the layout for the specified log event and stores the result
in per-log event cache.
Registers the specified target type to the factory under a specified name.
</summary>
<param name="logEvent">The log event.</param>
<param name="targetName">The name of the target (e.g. <code>File</code> or <code>Console</code>)</param>
<param name="targetType">The type of the new target</param>
<remarks>
Calling this method enables you to store the log event in a buffer
and/or potentially evaluate it in another thread even though the
layout may contain thread-dependent renderer.
The name specified in the targetName parameter can then be used
to create target.
</remarks>
</member>
<member name="M:NLog.Layouts.LayoutWithHeaderAndFooter.Initialize">
<member name="M:NLog.TargetFactory.CreateTarget(System.String)">
<summary>
Initializes the layout.
Creates the target object based on its target name.
</summary>
<param name="name">The name of the target (e.g. <code>File</code> or <code>Console</code>)</param>
<returns>A new instance of the Target object.</returns>
</member>
<member name="M:NLog.Layouts.LayoutWithHeaderAndFooter.Close">
<member name="P:NLog.TargetFactory.TargetTypes">
<summary>
Closes the layout.
Collection of target types added to the factory.
</summary>
</member>
<member name="M:NLog.Layouts.LayoutWithHeaderAndFooter.PopulateLayouts(NLog.LayoutCollection)">
<member name="T:NLog.LoggerReconfiguredDelegate">
<summary>
Add this layout and all sub-layouts to the specified collection..
Represents a method that's invoked each time a <see cref="T:NLog.Logger"/> configuration changes.
</summary>
<param name="layouts">The collection of layouts.</param>
<param name="logger">logger that was reconfigured</param>
<remarks>
'Reconfiguring' a logger means rebuilding the list of targets and filters
that will be invoked on logging.
This may or may not influence the result returned by IsXXXXEnabled properties.
</remarks>
</member>
<member name="P:NLog.Layouts.LayoutWithHeaderAndFooter.Layout">
<member name="T:NLog.Logger">
<summary>
Main layout (can be repeated multiple times)
Provides logging interface and utility functions.
</summary>
<value></value>
</member>
<member name="P:NLog.Layouts.LayoutWithHeaderAndFooter.Header">
<member name="M:NLog.Logger.#ctor">
<summary>
Header
Initializes a new instance of the <see cref="T:NLog.Logger"/> class.
</summary>
<value></value>
</member>
<member name="P:NLog.Layouts.LayoutWithHeaderAndFooter.Footer">
<member name="M:NLog.Logger.IsEnabled(NLog.LogLevel)">
<summary>
Footer
Determines if logging is enabled for the specified level.
</summary>
<value></value>
<param name="level">level to be checked</param>
<returns><see langword="true" /> if logging is enabled for the specified level, otherwise it returns <see langword="false" />.</returns>
</member>
<member name="T:NLog.Config.SupportedRuntimeAttributeBase">
<member name="M:NLog.Logger.Log(NLog.LogEventInfo)">
<overloads>
Writes the diagnostic message at the specified level using the specified format provider and format parameters.
</overloads>
<summary>
Marks classes and properties as supporting particular runtime framework
and operating system.
Writes the specified diagnostic message.
</summary>
<param name="logEvent">log event</param>
</member>
<member name="M:NLog.Config.SupportedRuntimeAttributeBase.#ctor">
<member name="M:NLog.Logger.Log(System.Type,NLog.LogEventInfo)">
<overloads>
Writes the diagnostic message at the specified level using the specified format provider and format parameters.
</overloads>
<summary>
Creates a new instance of <see cref="T:NLog.Config.SupportedRuntimeAttributeBase"/>.
Writes the specified diagnostic message.
</summary>
<param name="logEvent">log event</param>
<param name="wrapperType">The name of the type that wraps Logger</param>
</member>
<member name="P:NLog.Config.SupportedRuntimeAttributeBase.Framework">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String)">
<overloads>
Writes the diagnostic message at the specified level using the specified format provider and format parameters.
</overloads>
<summary>
Supported runtime framework.
Writes the diagnostic message at the specified level.
</summary>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> to be written.</param>
</member>
<member name="P:NLog.Config.SupportedRuntimeAttributeBase.OS">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.Object)">
<summary>
Supported operating system.
Writes the diagnostic message at the specified level.
</summary>
<param name="level">the log level.</param>
<param name="obj">A <see langword="object" /> to be written.</param>
</member>
<member name="P:NLog.Config.SupportedRuntimeAttributeBase.MinRuntimeVersion">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.Object)">
<summary>
Minimum runtime version supported.
Writes the diagnostic message at the specified level.
</summary>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="obj">A <see langword="object" /> to be written.</param>
</member>
<member name="P:NLog.Config.SupportedRuntimeAttributeBase.MaxRuntimeVersion">
<member name="M:NLog.Logger.LogException(NLog.LogLevel,System.String,System.Exception)">
<summary>
Maximum runtime version supported.
Writes the diagnostic message and exception at the specified level.
</summary>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> to be written.</param>
<param name="exception">An exception to be logged.</param>
</member>
<member name="P:NLog.Config.SupportedRuntimeAttributeBase.MinOSVersion">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.Object[])">
<summary>
Minimum operating system version supported.
Writes the diagnostic message at the specified level using the specified parameters and formatting them with the supplied format provider.
</summary>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="args">Arguments to format.</param>
</member>
<member name="P:NLog.Config.SupportedRuntimeAttributeBase.MaxOSVersion">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.Object[])">
<summary>
Maximum operating system version supported.
Writes the diagnostic message at the specified level using the specified parameters.
</summary>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="args">Arguments to format.</param>
</member>
<member name="T:NLog.Config.SimpleConfigurator">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.Object,System.Object)">
<summary>
Provides simple programmatic configuration API used for trivial logging cases.
Writes the diagnostic message at the specified level using the specified parameters.
</summary>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="arg1">First argument to format.</param>
<param name="arg2">Second argument to format.</param>
</member>
<member name="M:NLog.Config.SimpleConfigurator.ConfigureForConsoleLogging">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.Object,System.Object,System.Object)">
<summary>
Configures NLog for console logging so that all messages above and including
the <see cref="F:NLog.LogLevel.Info"/> level are output to the console.
Writes the diagnostic message at the specified level using the specified parameters.
</summary>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="arg1">First argument to format.</param>
<param name="arg2">Second argument to format.</param>
<param name="arg3">Third argument to format.</param>
</member>
<member name="M:NLog.Config.SimpleConfigurator.ConfigureForConsoleLogging(NLog.LogLevel)">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.Boolean)">
<summary>
Configures NLog for console logging so that all messages above and including
the specified level are output to the console.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Boolean" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="minLevel">The minimal logging level.</param>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Boolean" /> argument to format.</param>
</member>
<member name="M:NLog.Config.SimpleConfigurator.ConfigureForTargetLogging(NLog.Target)">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.Boolean)">
<summary>
Configures NLog for to log to the specified target so that all messages
above and including the <see cref="F:NLog.LogLevel.Info"/> level are output.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Boolean" /> as a parameter.
</summary>
<param name="target">The target to log all messages to.</param>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Boolean" /> argument to format.</param>
</member>
<member name="M:NLog.Config.SimpleConfigurator.ConfigureForTargetLogging(NLog.Target,NLog.LogLevel)">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.Char)">
<summary>
Configures NLog for to log to the specified target so that all messages
above and including the specified level are output.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Char" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="target">The target to log all messages to.</param>
<param name="minLevel">The minimal logging level.</param>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Char" /> argument to format.</param>
</member>
<member name="M:NLog.Config.SimpleConfigurator.ConfigureForFileLogging(System.String)">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.Char)">
<summary>
Configures NLog for file logging so that all messages above and including
the <see cref="F:NLog.LogLevel.Info"/> level are written to the specified file.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Char" /> as a parameter.
</summary>
<param name="fileName">Log file name.</param>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Char" /> argument to format.</param>
</member>
<member name="M:NLog.Config.SimpleConfigurator.ConfigureForFileLogging(System.String,NLog.LogLevel)">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.Byte)">
<summary>
Configures NLog for file logging so that all messages above and including
the specified level are written to the specified file.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Byte" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="fileName">Log file name.</param>
<param name="minLevel">The minimal logging level.</param>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Byte" /> argument to format.</param>
</member>
<member name="T:NLog.Targets.Wrappers.PostFilteringTargetWrapper">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.Byte)">
<summary>
A target wrapper that filters buffered log entries based on a set of conditions
that are evaluated on all events.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Byte" /> as a parameter.
</summary>
<remarks>
PostFilteringWrapper must be used with some type of buffering target or wrapper, such as
AsyncTargetWrapper, BufferingWrapper or ASPNetBufferingWrapper.
</remarks>
<example>
<p>
This example works like this. If there are no Warn,Error or Fatal messages in the buffer
only Info messages are written to the file, but if there are any warnings or errors,
the output includes detailed trace (levels &gt;= Debug). You can plug in a different type
of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different
functionality.
</p>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/PostFilteringWrapper/NLog.config" />
<p>
The above examples assume just one target and a single rule. See below for
a programmatic configuration that's equivalent to the above config file:
</p>
<code lang="C#" src="examples/targets/Configuration API/PostFilteringWrapper/Simple/Example.cs" />
</example>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Byte" /> argument to format.</param>
</member>
<member name="M:NLog.Targets.Wrappers.PostFilteringTargetWrapper.#ctor">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.String)">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.Wrappers.PostFilteringTargetWrapper"/>.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.String" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.String" /> argument to format.</param>
</member>
<member name="M:NLog.Targets.Wrappers.PostFilteringTargetWrapper.Write(NLog.LogEventInfo[])">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.String)">
<summary>
Evaluates all filtering rules to find the first one that matches.
The matching rule determines the filtering condition to be applied
to all items in a buffer. If no condition matches, default filter
is applied to the array of log events.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.String" /> as a parameter.
</summary>
<param name="logEvents">Array of log events to be post-filtered.</param>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.String" /> argument to format.</param>
</member>
<member name="M:NLog.Targets.Wrappers.PostFilteringTargetWrapper.Write(NLog.LogEventInfo)">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.Int32)">
<summary>
Processes a single log event. Not very useful for this post-filtering
wrapper.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Int32" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="logEvent">Log event.</param>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int32" /> argument to format.</param>
</member>
<member name="M:NLog.Targets.Wrappers.PostFilteringTargetWrapper.PopulateLayouts(NLog.LayoutCollection)">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.Int32)">
<summary>
Adds all layouts used by this target to the specified collection.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Int32" /> as a parameter.
</summary>
<param name="layouts">The collection to add layouts to.</param>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int32" /> argument to format.</param>
</member>
<member name="P:NLog.Targets.Wrappers.PostFilteringTargetWrapper.DefaultFilter">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.Int64)">
<summary>
Default filter to be applied when no specific rule matches.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Int64" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int64" /> argument to format.</param>
</member>
<member name="P:NLog.Targets.Wrappers.PostFilteringTargetWrapper.Rules">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.Int64)">
<summary>
Collection of filtering rules. The rules are processed top-down
and the first rule that matches determines the filtering condition to
be applied to log events.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Int64" /> as a parameter.
</summary>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int64" /> argument to format.</param>
</member>
<member name="T:NLog.Targets.Wrappers.FilteringTargetWrapper">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.Single)">
<summary>
A target wrapper that filters log entries based on a condition.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Single" /> as a parameter and formatting it with the supplied format provider.
</summary>
<example>
<p>This example causes the messages not contains the string '1' to be ignored.</p>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/FilteringWrapper/NLog.config" />
<p>
The above examples assume just one target and a single rule. See below for
a programmatic configuration that's equivalent to the above config file:
</p>
<code lang="C#" src="examples/targets/Configuration API/FilteringWrapper/Simple/Example.cs" />
</example>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Single" /> argument to format.</param>
</member>
<member name="M:NLog.Targets.Wrappers.FilteringTargetWrapper.#ctor">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.Single)">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.Wrappers.FilteringTargetWrapper"/>.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Single" /> as a parameter.
</summary>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Single" /> argument to format.</param>
</member>
<member name="M:NLog.Targets.Wrappers.FilteringTargetWrapper.#ctor(NLog.Target,System.String)">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.Double)">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.Wrappers.FilteringTargetWrapper"/> and
initializes the <see cref="P:NLog.Targets.Wrappers.WrapperTargetBase.WrappedTarget"/> and
<see cref="P:NLog.Targets.Wrappers.FilteringTargetWrapper.Condition"/> properties.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Double" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Double" /> argument to format.</param>
</member>
<member name="M:NLog.Targets.Wrappers.FilteringTargetWrapper.Write(NLog.LogEventInfo)">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.Double)">
<summary>
Checks the condition against the passed log event.
If the condition is met, the log event is forwarded to
the wrapped target.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Double" /> as a parameter.
</summary>
<param name="logEvent">Log event.</param>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Double" /> argument to format.</param>
</member>
<member name="M:NLog.Targets.Wrappers.FilteringTargetWrapper.PopulateLayouts(NLog.LayoutCollection)">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.Decimal)">
<summary>
Adds all layouts used by this target to the specified collection.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Decimal" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="layouts">The collection to add layouts to.</param>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Decimal" /> argument to format.</param>
</member>
<member name="P:NLog.Targets.Wrappers.FilteringTargetWrapper.Condition">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.Decimal)">
<summary>
Condition expression. Log events who meet this condition will be forwarded
to the wrapped target.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Decimal" /> as a parameter.
</summary>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Decimal" /> argument to format.</param>
</member>
<member name="T:NLog.Targets.MailTarget">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.Object)">
<summary>
Sends logging messages by email using SMTP protocol.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Object" /> as a parameter and formatting it with the supplied format provider.
</summary>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/Mail/Simple/NLog.config" />
<p>
This assumes just one target and a single rule. More configuration
options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/Mail/Simple/Example.cs" />
<p>
Mail target works best when used with BufferingWrapper target
which lets you send multiple logging messages in single mail
</p>
<p>
To set up the buffered mail target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/Mail/Buffered/NLog.config" />
<p>
To set up the buffered mail target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/Mail/Buffered/Example.cs" />
</example>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Object" /> argument to format.</param>
</member>
<member name="M:NLog.Targets.MailTarget.#ctor">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.Object)">
<summary>
Creates a new instance of <see cref="T:NLog.Targets.MailTarget"/>.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.Object" /> as a parameter.
</summary>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Object" /> argument to format.</param>
</member>
<member name="M:NLog.Targets.MailTarget.PopulateLayouts(NLog.LayoutCollection)">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.SByte)">
<summary>
Adds all layouts used by this target to the specified collection.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.SByte" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="layouts">The collection to add layouts to.</param>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.SByte" /> argument to format.</param>
</member>
<member name="M:NLog.Targets.MailTarget.Write(NLog.LogEventInfo)">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.SByte)">
<summary>
Renders the logging event message and adds it to the internal ArrayList of log messages.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.SByte" /> as a parameter.
</summary>
<param name="logEvent">The logging event.</param>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.SByte" /> argument to format.</param>
</member>
<member name="M:NLog.Targets.MailTarget.Write(NLog.LogEventInfo[])">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.UInt32)">
<summary>
Renders an array logging events.
Writes the diagnostic message at the specified level using the specified <see cref="T:System.UInt32" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="events">Array of logging events.</param>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt32" /> argument to format.</param>
</member>
<member name="P:NLog.Targets.MailTarget.From">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.UInt32)">
<summary>
Sender's email address (e.g. joe@domain.com)
Writes the diagnostic message at the specified level using the specified <see cref="T:System.UInt32" /> as a parameter.
</summary>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt32" /> argument to format.</param>
</member>
<member name="P:NLog.Targets.MailTarget.To">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.IFormatProvider,System.String,System.UInt64)">
<summary>
Recipients' email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com)
Writes the diagnostic message at the specified level using the specified <see cref="T:System.UInt64" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="level">the log level.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt64" /> argument to format.</param>
</member>
<member name="P:NLog.Targets.MailTarget.CC">
<member name="M:NLog.Logger.Log(NLog.LogLevel,System.String,System.UInt64)">
<summary>
CC email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com)
Writes the diagnostic message at the specified level using the specified <see cref="T:System.UInt64" /> as a parameter.
</summary>
<param name="level">the log level.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt64" /> argument to format.</param>
</member>
<member name="P:NLog.Targets.MailTarget.BCC">
<member name="M:NLog.Logger.Trace(System.String)">
<overloads>
Writes the diagnostic message at the <c>Trace</c> level using the specified format provider and format parameters.
</overloads>
<summary>
BCC email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com)
Writes the diagnostic message at the <c>Trace</c> level.
</summary>
<param name="message">A <see langword="string" /> to be written.</param>
</member>
<member name="P:NLog.Targets.MailTarget.AddNewLines">
<member name="M:NLog.Logger.Trace(System.Object)">
<summary>
Whether to add new lines between log entries.
Writes the diagnostic message at the <c>Trace</c> level.
</summary>
<value><c>true</c> if new lines should be added; otherwise, <c>false</c>.</value>
<param name="obj">A <see langword="object" /> to be written.</param>
</member>
<member name="P:NLog.Targets.MailTarget.Subject">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.Object)">
<summary>
Mail subject.
Writes the diagnostic message at the <c>Trace</c> level.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="obj">A <see langword="object" /> to be written.</param>
</member>
<member name="P:NLog.Targets.MailTarget.Body">
<member name="M:NLog.Logger.TraceException(System.String,System.Exception)">
<summary>
Mail message body (repeated for each log message send in one mail)
Writes the diagnostic message and exception at the <c>Trace</c> level.
</summary>
<param name="message">A <see langword="string" /> to be written.</param>
<param name="exception">An exception to be logged.</param>
</member>
<member name="P:NLog.Targets.MailTarget.Encoding">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.Object[])">
<summary>
Encoding to be used for sending e-mail.
Writes the diagnostic message at the <c>Trace</c> level using the specified parameters and formatting them with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="args">Arguments to format.</param>
</member>
<member name="P:NLog.Targets.MailTarget.HTML">
<member name="M:NLog.Logger.Trace(System.String,System.Object[])">
<summary>
Send message as HTML instead of plain text.
Writes the diagnostic message at the <c>Trace</c> level using the specified parameters.
</summary>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="args">Arguments to format.</param>
</member>
<member name="P:NLog.Targets.MailTarget.SmtpServer">
<member name="M:NLog.Logger.Trace(System.String,System.Object,System.Object)">
<summary>
SMTP Server to be used for sending.
Writes the diagnostic message at the <c>Trace</c> level using the specified parameters.
</summary>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="arg1">First argument to format.</param>
<param name="arg2">Second argument to format.</param>
</member>
<member name="P:NLog.Targets.MailTarget.SmtpAuthentication">
<member name="M:NLog.Logger.Trace(System.String,System.Object,System.Object,System.Object)">
<summary>
SMTP Authentication mode.
Writes the diagnostic message at the <c>Trace</c> level using the specified parameters.
</summary>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="arg1">First argument to format.</param>
<param name="arg2">Second argument to format.</param>
<param name="arg3">Third argument to format.</param>
</member>
<member name="P:NLog.Targets.MailTarget.SmtpUsername">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.Boolean)">
<summary>
The username used to connect to SMTP server (used when SmtpAuthentication is set to "basic").
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Boolean" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Boolean" /> argument to format.</param>
</member>
<member name="P:NLog.Targets.MailTarget.SmtpPassword">
<member name="M:NLog.Logger.Trace(System.String,System.Boolean)">
<summary>
The password used to authenticate against SMTP server (used when SmtpAuthentication is set to "basic").
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Boolean" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Boolean" /> argument to format.</param>
</member>
<member name="P:NLog.Targets.MailTarget.SmtpPort">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.Char)">
<summary>
The port that SMTP Server is listening on.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Char" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Char" /> argument to format.</param>
</member>
<member name="T:NLog.Targets.MailTarget.SmtpAuthenticationMode">
<member name="M:NLog.Logger.Trace(System.String,System.Char)">
<summary>
SMTP authentication modes.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Char" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Char" /> argument to format.</param>
</member>
<member name="F:NLog.Targets.MailTarget.SmtpAuthenticationMode.None">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.Byte)">
<summary>
No authentication.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Byte" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Byte" /> argument to format.</param>
</member>
<member name="F:NLog.Targets.MailTarget.SmtpAuthenticationMode.Basic">
<member name="M:NLog.Logger.Trace(System.String,System.Byte)">
<summary>
Basic - username and password
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Byte" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Byte" /> argument to format.</param>
</member>
<member name="F:NLog.Targets.MailTarget.SmtpAuthenticationMode.Ntlm">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.String)">
<summary>
NTLM Authentication
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.String" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.String" /> argument to format.</param>
</member>
<member name="T:NLog.TargetFactory">
<member name="M:NLog.Logger.Trace(System.String,System.String)">
<summary>
A factory of logging targets. Creates new targets based on their names.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.String" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.String" /> argument to format.</param>
</member>
<member name="M:NLog.TargetFactory.Clear">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.Int32)">
<summary>
Removes all target information from the factory.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Int32" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int32" /> argument to format.</param>
</member>
<member name="M:NLog.TargetFactory.Reset">
<member name="M:NLog.Logger.Trace(System.String,System.Int32)">
<summary>
Removes all targets and reloads them from NLog assembly and default extension assemblies.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Int32" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int32" /> argument to format.</param>
</member>
<member name="M:NLog.TargetFactory.AddTargetsFromAssembly(System.Reflection.Assembly,System.String)">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.Int64)">
<summary>
Scans the specified assembly for types marked with <see cref="T:NLog.TargetAttribute"/> and adds
them to the factory. Optionally it prepends the specified text to the target names to avoid
naming collisions.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Int64" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="theAssembly">The assembly to be scanned for targets.</param>
<param name="prefix">The prefix to be prepended to target names.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int64" /> argument to format.</param>
</member>
<member name="M:NLog.TargetFactory.AddDefaultTargets">
<member name="M:NLog.Logger.Trace(System.String,System.Int64)">
<summary>
Adds default targets from the NLog.dll assembly.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Int64" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int64" /> argument to format.</param>
</member>
<member name="M:NLog.TargetFactory.AddTarget(System.String,System.Type)">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.Single)">
<summary>
Registers the specified target type to the factory under a specified name.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Single" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="targetName">The name of the target (e.g. <code>File</code> or <code>Console</code>)</param>
<param name="targetType">The type of the new target</param>
<remarks>
The name specified in the targetName parameter can then be used
to create target.
</remarks>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Single" /> argument to format.</param>
</member>
<member name="M:NLog.TargetFactory.CreateTarget(System.String)">
<member name="M:NLog.Logger.Trace(System.String,System.Single)">
<summary>
Creates the target object based on its target name.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Single" /> as a parameter.
</summary>
<param name="name">The name of the target (e.g. <code>File</code> or <code>Console</code>)</param>
<returns>A new instance of the Target object.</returns>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Single" /> argument to format.</param>
</member>
<member name="P:NLog.TargetFactory.TargetTypes">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.Double)">
<summary>
Collection of target types added to the factory.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Double" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Double" /> argument to format.</param>
</member>
<member name="T:NLog.LayoutRenderers.CounterLayoutRenderer">
<member name="M:NLog.Logger.Trace(System.String,System.Double)">
<summary>
A counter value (increases on each layout rendering).
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Double" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Double" /> argument to format.</param>
</member>
<member name="M:NLog.LayoutRenderers.CounterLayoutRenderer.GetEstimatedBufferSize(NLog.LogEventInfo)">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.Decimal)">
<summary>
Returns the estimated number of characters that are needed to
hold the rendered value for the specified logging event.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Decimal" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="logEvent">Logging event information.</param>
<returns>The number of characters.</returns>
<remarks>
If the exact number is not known or
expensive to calculate this function should return a rough estimate
that's big enough in most cases, but not too big, in order to conserve memory.
</remarks>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Decimal" /> argument to format.</param>
</member>
<member name="M:NLog.LayoutRenderers.CounterLayoutRenderer.Append(System.Text.StringBuilder,NLog.LogEventInfo)">
<member name="M:NLog.Logger.Trace(System.String,System.Decimal)">
<summary>
Renders the specified counter value and appends it to the specified <see cref="T:System.Text.StringBuilder"/>.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Decimal" /> as a parameter.
</summary>
<param name="builder">The <see cref="T:System.Text.StringBuilder"/> to append the rendered data to.</param>
<param name="logEvent">Logging event.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Decimal" /> argument to format.</param>
</member>
<member name="P:NLog.LayoutRenderers.CounterLayoutRenderer.Value">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.Object)">
<summary>
The initial value of the counter
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Object" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Object" /> argument to format.</param>
</member>
<member name="P:NLog.LayoutRenderers.CounterLayoutRenderer.Increment">
<member name="M:NLog.Logger.Trace(System.String,System.Object)">
<summary>
The value to be added to the counter after each layout rendering.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.Object" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Object" /> argument to format.</param>
</member>
<member name="P:NLog.LayoutRenderers.CounterLayoutRenderer.Sequence">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.SByte)">
<summary>
The name of the sequence. Different named sequences can have individual values.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.SByte" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.SByte" /> argument to format.</param>
</member>
<member name="T:NLog.Internal.NetworkSenders.TcpNetworkSender">
<member name="M:NLog.Logger.Trace(System.String,System.SByte)">
<summary>
Sends messages over a TCP network connection.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.SByte" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.SByte" /> argument to format.</param>
</member>
<member name="T:NLog.Internal.NetworkSenders.NetworkSender">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.UInt32)">
<summary>
A base class for all network senders. Supports one-way sending of messages
over various protocols.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.UInt32" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt32" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.NetworkSenders.NetworkSender.#ctor(System.String)">
<member name="M:NLog.Logger.Trace(System.String,System.UInt32)">
<summary>
Creates a new instance of the <see cref="T:NLog.Internal.NetworkSenders.NetworkSender"/> and initializes
it with the specified URL.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.UInt32" /> as a parameter.
</summary>
<param name="url">URL.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt32" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.NetworkSenders.NetworkSender.Finalize">
<member name="M:NLog.Logger.Trace(System.IFormatProvider,System.String,System.UInt64)">
<summary>
Disposes the <see cref="T:NLog.Internal.NetworkSenders.NetworkSender"/> object.
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.UInt64" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt64" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.NetworkSenders.NetworkSender.Create(System.String)">
<member name="M:NLog.Logger.Trace(System.String,System.UInt64)">
<summary>
Creates a new instance of the network sender based on a network URL:
Writes the diagnostic message at the <c>Trace</c> level using the specified <see cref="T:System.UInt64" /> as a parameter.
</summary>
<param name="url">URL that determines the network sender to be created.</param>
<returns>A newly created network sender.</returns>
<remarks>
If the url starts with <c>tcp://</c> - a new <see cref="T:NLog.Internal.NetworkSenders.TcpNetworkSender"/> is created.<br/>
If the url starts with <c>udp://</c> - a new <see cref="T:NLog.Internal.NetworkSenders.UdpNetworkSender"/> is created.<br/>
</remarks>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt64" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.NetworkSenders.NetworkSender.Close">
<member name="M:NLog.Logger.Debug(System.String)">
<overloads>
Writes the diagnostic message at the <c>Debug</c> level using the specified format provider and format parameters.
</overloads>
<summary>
Closes the sender and releases any unmanaged resources.
Writes the diagnostic message at the <c>Debug</c> level.
</summary>
<param name="message">A <see langword="string" /> to be written.</param>
</member>
<member name="M:NLog.Internal.NetworkSenders.NetworkSender.Flush">
<member name="M:NLog.Logger.Debug(System.Object)">
<summary>
Flushes any buffers.
Writes the diagnostic message at the <c>Debug</c> level.
</summary>
<param name="obj">A <see langword="object" /> to be written.</param>
</member>
<member name="M:NLog.Internal.NetworkSenders.NetworkSender.Send(System.Byte[],System.Int32,System.Int32)">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.Object)">
<summary>
Send the given text over the specified protocol.
Writes the diagnostic message at the <c>Debug</c> level.
</summary>
<param name="bytes">Bytes to be sent.</param>
<param name="offset">Offset in buffer</param>
<param name="length">Number of bytes to send</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="obj">A <see langword="object" /> to be written.</param>
</member>
<member name="M:NLog.Internal.NetworkSenders.NetworkSender.DoSend(System.Byte[],System.Int32,System.Int32)">
<member name="M:NLog.Logger.DebugException(System.String,System.Exception)">
<summary>
Actually sends the given text over the specified protocol.
Writes the diagnostic message and exception at the <c>Debug</c> level.
</summary>
<param name="bytes">The bytes to be sent.</param>
<param name="offset">Offset in buffer</param>
<param name="length">Number of bytes to send</param>
<remarks>To be overridden in inheriting classes.</remarks>
<param name="message">A <see langword="string" /> to be written.</param>
<param name="exception">An exception to be logged.</param>
</member>
<member name="M:NLog.Internal.NetworkSenders.NetworkSender.Dispose">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.Object[])">
<summary>
Closes the sender and releases any unmanaged resources.
Writes the diagnostic message at the <c>Debug</c> level using the specified parameters and formatting them with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="args">Arguments to format.</param>
</member>
<member name="P:NLog.Internal.NetworkSenders.NetworkSender.Address">
<member name="M:NLog.Logger.Debug(System.String,System.Object[])">
<summary>
The address of the network endpoint.
Writes the diagnostic message at the <c>Debug</c> level using the specified parameters.
</summary>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="args">Arguments to format.</param>
</member>
<member name="M:NLog.Internal.NetworkSenders.TcpNetworkSender.#ctor(System.String)">
<member name="M:NLog.Logger.Debug(System.String,System.Object,System.Object)">
<summary>
Creates a new instance of <see cref="T:NLog.Internal.NetworkSenders.TcpNetworkSender"/> and initializes
it with the specified URL. Connects to the server specified in the URL.
Writes the diagnostic message at the <c>Debug</c> level using the specified parameters.
</summary>
<param name="url">URL. Must start with tcp://</param>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="arg1">First argument to format.</param>
<param name="arg2">Second argument to format.</param>
</member>
<member name="M:NLog.Internal.NetworkSenders.TcpNetworkSender.DoSend(System.Byte[],System.Int32,System.Int32)">
<member name="M:NLog.Logger.Debug(System.String,System.Object,System.Object,System.Object)">
<summary>
Sends the specified text over the connected socket.
Writes the diagnostic message at the <c>Debug</c> level using the specified parameters.
</summary>
<param name="bytes">The bytes to be sent.</param>
<param name="offset">Offset in buffer</param>
<param name="length">Number of bytes to send</param>
<remarks>To be overridden in inheriting classes.</remarks>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="arg1">First argument to format.</param>
<param name="arg2">Second argument to format.</param>
<param name="arg3">Third argument to format.</param>
</member>
<member name="M:NLog.Internal.NetworkSenders.TcpNetworkSender.Close">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.Boolean)">
<summary>
Closes the socket.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Boolean" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Boolean" /> argument to format.</param>
</member>
<member name="T:NLog.Internal.FilterDictionary">
<member name="M:NLog.Logger.Debug(System.String,System.Boolean)">
<summary>
A dictionary with keys of type string and values of type Filter
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Boolean" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Boolean" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.FilterDictionary.#ctor">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.Char)">
<summary>
Initializes a new empty instance of the FilterDictionary class
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Char" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Char" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.FilterDictionary.Add(System.String,NLog.Filter)">
<member name="M:NLog.Logger.Debug(System.String,System.Char)">
<summary>
Adds an element with the specified key and value to this FilterDictionary.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Char" /> as a parameter.
</summary>
<param name="key">
The string key of the element to add.
</param>
<param name="value">
The Filter value of the element to add.
</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Char" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.FilterDictionary.Contains(System.String)">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.Byte)">
<summary>
Determines whether this FilterDictionary contains a specific key.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Byte" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="key">
The string key to locate in this FilterDictionary.
</param>
<returns>
true if this FilterDictionary contains an element with the specified key;
otherwise, false.
</returns>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Byte" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.FilterDictionary.ContainsKey(System.String)">
<member name="M:NLog.Logger.Debug(System.String,System.Byte)">
<summary>
Determines whether this FilterDictionary contains a specific key.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Byte" /> as a parameter.
</summary>
<param name="key">
The string key to locate in this FilterDictionary.
</param>
<returns>
true if this FilterDictionary contains an element with the specified key;
otherwise, false.
</returns>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Byte" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.FilterDictionary.ContainsValue(NLog.Filter)">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.String)">
<summary>
Determines whether this FilterDictionary contains a specific value.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.String" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="value">
The Filter value to locate in this FilterDictionary.
</param>
<returns>
true if this FilterDictionary contains an element with the specified value;
otherwise, false.
</returns>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.String" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.FilterDictionary.Remove(System.String)">
<member name="M:NLog.Logger.Debug(System.String,System.String)">
<summary>
Removes the element with the specified key from this FilterDictionary.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.String" /> as a parameter.
</summary>
<param name="key">
The string key of the element to remove.
</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.String" /> argument to format.</param>
</member>
<member name="P:NLog.Internal.FilterDictionary.Item(System.String)">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.Int32)">
<summary>
Gets or sets the Filter associated with the given string
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Int32" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="key">
The string whose value to get or set.
</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int32" /> argument to format.</param>
</member>
<member name="P:NLog.Internal.FilterDictionary.Keys">
<member name="M:NLog.Logger.Debug(System.String,System.Int32)">
<summary>
Gets a collection containing the keys in this FilterDictionary.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Int32" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int32" /> argument to format.</param>
</member>
<member name="P:NLog.Internal.FilterDictionary.Values">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.Int64)">
<summary>
Gets a collection containing the values in this FilterDictionary.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Int64" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int64" /> argument to format.</param>
</member>
<member name="T:NLog.Internal.FormHelper">
<member name="M:NLog.Logger.Debug(System.String,System.Int64)">
<summary>
Form helper
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Int64" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int64" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.FormHelper.FindControl(System.String,System.Windows.Forms.Control)">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.Single)">
<summary>
Finds control embended on searchControl
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Single" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="name">name of Control</param>
<param name="searchControl">Control in which we're searching for control</param>
<returns>null if no control has been found</returns>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Single" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.FormHelper.FindControl(System.String,System.Windows.Forms.Control,System.Type)">
<member name="M:NLog.Logger.Debug(System.String,System.Single)">
<summary>
Finds control of specified type embended on searchControl
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Single" /> as a parameter.
</summary>
<param name="name">name of Control</param>
<param name="searchControl">Control in which we're searching for control</param>
<param name="controlType">Type of control to search</param>
<returns>null if no control has been found</returns>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Single" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.FormHelper.CreateForm(System.String,System.Int32,System.Int32,System.Boolean)">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.Double)">
<summary>
Creates Form
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Double" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="name">Name of form</param>
<param name="width">Width of form</param>
<param name="height">Height of form</param>
<param name="show">Auto show form</param>
<returns>Created form</returns>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Double" /> argument to format.</param>
</member>
<member name="M:NLog.Internal.FormHelper.CreateRichTextBox(System.String,System.Windows.Forms.Form)">
<member name="M:NLog.Logger.Debug(System.String,System.Double)">
<summary>
Creates RichTextBox and docks in parentForm
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Double" /> as a parameter.
</summary>
<param name="name">Name of RichTextBox</param>
<param name="parentForm">Form to dock RichTextBox</param>
<returns>Created RichTextBox</returns>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Double" /> argument to format.</param>
</member>
<member name="T:NLog.Filters.WhenContainsFilter">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.Decimal)">
<summary>
Matches when the calculated layout contains the specified substring.
This filter is deprecated in favour of <c>&lt;when /&gt;</c> which is based on <a href="conditions.html">contitions</a>
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Decimal" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Decimal" /> argument to format.</param>
</member>
<member name="M:NLog.Filters.WhenContainsFilter.#ctor">
<member name="M:NLog.Logger.Debug(System.String,System.Decimal)">
<summary>
Initializes a new instance of the filter object.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Decimal" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Decimal" /> argument to format.</param>
</member>
<member name="M:NLog.Filters.WhenContainsFilter.Check(NLog.LogEventInfo)">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.Object)">
<summary>
Checks whether log event should be logged or not.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Object" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="logEvent">Log event.</param>
<returns>
<see cref="F:NLog.FilterResult.Ignore"/> - if the log event should be ignored<br/>
<see cref="F:NLog.FilterResult.Neutral"/> - if the filter doesn't want to decide<br/>
<see cref="F:NLog.FilterResult.Log"/> - if the log event should be logged<br/>
</returns>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Object" /> argument to format.</param>
</member>
<member name="P:NLog.Filters.WhenContainsFilter.IgnoreCase">
<member name="M:NLog.Logger.Debug(System.String,System.Object)">
<summary>
Ignore case when comparing strings.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.Object" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Object" /> argument to format.</param>
</member>
<member name="P:NLog.Filters.WhenContainsFilter.Substring">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.SByte)">
<summary>
Substring to be matched.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.SByte" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.SByte" /> argument to format.</param>
</member>
<member name="T:NLog.Config.ConfigSectionHandler">
<member name="M:NLog.Logger.Debug(System.String,System.SByte)">
<summary>
NLog configuration section handler class for configuring NLog from App.config
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.SByte" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.SByte" /> argument to format.</param>
</member>
<member name="T:NLog.Config.AcceptsLayoutAttribute">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.UInt32)">
<summary>
Attribute used to mark string parameters that accept layouts.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.UInt32" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt32" /> argument to format.</param>
</member>
<member name="M:NLog.Config.AcceptsLayoutAttribute.#ctor">
<member name="M:NLog.Logger.Debug(System.String,System.UInt32)">
<summary>
Creates a new instance of AcceptsLayoutAttribute
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.UInt32" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt32" /> argument to format.</param>
</member>
<member name="T:NLog.Conditions.ConditionLoggerNameExpression">
<member name="M:NLog.Logger.Debug(System.IFormatProvider,System.String,System.UInt64)">
<summary>
Condition logger name expression (represented by the <b>logger</b> keyword).
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.UInt64" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt64" /> argument to format.</param>
</member>
<member name="M:NLog.Conditions.ConditionLoggerNameExpression.#ctor">
<member name="M:NLog.Logger.Debug(System.String,System.UInt64)">
<summary>
Creates a new instance of <see cref="T:NLog.Conditions.ConditionLoggerNameExpression"/>.
Writes the diagnostic message at the <c>Debug</c> level using the specified <see cref="T:System.UInt64" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt64" /> argument to format.</param>
</member>
<member name="M:NLog.Conditions.ConditionLoggerNameExpression.Evaluate(NLog.LogEventInfo)">
<member name="M:NLog.Logger.Info(System.String)">
<overloads>
Writes the diagnostic message at the <c>Info</c> level using the specified format provider and format parameters.
</overloads>
<summary>
Evaluates to the logger name.
Writes the diagnostic message at the <c>Info</c> level.
</summary>
<param name="context">evaluation context</param>
<returns>The logger name</returns>
<param name="message">A <see langword="string" /> to be written.</param>
</member>
<member name="M:NLog.Conditions.ConditionLoggerNameExpression.ToString">
<member name="M:NLog.Logger.Info(System.Object)">
<summary>
Returns a string representation of this expression
Writes the diagnostic message at the <c>Info</c> level.
</summary>
<returns>a <b>logger</b> string</returns>
<param name="obj">A <see langword="object" /> to be written.</param>
</member>
<member name="T:NLog.Win32.Targets.MSMQTarget">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.Object)">
<summary>
Writes log message to the specified message queue handled by MSMQ.
Writes the diagnostic message at the <c>Info</c> level.
</summary>
<example>
<p>
To set up the target in the <a href="config.html">configuration file</a>,
use the following syntax:
</p>
<code lang="XML" src="examples/targets/Configuration File/MSMQ/Simple/NLog.config" />
<p>
You can use a single target to write to multiple queues (similar to writing to multiple files with the File target).
</p>
<code lang="XML" src="examples/targets/Configuration File/MSMQ/Multiple/NLog.config" />
<p>
The above examples assume just one target and a single rule.
More configuration options are described <a href="config.html">here</a>.
</p>
<p>
To set up the log target programmatically use code like this:
</p>
<code lang="C#" src="examples/targets/Configuration API/MSMQ/Simple/Example.cs" />
</example>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="obj">A <see langword="object" /> to be written.</param>
</member>
<member name="M:NLog.Win32.Targets.MSMQTarget.PopulateLayouts(NLog.LayoutCollection)">
<member name="M:NLog.Logger.InfoException(System.String,System.Exception)">
<summary>
Adds all layouts used by this target to the specified collection.
Writes the diagnostic message and exception at the <c>Info</c> level.
</summary>
<param name="layouts">The collection to add layouts to.</param>
<param name="message">A <see langword="string" /> to be written.</param>
<param name="exception">An exception to be logged.</param>
</member>
<member name="M:NLog.Win32.Targets.MSMQTarget.Write(NLog.LogEventInfo)">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.Object[])">
<summary>
Writes the specified logging event to a queue specified in the Queue
parameter.
Writes the diagnostic message at the <c>Info</c> level using the specified parameters and formatting them with the supplied format provider.
</summary>
<param name="logEvent">The logging event.</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="args">Arguments to format.</param>
</member>
<member name="M:NLog.Win32.Targets.MSMQTarget.PrepareMessage(NLog.LogEventInfo)">
<member name="M:NLog.Logger.Info(System.String,System.Object[])">
<summary>
Prepares a message to be sent to the message queue.
Writes the diagnostic message at the <c>Info</c> level using the specified parameters.
</summary>
<param name="logEvent">The log event to be used when calculating label and text to be written.</param>
<returns>The message to be sent</returns>
<remarks>
You may override this method in inheriting classes
to provide services like encryption or message
authentication.
</remarks>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="args">Arguments to format.</param>
</member>
<member name="P:NLog.Win32.Targets.MSMQTarget.Queue">
<member name="M:NLog.Logger.Info(System.String,System.Object,System.Object)">
<summary>
Name of the queue to write to.
Writes the diagnostic message at the <c>Info</c> level using the specified parameters.
</summary>
<remarks>
To write to a private queue on a local machine use <c>.\private$\QueueName</c>.
For other available queue names, consult MSMQ documentation.
</remarks>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="arg1">First argument to format.</param>
<param name="arg2">Second argument to format.</param>
</member>
<member name="P:NLog.Win32.Targets.MSMQTarget.Label">
<member name="M:NLog.Logger.Info(System.String,System.Object,System.Object,System.Object)">
<summary>
The label to associate with each message.
Writes the diagnostic message at the <c>Info</c> level using the specified parameters.
</summary>
<remarks>
By default no label is associated.
</remarks>
<param name="message">A <see langword="string" /> containing format items.</param>
<param name="arg1">First argument to format.</param>
<param name="arg2">Second argument to format.</param>
<param name="arg3">Third argument to format.</param>
</member>
<member name="P:NLog.Win32.Targets.MSMQTarget.CreateQueueIfNotExists">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.Boolean)">
<summary>
Create the queue if it doesn't exists.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Boolean" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Boolean" /> argument to format.</param>
</member>
<member name="P:NLog.Win32.Targets.MSMQTarget.Encoding">
<member name="M:NLog.Logger.Info(System.String,System.Boolean)">
<summary>
Encoding to be used when writing text to the queue.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Boolean" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Boolean" /> argument to format.</param>
</member>
<member name="P:NLog.Win32.Targets.MSMQTarget.UseXmlEncoding">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.Char)">
<summary>
Use the XML format when serializing message.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Char" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Char" /> argument to format.</param>
</member>
<member name="P:NLog.Win32.Targets.MSMQTarget.Recoverable">
<member name="M:NLog.Logger.Info(System.String,System.Char)">
<summary>
Use recoverable messages (with guaranteed delivery).
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Char" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Char" /> argument to format.</param>
</member>
<member name="T:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.Byte)">
<summary>
A collection of elements of type ConsoleWordHighlightingRule
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Byte" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Byte" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.#ctor">
<member name="M:NLog.Logger.Info(System.String,System.Byte)">
<summary>
Initializes a new empty instance of the ConsoleWordHighlightingRuleCollection class.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Byte" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Byte" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.#ctor(NLog.Win32.Targets.ConsoleWordHighlightingRule[])">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.String)">
<summary>
Initializes a new instance of the ConsoleWordHighlightingRuleCollection class, containing elements
copied from an array.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.String" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="items">
The array whose elements are to be added to the new ConsoleWordHighlightingRuleCollection.
</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.String" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.#ctor(NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection)">
<member name="M:NLog.Logger.Info(System.String,System.String)">
<summary>
Initializes a new instance of the ConsoleWordHighlightingRuleCollection class, containing elements
copied from another instance of ConsoleWordHighlightingRuleCollection
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.String" /> as a parameter.
</summary>
<param name="items">
The ConsoleWordHighlightingRuleCollection whose elements are to be added to the new ConsoleWordHighlightingRuleCollection.
</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.String" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.AddRange(NLog.Win32.Targets.ConsoleWordHighlightingRule[])">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.Int32)">
<summary>
Adds the elements of an array to the end of this ConsoleWordHighlightingRuleCollection.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Int32" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="items">
The array whose elements are to be added to the end of this ConsoleWordHighlightingRuleCollection.
</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int32" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.AddRange(NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection)">
<member name="M:NLog.Logger.Info(System.String,System.Int32)">
<summary>
Adds the elements of another ConsoleWordHighlightingRuleCollection to the end of this ConsoleWordHighlightingRuleCollection.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Int32" /> as a parameter.
</summary>
<param name="items">
The ConsoleWordHighlightingRuleCollection whose elements are to be added to the end of this ConsoleWordHighlightingRuleCollection.
</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int32" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Add(NLog.Win32.Targets.ConsoleWordHighlightingRule)">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.Int64)">
<summary>
Adds an instance of type ConsoleWordHighlightingRule to the end of this ConsoleWordHighlightingRuleCollection.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Int64" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="value">
The ConsoleWordHighlightingRule to be added to the end of this ConsoleWordHighlightingRuleCollection.
</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int64" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Contains(NLog.Win32.Targets.ConsoleWordHighlightingRule)">
<member name="M:NLog.Logger.Info(System.String,System.Int64)">
<summary>
Determines whether a specfic ConsoleWordHighlightingRule value is in this ConsoleWordHighlightingRuleCollection.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Int64" /> as a parameter.
</summary>
<param name="value">
The ConsoleWordHighlightingRule value to locate in this ConsoleWordHighlightingRuleCollection.
</param>
<returns>
true if value is found in this ConsoleWordHighlightingRuleCollection;
false otherwise.
</returns>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Int64" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.IndexOf(NLog.Win32.Targets.ConsoleWordHighlightingRule)">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.Single)">
<summary>
Return the zero-based index of the first occurrence of a specific value
in this ConsoleWordHighlightingRuleCollection
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Single" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="value">
The ConsoleWordHighlightingRule value to locate in the ConsoleWordHighlightingRuleCollection.
</param>
<returns>
The zero-based index of the first occurrence of the _ELEMENT value if found;
-1 otherwise.
</returns>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Single" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Insert(System.Int32,NLog.Win32.Targets.ConsoleWordHighlightingRule)">
<member name="M:NLog.Logger.Info(System.String,System.Single)">
<summary>
Inserts an element into the ConsoleWordHighlightingRuleCollection at the specified index
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Single" /> as a parameter.
</summary>
<param name="index">
The index at which the ConsoleWordHighlightingRule is to be inserted.
</param>
<param name="value">
The ConsoleWordHighlightingRule to insert.
</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Single" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Remove(NLog.Win32.Targets.ConsoleWordHighlightingRule)">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.Double)">
<summary>
Removes the first occurrence of a specific ConsoleWordHighlightingRule from this ConsoleWordHighlightingRuleCollection.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Double" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="value">
The ConsoleWordHighlightingRule value to remove from this ConsoleWordHighlightingRuleCollection.
</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Double" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.GetEnumerator">
<member name="M:NLog.Logger.Info(System.String,System.Double)">
<summary>
Returns an enumerator that can iterate through the elements of this ConsoleWordHighlightingRuleCollection.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Double" /> as a parameter.
</summary>
<returns>
An object that implements System.Collections.IEnumerator.
</returns>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Double" /> argument to format.</param>
</member>
<member name="P:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Item(System.Int32)">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.Decimal)">
<summary>
Gets or sets the ConsoleWordHighlightingRule at the given index in this ConsoleWordHighlightingRuleCollection.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Decimal" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Decimal" /> argument to format.</param>
</member>
<member name="T:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Enumerator">
<member name="M:NLog.Logger.Info(System.String,System.Decimal)">
<summary>
Type-specific enumeration class, used by ConsoleWordHighlightingRuleCollection.GetEnumerator.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Decimal" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Decimal" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Enumerator.#ctor(NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection)">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.Object)">
<summary>
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Object" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="collection"></param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Object" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Enumerator.MoveNext">
<member name="M:NLog.Logger.Info(System.String,System.Object)">
<summary>
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.Object" /> as a parameter.
</summary>
<returns></returns>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.Object" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Enumerator.Reset">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.SByte)">
<summary>
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.SByte" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.SByte" /> argument to format.</param>
</member>
<member name="P:NLog.Win32.Targets.ConsoleWordHighlightingRuleCollection.Enumerator.Current">
<member name="M:NLog.Logger.Info(System.String,System.SByte)">
<summary>
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.SByte" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.SByte" /> argument to format.</param>
</member>
<member name="T:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.UInt32)">
<summary>
A collection of elements of type ConsoleRowHighlightingRule
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.UInt32" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt32" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.#ctor">
<member name="M:NLog.Logger.Info(System.String,System.UInt32)">
<summary>
Initializes a new empty instance of the ConsoleRowHighlightingRuleCollection class.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.UInt32" /> as a parameter.
</summary>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt32" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.#ctor(NLog.Win32.Targets.ConsoleRowHighlightingRule[])">
<member name="M:NLog.Logger.Info(System.IFormatProvider,System.String,System.UInt64)">
<summary>
Initializes a new instance of the ConsoleRowHighlightingRuleCollection class, containing elements
copied from an array.
Writes the diagnostic message at the <c>Info</c> level using the specified <see cref="T:System.UInt64" /> as a parameter and formatting it with the supplied format provider.
</summary>
<param name="items">
The array whose elements are to be added to the new ConsoleRowHighlightingRuleCollection.
</param>
<param name="formatProvider">An IFormatProvider that supplies culture-specific formatting information.</param>
<param name="message">A <see langword="string" /> containing one format item.</param>
<param name="argument">The <see cref="T:System.UInt64" /> argument to format.</param>
</member>
<member name="M:NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection.#ctor(NLog.Win32.Targets.ConsoleRowHighlightingRuleCollection)">
<member name="M:NL