home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 October / CMCD1004.ISO / Software / Shareware / Programare / netxp / netxp.exe / Assembly / NETXP.Components.Extenders.xml < prev    next >
Encoding:
Extensible Markup Language  |  2004-08-19  |  11.3 KB  |  218 lines
  1. <?xml version="1.0"?>
  2. <doc>
  3.     <assembly>
  4.         <name>NETXP.Components.Extenders</name>
  5.     </assembly>
  6.     <members>
  7.         <member name="T:NETXP.Components.Extenders.MenuImageExtender">
  8.             <summary>
  9.             A custom extender class that adds an <c>Image</c>
  10.             attribute to <c>MenuItem</c> objects, and custom draws the menu.
  11.             </summary>
  12.             <remarks>
  13.             This extension was written to provide an simple way to link
  14.             icons with a menu, and owner draw the menu.
  15.             By using an extender, no custom coding is required.
  16.             </remarks>
  17.         </member>
  18.         <member name="F:NETXP.Components.Extenders.MenuImageExtender.IMAGE_BUFFER">
  19.             <summary>
  20.             Menu images should be 16 x 16
  21.             </summary>
  22.         </member>
  23.         <member name="F:NETXP.Components.Extenders.MenuImageExtender.m_hashTable">
  24.             <summary>
  25.             Hashtable is used to relate added <c>MenuItem</c> components
  26.             with each custom status messsage attribute value.
  27.             </summary>
  28.         </member>
  29.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.#ctor(System.ComponentModel.IContainer)">
  30.             <summary>
  31.             Constructor for instance that supports Class Composition designer.
  32.             </summary>
  33.             <param name="container">Reference to container hosting this instance.</param>
  34.         </member>
  35.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.#ctor">
  36.             <summary>
  37.             Creates the extender.
  38.             </summary>
  39.         </member>
  40.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.SetImage(System.ComponentModel.Component,System.Drawing.Image)">
  41.             <summary>
  42.             Used to set a Image property value for
  43.             a specific <c>MenuItem</c> component instance.
  44.             </summary>
  45.             <param name="component">The <c>MenuItem</c> object to store</param>
  46.             <param name="imageValue">The value to associate with the menu item</param>
  47.         </member>
  48.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.GetImage(System.ComponentModel.Component)">
  49.             <summary>
  50.             Used to retrieve the Image extender property value
  51.             for a given <c>MenuItem</c> component instance.
  52.             </summary>
  53.             <param name="component">The menu item instance associated with the value</param>
  54.             <returns>Returns the Image property value for the specified <c>MenuItem</c> component instance.</returns>
  55.         </member>
  56.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.CanExtend(System.Object)">
  57.             <summary>
  58.             Used to determine if the given component is supported by
  59.             the extender.
  60.             </summary>
  61.             <param name="component">component to evaluate for compatability</param>
  62.             <returns>Returns True/False if the component supports the extender.</returns>
  63.         </member>
  64.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.OnMeasureItem(System.Object,System.Windows.Forms.MeasureItemEventArgs)">
  65.             <summary>
  66.             Event triggered to measure the size of a owner drawn <c>MenuItem</c>.
  67.             <param name="sender">the menu item client object</param>
  68.             <param name="e">the event arguments</param>
  69.             </summary>
  70.         </member>
  71.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.OnDrawItem(System.Object,System.Windows.Forms.DrawItemEventArgs)">
  72.             <summary>
  73.             Event triggered to owner draw the provide <c>MenuItem</c>.
  74.             </summary>
  75.             <param name="sender">the menu item client object</param>
  76.             <param name="e">the event arguments</param>
  77.         </member>
  78.         <member name="T:NETXP.Components.Extenders.MenuImageExtender.MenuHelper">
  79.             <summary>
  80.             
  81.             </summary>
  82.             <remarks>
  83.             </remarks>
  84.         </member>
  85.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.MenuHelper.CalcHeight">
  86.             <summary>
  87.             Based on the menu item text, and the image size,
  88.             performs a calculation to determine the correct <c>MenuItem</c> height.
  89.             </summary>
  90.             <returns>Returns an <c>int</c> value that contains the calculated height of the menu item.</returns>
  91.         </member>
  92.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.MenuHelper.CalcWidth">
  93.             <summary>
  94.             Based on the menu item text, and the image size,
  95.             performs a calculation to determine the correct <c>MenuItem</c> width.
  96.             </summary>
  97.             <returns>Returns an <c>int</c> value that contains the calculated width of the menu item.</returns>
  98.         </member>
  99.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.MenuHelper.HasShortcut">
  100.             <summary>
  101.             A method to evaluate if the <c>MenuItem</c> has a shortcut selected, and the shortcut
  102.             has been selected for show.
  103.             </summary>
  104.             <returns>Returns True/False whether the menu has a shortcut to be displayed.</returns>
  105.         </member>
  106.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.MenuHelper.IsSeparator">
  107.             <summary>
  108.             Evaluates whether the <c>MenuItem</c> is a separator by evaluating the text.
  109.             </summary>
  110.             <returns>Returns True/False whether the menu is a separator.</returns>
  111.         </member>
  112.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.MenuHelper.IsTopLevel">
  113.             <summary>
  114.             Evaluates whether the <c>MenuItem</c> is a top-level menu that is sited directly
  115.             on a <c>MainMenu</c> control.
  116.             </summary>
  117.             <returns>Returns True/False if the menu item is a top-level menu.</returns>
  118.         </member>
  119.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.MenuHelper.DrawMenu(System.Drawing.Rectangle,System.Boolean,System.Drawing.Image)">
  120.             <summary>
  121.             Draws a normal menu item including any related icons, checkboxes,
  122.             menu text, shortcuts text, and parent/submenu arrows.
  123.             </summary>
  124.             <param name="bounds">a <c>Rectangle</c> that holds the drawing canvas boundaries</param>
  125.             <param name="selected">True/False if the menu item is currently selected</param>
  126.             <param name="image">the image of the menu icon to draw, defaults to null</param>
  127.         </member>
  128.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.MenuHelper.DrawBackground(System.Drawing.Rectangle,System.Boolean)">
  129.             <summary>
  130.             Draws the <c>MenuItem</c> background.
  131.             </summary>
  132.             <param name="bounds">a <c>Rectangle</c> that holds the painting canvas boundaries</param>
  133.             <param name="selected">True/False if the menu item is currently selected</param>
  134.         </member>
  135.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.MenuHelper.DrawSeparator(System.Drawing.Rectangle)">
  136.             <summary>
  137.             Draws a menu separator.
  138.             </summary>
  139.             <param name="bounds">a <c>Rectangle</c> that holds the drawing canvas boundaries</param>
  140.         </member>
  141.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.MenuHelper.DrawMenuText(System.Drawing.Rectangle,System.Boolean)">
  142.             <summary>
  143.             Draws the text for an ownerdrawn <c>MenuItem</c>.
  144.             </summary>
  145.             <param name="bounds">a <c>Rectangle</c> that holds the drawing area boundaries</param>
  146.             <param name="selected">True/False whether the menu item is currently selected</param>
  147.         </member>
  148.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.MenuHelper.DrawCheckBox(System.Drawing.Rectangle)">
  149.             <summary>
  150.             Draws a checked item next to a <c>MenuItem</c>.
  151.             </summary>
  152.             <param name="bounds">a <c>Rectangle</c> that identifies the drawing area boundaries</param>
  153.         </member>
  154.         <member name="M:NETXP.Components.Extenders.MenuImageExtender.MenuHelper.DrawImage(System.Drawing.Image,System.Drawing.Rectangle)">
  155.             <summary>
  156.             Draws a provided image onto the <c>MenuItem</c>.
  157.             </summary>
  158.             <param name="menuImage">an <c>Image</c> to paint on the menu</param>
  159.             <param name="bounds">a <c>Rectangle</c> that holds the drawing space boundaries</param>
  160.         </member>
  161.         <member name="P:NETXP.Components.Extenders.MenuImageExtender.MenuHelper.ShortcutText">
  162.             <summary>
  163.             Formats the <c>MenuItem</c> and returns the shortcut selection
  164.             as a displayable text string.
  165.             </summary>
  166.             <value>a string, the menu item shortcut as text</value>
  167.         </member>
  168.         <member name="T:NETXP.Components.Extenders.StatusMessages">
  169.             <summary>
  170.             Implements an extender for menu item status messages (typically for CommandBar items)
  171.             </summary>
  172.         </member>
  173.         <member name="M:NETXP.Components.Extenders.StatusMessages.#ctor(System.ComponentModel.IContainer)">
  174.             <summary>
  175.             Creates a new StatusMessages extender for the specified container.
  176.             </summary>
  177.             <param name="container">The container</param>
  178.         </member>
  179.         <member name="M:NETXP.Components.Extenders.StatusMessages.#ctor">
  180.             <summary>
  181.             Creates a new StatusMessages extender.
  182.             </summary>
  183.         </member>
  184.         <member name="M:NETXP.Components.Extenders.StatusMessages.SetStatusMessage(System.ComponentModel.Component,System.String)">
  185.             <summary>
  186.             Sets the status message.
  187.             </summary>
  188.             <param name="component">The component to associate with the value.</param>
  189.             <param name="value">The string value pertaining to the status message.</param>
  190.         </member>
  191.         <member name="M:NETXP.Components.Extenders.StatusMessages.GetStatusMessage(System.ComponentModel.Component)">
  192.             <summary>
  193.             Retrieves the status message.
  194.             </summary>
  195.             <param name="component">The component to associate with the value.</param>
  196.             <returns>The string value pertaining to the status message.</returns>
  197.         </member>
  198.         <member name="M:NETXP.Components.Extenders.StatusMessages.GetStatusBar">
  199.             <summary>
  200.             Retrieves the status bar that displays the status messages.
  201.             </summary>
  202.             <returns>The status bar.</returns>
  203.         </member>
  204.         <member name="M:NETXP.Components.Extenders.StatusMessages.CanExtend(System.Object)">
  205.             <summary>
  206.             Can the component be extended?
  207.             </summary>
  208.             <param name="component">The component to check.</param>
  209.             <returns>True if it can be extended.</returns>
  210.         </member>
  211.         <member name="P:NETXP.Components.Extenders.StatusMessages.StatusBar">
  212.             <summary>
  213.             The status bar displaying the status messages.
  214.             </summary>
  215.         </member>
  216.     </members>
  217. </doc>
  218.