Common.Logging.xml 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Common.Logging</name>
  5. </assembly>
  6. <members>
  7. <member name="T:CoverageExcludeAttribute">
  8. <summary>
  9. Indicates classes or members to be ignored by NCover
  10. </summary>
  11. <remarks>
  12. Note, the name is chosen, because TestDriven.NET uses it as //ea argument to "Test With... Coverage"
  13. </remarks>
  14. <author>Erich Eichinger</author>
  15. </member>
  16. <member name="T:Common.Logging.Configuration.NameValueCollectionHelper">
  17. <summary>
  18. Helper class for working with NameValueCollection
  19. </summary>
  20. </member>
  21. <member name="M:Common.Logging.Configuration.NameValueCollectionHelper.ToCommonLoggingCollection(System.Collections.Specialized.NameValueCollection)">
  22. <summary>
  23. Convert a <see cref="T:System.Collections.Specialized.NameValueCollection"/> into the corresponding
  24. common logging equivalent <see cref="T:Common.Logging.Configuration.NameValueCollection"/>
  25. </summary>
  26. <param name="properties">The properties.</param>
  27. <returns></returns>
  28. </member>
  29. <member name="T:Common.Logging.Simple.CommonLoggingTraceListener">
  30. <summary>
  31. A <see cref="T:System.Diagnostics.TraceListener"/> implementation sending all <see cref="T:System.Diagnostics.Trace">System.Diagnostics.Trace</see> output to
  32. the Common.Logging infrastructure.
  33. </summary>
  34. <remarks>
  35. This listener captures all output sent by calls to <see cref="T:System.Diagnostics.Trace">System.Diagnostics.Trace</see> and
  36. and <see cref="T:System.Diagnostics.TraceSource"/> and sends it to an <see cref="T:Common.Logging.ILog"/> instance.<br/>
  37. The <see cref="T:Common.Logging.ILog"/> instance to be used is obtained by calling
  38. <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>. The name of the logger is created by passing
  39. this listener's <see cref="P:System.Diagnostics.TraceListener.Name"/> and any <c>source</c> or <c>category</c> passed
  40. into this listener (see <see cref="M:System.Diagnostics.TraceListener.WriteLine(System.Object,System.String)"/> or <see cref="M:System.Diagnostics.TraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.String,System.Object[])"/> for example).
  41. </remarks>
  42. <example>
  43. The snippet below shows how to add and configure this listener to your app.config:
  44. <code lang="XML">
  45. &lt;system.diagnostics&gt;
  46. &lt;sharedListeners&gt;
  47. &lt;add name="Diagnostics"
  48. type="Common.Logging.Simple.CommonLoggingTraceListener, Common.Logging"
  49. initializeData="DefaultTraceEventType=Information; LoggerNameFormat={listenerName}.{sourceName}"&gt;
  50. &lt;filter type="System.Diagnostics.EventTypeFilter" initializeData="Information"/&gt;
  51. &lt;/add&gt;
  52. &lt;/sharedListeners&gt;
  53. &lt;trace&gt;
  54. &lt;listeners&gt;
  55. &lt;add name="Diagnostics" /&gt;
  56. &lt;/listeners&gt;
  57. &lt;/trace&gt;
  58. &lt;/system.diagnostics&gt;
  59. </code>
  60. </example>
  61. <author>Erich Eichinger</author>
  62. </member>
  63. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.#ctor">
  64. <summary>
  65. Creates a new instance with the default name "Diagnostics" and <see cref="T:Common.Logging.LogLevel"/> "Trace".
  66. </summary>
  67. </member>
  68. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.#ctor(System.String)">
  69. <summary>
  70. Creates a new instance initialized with properties from the <paramref name="initializeData"/>. string.
  71. </summary>
  72. <remarks>
  73. <paramref name="initializeData"/> is a semicolon separated string of name/value pairs, where each pair has
  74. the form <c>key=value</c>. E.g.
  75. "<c>Name=MyLoggerName;LogLevel=Debug</c>"
  76. </remarks>
  77. <param name="initializeData">a semicolon separated list of name/value pairs.</param>
  78. </member>
  79. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.#ctor(System.Collections.Specialized.NameValueCollection)">
  80. <summary>
  81. Creates a new instance initialized with the specified properties.
  82. </summary>
  83. <param name="properties">name/value configuration properties.</param>
  84. </member>
  85. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.Log(System.Diagnostics.TraceEventType,System.String,System.Int32,System.String,System.Object[])">
  86. <summary>
  87. Logs the given message to the Common.Logging infrastructure.
  88. </summary>
  89. <param name="eventType">the eventType</param>
  90. <param name="source">the <see cref="T:System.Diagnostics.TraceSource"/> name or category name passed into e.g. <see cref="M:System.Diagnostics.Trace.Write(System.Object,System.String)"/>.</param>
  91. <param name="id">the id of this event</param>
  92. <param name="format">the message format</param>
  93. <param name="args">the message arguments</param>
  94. </member>
  95. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.Write(System.Object)">
  96. <summary>
  97. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  98. </summary>
  99. </member>
  100. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.Write(System.Object,System.String)">
  101. <summary>
  102. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  103. </summary>
  104. </member>
  105. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.Write(System.String)">
  106. <summary>
  107. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  108. </summary>
  109. </member>
  110. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.Write(System.String,System.String)">
  111. <summary>
  112. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  113. </summary>
  114. </member>
  115. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.WriteLine(System.Object)">
  116. <summary>
  117. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  118. </summary>
  119. </member>
  120. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.WriteLine(System.Object,System.String)">
  121. <summary>
  122. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  123. </summary>
  124. </member>
  125. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.WriteLine(System.String)">
  126. <summary>
  127. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>.
  128. </summary>
  129. </member>
  130. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.WriteLine(System.String,System.String)">
  131. <summary>
  132. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>
  133. </summary>
  134. </member>
  135. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32)">
  136. <summary>
  137. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>
  138. </summary>
  139. </member>
  140. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.String)">
  141. <summary>
  142. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>
  143. </summary>
  144. </member>
  145. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.String,System.Object[])">
  146. <summary>
  147. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>
  148. </summary>
  149. </member>
  150. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.TraceData(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.Object[])">
  151. <summary>
  152. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>
  153. </summary>
  154. </member>
  155. <member name="M:Common.Logging.Simple.CommonLoggingTraceListener.TraceData(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.Object)">
  156. <summary>
  157. Writes message to logger provided by <see cref="M:Common.Logging.LogManager.GetLogger(System.String)"/>
  158. </summary>
  159. </member>
  160. <member name="P:Common.Logging.Simple.CommonLoggingTraceListener.DefaultTraceEventType">
  161. <summary>
  162. Sets the default <see cref="T:System.Diagnostics.TraceEventType"/> to use for logging
  163. all events emitted by <see cref="T:System.Diagnostics.Trace"/><c>.Write(...)</c> and
  164. <see cref="T:System.Diagnostics.Trace"/><c>.WriteLine(...)</c> methods.
  165. </summary>
  166. <remarks>
  167. This listener captures all output sent by calls to <see cref="T:System.Diagnostics.Trace"/> and
  168. sends it to an <see cref="T:Common.Logging.ILog"/> instance using the <see cref="T:Common.Logging.LogLevel"/> specified
  169. on <see cref="T:Common.Logging.LogLevel"/>.
  170. </remarks>
  171. </member>
  172. <member name="P:Common.Logging.Simple.CommonLoggingTraceListener.LoggerNameFormat">
  173. <summary>
  174. Format to use for creating the logger name. Defaults to "{listenerName}.{sourceName}".
  175. </summary>
  176. <remarks>
  177. Available placeholders are:
  178. <list type="bullet">
  179. <item>{listenerName}: the configured name of this listener instance.</item>
  180. <item>{sourceName}: the trace source name an event originates from (see e.g. <see cref="M:System.Diagnostics.TraceListener.TraceEvent(System.Diagnostics.TraceEventCache,System.String,System.Diagnostics.TraceEventType,System.Int32,System.String,System.Object[])"/>.</item>
  181. </list>
  182. </remarks>
  183. </member>
  184. <member name="T:Common.Logging.ConfigurationSectionHandler">
  185. <summary>
  186. Used in an application's configuration file (App.Config or Web.Config) to configure the logging subsystem.
  187. </summary>
  188. <example>
  189. An example configuration section that writes log messages to the Console using the
  190. built-in Console Logger.
  191. <code lang="XML">
  192. &lt;configuration&gt;
  193. &lt;configSections&gt;
  194. &lt;sectionGroup name=&quot;common&quot;&gt;
  195. &lt;section name=&quot;logging&quot; type=&quot;Common.Logging.ConfigurationSectionHandler, Common.Logging&quot; /&gt;
  196. &lt;/sectionGroup&gt;
  197. &lt;/configSections&gt;
  198. &lt;common&gt;
  199. &lt;logging&gt;
  200. &lt;factoryAdapter type=&quot;Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging&quot;&gt;
  201. &lt;arg key=&quot;showLogName&quot; value=&quot;true&quot; /&gt;
  202. &lt;arg key=&quot;showDataTime&quot; value=&quot;true&quot; /&gt;
  203. &lt;arg key=&quot;level&quot; value=&quot;ALL&quot; /&gt;
  204. &lt;arg key=&quot;dateTimeFormat&quot; value=&quot;yyyy/MM/dd HH:mm:ss:fff&quot; /&gt;
  205. &lt;/factoryAdapter&gt;
  206. &lt;/logging&gt;
  207. &lt;/common&gt;
  208. &lt;/configuration&gt;
  209. </code>
  210. </example>
  211. </member>
  212. <member name="M:Common.Logging.ConfigurationSectionHandler.#cctor">
  213. <summary>
  214. Ensure static fields get initialized before any class member
  215. can be accessed (avoids beforeFieldInit)
  216. </summary>
  217. </member>
  218. <member name="M:Common.Logging.ConfigurationSectionHandler.#ctor">
  219. <summary>
  220. Constructor
  221. </summary>
  222. </member>
  223. <member name="M:Common.Logging.ConfigurationSectionHandler.ReadConfiguration(System.Xml.XmlNode)">
  224. <summary>
  225. Retrieves the <see cref="T:System.Type"/> of the logger the use by looking at the logFactoryAdapter element
  226. of the logging configuration element.
  227. </summary>
  228. <param name="section"></param>
  229. <returns>
  230. A <see cref="T:Common.Logging.Configuration.LogSetting"/> object containing the specified type that implements
  231. <see cref="T:Common.Logging.ILoggerFactoryAdapter"/> along with zero or more properties that will be
  232. passed to the logger factory adapter's constructor as an <see cref="T:System.Collections.IDictionary"/>.
  233. </returns>
  234. </member>
  235. <member name="M:Common.Logging.ConfigurationSectionHandler.Create(Common.Logging.Configuration.LogSetting,System.Object,System.Xml.XmlNode)">
  236. <summary>
  237. Verifies that the logFactoryAdapter element appears once in the configuration section.
  238. </summary>
  239. <param name="parent">settings of a parent section - atm this must always be null</param>
  240. <param name="configContext">Additional information about the configuration process.</param>
  241. <param name="section">The configuration section to apply an XPath query too.</param>
  242. <returns>
  243. A <see cref="T:Common.Logging.Configuration.LogSetting"/> object containing the specified logFactoryAdapter type
  244. along with user supplied configuration properties.
  245. </returns>
  246. </member>
  247. <member name="M:Common.Logging.ConfigurationSectionHandler.System#Configuration#IConfigurationSectionHandler#Create(System.Object,System.Object,System.Xml.XmlNode)">
  248. <summary>
  249. Verifies that the logFactoryAdapter element appears once in the configuration section.
  250. </summary>
  251. <param name="parent">The parent of the current item.</param>
  252. <param name="configContext">Additional information about the configuration process.</param>
  253. <param name="section">The configuration section to apply an XPath query too.</param>
  254. <returns>
  255. A <see cref="T:Common.Logging.Configuration.LogSetting"/> object containing the specified logFactoryAdapter type
  256. along with user supplied configuration properties.
  257. </returns>
  258. </member>
  259. <member name="T:Common.Logging.Simple.ConsoleOutLogger">
  260. <summary>
  261. Sends log messages to <see cref="P:System.Console.Out"/>.
  262. </summary>
  263. <author>Gilles Bayon</author>
  264. </member>
  265. <member name="M:Common.Logging.Simple.ConsoleOutLogger.#ctor(System.String,Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
  266. <summary>
  267. Creates and initializes a logger that writes messages to <see cref="P:System.Console.Out"/>.
  268. </summary>
  269. <param name="logName">The name, usually type name of the calling class, of the logger.</param>
  270. <param name="logLevel">The current logging threshold. Messages recieved that are beneath this threshold will not be logged.</param>
  271. <param name="showLevel">Include the current log level in the log message.</param>
  272. <param name="showDateTime">Include the current time in the log message.</param>
  273. <param name="showLogName">Include the instance name in the log message.</param>
  274. <param name="dateTimeFormat">The date and time format to use in the log message.</param>
  275. </member>
  276. <member name="M:Common.Logging.Simple.ConsoleOutLogger.WriteInternal(Common.Logging.LogLevel,System.Object,System.Exception)">
  277. <summary>
  278. Do the actual logging by constructing the log message using a <see cref="T:System.Text.StringBuilder"/> then
  279. sending the output to <see cref="P:System.Console.Out"/>.
  280. </summary>
  281. <param name="level">The <see cref="T:Common.Logging.LogLevel"/> of the message.</param>
  282. <param name="message">The log message.</param>
  283. <param name="e">An optional <see cref="T:System.Exception"/> associated with the message.</param>
  284. </member>
  285. <member name="T:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter">
  286. <summary>
  287. Factory for creating <see cref="T:Common.Logging.ILog"/> instances that write data to <see cref="P:System.Console.Out"/>.
  288. </summary>
  289. <remarks>
  290. <example>
  291. Below is an example how to configure this adapter:
  292. <code>
  293. &lt;configuration&gt;
  294. &lt;configSections&gt;
  295. &lt;sectionGroup name="common"&gt;
  296. &lt;section name="logging"
  297. type="Common.Logging.ConfigurationSectionHandler, Common.Logging"
  298. requirePermission="false" /&gt;
  299. &lt;/sectionGroup&gt;
  300. &lt;/configSections&gt;
  301. &lt;common&gt;
  302. &lt;logging&gt;
  303. &lt;factoryAdapter type="Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter, Common.Logging"&gt;
  304. &lt;arg key="level" value="ALL" /&gt;
  305. &lt;/factoryAdapter&gt;
  306. &lt;/logging&gt;
  307. &lt;/common&gt;
  308. &lt;/configuration&gt;
  309. </code>
  310. </example>
  311. </remarks>
  312. <seealso cref="T:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter"/>
  313. <seealso cref="P:Common.Logging.LogManager.Adapter"/>
  314. <seealso cref="T:Common.Logging.ConfigurationSectionHandler"/>
  315. <author>Gilles Bayon</author>
  316. <author>Mark Pollack</author>
  317. <author>Erich Eichinger</author>
  318. </member>
  319. <member name="M:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter.#ctor">
  320. <summary>
  321. Initializes a new instance of the <see cref="T:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter"/> class using default
  322. settings.
  323. </summary>
  324. </member>
  325. <member name="M:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter.#ctor(Common.Logging.Configuration.NameValueCollection)">
  326. <summary>
  327. Initializes a new instance of the <see cref="T:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter"/> class.
  328. </summary>
  329. <remarks>
  330. Looks for level, showDateTime, showLogName, dateTimeFormat items from
  331. <paramref name="properties"/> for use when the GetLogger methods are called.
  332. <see cref="T:Common.Logging.ConfigurationSectionHandler"/> for more information on how to use the
  333. standard .NET application configuraiton file (App.config/Web.config)
  334. to configure this adapter.
  335. </remarks>
  336. <param name="properties">The name value collection, typically specified by the user in
  337. a configuration section named common/logging.</param>
  338. </member>
  339. <member name="M:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter.#ctor(System.Collections.Specialized.NameValueCollection)">
  340. <summary>
  341. Constructor for binary backwards compatibility with non-portableversions
  342. </summary>
  343. <param name="properties">The properties.</param>
  344. </member>
  345. <member name="M:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter.#ctor(Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
  346. <summary>
  347. Initializes a new instance of the <see cref="T:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter"/> class with
  348. default settings for the loggers created by this factory.
  349. </summary>
  350. </member>
  351. <member name="M:Common.Logging.Simple.ConsoleOutLoggerFactoryAdapter.CreateLogger(System.String,Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
  352. <summary>
  353. Creates a new <see cref="T:Common.Logging.Simple.ConsoleOutLogger"/> instance.
  354. </summary>
  355. </member>
  356. <member name="T:Common.Logging.Simple.TraceLogger">
  357. <summary>
  358. Logger sending everything to the trace output stream using <see cref="T:System.Diagnostics.Trace"/>.
  359. </summary>
  360. <remarks>
  361. Beware not to use <see cref="T:Common.Logging.Simple.CommonLoggingTraceListener"/> in combination with this logger as
  362. this would result in an endless loop for obvious reasons!
  363. </remarks>
  364. <seealso cref="P:Common.Logging.LogManager.Adapter"/>
  365. <seealso cref="T:Common.Logging.ConfigurationSectionHandler"/>
  366. <author>Gilles Bayon</author>
  367. <author>Erich Eichinger</author>
  368. </member>
  369. <member name="M:Common.Logging.Simple.TraceLogger.#ctor(System.Boolean,System.String,Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
  370. <summary>
  371. Creates a new TraceLogger instance.
  372. </summary>
  373. <param name="useTraceSource">whether to use <see cref="T:System.Diagnostics.TraceSource"/> or <see cref="T:System.Diagnostics.Trace"/> for logging.</param>
  374. <param name="logName">the name of this logger</param>
  375. <param name="logLevel">the default log level to use</param>
  376. <param name="showLevel">Include the current log level in the log message.</param>
  377. <param name="showDateTime">Include the current time in the log message.</param>
  378. <param name="showLogName">Include the instance name in the log message.</param>
  379. <param name="dateTimeFormat">The date and time format to use in the log message.</param>
  380. </member>
  381. <member name="M:Common.Logging.Simple.TraceLogger.IsLevelEnabled(Common.Logging.LogLevel)">
  382. <summary>
  383. Determines if the given log level is currently enabled.
  384. checks <see cref="P:System.Diagnostics.TraceSource.Switch"/> if <see cref="P:Common.Logging.Simple.TraceLoggerFactoryAdapter.UseTraceSource"/> is true.
  385. </summary>
  386. </member>
  387. <member name="M:Common.Logging.Simple.TraceLogger.WriteInternal(Common.Logging.LogLevel,System.Object,System.Exception)">
  388. <summary>
  389. Do the actual logging.
  390. </summary>
  391. <param name="level"></param>
  392. <param name="message"></param>
  393. <param name="e"></param>
  394. </member>
  395. <member name="M:Common.Logging.Simple.TraceLogger.OnDeserialization(System.Object)">
  396. <summary>
  397. Called after deserialization completed.
  398. </summary>
  399. </member>
  400. <member name="T:Common.Logging.Simple.TraceLogger.FormatOutputMessage">
  401. <summary>
  402. Used to defer message formatting until it is really needed.
  403. </summary>
  404. <remarks>
  405. This class also improves performance when multiple
  406. <see cref="T:System.Diagnostics.TraceListener"/>s are configured.
  407. </remarks>
  408. </member>
  409. <member name="T:Common.Logging.Simple.TraceLoggerFactoryAdapter">
  410. <summary>
  411. Factory for creating <see cref="T:Common.Logging.ILog"/> instances that send
  412. everything to the <see cref="T:System.Diagnostics.Trace"/> output stream.
  413. </summary>
  414. <remarks>
  415. Beware not to use <see cref="T:Common.Logging.Simple.CommonLoggingTraceListener"/> in combination with this logger factory
  416. as this would result in an endless loop for obvious reasons!
  417. <example>
  418. Below is an example how to configure this adapter:
  419. <code>
  420. &lt;configuration&gt;
  421. &lt;configSections&gt;
  422. &lt;sectionGroup name="common"&gt;
  423. &lt;section name="logging"
  424. type="Common.Logging.ConfigurationSectionHandler, Common.Logging"
  425. requirePermission="false" /&gt;
  426. &lt;/sectionGroup&gt;
  427. &lt;/configSections&gt;
  428. &lt;common&gt;
  429. &lt;logging&gt;
  430. &lt;factoryAdapter type="Common.Logging.Simple.TraceLoggerFactoryAdapter, Common.Logging"&gt;
  431. &lt;arg key="level" value="ALL" /&gt;
  432. &lt;/factoryAdapter&gt;
  433. &lt;/logging&gt;
  434. &lt;/common&gt;
  435. &lt;/configuration&gt;
  436. </code>
  437. </example>
  438. </remarks>
  439. <seealso cref="T:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter"/>
  440. <seealso cref="P:Common.Logging.LogManager.Adapter"/>
  441. <seealso cref="T:Common.Logging.ConfigurationSectionHandler"/>
  442. <author>Gilles Bayon</author>
  443. <author>Mark Pollack</author>
  444. <author>Erich Eichinger</author>
  445. </member>
  446. <member name="M:Common.Logging.Simple.TraceLoggerFactoryAdapter.#ctor">
  447. <summary>
  448. Initializes a new instance of the <see cref="T:Common.Logging.Simple.TraceLoggerFactoryAdapter"/> class using default settings.
  449. </summary>
  450. </member>
  451. <member name="M:Common.Logging.Simple.TraceLoggerFactoryAdapter.#ctor(Common.Logging.Configuration.NameValueCollection)">
  452. <summary>
  453. Initializes a new instance of the <see cref="T:Common.Logging.Simple.TraceLoggerFactoryAdapter"/> class.
  454. </summary>
  455. <remarks>
  456. Looks for level, showDateTime, showLogName, dateTimeFormat items from
  457. <paramref name="properties"/> for use when the GetLogger methods are called.
  458. <see cref="T:Common.Logging.ConfigurationSectionHandler"/> for more information on how to use the
  459. standard .NET application configuraiton file (App.config/Web.config)
  460. to configure this adapter.
  461. </remarks>
  462. <param name="properties">The name value collection, typically specified by the user in
  463. a configuration section named common/logging.</param>
  464. </member>
  465. <member name="M:Common.Logging.Simple.TraceLoggerFactoryAdapter.#ctor(Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String,System.Boolean)">
  466. <summary>
  467. Initializes a new instance of the <see cref="T:Common.Logging.Simple.AbstractSimpleLoggerFactoryAdapter"/> class with
  468. default settings for the loggers created by this factory.
  469. </summary>
  470. </member>
  471. <member name="M:Common.Logging.Simple.TraceLoggerFactoryAdapter.CreateLogger(System.String,Common.Logging.LogLevel,System.Boolean,System.Boolean,System.Boolean,System.String)">
  472. <summary>
  473. Creates a new <see cref="T:Common.Logging.Simple.TraceLogger"/> instance.
  474. </summary>
  475. </member>
  476. <member name="P:Common.Logging.Simple.TraceLoggerFactoryAdapter.UseTraceSource">
  477. <summary>
  478. Whether to use <see cref="T:System.Diagnostics.Trace"/>.<c>TraceXXXX(string,object[])</c> methods for logging
  479. or <see cref="T:System.Diagnostics.TraceSource"/>.
  480. </summary>
  481. </member>
  482. </members>
  483. </doc>