sdk/samples/msdn/Attributes/Misc/AttributeSample.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>AttributeUser</name>
   5     </assembly>
   6     <members>
   7         <member name="T:AttributeUser.ItemProcessor">
   8             <summary>
   9             The ItemProcessor class uses the custom attribute defined in the TraceLibrary
  10             project to provide trace output services to the class based on the trace
  11             level defined in the application configuration file.
  12             </summary>
  13         </member>
  14         <member name="M:AttributeUser.ItemProcessor.ProcessItem(System.String,System.Int32@)">
  15             <summary>
  16             This method simulates calls to process various items and is used to
  17             demonstrate the TraceAttribute's functionality.  Infrequently, this
  18             method will throw exceptions, and at other times will supply additional
  19             trace output in the form of Warning and Verbose messages.
  20             </summary>
  21             <remarks>
  22             Note that even if this class remained unaware that the TraceOutput object
  23             was available through the call context, the TraceAttribute would still
  24             provide tracing functionality.
  25             </remarks>
  26             <param name="itemName">The name of the item to be processed</param>
  27             <param name="total">A "ref" parameter whose value is shown (before and after the call) in the trace output</param>
  28             <returns>A new string based on the item name and the wait time generated within the method</returns>
  29         </member>
  30         <member name="T:AttributeUser.MainForm">
  31             <summary>
  32             The MainForm class provides the client interface for this sample.
  33             </summary>
  34         </member>
  35         <member name="F:AttributeUser.MainForm.components">
  36             <summary>
  37             Required designer variable.
  38             </summary>
  39         </member>
  40         <member name="M:AttributeUser.MainForm.#ctor">
  41             <summary>
  42             Creates a new instance of the main form.
  43             </summary>
  44         </member>
  45         <member name="M:AttributeUser.MainForm.Dispose(System.Boolean)">
  46             <summary>
  47             Clean up any resources being used.
  48             </summary>
  49         </member>
  50         <member name="M:AttributeUser.MainForm.InitializeComponent">
  51             <summary>
  52             Required method for Designer support - do not modify
  53             the contents of this method with the code editor.
  54             </summary>
  55         </member>
  56         <member name="M:AttributeUser.MainForm.Main">
  57             <summary>
  58             The main entry point for the application.
  59             </summary>
  60         </member>
  61         <member name="M:AttributeUser.MainForm.ItemNameTextBox_TextChanged(System.Object,System.EventArgs)">
  62             <summary>
  63             This method enables the Add button if the text box contains any non-empty
  64             data, or disables the Add button otherwise.
  65             </summary>
  66             <param name="sender"></param>
  67             <param name="e"></param>
  68         </member>
  69         <member name="M:AttributeUser.MainForm.AddItemButton_Click(System.Object,System.EventArgs)">
  70             <summary>
  71             This method adds the entry in the item name text box to the list of
  72             items to be processed.
  73             </summary>
  74             <param name="sender"></param>
  75             <param name="e"></param>
  76         </member>
  77         <member name="M:AttributeUser.MainForm.ProcessItemsButton_Click(System.Object,System.EventArgs)">
  78             <summary>
  79             This method loops through the list of items to be processed and calls
  80             the ItemProcessor's ProcessItem method for each, handling any
  81             exception that may have been generated.
  82             </summary>
  83             <param name="sender"></param>
  84             <param name="e"></param>
  85         </member>
  86     </members>
  87 </doc>