home *** CD-ROM | disk | FTP | other *** search
/ PC Pro 2005 June (DVD) / DPPRO0605DVD.iso / Install / System32 / VCLX90.XML < prev    next >
Encoding:
Extensible Markup Language  |  2004-10-22  |  376.0 KB  |  6,177 lines
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <doc>
  3.    <assembly>vclx</assembly>
  4.    <members>
  5.       <member name="T:CheckLst.TCheckListBox">
  6.          <summary>
  7.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  8.                
  9.                <class namespace="CheckLst">TCheckListBox</class> displays a scrollable list with check boxes next to each item.</para>
  10.          </summary>
  11.          <comments>
  12.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  13.                
  14.                <class namespace="CheckLst">TCheckListBox</class> is similar to TListBox, except that each item has a check box next to it. Users can check or uncheck items in the list.</para>
  15.          </comments>
  16.       </member>
  17.       <member name="M:CheckLst.CheckLst.Destroy">
  18.          <summary>
  19.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  20.                      
  21.                <method namespace="CheckLst" class="TCheckListBox">Destroy</method>s the <method namespace="CheckLst" class="TCheckListBox">TCheckListBox</method> instance and frees its memory.</para>
  22.          </summary>
  23.          <comments>
  24.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="CheckLst" class="TCheckListBox">Destroy</method> directly in an application. Call Free instead. Free verifies that the check list box is not nil before it calls <method namespace="CheckLst" class="TCheckListBox">Destroy</method>.</para>
  25.          </comments>
  26.       </member>
  27.       <member name="P:CheckLst.CheckLst.Checked">
  28.          <summary>
  29.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates which items are checked.</para>
  30.          </summary>
  31.          <comments>
  32.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For each member of the Items array, <property namespace="CheckLst" class="TCheckListBox">Checked</property> is true if a check mark appears in the item's check box. <property namespace="CheckLst" class="TCheckListBox">Checked</property> corresponds to the cb<property namespace="CheckLst" class="TCheckListBox">Checked</property> state; that is, <property namespace="CheckLst" class="TCheckListBox">Checked</property> is true when State = cb<property namespace="CheckLst" class="TCheckListBox">Checked</property> and false when State = cbUnchecked or State = cbGrayed.</para>
  33.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  34.                      
  35.                <para>Items that have been disabled using the ItemEnabled property may still have a state of cb<property namespace="CheckLst" class="TCheckListBox">Checked</property> and a <property namespace="CheckLst" class="TCheckListBox">Checked</property> property of true.</para>
  36.                   
  37.             </note>
  38.          </comments>
  39.       </member>
  40.       <member name="P:CheckLst.CheckLst.ItemEnabled">
  41.          <summary>
  42.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Enables or disables individual items in the list.</para>
  43.          </summary>
  44.          <comments>
  45.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="CheckLst" class="TCheckListBox">ItemEnabled</property> to enable or disable individual list items without using the cbGrayed state. Using <property namespace="CheckLst" class="TCheckListBox">ItemEnabled</property> allows the list box to display check marks for items with a state of cbChecked while still graying the item and preventing the user from changing its state.</para>
  46.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For each member of the Items array, <property namespace="CheckLst" class="TCheckListBox">ItemEnabled</property> is true if the user can change the state of the item. Enabled items have a state of cbChecked or cbUnchecked. </para>
  47.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  48.                      
  49.                <property namespace="CheckLst" class="TCheckListBox">ItemEnabled</property> is false when State =cbGrayed or when the item has been explicitly disabled using this property.</para>
  50.          </comments>
  51.       </member>
  52.       <member name="P:CheckLst.CheckLst.State">
  53.          <summary>
  54.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates which items are checked.</para>
  55.          </summary>
  56.          <comments>
  57.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For each member of the Items array, <property namespace="CheckLst" class="TCheckListBox">State</property> indicates whether its check box is selected (cbChecked), deselected (cbUnchecked), or grayed (cbGrayed).</para>
  58.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  59.                      
  60.                <property namespace="CheckLst" class="TCheckListBox">State</property> combines the information provided by the Boolean Checked property and the Boolean ItemEnabled property:</para>
  61.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> When Checked is true, <property namespace="CheckLst" class="TCheckListBox">State</property> is cbChecked. (However, when Checked is false, <property namespace="CheckLst" class="TCheckListBox">State</property> may be either cbUnchecked or cbGrayed.)</para>
  62.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="CheckLst" class="TCheckListBox">State</property> is cbGrayed, ItemEnabled is false. (However, ItemEnabled may also be false when <property namespace="CheckLst" class="TCheckListBox">State</property> is cbUnchecked or cbChecked.)</para>
  63.          </comments>
  64.       </member>
  65.       <member name="P:CheckLst.CheckLst.Header">
  66.          <summary>
  67.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates which items act as headers.</para>
  68.          </summary>
  69.          <comments>
  70.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="CheckLst" class="TCheckListBox">Header</property> to true to specify that an item in the check listbox acts as a header rather than a selectable item. By setting <property namespace="CheckLst" class="TCheckListBox">Header</property> to true for various items in the list, you can divide the check listbox into multiple sections, where each header labels the beginning of a section.</para>
  71.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="CheckLst" class="TCheckListBox">Header</property> is true for an item, the list box does not display a check box next to the item, but rather, it displays only the item's text. This item is drawn with a background color of <property namespace="CheckLst" class="TCheckListBox">Header</property>BackgroundColor and a font color of <property namespace="CheckLst" class="TCheckListBox">Header</property>Color, which can be used to make it visually distinct from the checkable items in the list box.</para>
  72.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index is the index of the item.</para>
  73.          </comments>
  74.       </member>
  75.       <member name="P:CheckLst.CheckLst.AllowGrayed">
  76.          <summary>
  77.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether check box can be in a "grayed" state.</para>
  78.          </summary>
  79.          <comments>
  80.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <property namespace="CheckLst" class="TCheckListBox">AllowGrayed</property> is set to true, each item has three possible states: checked, unchecked, and grayed. If <property namespace="CheckLst" class="TCheckListBox">AllowGrayed</property> is set to false, each item has only two possible states: checked and unchecked.</para>
  81.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  82.                      
  83.                <para>It is also possible to disable individual items while still showing whether they are checked or unchecked. To disable items without using the grayed state, use the ItemEnabled property.</para>
  84.                   
  85.             </note>
  86.          </comments>
  87.       </member>
  88.       <member name="P:CheckLst.CheckLst.Flat">
  89.          <summary>
  90.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether the check boxes appear three-dimensional.</para>
  91.          </summary>
  92.          <comments>
  93.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When <property namespace="CheckLst" class="TCheckListBox">Flat</property> is true (the default), the check boxes in the list box have flat borders. Setting <property namespace="CheckLst" class="TCheckListBox">Flat</property> to false gives the check boxes raised borders, which create a three-dimensional look.</para>
  94.          </comments>
  95.       </member>
  96.       <member name="P:CheckLst.CheckLst.HeaderColor">
  97.          <summary>
  98.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the font color for a header item in the list box.</para>
  99.          </summary>
  100.          <comments>
  101.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="CheckLst" class="TCheckListBox">HeaderColor</property> to indicate the font color of header items. Header items are items in the list box for which the Header property is true. <property namespace="CheckLst" class="TCheckListBox">HeaderColor</property> should be a color that provides contrast with the HeaderBackgroundColor property, which specifies the background color for header items.</para>
  102.          </comments>
  103.       </member>
  104.       <member name="P:CheckLst.CheckLst.HeaderBackgroundColor">
  105.          <summary>
  106.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the background color for a header item in the listbox.</para>
  107.          </summary>
  108.          <comments>
  109.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="CheckLst" class="TCheckListBox">HeaderBackgroundColor</property> to indicate the color that appears as the background of header items. Header items are items in the list box for which the Header property is true. <property namespace="CheckLst" class="TCheckListBox">HeaderBackgroundColor</property> can make a header item visually more distinct from the checkable items in the list box.</para>
  110.          </comments>
  111.       </member>
  112.       <member name="E:CheckLst.CheckLst.OnClickCheck">
  113.          <summary>
  114.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the user selects or deselects an item's check box.</para>
  115.          </summary>
  116.          <comments>
  117.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="CheckLst" class="TCheckListBox">OnClickCheck</event> event handler to implement any special processing that should occur when the user checks or unchecks an item.</para>
  118.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  119.                      
  120.                <para>This event does not occur for items that are grayed (State=cbGrayed) or disabled (ItemEnabled=false).</para>
  121.                   
  122.             </note>
  123.          </comments>
  124.       </member>
  125.       <member name="T:Outline.OutlineError">
  126.          <summary>
  127.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  128.                
  129.                <class namespace="Outline">OutlineError</class> is a special exception class for invalid outline-node indexes.</para>
  130.          </summary>
  131.          <comments>
  132.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  133.                
  134.                <class namespace="Outline">OutlineError</class> is raised when an application cannot access a specified outline node. In most cases, this occurs because the index used is invalid.</para>
  135.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  136.                
  137.                <class namespace="Outline">OutlineError</class> is raised internally to abort look-ups of outline components. Because it does not descend from Exception, it never appears at runtimeΓÇöeven if the debugger is set to break on exceptions. Thus it is a useful tool for aborting deep recursions.</para>
  138.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  139.                
  140.                <para>
  141.                   
  142.                   <class namespace="Outline">OutlineError</class> is raised by the TOutline component, which is maintained for backward compatibility.</para>
  143.             
  144.             </note>
  145.          </comments>
  146.       </member>
  147.       <member name="T:Outline.EOutlineError">
  148.          <summary>
  149.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  150.                
  151.                <class namespace="outline">EOutlineError</class> is the exception class for outline components.</para>
  152.          </summary>
  153.          <comments>
  154.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  155.                
  156.                <class namespace="outline">EOutlineError</class> is raised when an error occurs as an application works with an outline component. For example, an <class namespace="outline">EOutlineError</class> exception occurs when an application</para>
  157.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Attempts to access an outline using an invalid node index.</para>
  158.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Attempts to expand a node whose parent isn't expanded.</para>
  159.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Attempts to load items from a file using an invalid file extension.</para>
  160.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  161.                
  162.                <para>
  163.                   
  164.                   <class namespace="outline">EOutlineError</class> is raised by the TOutline component, which is maintained for backward compatibility.</para>
  165.             
  166.             </note>
  167.          </comments>
  168.       </member>
  169.       <member name="T:Outline.TAttachMode">
  170.          <summary>
  171.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  172.                
  173.                <condition os="Windows">
  174.                   
  175.                   <type namespace="OleAuto">TAttachMode</type> indicates how an outline node should be inserted into an outline.</condition>
  176.             
  177.             </para>
  178.          </summary>
  179.          <comments>
  180.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  181.                
  182.                <condition os="Windows">
  183.                   
  184.                   <type namespace="OleAuto">TAttachMode</type> is used by methods that move outline nodes within an outline. It includes the following values:</condition>
  185.             
  186.             </para>
  187.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  188.                
  189.                <tr>
  190.                   
  191.                   <th>Value</th>
  192.                   
  193.                   <th>Description</th>
  194.                
  195.                </tr>
  196.                
  197.                <tr>
  198.                   
  199.                   <td>
  200.                      
  201.                      <para>oaAdd</para>
  202.                   
  203.                   </td>
  204.                   
  205.                   <td>
  206.                      
  207.                      <para>The item is attached as if added with the Add method. The moved item becomes the last sibling of the item specified by the Destination parameter, sharing the same parent as the Destination item.</para>
  208.                   
  209.                   </td>
  210.                
  211.                </tr>
  212.                
  213.                <tr>
  214.                   
  215.                   <td>
  216.                      
  217.                      <para>oaAddChild</para>
  218.                   
  219.                   </td>
  220.                   
  221.                   <td>
  222.                      
  223.                      <para>The item is attached as if added with the AddChild method. The moved item becomes the last child of the item specified by the Destination parameter. The Destination item becomes the parent of the moved item.</para>
  224.                   
  225.                   </td>
  226.                
  227.                </tr>
  228.                
  229.                <tr>
  230.                   
  231.                   <td>
  232.                      
  233.                      <para>oaInsert</para>
  234.                   
  235.                   </td>
  236.                   
  237.                   <td>
  238.                      
  239.                      <para>The item is attached as if inserted with the Insert method. The moved item replaces the Destination item in the outline, while the Destination item and all other following items are moved down one row.</para>
  240.                   
  241.                   </td>
  242.                
  243.                </tr>
  244.             
  245.             </table>
  246.          </comments>
  247.       </member>
  248.       <member name="T:Outline.TOutlineNode">
  249.          <summary>
  250.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  251.                
  252.                <class namespace="outline">TOutlineNode</class> represents a node in a TCustomOutline object. </para>
  253.          </summary>
  254.          <comments>
  255.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="outline">TOutlineNode</class> to describe a node in a Win 3.1 outline. Each outline node appears as a line, or row, of the outline. An outline node can have from 0 to 16368 subnodes, which are subordinate to the parent node in the outline structure.</para>
  256.          </comments>
  257.       </member>
  258.       <member name="M:Outline.Outline.GetDisplayWidth">
  259.          <summary>
  260.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the distance, in pixels, from the left edge of the outline to the right edge of the outline node.</para>
  261.          </summary>
  262.          <comments>
  263.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="outline" class="TOutlineNode">GetDisplayWidth</method> to determine the length of the line in the outline that contains the outline node. <method namespace="outline" class="TOutlineNode">GetDisplayWidth</method> adjusts for the lines and bitmaps specified by the OutlineStyle property of the outline.</para>
  264.          </comments>
  265.       </member>
  266.       <member name="M:Outline.Outline.getFirstChild">
  267.          <summary>
  268.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the Index value of the first subnode.</para>
  269.          </summary>
  270.          <comments>
  271.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="outline" class="TOutlineNode">GetFirstChild</method> to locate the first subnode of a node when traversing the outline tree. If the node has no descendants, <method namespace="outline" class="TOutlineNode">GetFirstChild</method> returns -1.</para>
  272.          </comments>
  273.       </member>
  274.       <member name="M:Outline.Outline.GetLastChild">
  275.          <summary>
  276.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the Index value of the last subnode.</para>
  277.          </summary>
  278.          <comments>
  279.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="outline" class="TOutlineNode">GetLastChild</method> to locate the last subnode of a node. If the node has no descendants, <method namespace="outline" class="TOutlineNode">GetLastChild</method> returns -1.</para>
  280.          </comments>
  281.       </member>
  282.       <member name="M:Outline.Outline.GetNextChild">
  283.          <summary>
  284.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the Index value of the next child of an outline node.</para>
  285.          </summary>
  286.          <comments>
  287.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="outline" class="TOutlineNode">GetNextChild</method> to obtain the index of the next immediate descendant of a node, following the child node with the index given by the Value parameter. If the child node indicated by Value has no next sibling, or if the child node indicated by Value is not an immediate descendant of the outline node, <method namespace="outline" class="TOutlineNode">GetNextChild</method> returns -1.</para>
  288.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index values reflect a depth-first traversal of the outline. Thus, the node returned by <method namespace="outline" class="TOutlineNode">GetNextChild</method> is not simply the node with an index of Value+1, unless the node with index Value has no descendants. <method namespace="outline" class="TOutlineNode">GetNextChild</method> allows a breadth-first traversal of the outline. </para>
  289.          </comments>
  290.       </member>
  291.       <member name="M:Outline.Outline.GetPrevChild">
  292.          <summary>
  293.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the Index value of the previous child of an outline node.</para>
  294.          </summary>
  295.          <comments>
  296.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="outline" class="TOutlineNode">GetPrevChild</method> to obtain the index of the previous immediate descendant of a node, preceding the child node with the index given by the Value parameter. If the child node indicated by Value has no prior sibling, or if the child node indicated by Value is not an immediate descendant of the outline node, <method namespace="outline" class="TOutlineNode">GetPrevChild</method> returns -1.</para>
  297.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index values reflect a depth-first traversal of the outline. Thus, the previous sibling of the child node indicated by Value is not simply one less than Value, unless that previous sibling has no descendants. </para>
  298.          </comments>
  299.       </member>
  300.       <member name="M:Outline.Outline.Create">
  301.          <summary>
  302.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  303.                      
  304.                <method namespace="outline" class="TOutlineNode">Create</method>s a new <method namespace="outline" class="TOutlineNode">TOutlineNode</method> object.</para>
  305.          </summary>
  306.          <comments>
  307.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call the constructor for <method namespace="outline" class="TOutlineNode">TOutlineNode</method> directly. Instead, use one of the methods of the outline component in which the node should appear. These methods are as follows:</para>
  308.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  309.                      
  310.                <tr>
  311.                         
  312.                   <th>Method</th>
  313.                         
  314.                   <th>Action</th>
  315.                      
  316.                </tr>
  317.                      
  318.                <tr>
  319.                         
  320.                   <td>
  321.                            
  322.                      <para>Add</para>
  323.                         
  324.                   </td>
  325.                         
  326.                   <td>
  327.                            
  328.                      <para>Creates the node as the last sibling of a specified node.</para>
  329.                         
  330.                   </td>
  331.                      
  332.                </tr>
  333.                      
  334.                <tr>
  335.                         
  336.                   <td>
  337.                            
  338.                      <para>AddObject</para>
  339.                         
  340.                   </td>
  341.                         
  342.                   <td>
  343.                            
  344.                      <para>Same as Add, but also initializing the node's Data property.</para>
  345.                         
  346.                   </td>
  347.                      
  348.                </tr>
  349.                      
  350.                <tr>
  351.                         
  352.                   <td>
  353.                            
  354.                      <para>AddChild</para>
  355.                         
  356.                   </td>
  357.                         
  358.                   <td>
  359.                            
  360.                      <para>Creates the node as the last child of a specified node.</para>
  361.                         
  362.                   </td>
  363.                      
  364.                </tr>
  365.                      
  366.                <tr>
  367.                         
  368.                   <td>
  369.                            
  370.                      <para>AddChildObject</para>
  371.                         
  372.                   </td>
  373.                         
  374.                   <td>
  375.                            
  376.                      <para>Same as AddChild, but also initializing the node's Data property.</para>
  377.                         
  378.                   </td>
  379.                      
  380.                </tr>
  381.                      
  382.                <tr>
  383.                         
  384.                   <td>
  385.                            
  386.                      <para>Insert</para>
  387.                         
  388.                   </td>
  389.                         
  390.                   <td>
  391.                            
  392.                      <para>Creates the node in the current position of an existing node.</para>
  393.                         
  394.                   </td>
  395.                      
  396.                </tr>
  397.                      
  398.                <tr>
  399.                         
  400.                   <td>
  401.                            
  402.                      <para>InsertObject</para>
  403.                         
  404.                   </td>
  405.                         
  406.                   <td>
  407.                            
  408.                      <para>Same as Insert, but also initializing the node's Data property.</para>
  409.                         
  410.                   </td>
  411.                      
  412.                </tr>
  413.                   
  414.             </table>
  415.          </comments>
  416.       </member>
  417.       <member name="M:Outline.Outline.ChangeLevelBy">
  418.          <summary>
  419.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Changes the level of an outline node.</para>
  420.          </summary>
  421.          <comments>
  422.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="outline" class="TOutlineNode">ChangeLevelBy</method> to move a node up or down a branch in the outline. Specify a Value parameter value of -1 to move up (toward the root) one level. Specify a Value parameter value of 1 to move down (away from the root) one level.</para>
  423.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When moving up one level, an item becomes the next sibling of its former parent. When moving down one level, an item becomes the last child of its former prior sibling. </para>
  424.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Nodes at the first level can not be moved up, as they have no parent. The first node in the outline can not be moved down either, as it has no prior sibling.</para>
  425.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  426.                      
  427.                <para>Before calling <method namespace="outline" class="TOutlineNode">ChangeLevelBy</method>, be sure that the node has the appropriate number of parents or that the appropriate prior siblings exist.</para>
  428.                   
  429.             </note>
  430.          </comments>
  431.       </member>
  432.       <member name="M:Outline.Outline.Collapse">
  433.          <summary>
  434.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  435.                      
  436.                <method namespace="outline" class="TOutlineNode">Collapse</method>s an outline item.</para>
  437.          </summary>
  438.          <comments>
  439.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  440.                      
  441.                <method namespace="outline" class="TOutlineNode">Collapse</method> sets the Expanded property to false. When an outline node is collapsed, its descendants are hidden and, depending on the OutlineStyle property of the outline in which the node is contained, the plus picture or closed picture is displayed.</para>
  442.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  443.                      
  444.                <method namespace="outline" class="TOutlineNode">Collapse</method> does nothing to nodes that have no descendants.</para>
  445.          </comments>
  446.       </member>
  447.       <member name="M:Outline.Outline.Expand">
  448.          <summary>
  449.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  450.                      
  451.                <method namespace="outline" class="TOutlineNode">Expand</method>s an outline item.</para>
  452.          </summary>
  453.          <comments>
  454.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  455.                      
  456.                <method namespace="outline" class="TOutlineNode">Expand</method> sets the <method namespace="outline" class="TOutlineNode">Expand</method>ed property to true. When an outline node is expanded, its descendants are displayed and, depending on the OutlineStyle property of the outline in which the node is contained, the minus picture or open picture is displayed.</para>
  457.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  458.                      
  459.                <method namespace="outline" class="TOutlineNode">Expand</method> does nothing to nodes that have no descendants.</para>
  460.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  461.                      
  462.                <para>
  463.                         
  464.                   <method namespace="outline" class="TOutlineNode">Expand</method> only ensures that the immediate children of a node are visible. To expand all descendants of a node, use the Full<method namespace="outline" class="TOutlineNode">Expand</method> method.</para>
  465.                   
  466.             </note>
  467.          </comments>
  468.       </member>
  469.       <member name="M:Outline.Outline.FullExpand">
  470.          <summary>
  471.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Expands an outline node and all its descendants.</para>
  472.          </summary>
  473.          <comments>
  474.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="outline" class="TOutlineNode">FullExpand</method> to expand all the nodes in the subtree of the outline rooted at the outline node. <method namespace="outline" class="TOutlineNode">FullExpand</method> sets the Expanded property of the node and all its descendants to true.</para>
  475.          </comments>
  476.       </member>
  477.       <member name="M:Outline.Outline.MoveTo">
  478.          <summary>
  479.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Moves an outline node from one location within the outline to another. </para>
  480.          </summary>
  481.          <comments>
  482.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="outline" class="TOutlineNode">MoveTo</method> to reposition the node to the position indicated by the Destination parameter. Destination is the Index value of another outline node. The AttachMode parameter specifies how to attach the moved node to the destination position.</para>
  483.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  484.                      
  485.                <para>To change only the level of a node, use the ChangeLevelBy method.</para>
  486.                   
  487.             </note>
  488.          </comments>
  489.       </member>
  490.       <member name="M:Outline.Outline.Destroy">
  491.          <summary>
  492.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Frees the memory associated with the <method namespace="outline" class="TOutlineNode">TOutlineNode</method> object. </para>
  493.          </summary>
  494.          <comments>
  495.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="outline" class="TOutlineNode">Destroy</method> directly. The preferred method of deleting nodes is to use the Delete method of the containing outline component.</para>
  496.          </comments>
  497.       </member>
  498.       <member name="P:Outline.Outline.Parent">
  499.          <summary>
  500.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Identifies the immediate ancestor of the node.</para>
  501.          </summary>
  502.          <comments>
  503.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="outline" class="TOutlineNode">Parent</property> to find the parent of an outline node. A parent node is one level higher and contains the child node as a subnode.</para>
  504.          </comments>
  505.       </member>
  506.       <member name="P:Outline.Outline.Expanded">
  507.          <summary>
  508.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether descendants of the outline node are displayed.</para>
  509.          </summary>
  510.          <comments>
  511.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="outline" class="TOutlineNode">Expanded</property> to true to display all subnodes of a node. When an outline node is expanded, its descendants are displayed and, depending on the OutlineStyle property of the outline in which the node is contained, the minus picture or open picture is displayed.</para>
  512.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="outline" class="TOutlineNode">Expanded</property> to false to collapse the node. When an outline node is collapsed, its descendants are hidden and, depending on the OutlineStyle property of the outline in which the node is contained, the plus picture or closed picture is displayed.</para>
  513.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  514.                      
  515.                <property namespace="outline" class="TOutlineNode">Expanded</property> is not meaningful for nodes that have no descendants.</para>
  516.          </comments>
  517.       </member>
  518.       <member name="P:Outline.Outline.Text">
  519.          <summary>
  520.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the string that identifies the outline node.</para>
  521.          </summary>
  522.          <comments>
  523.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="outline" class="TOutlineNode">Text</property> to determine the string that is displayed in the outline to represent the node. </para>
  524.          </comments>
  525.       </member>
  526.       <member name="P:Outline.Outline.Data">
  527.          <summary>
  528.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Points to application-specific data associated with the node.</para>
  529.          </summary>
  530.          <comments>
  531.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="outline" class="TOutlineNode">Data</property> to associate an arbitrary value with a node in an outline. For example, if the outline represents the table of contents to an electronic document, <property namespace="outline" class="TOutlineNode">Data</property> could point to an object that provides jump information for accessing the section of the document named by the node.</para>
  532.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <property namespace="outline" class="TOutlineNode">Data</property> property is usually described by the Text property, which is displayed in the rendered image of the node.</para>
  533.          </comments>
  534.       </member>
  535.       <member name="P:Outline.Outline.Index">
  536.          <summary>
  537.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Identifies the node in the Items array maintained by the outline.</para>
  538.          </summary>
  539.          <comments>
  540.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="outline" class="TOutlineNode">Index</property> to determine the row of the outline where the node appears. The first node has an <property namespace="outline" class="TOutlineNode">Index</property> value of 1, and subsequent nodes are indexed sequentially. If a node has subnodes, the <property namespace="outline" class="TOutlineNode">Index</property> value of the parent node is one less than the <property namespace="outline" class="TOutlineNode">Index</property> value of its first descendant.</para>
  541.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When nodes in the outline are added, moved, or deleted, the values of the <property namespace="outline" class="TOutlineNode">Index</property> properties of all subsequent nodes must be recalculated to be valid. Sometimes, the recalculation of indexes is deferred until all changes to the nodes are complete. To ensure that the value of <property namespace="outline" class="TOutlineNode">Index</property> is valid, call the SetUpdateState method of the outline that contains the node.</para>
  542.          </comments>
  543.       </member>
  544.       <member name="P:Outline.Outline.Level">
  545.          <summary>
  546.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the level of indentation of a node within the outline.</para>
  547.          </summary>
  548.          <comments>
  549.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="outline" class="TOutlineNode">Level</property> is 1 for nodes that directly descend from the root of the outline (the top level). The value of <property namespace="outline" class="TOutlineNode">Level</property> is 2 for their children, and so on.</para>
  550.          </comments>
  551.       </member>
  552.       <member name="P:Outline.Outline.HasItems">
  553.          <summary>
  554.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the outline node has any subnodes. </para>
  555.          </summary>
  556.          <comments>
  557.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read HasItem to determine whether the outline node is a leaf node. Depending on the OutlineStyle property of the outline that contains the node, leaf nodes may appear with the leaf bitmap. If the node is not a leaf, subnodes appear below and indented from the node when it is expanded.</para>
  558.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">HasItem returns true if the node has any descendants, even if the node is collapsed and the descendants are not visible. HasItem returns false if the node is a leaf node.</para>
  559.          </comments>
  560.       </member>
  561.       <member name="P:Outline.Outline.IsVisible">
  562.          <summary>
  563.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the outline node is visible in the outline.</para>
  564.          </summary>
  565.          <comments>
  566.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="outline" class="TOutlineNode">IsVisible</property> to determine whether the node is part of the current image of the outline. A node is visible if it is on level 1 or if all its parents are expanded. </para>
  567.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  568.                      
  569.                <para>Do not confuse <property namespace="outline" class="TOutlineNode">IsVisible</property> with the Visible property of TControl objects. Outline nodes are not controls, but merely helper objects that describe nodes for an outline control. <property namespace="outline" class="TOutlineNode">IsVisible</property> indicates whether a node is visible because its parents are expanded or collapsed. It does not provide information about whether the node has been scrolled out of view, or even if the outline is not visible.</para>
  570.                   
  571.             </note>
  572.          </comments>
  573.       </member>
  574.       <member name="P:Outline.Outline.TopItem">
  575.          <summary>
  576.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates which outline node is the topmost ancestor of a node.</para>
  577.          </summary>
  578.          <comments>
  579.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="outline" class="TOutlineNode">TopItem</property> to determine the first node in the branch of the outline tree that contains the outline node. The <property namespace="outline" class="TOutlineNode">TopItem</property> property specifies the Index value of the level 1 ancestor of the outline node. For a node on level 1, <property namespace="outline" class="TOutlineNode">TopItem</property> has the same value as the Index property.</para>
  580.          </comments>
  581.       </member>
  582.       <member name="P:Outline.Outline.FullPath">
  583.          <summary>
  584.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Describes an outline node, using its text and the text of all ancestor nodes in the outline.</para>
  585.          </summary>
  586.          <comments>
  587.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="outline" class="TOutlineNode">FullPath</property> to obtain a description of the entire branch of the outline leading to the outline node. <property namespace="outline" class="TOutlineNode">FullPath</property> consists of the values of the Text properties of all outline items, starting with the text of the node at the first level and traversing the outline down to the outline node. The string specified as the ItemSeparator property of the outline separates the text for each node in the path.</para>
  588.          </comments>
  589.       </member>
  590.       <member name="T:Outline.TOutlineStyle">
  591.          <summary>
  592.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  593.                
  594.                <condition os="Windows">
  595.                   
  596.                   <type namespace="OleAuto">TOutlineStyle</type> determines how the nodes of an outline are drawn.</condition>
  597.             
  598.             </para>
  599.          </summary>
  600.          <comments>
  601.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  602.                
  603.                <condition os="Windows">
  604.                   
  605.                   <type namespace="OleAuto">TOutlineStyle</type> is the type of TCustomOutline.::OutlineStyle. It includes the following values:</condition>
  606.             
  607.             </para>
  608.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  609.                
  610.                <tr>
  611.                   
  612.                   <th>Value</th>
  613.                   
  614.                   <th>Meaning</th>
  615.                
  616.                </tr>
  617.                
  618.                <tr>
  619.                   
  620.                   <td>
  621.                      
  622.                      <para>osText</para>
  623.                   
  624.                   </td>
  625.                   
  626.                   <td>
  627.                      
  628.                      <para>Only the text of nodes is drawn.</para>
  629.                   
  630.                   </td>
  631.                
  632.                </tr>
  633.                
  634.                <tr>
  635.                   
  636.                   <td>
  637.                      
  638.                      <para>osPlusMinusText</para>
  639.                   
  640.                   </td>
  641.                   
  642.                   <td>
  643.                      
  644.                      <para>In addition to the text, each node displays plus picture (when it can be expanded) or minus picture (when it can be collapsed).</para>
  645.                   
  646.                   </td>
  647.                
  648.                </tr>
  649.                
  650.                <tr>
  651.                   
  652.                   <td>
  653.                      
  654.                      <para>osPictureText</para>
  655.                   
  656.                   </td>
  657.                   
  658.                   <td>
  659.                      
  660.                      <para>In addition to the text, each node displays the open picture (when it is expanded), closed picture (when it is collapsed), or leaf picture (when it has no subnodes).</para>
  661.                   
  662.                   </td>
  663.                
  664.                </tr>
  665.                
  666.                <tr>
  667.                   
  668.                   <td>
  669.                      
  670.                      <para>osPlusMinusPictureText</para>
  671.                   
  672.                   </td>
  673.                   
  674.                   <td>
  675.                      
  676.                      <para>In addition to the text, each node displays the plus picture or minus picture (as in osPlusMinusText), and the open, closed or leaf picture (as in osPictureText).</para>
  677.                   
  678.                   </td>
  679.                
  680.                </tr>
  681.                
  682.                <tr>
  683.                   
  684.                   <td>
  685.                      
  686.                      <para>osTreeText</para>
  687.                   
  688.                   </td>
  689.                   
  690.                   <td>
  691.                      
  692.                      <para>Visible lines connect the outline nodes.</para>
  693.                   
  694.                   </td>
  695.                
  696.                </tr>
  697.                
  698.                <tr>
  699.                   
  700.                   <td>
  701.                      
  702.                      <para>osTreePictureText</para>
  703.                   
  704.                   </td>
  705.                   
  706.                   <td>
  707.                      
  708.                      <para>In addition to the text, each node displays the open picture (when it is expanded), closed picture (when it is collapsed), or leaf picture (when it has no subnodes). Visible lines connect the outline nodes.</para>
  709.                   
  710.                   </td>
  711.                
  712.                </tr>
  713.             
  714.             </table>
  715.          </comments>
  716.       </member>
  717.       <member name="T:Outline.TOutlineType">
  718.          <summary>
  719.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  720.                
  721.                <condition os="Windows">
  722.                   
  723.                   <type namespace="OleAuto">TOutlineType</type> indicates whether an outline is owner-drawn.</condition>
  724.             
  725.             </para>
  726.          </summary>
  727.          <comments>
  728.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  729.                
  730.                <condition os="Windows">
  731.                   
  732.                   <type namespace="OleAuto">TOutlineType</type> determines whether an outline is drawn automatically or by user code in an OnDrawItem event.</condition>
  733.             
  734.             </para>
  735.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  736.                
  737.                <tr>
  738.                   
  739.                   <th>Value</th>
  740.                   
  741.                   <th>Meaning</th>
  742.                
  743.                </tr>
  744.                
  745.                <tr>
  746.                   
  747.                   <td>
  748.                      
  749.                      <para>otStandardItems</para>
  750.                   
  751.                   </td>
  752.                   
  753.                   <td>
  754.                      
  755.                      <para>Items are drawn automatically.</para>
  756.                   
  757.                   </td>
  758.                
  759.                </tr>
  760.                
  761.                <tr>
  762.                   
  763.                   <td>
  764.                      
  765.                      <para>otOwnerDraw</para>
  766.                   
  767.                   </td>
  768.                   
  769.                   <td>
  770.                      
  771.                      <para>Items are drawn on the Canvas by application code.</para>
  772.                   
  773.                   </td>
  774.                
  775.                </tr>
  776.             
  777.             </table>
  778.          </comments>
  779.       </member>
  780.       <member name="T:Outline.TOutlineOption">
  781.          <summary>
  782.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  783.                
  784.                <condition os="Windows">
  785.                   
  786.                   <type namespace="OleAuto">TOutlineOption</type>s represents the style in which an outline is drawn.</condition>
  787.             
  788.             </para>
  789.          </summary>
  790.          <comments>
  791.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  792.                
  793.                <condition os="Windows">
  794.                   
  795.                   <type namespace="OleAuto">TOutlineOption</type>s is a set of <type namespace="OleAuto">TOutlineOption</type> values. Together they influence the way an outline is drawn. Each <type namespace="OleAuto">TOutlineOption</type> value is described below:</condition>
  796.             
  797.             </para>
  798.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  799.                
  800.                <tr>
  801.                   
  802.                   <th>Value</th>
  803.                   
  804.                   <th>Meaning</th>
  805.                
  806.                </tr>
  807.                
  808.                <tr>
  809.                   
  810.                   <td>
  811.                      
  812.                      <para>ooDrawTreeRoot</para>
  813.                   
  814.                   </td>
  815.                   
  816.                   <td>
  817.                      
  818.                      <para>The first item (Index value of 1) is connected to the root item by the outline tree. This means that the tree will extend from the top of the outline to all the first level items. Without ooDrawTreeRoot, all first level items appear leftmost in the outline, not connected by the tree.</para>
  819.                   
  820.                   </td>
  821.                
  822.                </tr>
  823.                
  824.                <tr>
  825.                   
  826.                   <td>
  827.                      
  828.                      <para>ooDrawFocusRect</para>
  829.                   
  830.                   </td>
  831.                   
  832.                   <td>
  833.                      
  834.                      <para>The outline draws a focus rectangle around the selected item.</para>
  835.                   
  836.                   </td>
  837.                
  838.                </tr>
  839.                
  840.                <tr>
  841.                   
  842.                   <td>
  843.                      
  844.                      <para>ooStretchBitmaps</para>
  845.                   
  846.                   </td>
  847.                   
  848.                   <td>
  849.                      
  850.                      <para>The outline stretches the standard bitmaps (PictureLeaf, PictureOpen, PictureClosed, PicturePlus, PictureMinus) to fit in the size of the item, determined by the size of the Font of the Text. Without ooStretchBitmaps, the bitmaps will be cropped if larger than the height of the item text, or won't fill up the entire item space if smaller than the text.</para>
  851.                   
  852.                   </td>
  853.                
  854.                </tr>
  855.             
  856.             </table>
  857.          </comments>
  858.       </member>
  859.       <member name="T:Outline.TCustomOutline">
  860.          <summary>
  861.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  862.                
  863.                <class namespace="Outline">TCustomOutline</class> is the base class for controls that display outline nodes (TOutlineNode objects).</para>
  864.          </summary>
  865.          <comments>
  866.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="Outline">TCustomOutline</class> as a base class when defining a control that displays outline nodes in a two-dimensional layout. <class namespace="Outline">TCustomOutline</class> introduces the ability to manage a hierarchy of outline nodes, including the ability to control the appearance and layout of those nodes and to expand or collapse branches of the outline tree.</para>
  867.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not create instances of <class namespace="Outline">TCustomOutline</class>. To add an outline control to a form, use the TOutline object, which publishes many of the properties, events, and methods of <class namespace="Outline">TCustomOutline</class>, or TTreeView, which wraps the Windows control that performs the same function.</para>
  868.          </comments>
  869.       </member>
  870.       <member name="M:Outline.Outline.SetGoodIndex">
  871.          <summary>
  872.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the first node in the Items array that must be reindexed to make the index of the Value parameter correct.</para>
  873.          </summary>
  874.          <comments>
  875.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">SetGoodIndex</method> to determine how much of the Items array must be reindexed after changing the nodes in the outline. All nodes from the root to the value returned by <method namespace="Outline" class="TCustomOutline">SetGoodIndex</method> do not need to be reindexed.</para>
  876.          </comments>
  877.       </member>
  878.       <member name="M:Outline.Outline.BadIndex">
  879.          <summary>
  880.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether a node's index is up to date.</para>
  881.          </summary>
  882.          <comments>
  883.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Outline" class="TCustomOutline">BadIndex</method> to determine whether the Index property of the TOutlineNode object specified by the Value parameter accurately reflects the position of the node in the outline. </para>
  884.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If nodes are added or removed after a call to BeginUpdate, the indexes may be out of date until the EndUpdate method is called.</para>
  885.          </comments>
  886.       </member>
  887.       <member name="M:Outline.Outline.Add">
  888.          <summary>
  889.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  890.                      
  891.                <method namespace="Outline" class="TCustomOutline">Add</method>s a node to the outline.</para>
  892.          </summary>
  893.          <comments>
  894.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Outline" class="TCustomOutline">Add</method> to add a TOutlineNode object to the outline. Text specifies the Text property value of the new node.</para>
  895.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index specifies where to add the new node. The new node is positioned in the outline as the last sibling of the node identified by Index. To add nodes to the beginning of the outline, specify zero (0) as the Index parameter.</para>
  896.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Nodes that appear after the new node are moved down one row and reindexed in the Items property array with valid Index values. If BeginUpdate has been called, the Items array is not reindexed until the EndUpdate method is called.</para>
  897.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  898.                      
  899.                <method namespace="Outline" class="TCustomOutline">Add</method> returns the Index property of the new node.</para>
  900.          </comments>
  901.       </member>
  902.       <member name="M:Outline.Outline.AddChild">
  903.          <summary>
  904.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Adds a child node to a node in the outline.</para>
  905.          </summary>
  906.          <comments>
  907.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Outline" class="TCustomOutline">AddChild</method> to add a TOutlineNode object as the child of a node in the outline. Text specifies the Text property value of the new node.</para>
  908.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index specifies where to add the new node. The new node is positioned in the outline as the last child of the node identified by Index. To add nodes to the top level of the outline (off the root), specify zero (0) as the Index parameter.</para>
  909.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Nodes that appear after the new node are moved down one row and reindexed in the Items property array with valid Index values. If BeginUpdate has been called, the Items array is not reindexed until the EndUpdate method is called.</para>
  910.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  911.                      
  912.                <method namespace="Outline" class="TCustomOutline">AddChild</method> returns the Index property of the new node.</para>
  913.          </comments>
  914.       </member>
  915.       <member name="M:Outline.Outline.AddChildObject">
  916.          <summary>
  917.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Adds a child node containing data to a node in the outline.</para>
  918.          </summary>
  919.          <comments>
  920.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Outline" class="TCustomOutline">AddChildObject</method> to add a TOutlineNode object as the child of a node in the outline and assign it a data pointer. Text specifies the value of the Text property for the new node. Data specifies the value of the Data property for the new node.</para>
  921.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index specifies where to add the new node. The new node is positioned in the outline as the last child of the node identified by Index. To add nodes to the top level of the outline (off the root), specify zero (0) as the Index parameter.</para>
  922.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Nodes that appear after the new node are moved down one row and reindexed in the Items property array with valid Index values. If BeginUpdate has been called, the Items array is not reindexed until the EndUpdate method is called.</para>
  923.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  924.                      
  925.                <method namespace="Outline" class="TCustomOutline">AddChildObject</method> returns the Index property of the new node.</para>
  926.          </comments>
  927.       </member>
  928.       <member name="M:Outline.Outline.AddObject">
  929.          <summary>
  930.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Adds a node containing data to the outline.</para>
  931.          </summary>
  932.          <comments>
  933.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Outline" class="TCustomOutline">AddObject</method> to add a TOutlineNode object to the outline and assign it a data pointer. Text specifies the value of the Text property for the new node. Data specifies the value of the Data property for the new node.</para>
  934.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index specifies where to add the new node. The new node is positioned in the outline as the last sibling of the node identified by Index. To add nodes to the beginning of the outline, specify zero (0) as the Index parameter.</para>
  935.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Nodes that appear after the new node are moved down one row and reindexed in the Items property array with valid Index values. If BeginUpdate has been called, the Items array is not reindexed until the EndUpdate method is called.</para>
  936.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">AddChild returns the Index property of the new node.</para>
  937.          </comments>
  938.       </member>
  939.       <member name="M:Outline.Outline.Insert">
  940.          <summary>
  941.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  942.                      
  943.                <method namespace="Outline" class="TCustomOutline">Insert</method>s a node at a specified position.</para>
  944.          </summary>
  945.          <comments>
  946.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Outline" class="TCustomOutline">Insert</method> to add a TOutlineNode object to the outline. Text specifies the Text property value of the new node.</para>
  947.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index specifies where to add the new node. The new node is positioned in the outline in the position currently occupied by the node identified by Index. The new node is inserted at the same level as the node currently identified by Index, so that the original node and the new node are siblings and share the same parent. To add nodes to the beginning of the outline, specify zero (0) as the Index parameter.</para>
  948.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Nodes that appear after the new node, including the one specified by Index before <method namespace="Outline" class="TCustomOutline">Insert</method> is called, are moved down one row and reindexed in the Items property array with valid Index values. If BeginUpdate has been called, the Items array is not reindexed until the EndUpdate method is called.</para>
  949.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  950.                      
  951.                <method namespace="Outline" class="TCustomOutline">Insert</method> returns the Index property of the new node.</para>
  952.          </comments>
  953.       </member>
  954.       <member name="M:Outline.Outline.InsertObject">
  955.          <summary>
  956.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Inserts a node containing data at a specified position.</para>
  957.          </summary>
  958.          <comments>
  959.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="Outline" class="TCustomOutline">InsertObject</method> to add a TOutlineNode object to the outline and assign it a data pointer. Text specifies the value of the Text property for the new node. Data specifies the value of the Data property for the new node.</para>
  960.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index specifies where to add the new node. The new node is positioned in the outline in the position currently occupied by the node identified by Index. The new node is inserted at the same level as the node currently identified by Index, so that the original node and the new node are siblings and share the same parent. To add nodes to the beginning of the outline, specify zero (0) as the Index parameter.</para>
  961.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Nodes that appear after the new node, including the one specified by Index before Insert is called, are moved down one row and reindexed in the Items property array with valid Index values. If BeginUpdate has been called, the Items array is not reindexed until the EndUpdate method is called.</para>
  962.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Insert returns the Index property of the new node.</para>
  963.          </comments>
  964.       </member>
  965.       <member name="M:Outline.Outline.GetDataItem">
  966.          <summary>
  967.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the index of the first node in the outline that has the Value pointer as its Data property.</para>
  968.          </summary>
  969.          <comments>
  970.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">GetDataItem</method> to locate the node that corresponds to the Value parameter. <method namespace="Outline" class="TCustomOutline">GetDataItem</method> returns an index into the Items property array.</para>
  971.          </comments>
  972.       </member>
  973.       <member name="M:Outline.Outline.GetItem">
  974.          <summary>
  975.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the index of the node at the position indicated by the X and Y parameters.</para>
  976.          </summary>
  977.          <comments>
  978.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">GetItem</method> to locate the node at the specified screen pixel coordinates. <method namespace="Outline" class="TCustomOutline">GetItem</method> returns an index into the Items property array.</para>
  979.          </comments>
  980.       </member>
  981.       <member name="M:Outline.Outline.GetNodeDisplayWidth">
  982.          <summary>
  983.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the length of the row containing a specified node.</para>
  984.          </summary>
  985.          <comments>
  986.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">GetNodeDisplayWidth</method> to determine the length, in pixels, of the line in the outline that contains the node specified by the Node parameter. <method namespace="Outline" class="TCustomOutline">GetNodeDisplayWidth</method> adjusts for the lines and bitmaps specified by the OutlineStyle property.</para>
  987.          </comments>
  988.       </member>
  989.       <member name="M:Outline.Outline.GetTextItem">
  990.          <summary>
  991.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the index of the first node in the outline with the Value parameter as its Text property.</para>
  992.          </summary>
  993.          <comments>
  994.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">GetTextItem</method> to locate the node that corresponds to the Value parameter. <method namespace="Outline" class="TCustomOutline">GetTextItem</method> returns an index into the Items property array.</para>
  995.          </comments>
  996.       </member>
  997.       <member name="M:Outline.Outline.GetVisibleNode">
  998.          <summary>
  999.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the TOutlineNode object for the node indicated by a position in the image of the outline.</para>
  1000.          </summary>
  1001.          <comments>
  1002.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">GetVisibleNode</method> to locate a node with the position given by the Index parameter, where all nodes that are hidden because their parent node is collapsed are ignored. An Index of 0 indicates the first visible node, an Index of 1 indicates the second visible node, and so on. If the outline is fully expanded, <method namespace="Outline" class="TCustomOutline">GetVisibleNode</method> returns the value of Items[Index+1].</para>
  1003.          </comments>
  1004.       </member>
  1005.       <member name="M:Outline.Outline.Create">
  1006.          <summary>
  1007.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1008.                      
  1009.                <method namespace="Outline" class="TCustomOutline">Create</method>s an instance of <method namespace="Outline" class="TCustomOutline">TCustomOutline</method>.</para>
  1010.          </summary>
  1011.          <comments>
  1012.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">Create</method> to instantiate a <method namespace="Outline" class="TCustomOutline">TCustomOutline</method> object at runtime. Outlines placed on forms at design time are created automatically.</para>
  1013.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1014.                      
  1015.                <method namespace="Outline" class="TCustomOutline">Create</method> initializes the outline object, setting the values of some internal properties, as well as setting</para>
  1016.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Color to clWindow and ParentColor to false.</para>
  1017.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Height to 97 and Width to 121.</para>
  1018.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ItemSeparator to '\'.</para>
  1019.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Options to [ooDrawTreeRoot, ooDrawFocusRect].</para>
  1020.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">OutlineStyle to osTreePictureText.</para>
  1021.          </comments>
  1022.       </member>
  1023.       <member name="M:Outline.Outline.Loaded">
  1024.          <summary>
  1025.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets up the outline after it has been streamed in.</para>
  1026.          </summary>
  1027.          <comments>
  1028.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The streaming system calls <method namespace="Outline" class="TCustomOutline">Loaded</method> after the outline has been fully loaded into memory. <method namespace="Outline" class="TCustomOutline">Loaded</method> makes sure that all indexes are correct, loads any custom bitmaps that replaced the default values, and selects the first node in the outline.</para>
  1029.          </comments>
  1030.       </member>
  1031.       <member name="M:Outline.Outline.Click">
  1032.          <summary>
  1033.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Updates the SelectedItem property.</para>
  1034.          </summary>
  1035.          <comments>
  1036.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1037.                      
  1038.                <method namespace="Outline" class="TCustomOutline">Click</method> is called automatically when the user clicks the mouse on a node in the outline. <method namespace="Outline" class="TCustomOutline">Click</method> updates the SelectedItem property before the On<method namespace="Outline" class="TCustomOutline">Click</method> event handler is called by the inherited method.</para>
  1039.          </comments>
  1040.       </member>
  1041.       <member name="M:Outline.Outline.KeyDown">
  1042.          <summary>
  1043.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides special processing when the user presses a key.</para>
  1044.          </summary>
  1045.          <comments>
  1046.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1047.                      
  1048.                <method namespace="Outline" class="TCustomOutline">KeyDown</method> is called automatically when the user presses a key. After calling the inherited method, which generates an On<method namespace="Outline" class="TCustomOutline">KeyDown</method> event, <method namespace="Outline" class="TCustomOutline">KeyDown</method> processes the following keystrokes:</para>
  1049.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1050.                      
  1051.                <tr>
  1052.                         
  1053.                   <th>Key</th>
  1054.                         
  1055.                   <th>Behavior</th>
  1056.                      
  1057.                </tr>
  1058.                      
  1059.                <tr>
  1060.                         
  1061.                   <td>
  1062.                            
  1063.                      <para>Home</para>
  1064.                         
  1065.                   </td>
  1066.                         
  1067.                   <td>
  1068.                            
  1069.                      <para>Selects the first node in the outline.</para>
  1070.                         
  1071.                   </td>
  1072.                      
  1073.                </tr>
  1074.                      
  1075.                <tr>
  1076.                         
  1077.                   <td>
  1078.                            
  1079.                      <para>End</para>
  1080.                         
  1081.                   </td>
  1082.                         
  1083.                   <td>
  1084.                            
  1085.                      <para>Selects the last node in the outline.</para>
  1086.                         
  1087.                   </td>
  1088.                      
  1089.                </tr>
  1090.                      
  1091.                <tr>
  1092.                         
  1093.                   <td>
  1094.                            
  1095.                      <para>Return</para>
  1096.                         
  1097.                   </td>
  1098.                         
  1099.                   <td>
  1100.                            
  1101.                      <para>Toggles the selected node between its collapsed and expanded states.</para>
  1102.                         
  1103.                   </td>
  1104.                      
  1105.                </tr>
  1106.                      
  1107.                <tr>
  1108.                         
  1109.                   <td>
  1110.                            
  1111.                      <para>Ctrl+*</para>
  1112.                         
  1113.                   </td>
  1114.                         
  1115.                   <td>
  1116.                            
  1117.                      <para>Fully expands the outline.</para>
  1118.                         
  1119.                   </td>
  1120.                      
  1121.                </tr>
  1122.                      
  1123.                <tr>
  1124.                         
  1125.                   <td>
  1126.                            
  1127.                      <para>Right arrow</para>
  1128.                         
  1129.                   </td>
  1130.                         
  1131.                   <td>
  1132.                            
  1133.                      <para>Selects the first child of the selected node.</para>
  1134.                         
  1135.                   </td>
  1136.                      
  1137.                </tr>
  1138.                      
  1139.                <tr>
  1140.                         
  1141.                   <td>
  1142.                            
  1143.                      <para>Left arrow</para>
  1144.                         
  1145.                   </td>
  1146.                         
  1147.                   <td>
  1148.                            
  1149.                      <para>Selects the parent of the selected node.</para>
  1150.                         
  1151.                   </td>
  1152.                      
  1153.                </tr>
  1154.                      
  1155.                <tr>
  1156.                         
  1157.                   <td>
  1158.                            
  1159.                      <para>Ctrl+Up arrow</para>
  1160.                         
  1161.                   </td>
  1162.                         
  1163.                   <td>
  1164.                            
  1165.                      <para>Selects the node following the selected node.</para>
  1166.                         
  1167.                   </td>
  1168.                      
  1169.                </tr>
  1170.                      
  1171.                <tr>
  1172.                         
  1173.                   <td>
  1174.                            
  1175.                      <para>Ctrl+Down arrow</para>
  1176.                         
  1177.                   </td>
  1178.                         
  1179.                   <td>
  1180.                            
  1181.                      <para>Selects the node preceding the selected node.</para>
  1182.                         
  1183.                   </td>
  1184.                      
  1185.                </tr>
  1186.                   
  1187.             </table>
  1188.          </comments>
  1189.       </member>
  1190.       <member name="M:Outline.Outline.KeyPress">
  1191.          <summary>
  1192.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides special processing when a key is pressed.</para>
  1193.          </summary>
  1194.          <comments>
  1195.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1196.                      
  1197.                <method namespace="Outline" class="TCustomOutline">KeyPress</method> is called automatically after the user presses a key but before it is released. After calling the inherited method, which generates an On<method namespace="Outline" class="TCustomOutline">KeyPress</method> event, <method namespace="Outline" class="TCustomOutline">KeyPress</method> processes the following characters :</para>
  1198.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1199.                      
  1200.                <tr>
  1201.                         
  1202.                   <th>Key</th>
  1203.                         
  1204.                   <th>Behavior</th>
  1205.                      
  1206.                </tr>
  1207.                      
  1208.                <tr>
  1209.                         
  1210.                   <td>
  1211.                            
  1212.                      <para>+</para>
  1213.                         
  1214.                   </td>
  1215.                         
  1216.                   <td>
  1217.                            
  1218.                      <para>Expands the selected node.</para>
  1219.                         
  1220.                   </td>
  1221.                      
  1222.                </tr>
  1223.                      
  1224.                <tr>
  1225.                         
  1226.                   <td>
  1227.                            
  1228.                      <para>-</para>
  1229.                         
  1230.                   </td>
  1231.                         
  1232.                   <td>
  1233.                            
  1234.                      <para>Collapses the selected node.</para>
  1235.                         
  1236.                   </td>
  1237.                      
  1238.                </tr>
  1239.                      
  1240.                <tr>
  1241.                         
  1242.                   <td>
  1243.                            
  1244.                      <para>*</para>
  1245.                         
  1246.                   </td>
  1247.                         
  1248.                   <td>
  1249.                            
  1250.                      <para>Fully expands the outline.</para>
  1251.                         
  1252.                   </td>
  1253.                      
  1254.                </tr>
  1255.                   
  1256.             </table>
  1257.          </comments>
  1258.       </member>
  1259.       <member name="M:Outline.Outline.DrawCell">
  1260.          <summary>
  1261.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Draws a node in the outline.</para>
  1262.          </summary>
  1263.          <comments>
  1264.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1265.                      
  1266.                <method namespace="Outline" class="TCustomOutline">DrawCell</method> is called automatically whenever the outline needs to draw a node. If the Style property is otOwnerDraw and an OnDrawItem event handler has been supplied, <method namespace="Outline" class="TCustomOutline">DrawCell</method> generates an OnDrawItem event. Otherwise, <method namespace="Outline" class="TCustomOutline">DrawCell</method> draws the node in the manner indicated by the OutlineStyle property.</para>
  1267.          </comments>
  1268.       </member>
  1269.       <member name="M:Outline.Outline.DblClick">
  1270.          <summary>
  1271.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Expands or collapses the selected node.</para>
  1272.          </summary>
  1273.          <comments>
  1274.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1275.                      
  1276.                <method namespace="Outline" class="TCustomOutline">DblClick</method> is called automatically when the user double clicks the mouse on a node in the outline. After calling the On<method namespace="Outline" class="TCustomOutline">DblClick</method> event handler, <method namespace="Outline" class="TCustomOutline">DblClick</method> updates the SelectedItem property and expands the selected node if it is collapsed or collapses the selected node if it is expanded.</para>
  1277.          </comments>
  1278.       </member>
  1279.       <member name="M:Outline.Outline.SetLevel">
  1280.          <summary>
  1281.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the level of an outline node.</para>
  1282.          </summary>
  1283.          <comments>
  1284.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">SetLevel</method> to change the nesting depth of the node specified by the Node parameter. CurLevel is the node's current level and NewLevel is the node's new level.</para>
  1285.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For example, consider the outline specified by the following value of Lines:</para>
  1286.             <codeBlock xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">NodeA
  1287.  NodeB
  1288.   NodeC
  1289.  NodeD</codeBlock>
  1290.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Calling <method namespace="Outline" class="TCustomOutline">SetLevel</method> for NodeD with CurLevel set to 2 and NewLevel set to 4 results in the outline with the following value of Lines:</para>
  1291.             <codeBlock xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">NodeA
  1292.  NodeB
  1293.   NodeC
  1294.    NodeD</codeBlock>
  1295.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">That is, the parent of NodeD was changed from NodeA to NodeC.</para>
  1296.          </comments>
  1297.       </member>
  1298.       <member name="M:Outline.Outline.DeleteNode">
  1299.          <summary>
  1300.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Fixes up the outline after a node has been deleted.</para>
  1301.          </summary>
  1302.          <comments>
  1303.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1304.                      
  1305.                <method namespace="Outline" class="TCustomOutline">DeleteNode</method> is called automatically whenever a node in the outline is destroyed. It fixes up the index and makes sure that the SelectedItem property is valid. </para>
  1306.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To Delete a node from the outline, call the Delete method of the outline or free the TOulineNode object.</para>
  1307.          </comments>
  1308.       </member>
  1309.       <member name="M:Outline.Outline.Expand">
  1310.          <summary>
  1311.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates an On<method namespace="Outline" class="TCustomOutline">Expand</method> event.</para>
  1312.          </summary>
  1313.          <comments>
  1314.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1315.                      
  1316.                <method namespace="Outline" class="TCustomOutline">Expand</method> is called automatically after a node in the outline is expanded. It calls the On<method namespace="Outline" class="TCustomOutline">Expand</method> event handler if it is assigned.</para>
  1317.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Override the <method namespace="Outline" class="TCustomOutline">Expand</method> method to provide additional processing after nodes in the outline have been expanded, or to block the On<method namespace="Outline" class="TCustomOutline">Expand</method> event.</para>
  1318.          </comments>
  1319.       </member>
  1320.       <member name="M:Outline.Outline.Collapse">
  1321.          <summary>
  1322.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates an On<method namespace="Outline" class="TCustomOutline">Collapse</method> event.</para>
  1323.          </summary>
  1324.          <comments>
  1325.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1326.                      
  1327.                <method namespace="Outline" class="TCustomOutline">Collapse</method> is called automatically after a node in the outline is collapsed. It calls the On<method namespace="Outline" class="TCustomOutline">Collapse</method> event handler if it is assigned.</para>
  1328.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Override the <method namespace="Outline" class="TCustomOutline">Collapse</method> method to provide additional processing after nodes in the outline have been collapsed, or to block the On<method namespace="Outline" class="TCustomOutline">Collapse</method> event.</para>
  1329.          </comments>
  1330.       </member>
  1331.       <member name="M:Outline.Outline.DefineProperties">
  1332.          <summary>
  1333.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates a binary property for customized bitmap values.</para>
  1334.          </summary>
  1335.          <comments>
  1336.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The streaming system calls <method namespace="Outline" class="TCustomOutline">DefineProperties</method> to allow the outline to define new properties that should be saved with the outline object. <method namespace="Outline" class="TCustomOutline">DefineProperties</method> checks whether the outline uses any bitmaps other than the default values of PictureClosed, PictureLeaf, PictureMinus, PictureOpen, and PicturePlus. If the outline has customized any of these bitmaps, <method namespace="Outline" class="TCustomOutline">DefineProperties</method> uses the DefineBinaryProperty method of the Filer parameter to create a binary property for the customized values.</para>
  1337.          </comments>
  1338.       </member>
  1339.       <member name="M:Outline.Outline.MouseDown">
  1340.          <summary>
  1341.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Updates the SelectedItem property.</para>
  1342.          </summary>
  1343.          <comments>
  1344.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After calling the inherited method to generate an On<method namespace="Outline" class="TCustomOutline">MouseDown</method> event and locate the line under the mouse, <method namespace="Outline" class="TCustomOutline">MouseDown</method> sets the SelectedItem property to the node in the line under the mouse.</para>
  1345.          </comments>
  1346.       </member>
  1347.       <member name="M:Outline.Outline.Move">
  1348.          <summary>
  1349.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Repositions a node in the outline.</para>
  1350.          </summary>
  1351.          <comments>
  1352.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">Move</method> to reposition the node with the index specified by the Source parameter to the position indicated by the Destination parameter. The meaning of the Destination parameter depends on the value of the AttachMode parameter.</para>
  1353.          </comments>
  1354.       </member>
  1355.       <member name="M:Outline.Outline.SetDisplayWidth">
  1356.          <summary>
  1357.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the display width of the outline.</para>
  1358.          </summary>
  1359.          <comments>
  1360.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">SetDisplayWidth</method> to set the width of the image of the outline to the number of pixels specified by the Value parameter. Value should large enough to display the most deeply nested node. Use the GetNodeDisplayWidth method to determine the size needed to display the visible nodes.</para>
  1361.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the display width is greater than the client width of the control, users can scroll the image to view the entire width.</para>
  1362.          </comments>
  1363.       </member>
  1364.       <member name="M:Outline.Outline.Delete">
  1365.          <summary>
  1366.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1367.                      
  1368.                <method namespace="Outline" class="TCustomOutline">Delete</method>s a node from the outline.</para>
  1369.          </summary>
  1370.          <comments>
  1371.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">Delete</method> to remove a node and all its descendants from the outline. Index is the index of the node to delete.</para>
  1372.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1373.                      
  1374.                <method namespace="Outline" class="TCustomOutline">Delete</method> removes the node and its children, frees all associated memory, and then calls <method namespace="Outline" class="TCustomOutline">Delete</method>Node to update the indexes and make sure that SelectedItem is valid.</para>
  1375.          </comments>
  1376.       </member>
  1377.       <member name="M:Outline.Outline.FullExpand">
  1378.          <summary>
  1379.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Expands every node in the outline.</para>
  1380.          </summary>
  1381.          <comments>
  1382.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">FullExpand</method> to show all nodes in the outline. <method namespace="Outline" class="TCustomOutline">FullExpand</method> calls the <method namespace="Outline" class="TCustomOutline">FullExpand</method> method of the root node. This causes the Expanded property of all nodes in the outline to be set to true. Every node in the Items array appears fully expanded in the outline. Depending on the value of OutlineStyle, each node that has descendants is then represented with the PictureOpen bitmap and/or the PictureMinus bitmap. The appearance of leaf nodes is unaffected.</para>
  1383.          </comments>
  1384.       </member>
  1385.       <member name="M:Outline.Outline.FullCollapse">
  1386.          <summary>
  1387.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Causes all top-level nodes in the outline to collapse.</para>
  1388.          </summary>
  1389.          <comments>
  1390.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">FullCollapse</method> to shrink the outline as much as possible. <method namespace="Outline" class="TCustomOutline">FullCollapse</method> sets the Expanded property of each TOutlineNode that is a direct descendant of the root of the outline to false. This causes all the descendants of these top-level nodes to be hidden. Depending on the value of OutlineStyle, each collapsed top-level node is then represented with the PictureClosed bitmap and/or the PicturePlus bitmap.</para>
  1391.          </comments>
  1392.       </member>
  1393.       <member name="M:Outline.Outline.LoadFromFile">
  1394.          <summary>
  1395.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Loads the outline from a text image stored in a file.</para>
  1396.          </summary>
  1397.          <comments>
  1398.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">LoadFromFile</method> to fill an outline from the file specified by the FileName parameter. Each line in the file represents a node in the outline. The file does not include the root node.</para>
  1399.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Leading tabs and spaces are converted into levels of the outline. Text without any leading tabs or spaces becomes level 1 items. For example, the following set of strings represents an outline with three first level children descended from the root, and an additional, second level child on the first and third nodes:</para>
  1400.             <codeBlock xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ChildA
  1401.  ChildA1
  1402. ChildB
  1403. ChildC
  1404.  ChildC1</codeBlock>
  1405.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To fill the outline from a text image read from a stream, use the LoadFromStream method. To fill the outline from a text image represented as a TStrings object, use the Lines property.</para>
  1406.          </comments>
  1407.       </member>
  1408.       <member name="M:Outline.Outline.LoadFromStream">
  1409.          <summary>
  1410.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Loads the outline from a text image read from a stream.</para>
  1411.          </summary>
  1412.          <comments>
  1413.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">LoadFromStream</method> to fill an outline from the stream specified by the Stream parameter. For example, use <method namespace="Outline" class="TCustomOutline">LoadFromStream</method> to load an outline from an image stored in a database table, using a TBlobStream object. Each node in the outline is separated by a newline character. The stream does not provide the root node.</para>
  1414.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Leading tabs and spaces are converted into levels of the outline. Text without any leading tabs or spaces becomes level 1 items. For example, the following set of strings represents an outline with three first level children descended from the root, and an additional, second level child on the first and third nodes:</para>
  1415.             <codeBlock xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ChildA
  1416.  ChildA1
  1417. ChildB
  1418. ChildC
  1419.  ChildC1</codeBlock>
  1420.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To fill the outline from a text image read from a file, use the LoadFromFile method. To fill the outline from a text image represented as a TStrings object, use the Lines property.</para>
  1421.          </comments>
  1422.       </member>
  1423.       <member name="M:Outline.Outline.SaveToFile">
  1424.          <summary>
  1425.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Saves the Lines property to a file.</para>
  1426.          </summary>
  1427.          <comments>
  1428.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">SaveToFile</method> to save a text image of the outline to the file specified by the FileName parameter. The image saved is the value of the Lines property, where each line of the file represents a node, and each level of the outline is represented by a tab character.</para>
  1429.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To write the outline to an arbitrary stream, use the SaveToStream method.</para>
  1430.          </comments>
  1431.       </member>
  1432.       <member name="M:Outline.Outline.SaveToStream">
  1433.          <summary>
  1434.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Writes the Lines property to a stream.</para>
  1435.          </summary>
  1436.          <comments>
  1437.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">SaveToStream</method> to write a text image of the outline to the stream specified by the Stream parameter. The image saved is the value of the Lines property, where each line of text represents a node, and each level of the outline is represented by a tab character.</para>
  1438.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To write the outline to a file, use the SaveToFile method.</para>
  1439.          </comments>
  1440.       </member>
  1441.       <member name="M:Outline.Outline.BeginUpdate">
  1442.          <summary>
  1443.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Prevents the updating of the outline until the EndUpdate method is called.</para>
  1444.          </summary>
  1445.          <comments>
  1446.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">BeginUpdate</method> before adding, removing, or moving multiple outline items. <method namespace="Outline" class="TCustomOutline">BeginUpdate</method> speeds processing time by deferring repaints and the adjustment of index values until EndUpdate is called. </para>
  1447.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1448.                      
  1449.                <para>Make sure that EndUpdate is called after all changes have been made to the nodes in the Items array.</para>
  1450.                   
  1451.             </note>
  1452.          </comments>
  1453.       </member>
  1454.       <member name="M:Outline.Outline.EndUpdate">
  1455.          <summary>
  1456.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Performs the reindexing and repaints deferred by a call to BeginUpdate.</para>
  1457.          </summary>
  1458.          <comments>
  1459.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">EndUpdate</method> at the end of a segment of code that began with a call to BeginUpdate. Every time BeginUpdate is called, an internal counter is incremented. When <method namespace="Outline" class="TCustomOutline">EndUpdate</method> is called, the counter is decremented. When every call to BeginUpdate has been matched by a call to <method namespace="Outline" class="TCustomOutline">EndUpdate</method>, <method namespace="Outline" class="TCustomOutline">EndUpdate</method> fixes up the indexes and repaints the outline.</para>
  1460.          </comments>
  1461.       </member>
  1462.       <member name="M:Outline.Outline.SetUpdateState">
  1463.          <summary>
  1464.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Enables or disables the maintenance of the node indexes.</para>
  1465.          </summary>
  1466.          <comments>
  1467.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">SetUpdateState</method> with Value set to true to block the recomputation of indexes. Call <method namespace="Outline" class="TCustomOutline">SetUpdateState</method> with Value set to false to recompute all indexes in the outline and enable the maintenance of indexes with every change to the nodes in the outline. </para>
  1468.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Unlike calls to BeginUpdate and EndUpdate, calls to <method namespace="Outline" class="TCustomOutline">SetUpdateState</method> do not nest: Calling <method namespace="Outline" class="TCustomOutline">SetUpdateState</method> with Value set to false always recomputes the indexes regardless of the number of previous calls to <method namespace="Outline" class="TCustomOutline">SetUpdateState</method> with Value set to true.</para>
  1469.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1470.                      
  1471.                <para>Calling <method namespace="Outline" class="TCustomOutline">SetUpdateState</method> takes precedence over any enabling or disabling of index maintenance provided by BeginUpdate or EndUpdate.</para>
  1472.                   
  1473.             </note>
  1474.          </comments>
  1475.       </member>
  1476.       <member name="M:Outline.Outline.Clear">
  1477.          <summary>
  1478.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Removes all items from the outline.</para>
  1479.          </summary>
  1480.          <comments>
  1481.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="Outline" class="TCustomOutline">Clear</method> to empty the outline of all its nodes. <method namespace="Outline" class="TCustomOutline">Clear</method> frees the memory for the removed items but not any memory for associated data.</para>
  1482.          </comments>
  1483.       </member>
  1484.       <member name="M:Outline.Outline.Destroy">
  1485.          <summary>
  1486.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1487.                      
  1488.                <method namespace="Outline" class="TCustomOutline">Destroy</method>s an instance of <method namespace="Outline" class="TCustomOutline">TCustomOutline</method>. </para>
  1489.          </summary>
  1490.          <comments>
  1491.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1492.                      
  1493.                <method namespace="Outline" class="TCustomOutline">Destroy</method> frees all memory associated with the outline. While the destructor frees the TOutlineNode objects that comprise the outline, any objects associated with those nodes are not freed.</para>
  1494.          </comments>
  1495.       </member>
  1496.       <member name="P:Outline.Outline.Lines">
  1497.          <summary>
  1498.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the Text property values of all nodes in the outline.</para>
  1499.          </summary>
  1500.          <comments>
  1501.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="Outline" class="TCustomOutline">Lines</property> to obtain a text representation of the outline. Set <property namespace="Outline" class="TCustomOutline">Lines</property> to fill the outline from a set of text strings. Each string in the <property namespace="Outline" class="TCustomOutline">Lines</property> property represents a node in the outline. <property namespace="Outline" class="TCustomOutline">Lines</property> does not include the root node.</para>
  1502.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Leading tabs and spaces are converted into levels of the outline. Text without any leading tabs or spaces becomes level 1 items. For example, the following set of strings represents an outline with three first level children descended from the root, and an additional, second level child on the first and third nodes:</para>
  1503.             <codeBlock xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ChildA
  1504.  ChildA1
  1505. ChildB
  1506. ChildC
  1507.  ChildC1</codeBlock>
  1508.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <property namespace="Outline" class="TCustomOutline">Lines</property> property is primarily useful for filling an outline with items at design time. While <property namespace="Outline" class="TCustomOutline">Lines</property> can be used to access the individual nodes at run time, it is much quicker to access an item with the Items property.</para>
  1509.          </comments>
  1510.       </member>
  1511.       <member name="P:Outline.Outline.OutlineStyle">
  1512.          <summary>
  1513.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies how the outline tree is displayed.</para>
  1514.          </summary>
  1515.          <comments>
  1516.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Outline" class="TCustomOutline">OutlineStyle</property> to one of the following values:</para>
  1517.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1518.                      
  1519.                <tr>
  1520.                         
  1521.                   <th>Value</th>
  1522.                         
  1523.                   <th>Meaning</th>
  1524.                      
  1525.                </tr>
  1526.                      
  1527.                <tr>
  1528.                         
  1529.                   <td>
  1530.                            
  1531.                      <para>osText</para>
  1532.                         
  1533.                   </td>
  1534.                         
  1535.                   <td>
  1536.                            
  1537.                      <para>Displays node text (specified in Text) only.</para>
  1538.                         
  1539.                   </td>
  1540.                      
  1541.                </tr>
  1542.                      
  1543.                <tr>
  1544.                         
  1545.                   <td>
  1546.                            
  1547.                      <para>osPlusMinusText</para>
  1548.                         
  1549.                   </td>
  1550.                         
  1551.                   <td>
  1552.                            
  1553.                      <para>Displays plus picture (specified in PicturePlus), minus picture (specified in PictureMinus), and node text (specified in Text).</para>
  1554.                         
  1555.                   </td>
  1556.                      
  1557.                </tr>
  1558.                      
  1559.                <tr>
  1560.                         
  1561.                   <td>
  1562.                            
  1563.                      <para>osPictureText</para>
  1564.                         
  1565.                   </td>
  1566.                         
  1567.                   <td>
  1568.                            
  1569.                      <para>Displays open picture (specified in PictureOpen), closed picture (specified in PictureClosed), leaf picture (specified in PictureLeaf) and node text (specified in Text).</para>
  1570.                         
  1571.                   </td>
  1572.                      
  1573.                </tr>
  1574.                      
  1575.                <tr>
  1576.                         
  1577.                   <td>
  1578.                            
  1579.                      <para>osPlusMinusPictureText</para>
  1580.                         
  1581.                   </td>
  1582.                         
  1583.                   <td>
  1584.                            
  1585.                      <para>Displays plus picture (specified in PicturePlus), minus picture (specified in PictureMinus), open picture (specified in PictureOpen), closed picture (specified in PictureClosed), leaf picture (specified in PictureLeaf), and node text (specified in Text).</para>
  1586.                         
  1587.                   </td>
  1588.                      
  1589.                </tr>
  1590.                      
  1591.                <tr>
  1592.                         
  1593.                   <td>
  1594.                            
  1595.                      <para>osTreeText</para>
  1596.                         
  1597.                   </td>
  1598.                         
  1599.                   <td>
  1600.                            
  1601.                      <para>Displays lines connecting outline nodes and node text (specified in Text).</para>
  1602.                         
  1603.                   </td>
  1604.                      
  1605.                </tr>
  1606.                      
  1607.                <tr>
  1608.                         
  1609.                   <td>
  1610.                            
  1611.                      <para>osTreePictureText</para>
  1612.                         
  1613.                   </td>
  1614.                         
  1615.                   <td>
  1616.                            
  1617.                      <para>Displays lines connecting outline nodes, open picture (specified in PictureOpen), closed picture (specified in PictureClosed), leaf picture (specified in PictureLeaf), and node text (specified in Text).</para>
  1618.                         
  1619.                   </td>
  1620.                      
  1621.                </tr>
  1622.                   
  1623.             </table>
  1624.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1625.                      
  1626.                <para>If the Style property is otOwnerDraw, the value of <property namespace="Outline" class="TCustomOutline">OutlineStyle</property> is ignored. The connecting lines, node bitmaps, and node text must all be drawn in an OnDrawItem event handler.</para>
  1627.                   
  1628.             </note>
  1629.          </comments>
  1630.       </member>
  1631.       <member name="P:Outline.Outline.Options">
  1632.          <summary>
  1633.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines how the nodes in the outline are drawn.</para>
  1634.          </summary>
  1635.          <comments>
  1636.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Outline" class="TCustomOutline">Options</property> to any combination of the following values:</para>
  1637.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1638.                      
  1639.                <tr>
  1640.                         
  1641.                   <th>Value</th>
  1642.                         
  1643.                   <th>Meaning</th>
  1644.                      
  1645.                </tr>
  1646.                      
  1647.                <tr>
  1648.                         
  1649.                   <td>
  1650.                            
  1651.                      <para>ooDrawTreeRoot</para>
  1652.                         
  1653.                   </td>
  1654.                         
  1655.                   <td>
  1656.                            
  1657.                      <para>The first item (Index value of 1) is connected to the root item by the outline tree. This means that the tree will extend from the top of the outline to all the first level items. Without ooDrawTreeRoot, all first level items appear leftmost in the outline, not connected by the tree.</para>
  1658.                         
  1659.                   </td>
  1660.                      
  1661.                </tr>
  1662.                      
  1663.                <tr>
  1664.                         
  1665.                   <td>
  1666.                            
  1667.                      <para>ooDrawFocusRect</para>
  1668.                         
  1669.                   </td>
  1670.                         
  1671.                   <td>
  1672.                            
  1673.                      <para>The outline draws a focus rectangle around the selected item.</para>
  1674.                         
  1675.                   </td>
  1676.                      
  1677.                </tr>
  1678.                      
  1679.                <tr>
  1680.                         
  1681.                   <td>
  1682.                            
  1683.                      <para>ooStretchBitmaps</para>
  1684.                         
  1685.                   </td>
  1686.                         
  1687.                   <td>
  1688.                            
  1689.                      <para>The outline stretches the standard bitmaps (PictureLeaf, PictureOpen, PictureClosed, PicturePlus, PictureMinus) to fit in the size of the item, determined by the size of the Font of the Text. Without ooStretchBitmaps, the bitmaps will be cropped if larger than the height of the item text, or won't fill up the entire item space if smaller than the text.</para>
  1690.                         
  1691.                   </td>
  1692.                      
  1693.                </tr>
  1694.                   
  1695.             </table>
  1696.          </comments>
  1697.       </member>
  1698.       <member name="P:Outline.Outline.Style">
  1699.          <summary>
  1700.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether the nodes and tree are drawn automatically.</para>
  1701.          </summary>
  1702.          <comments>
  1703.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By default, <property namespace="Outline" class="TCustomOutline">Style</property> is osStandard, meaning that the outline displays items in the style determined by the Outline<property namespace="Outline" class="TCustomOutline">Style</property> property. Set <property namespace="Outline" class="TCustomOutline">Style</property> to otOwnerDraw to create owner-draw outlines, meaning that items must be drawn on the canvas of the outline by code in an OnDrawItem event handler. </para>
  1704.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Owner-draw outlines can display items other than the Text of a node and the standard bitmaps specified in the PictureClosed, PictureOpen, PictureMinus, PicturePlus, and PictureLeaf properties. Owner-draw outlines require more programming, however, as the application must specify how to render the image for each node in an OnDrawItem event handler.</para>
  1705.          </comments>
  1706.       </member>
  1707.       <member name="P:Outline.Outline.ItemHeight">
  1708.          <summary>
  1709.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the height of each node in the outline.</para>
  1710.          </summary>
  1711.          <comments>
  1712.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Outline" class="TCustomOutline">ItemHeight</property> to the height, in pixels, of each node in the outline. Changing the <property namespace="Outline" class="TCustomOutline">ItemHeight</property> property also changes the font used to display the nodes.</para>
  1713.          </comments>
  1714.       </member>
  1715.       <member name="P:Outline.Outline.ItemSeparator">
  1716.          <summary>
  1717.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies a delimiting string for outline nodes.</para>
  1718.          </summary>
  1719.          <comments>
  1720.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="Outline" class="TCustomOutline">ItemSeparator</property> to the string that should appear between node names in the path description of any individual node in the outline. <property namespace="Outline" class="TCustomOutline">ItemSeparator</property> is used to implement the FullPath read method of TOutlineNode.</para>
  1721.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1722.                      
  1723.                <property namespace="Outline" class="TCustomOutline">ItemSeparator</property> is initialized to the backslash (\) character when the <property namespace="Outline" class="TCustomOutline">TCustomOutline</property> object is created.</para>
  1724.          </comments>
  1725.       </member>
  1726.       <member name="P:Outline.Outline.PicturePlus">
  1727.          <summary>
  1728.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the bitmap used to represent a collapsed item that has subitems.</para>
  1729.          </summary>
  1730.          <comments>
  1731.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By default, the <property namespace="Outline" class="TCustomOutline">PicturePlus</property> property is a plus sign (+). Set <property namespace="Outline" class="TCustomOutline">PicturePlus</property> to change the bitmap used for collapsed nodes.</para>
  1732.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1733.                      
  1734.                <para>The bitmap will not be displayed in the outline unless the OutlineStyle property is set to osPlusMinusPictureText or osPlusMinusText.</para>
  1735.                   
  1736.             </note>
  1737.          </comments>
  1738.       </member>
  1739.       <member name="P:Outline.Outline.PictureMinus">
  1740.          <summary>
  1741.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the bitmap used to represent an expanded item that has subitems.</para>
  1742.          </summary>
  1743.          <comments>
  1744.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By default, <property namespace="Outline" class="TCustomOutline">PictureMinus</property> is a minus sign (-). Set <property namespace="Outline" class="TCustomOutline">PictureMinus</property> to change the bitmap used for collapsible nodes.</para>
  1745.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1746.                      
  1747.                <para>The bitmap is not displayed in the outline unless the OutlineStyle property is set to osPlusMinusPictureText or osPlusMinusText.</para>
  1748.                   
  1749.             </note>
  1750.          </comments>
  1751.       </member>
  1752.       <member name="P:Outline.Outline.PictureOpen">
  1753.          <summary>
  1754.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the bitmap used to represent an expanded item that has subitems.</para>
  1755.          </summary>
  1756.          <comments>
  1757.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By default, the <property namespace="Outline" class="TCustomOutline">PictureOpen</property> property is an open file folder. Set <property namespace="Outline" class="TCustomOutline">PictureOpen</property> to change the bitmap used for expanded nodes.</para>
  1758.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1759.                      
  1760.                <para>The bitmap is not displayed in the outline unless the OutlineStyle property is set to osPictureText, osPlusMinusPictureText, or osTreePictureText.</para>
  1761.                   
  1762.             </note>
  1763.          </comments>
  1764.       </member>
  1765.       <member name="P:Outline.Outline.PictureClosed">
  1766.          <summary>
  1767.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the bitmap used to represent a collapsed node that has subitems.</para>
  1768.          </summary>
  1769.          <comments>
  1770.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By default, <property namespace="Outline" class="TCustomOutline">PictureClosed</property> is a closed file folder bitmap. Set <property namespace="Outline" class="TCustomOutline">PictureClosed</property> to change the bitmap used for collapsed nodes.</para>
  1771.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1772.                      
  1773.                <para>The bitmap is not displayed in the outline unless the OutlineStyle property is set to osPictureText, osPlusMinusPictureText, or osTreePictureText.</para>
  1774.                   
  1775.             </note>
  1776.          </comments>
  1777.       </member>
  1778.       <member name="P:Outline.Outline.PictureLeaf">
  1779.          <summary>
  1780.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the bitmap used to represent an item that does not have subitems.</para>
  1781.          </summary>
  1782.          <comments>
  1783.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By default, <property namespace="Outline" class="TCustomOutline">PictureLeaf</property> is a document bitmap. Set <property namespace="Outline" class="TCustomOutline">PictureLeaf</property> to change the bitmap used for leaf nodes.</para>
  1784.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1785.                      
  1786.                <para>The bitmap is not displayed in the outline unless the OutlineStyle property is set to osPictureText, osPlusMinusPictureText, or osTreePictureText.</para>
  1787.                   
  1788.             </note>
  1789.          </comments>
  1790.       </member>
  1791.       <member name="P:Outline.Outline.ItemCount">
  1792.          <summary>
  1793.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the number of nodes in the outline.</para>
  1794.          </summary>
  1795.          <comments>
  1796.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="Outline" class="TCustomOutline">ItemCount</property> to determine the number of nodes in the outline. Use <property namespace="Outline" class="TCustomOutline">ItemCount</property> with the Items property array to iterate over all nodes in the outline.</para>
  1797.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1798.                      
  1799.                <para>Reading <property namespace="Outline" class="TCustomOutline">ItemCount</property> can be computationally expensive, as it causes all the indexes used by the outline to be updated.</para>
  1800.                   
  1801.             </note>
  1802.          </comments>
  1803.       </member>
  1804.       <member name="P:Outline.Outline.Items">
  1805.          <summary>
  1806.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Lists the nodes in the outline.</para>
  1807.          </summary>
  1808.          <comments>
  1809.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="Outline" class="TCustomOutline">Items</property> to access a node in the outline. Each item is a TOutlineNode object.</para>
  1810.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Index is a number specifying the node to return, where <property namespace="Outline" class="TCustomOutline">Items</property>[0] refers to the root, <property namespace="Outline" class="TCustomOutline">Items</property>[1] is the first (topmost) node, and so on.</para>
  1811.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1812.                      
  1813.                <para>
  1814.                         
  1815.                   <property namespace="Outline" class="TCustomOutline">Items</property> is the default property of <property namespace="Outline" class="TCustomOutline">TCustomOutline</property>. This means that the name of the property may be omitted in code. Thus the line</para>
  1816.                   
  1817.             </note>
  1818.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1819.                      
  1820.                <para>Outline1.<property namespace="Outline" class="TCustomOutline">Items</property>[1].Text := Edit1.Text;</para>
  1821.                   
  1822.             </note>
  1823.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1824.                      
  1825.                <para>can also be written</para>
  1826.                   
  1827.             </note>
  1828.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1829.                      
  1830.                <para>Outline1[1].Text := Edit1.Text;</para>
  1831.                   
  1832.             </note>
  1833.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1834.                      
  1835.                <para>In C++, <property namespace="Outline" class="TCustomOutline">Items</property> can be accessed using the [] operator, to achieve an affect similar to the default property in Delphi.</para>
  1836.                   
  1837.             </note>
  1838.          </comments>
  1839.       </member>
  1840.       <member name="P:Outline.Outline.SelectedItem">
  1841.          <summary>
  1842.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the index of the selected node.</para>
  1843.          </summary>
  1844.          <comments>
  1845.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="Outline" class="TCustomOutline">SelectedItem</property> to determine the Index of the selected node. If no node is selected, <property namespace="Outline" class="TCustomOutline">SelectedItem</property> is 0. Set <property namespace="Outline" class="TCustomOutline">SelectedItem</property> to set focus to a particular node in the outline.</para>
  1846.          </comments>
  1847.       </member>
  1848.       <member name="E:Outline.Outline.OnExpand">
  1849.          <summary>
  1850.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs immediately after a node in the outline is expanded.</para>
  1851.          </summary>
  1852.          <comments>
  1853.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Outline" class="TCustomOutline">OnExpand</event> event handler to perform special processing when a node in the outline is expanded. The event handler identifies the node that was just expanded.</para>
  1854.          </comments>
  1855.       </member>
  1856.       <member name="E:Outline.Outline.OnCollapse">
  1857.          <summary>
  1858.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs immediately after a node in the outline is collapsed.</para>
  1859.          </summary>
  1860.          <comments>
  1861.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="Outline" class="TCustomOutline">OnCollapse</event> event handler to perform special processing when a node in the outline is collapsed. The event handler supplies the index of the node that collapsed.</para>
  1862.          </comments>
  1863.       </member>
  1864.       <member name="E:Outline.Outline.OnDrawItem">
  1865.          <summary>
  1866.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a node must be drawn in an owner-draw outline.</para>
  1867.          </summary>
  1868.          <comments>
  1869.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the Style property is set to otOwnerDraw, specify an <event namespace="Outline" class="TCustomOutline">OnDrawItem</event> event handler to render the image of each node in the outline. An <event namespace="Outline" class="TCustomOutline">OnDrawItem</event> event handler can display items other than the Text of a node and the standard bitmaps specified in the PictureClosed, PictureOpen, PictureMinus, PicturePlus, and PictureLeaf properties. </para>
  1870.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Draw the image of the node specified by the Index parameter onto the canvas of the outline. </para>
  1871.          </comments>
  1872.       </member>
  1873.       <member name="T:Outline.TOutline">
  1874.          <summary>
  1875.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1876.                
  1877.                <class namespace="Outline">TOutline</class> is a multilevel outline that displays the values of <class namespace="Outline">TOutline</class>Node objects.</para>
  1878.          </summary>
  1879.          <comments>
  1880.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use an outline to visually organize information in a hierarchical tree. Each item in an outline is contained in a <class namespace="Outline">TOutline</class>Node object. Outline controls allow an application to manage a hierarchy of outline nodes, including the ability to control the appearance and layout of those nodes and the ability to expand or collapse branches of the outline tree.</para>
  1881.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1882.                
  1883.                <class namespace="Outline">TOutline</class> is provided primarily for backward compatibility. New applications should use TTreeView instead.</para>
  1884.          </comments>
  1885.       </member>
  1886.       <member name="T:TabNotBk.TTabPage">
  1887.          <summary>
  1888.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1889.                
  1890.                <class namespace="TabNotBk">TTabPage</class> implements an individual tab page of a tabbed notebook control.</para>
  1891.          </summary>
  1892.          <comments>
  1893.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each instance of this class holds the controls to be displayed when it is the active page of a tabbed notebook. <class namespace="TabNotBk">TTabPage</class> objects are associated with the strings in the corresponding tabbed notebook's Pages property by setting their Caption property.</para>
  1894.          </comments>
  1895.       </member>
  1896.       <member name="T:TabNotBk.TTabbedNotebook">
  1897.          <summary>
  1898.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1899.                
  1900.                <class namespace="TabNotBk">TTabbedNotebook</class> contains multiple pages, each with its own set of controls.</para>
  1901.          </summary>
  1902.          <comments>
  1903.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1904.                
  1905.                <class namespace="TabNotBk">TTabbedNotebook</class> is provided for backwards compatibility. New applications should use TPageControl instead.</para>
  1906.          </comments>
  1907.       </member>
  1908.       <member name="M:TabNotBk.TabNotBk.GetIndexForPage">
  1909.          <summary>
  1910.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the PageIndex value of the specified page. </para>
  1911.          </summary>
  1912.          <comments>
  1913.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The PageIndex property value is determined by the page's position in the Pages property array. Specify the name of the page as the value of the PageName parameter. The name you specify must be one of the strings in the Pages property.</para>
  1914.          </comments>
  1915.       </member>
  1916.       <member name="M:TabNotBk.TabNotBk.Create">
  1917.          <summary>
  1918.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Constructs a tabbed notebook component.</para>
  1919.          </summary>
  1920.          <comments>
  1921.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="TabNotBk" class="TTabbedNotebook">Create</method>
  1922.                      
  1923.                <method namespace="TabNotBk" class="TTabbedNotebook">TTabbedNotebook</method> indirectly, using the new keyword, to instantiate a tabbed notebook at runtime. Tabbed notebooks added to forms at design time are created automatically.</para>
  1924.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The AOwner parameter assigns a value to the notebook's Owner property.</para>
  1925.          </comments>
  1926.       </member>
  1927.       <member name="M:TabNotBk.TabNotBk.TabFontChanged">
  1928.          <summary>
  1929.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Invalidates the tabs when the TabFont property changes.</para>
  1930.          </summary>
  1931.          <comments>
  1932.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1933.                      
  1934.                <method namespace="TabNotBk" class="TTabbedNotebook">TabFontChanged</method> is called automatically when the TabFont property changes. It invalidates the notebook so that the tabs are repainted in the new font.</para>
  1935.          </comments>
  1936.       </member>
  1937.       <member name="M:TabNotBk.TabNotBk.Destroy">
  1938.          <summary>
  1939.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1940.                      
  1941.                <method namespace="TabNotBk" class="TTabbedNotebook">Destroy</method>s a tabbed notebook component.</para>
  1942.          </summary>
  1943.          <comments>
  1944.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="TabNotBk" class="TTabbedNotebook">Destroy</method> directly in an application, Instead, use Free method, which checks that the notebook is not nil before calling <method namespace="TabNotBk" class="TTabbedNotebook">Destroy</method>.</para>
  1945.          </comments>
  1946.       </member>
  1947.       <member name="P:TabNotBk.TabNotBk.TopFont">
  1948.          <summary>
  1949.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Returns the current value of font used on the tabs of the tabbed notebook.</para>
  1950.          </summary>
  1951.          <comments>
  1952.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1953.                      
  1954.                <property namespace="TabNotBk" class="TTabbedNotebook">TopFont</property> is a read-only property that reports the TabFont value.</para>
  1955.          </comments>
  1956.       </member>
  1957.       <member name="P:TabNotBk.TabNotBk.ActivePage">
  1958.          <summary>
  1959.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines which page displays in the tabbed notebook control. </para>
  1960.          </summary>
  1961.          <comments>
  1962.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="TabNotBk" class="TTabbedNotebook">ActivePage</property> must be one of the strings contained in the Pages property.</para>
  1963.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1964.                      
  1965.                <para>To indicate the page that appears in the tabbed notebook by index rather than text, use the PageIndex property instead.</para>
  1966.                   
  1967.             </note>
  1968.          </comments>
  1969.       </member>
  1970.       <member name="P:TabNotBk.TabNotBk.PageIndex">
  1971.          <summary>
  1972.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines which page displays in the tabbed notebook component. </para>
  1973.          </summary>
  1974.          <comments>
  1975.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Changing the <property namespace="TabNotBk" class="TTabbedNotebook">PageIndex</property> value changes the page in the control.</para>
  1976.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Each string in the Pages property is automatically assigned a <property namespace="TabNotBk" class="TTabbedNotebook">PageIndex</property> value when the page is created. The first page receives a value of 0, the second has a value of 1, and so on. If you delete a string from the Pages property, the <property namespace="TabNotBk" class="TTabbedNotebook">PageIndex</property> values are reassigned so that the values always begin with 0 and continue to increase without any gaps between values.</para>
  1977.          </comments>
  1978.       </member>
  1979.       <member name="P:TabNotBk.TabNotBk.Pages">
  1980.          <summary>
  1981.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Contains the strings that identify the individual pages of the tabbed notebook control.</para>
  1982.          </summary>
  1983.          <comments>
  1984.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Tabbed notebook controls create a separate page for each string in the <property namespace="TabNotBk" class="TTabbedNotebook">Pages</property> property. For example, if <property namespace="TabNotBk" class="TTabbedNotebook">Pages</property> contains three strings, First, Second, and Third, the control has three separate pages.  Each string in <property namespace="TabNotBk" class="TTabbedNotebook">Pages</property> corresponds to a TTabPage object whose Caption property is the same as the string.</para>
  1985.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">You can change the active page in a tabbed notebook control with either the ActivePage or PageIndex property. </para>
  1986.          </comments>
  1987.       </member>
  1988.       <member name="P:TabNotBk.TabNotBk.TabFont">
  1989.          <summary>
  1990.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines the font used on the tabs of the tabbed notebook control. </para>
  1991.          </summary>
  1992.          <comments>
  1993.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="TabNotBk" class="TTabbedNotebook">TabFont</property> to specify the font characteristics used to display the label on the tabs of the notebook. </para>
  1994.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  1995.                      
  1996.                <para>The text on the selected tab is boldfaced if the selected font for the <property namespace="TabNotBk" class="TTabbedNotebook">TabFont</property> property is not also boldfaced.</para>
  1997.                   
  1998.             </note>
  1999.          </comments>
  2000.       </member>
  2001.       <member name="E:TabNotBk.TabNotBk.OnClick">
  2002.          <summary>
  2003.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when a tab of a tabbed notebook is selected.</para>
  2004.          </summary>
  2005.          <comments>
  2006.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="TabNotBk" class="TTabbedNotebook">OnClick</event> event handler to respond when the user selects a tab in the tabbed notebook. Immediately after the <event namespace="TabNotBk" class="TTabbedNotebook">OnClick</event> event occurs, the OnChange event occurs.</para>
  2007.          </comments>
  2008.       </member>
  2009.       <member name="E:TabNotBk.TabNotBk.OnChange">
  2010.          <summary>
  2011.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the page of a tabbed notebook changes.</para>
  2012.          </summary>
  2013.          <comments>
  2014.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an OnPage event handler to respond to a page change in a tabbed notebook. </para>
  2015.          </comments>
  2016.       </member>
  2017.       <member name="T:FileCtrl.TFileAttr">
  2018.          <summary>
  2019.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2020.                
  2021.                <condition os="Windows">
  2022.                   
  2023.                   <type namespace="OleAuto">TFileAttr</type> and TFileType determine which files a file list box displays.</condition>
  2024.             
  2025.             </para>
  2026.          </summary>
  2027.          <comments>
  2028.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2029.                
  2030.                <condition os="Windows">TFileType is a set of <type namespace="OleAuto">TFileAttr</type> values. These are the possible <type namespace="OleAuto">TFileAttr</type> values:</condition>
  2031.             
  2032.             </para>
  2033.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2034.                
  2035.                <tr>
  2036.                   
  2037.                   <th>Value</th>
  2038.                   
  2039.                   <th>Meaning</th>
  2040.                
  2041.                </tr>
  2042.                
  2043.                <tr>
  2044.                   
  2045.                   <td>
  2046.                      
  2047.                      <para>ftReadOnly</para>
  2048.                   
  2049.                   </td>
  2050.                   
  2051.                   <td>
  2052.                      
  2053.                      <para>The list box displays files with the read-only attribute.</para>
  2054.                   
  2055.                   </td>
  2056.                
  2057.                </tr>
  2058.                
  2059.                <tr>
  2060.                   
  2061.                   <td>
  2062.                      
  2063.                      <para>ftHidden</para>
  2064.                   
  2065.                   </td>
  2066.                   
  2067.                   <td>
  2068.                      
  2069.                      <para>The list box displays files with the hidden attribute.</para>
  2070.                   
  2071.                   </td>
  2072.                
  2073.                </tr>
  2074.                
  2075.                <tr>
  2076.                   
  2077.                   <td>
  2078.                      
  2079.                      <para>ftSystem</para>
  2080.                   
  2081.                   </td>
  2082.                   
  2083.                   <td>
  2084.                      
  2085.                      <para>The list box displays system files.</para>
  2086.                   
  2087.                   </td>
  2088.                
  2089.                </tr>
  2090.                
  2091.                <tr>
  2092.                   
  2093.                   <td>
  2094.                      
  2095.                      <para>ftVolumeID</para>
  2096.                   
  2097.                   </td>
  2098.                   
  2099.                   <td>
  2100.                      
  2101.                      <para>The list box displays the volume name.</para>
  2102.                   
  2103.                   </td>
  2104.                
  2105.                </tr>
  2106.                
  2107.                <tr>
  2108.                   
  2109.                   <td>
  2110.                      
  2111.                      <para>ftDirectory</para>
  2112.                   
  2113.                   </td>
  2114.                   
  2115.                   <td>
  2116.                      
  2117.                      <para>The list box displays directories.</para>
  2118.                   
  2119.                   </td>
  2120.                
  2121.                </tr>
  2122.                
  2123.                <tr>
  2124.                   
  2125.                   <td>
  2126.                      
  2127.                      <para>ftArchive</para>
  2128.                   
  2129.                   </td>
  2130.                   
  2131.                   <td>
  2132.                      
  2133.                      <para>The list box displays files with archive attribute.</para>
  2134.                   
  2135.                   </td>
  2136.                
  2137.                </tr>
  2138.                
  2139.                <tr>
  2140.                   
  2141.                   <td>
  2142.                      
  2143.                      <para>ftNormal</para>
  2144.                   
  2145.                   </td>
  2146.                   
  2147.                   <td>
  2148.                      
  2149.                      <para>The list box displays files with no special attributes.</para>
  2150.                   
  2151.                   </td>
  2152.                
  2153.                </tr>
  2154.             
  2155.             </table>
  2156.          </comments>
  2157.       </member>
  2158.       <member name="T:FileCtrl.TFileType">
  2159.          <summary>
  2160.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2161.                
  2162.                <type namespace="Qt">TFileType</type> describes possible combinations of file attributes.</para>
  2163.          </summary>
  2164.          <comments>
  2165.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2166.                
  2167.                <type namespace="Qt">TFileType</type> describes possible combinations of file attributes.</para>
  2168.          </comments>
  2169.       </member>
  2170.       <member name="T:FileCtrl.TFileListBox">
  2171.          <summary>
  2172.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2173.                
  2174.                <class namespace="FileCtrl">TFileListBox</class> is a specialized list box that lists all the files in a specified directory.</para>
  2175.          </summary>
  2176.          <comments>
  2177.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Add <class namespace="FileCtrl">TFileListBox</class> to a form to allow users to select a file. Use <class namespace="FileCtrl">TFileListBox</class> along with TDriveComboBox, TFilterComboBox, and TDirectoryListBox to add full file selection capabilities to a form. </para>
  2178.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2179.                
  2180.                <para>To add a standard Windows file open or save dialog to an application, use TOpenDialog or TSaveDialog instead.</para>
  2181.             
  2182.             </note>
  2183.          </comments>
  2184.       </member>
  2185.       <member name="M:FileCtrl.FileCtrl.Create">
  2186.          <summary>
  2187.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2188.                      
  2189.                <method namespace="FileCtrl" class="TFileListBox">Create</method>s an instance of <method namespace="FileCtrl" class="TFileListBox">TFileListBox</method>.</para>
  2190.          </summary>
  2191.          <comments>
  2192.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="FileCtrl" class="TFileListBox">Create</method> to create a <method namespace="FileCtrl" class="TFileListBox">TFileListBox</method> object at runtime. File list boxes placed on a form at design time are created automatically.</para>
  2193.          </comments>
  2194.       </member>
  2195.       <member name="M:FileCtrl.FileCtrl.Update">
  2196.          <summary>
  2197.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Refreshes the directory list for the file list box.</para>
  2198.          </summary>
  2199.          <comments>
  2200.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="FileCtrl" class="TFileListBox">Update</method> whenever the files listed by the file list box may be out of date. For example, if an application creates, renames, or deletes files, calling <method namespace="FileCtrl" class="TFileListBox">Update</method> will ensure that those changes are reflected in the file list box.</para>
  2201.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The list box is updated automatically when the Drive, Directory, FileType, or Mask property is changed.</para>
  2202.          </comments>
  2203.       </member>
  2204.       <member name="M:FileCtrl.FileCtrl.Destroy">
  2205.          <summary>
  2206.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2207.                      
  2208.                <method namespace="FileCtrl" class="TFileListBox">Destroy</method>s an instance of <method namespace="FileCtrl" class="TFileListBox">TFileListBox</method>.</para>
  2209.          </summary>
  2210.          <comments>
  2211.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="FileCtrl" class="TFileListBox">Destroy</method> directly in an application. Instead, call Free. Free checks that the file list box reference is not nil, and only then calls <method namespace="FileCtrl" class="TFileListBox">Destroy</method>.</para>
  2212.          </comments>
  2213.       </member>
  2214.       <member name="P:FileCtrl.FileCtrl.Drive">
  2215.          <summary>
  2216.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the drive which contains the files listed in the list box. </para>
  2217.          </summary>
  2218.          <comments>
  2219.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set the value of <property namespace="FileCtrl" class="TFileListBox">Drive</property> to the drive that contains the files that the list box should display. When the value of <property namespace="FileCtrl" class="TFileListBox">Drive</property> changes, the Directory value also changes to the current directory on the specified drive.</para>
  2220.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the form includes a TDirectoryListBox object, set the FileList property of the directory list box to have the <property namespace="FileCtrl" class="TFileListBox">Drive</property> property updated automatically when the <property namespace="FileCtrl" class="TFileListBox">Drive</property> property of the directory list box changes.</para>
  2221.          </comments>
  2222.       </member>
  2223.       <member name="P:FileCtrl.FileCtrl.Directory">
  2224.          <summary>
  2225.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the directory that contains all the files listed in the file list box.</para>
  2226.          </summary>
  2227.          <comments>
  2228.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="FileCtrl" class="TFileListBox">Directory</property> to update the file list box so that it displays the files in a new directory. If the form includes a T<property namespace="FileCtrl" class="TFileListBox">Directory</property>ListBox object, set the FileList property of the directory list box to have the <property namespace="FileCtrl" class="TFileListBox">Directory</property> property updated automatically when the user selects a new directory.</para>
  2229.          </comments>
  2230.       </member>
  2231.       <member name="P:FileCtrl.FileCtrl.FileName">
  2232.          <summary>
  2233.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the name of the selected file in the list box, including the path name. </para>
  2234.          </summary>
  2235.          <comments>
  2236.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="FileCtrl" class="TFileListBox">FileName</property> to initialize the file list box to a particular file. Read <property namespace="FileCtrl" class="TFileListBox">FileName</property> to obtain the name of the file the user selected.</para>
  2237.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the FileEdit property is set, the linked edit control displays the value of <property namespace="FileCtrl" class="TFileListBox">FileName</property> whenever the <property namespace="FileCtrl" class="TFileListBox">FileName</property> property changes.</para>
  2238.          </comments>
  2239.       </member>
  2240.       <member name="P:FileCtrl.FileCtrl.FileEdit">
  2241.          <summary>
  2242.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Links the directory list box to an edit control that displays the currently selected file.</para>
  2243.          </summary>
  2244.          <comments>
  2245.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="FileCtrl" class="TFileListBox">FileEdit</property> to an edit control that displays the selected file from the file list box, as is commonly done in Open and Save dialog boxes. If no file is selected in the file list box, the text of the edit control is the current value of the file list box's Mask property.</para>
  2246.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2247.                      
  2248.                <para>If the user changes the text of the edit control, the results are not automatically reflected in the file list box. Use the ApplyFilePath method to update the file list box when the edit control's text changes.</para>
  2249.                   
  2250.             </note>
  2251.          </comments>
  2252.       </member>
  2253.       <member name="P:FileCtrl.FileCtrl.FileType">
  2254.          <summary>
  2255.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines which files are displayed in the file list box based on the attributes of the files. </para>
  2256.          </summary>
  2257.          <comments>
  2258.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="FileCtrl" class="TFileListBox">FileType</property> to the type of files the list box should display. <property namespace="FileCtrl" class="TFileListBox">FileType</property> can specify more than one type of file. For example, if the value of <property namespace="FileCtrl" class="TFileListBox">FileType</property> is a set containing the values ftReadOnly and ftHidden, files that have either the read-only or the hidden attributes are displayed in the list box.</para>
  2259.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To set the <property namespace="FileCtrl" class="TFileListBox">FileType</property> property using the Object Inspector, click the <property namespace="FileCtrl" class="TFileListBox">FileType</property> property to see the attribute values. Then set each value to <condition language="Delphi">True or False</condition>
  2260.                      
  2261.                <condition language="CBuilder">true or false</condition> to specify whether it is included in the <property namespace="FileCtrl" class="TFileListBox">FileType</property> set.</para>
  2262.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2263.                      
  2264.                <para>The files that are listed can also be limited by the form of their names. To restrict the files to particular names, use the Mask property or include a TFilterComboBox on the form.</para>
  2265.                   
  2266.             </note>
  2267.          </comments>
  2268.       </member>
  2269.       <member name="P:FileCtrl.FileCtrl.Mask">
  2270.          <summary>
  2271.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Limits which files are displayed in the file list box. </para>
  2272.          </summary>
  2273.          <comments>
  2274.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="FileCtrl" class="TFileListBox">Mask</property> to a regular expression to limit the list box to files that match the mask. The value of the mask is a file name that may include wildcards. The asterisk (*) is a wildcard which matches any number of arbitrary characters. The question mark (?) is a wildcard which matches a single arbitrary character. The file mask *.* displays all files, which is the default value.</para>
  2275.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To specify multiple file masks, separate the file mask specifications with semicolons. For example, *.DLL;*.EXE.</para>
  2276.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the form includes a TFilterComboBox object, set the FileList property of the filter combo box to have the <property namespace="FileCtrl" class="TFileListBox">Mask</property> property updated automatically when the <property namespace="FileCtrl" class="TFileListBox">Mask</property> property of the filter combo box changes.</para>
  2277.          </comments>
  2278.       </member>
  2279.       <member name="P:FileCtrl.FileCtrl.ShowGlyphs">
  2280.          <summary>
  2281.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether glyphs (bitmaps) appear next to the file names listed in the file list box. </para>
  2282.          </summary>
  2283.          <comments>
  2284.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="FileCtrl" class="TFileListBox">ShowGlyphs</property> to true to display icons next to the files in the list that indicate the file type. Set <property namespace="FileCtrl" class="TFileListBox">ShowGlyphs</property> to false to list only the file names. </para>
  2285.          </comments>
  2286.       </member>
  2287.       <member name="E:FileCtrl.FileCtrl.OnChange">
  2288.          <summary>
  2289.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs immediately after the user changes the selected file in the list.</para>
  2290.          </summary>
  2291.          <comments>
  2292.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="FileCtrl" class="TFileListBox">OnChange</event> event handler to take specific action when the FileName property changes. If the FileEdit property has been set, the edit control is updated before the <event namespace="FileCtrl" class="TFileListBox">OnChange</event> event.</para>
  2293.          </comments>
  2294.       </member>
  2295.       <member name="T:FileCtrl.TDirectoryListBox">
  2296.          <summary>
  2297.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2298.                
  2299.                <class namespace="FileCtrl">TDirectoryListBox</class> represents a list box control that is aware of the directory structure of the current drive.</para>
  2300.          </summary>
  2301.          <comments>
  2302.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2303.                
  2304.                <class namespace="FileCtrl">TDirectoryListBox</class> implements the generic behavior introduced in TCustomListBox. <class namespace="FileCtrl">TDirectoryListBox</class> publishes many of the properties inherited from TCustomListBox and introduces new behavior to let the user change directories or drives.</para>
  2305.          </comments>
  2306.       </member>
  2307.       <member name="M:FileCtrl.FileCtrl.DisplayCase">
  2308.          <summary>
  2309.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Preserves or converts the case of the string passed to it.</para>
  2310.          </summary>
  2311.          <comments>
  2312.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2313.                      
  2314.                <method namespace="FileCtrl" class="TDirectoryListBox">DisplayCase</method> converts S to all-lower-case (using the currently installed language driver) if neither PreserveCase nor CaseSensitive is true. Otherwise, it returns S unmodified.</para>
  2315.          </comments>
  2316.       </member>
  2317.       <member name="M:FileCtrl.FileCtrl.FileCompareText">
  2318.          <summary>
  2319.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Compares two strings, taking into account the case-sensitivity of the file system.</para>
  2320.          </summary>
  2321.          <comments>
  2322.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If CaseSensitive is false, <method namespace="FileCtrl" class="TDirectoryListBox">FileCompareText</method> compares the strings passed to it case-insensitively. Otherwise, it uses AnsiCompareStr to compare the strings.</para>
  2323.          </comments>
  2324.       </member>
  2325.       <member name="M:FileCtrl.FileCtrl.Create">
  2326.          <summary>
  2327.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2328.                      
  2329.                <method namespace="FileCtrl" class="TDirectoryListBox">Create</method>s and initializes a directory list box.</para>
  2330.          </summary>
  2331.          <comments>
  2332.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="FileCtrl" class="TDirectoryListBox">Create</method> to instantiate a directory list box at runtime. For directory list boxes created at design time, <method namespace="FileCtrl" class="TDirectoryListBox">Create</method> is called automatically.</para>
  2333.          </comments>
  2334.       </member>
  2335.       <member name="M:FileCtrl.FileCtrl.OpenCurrent">
  2336.          <summary>
  2337.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Opens the selected directory.</para>
  2338.          </summary>
  2339.          <comments>
  2340.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2341.                      
  2342.                <method namespace="FileCtrl" class="TDirectoryListBox">OpenCurrent</method> opens the directory selected in the directory list box, as if the user had double-clicked the directory.</para>
  2343.          </comments>
  2344.       </member>
  2345.       <member name="M:FileCtrl.FileCtrl.Update">
  2346.          <summary>
  2347.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Refreshes the directory list.</para>
  2348.          </summary>
  2349.          <comments>
  2350.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="FileCtrl" class="TDirectoryListBox">Update</method> to refresh the directory list after new directories have been created or existing directories deleted.</para>
  2351.          </comments>
  2352.       </member>
  2353.       <member name="M:FileCtrl.FileCtrl.Destroy">
  2354.          <summary>
  2355.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Disposes of an instance of a directory list box.</para>
  2356.          </summary>
  2357.          <comments>
  2358.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="FileCtrl" class="TDirectoryListBox">Destroy</method> directly in an application. Call Free instead. Free checks that the list box reference is not nil before it calls <method namespace="FileCtrl" class="TDirectoryListBox">Destroy</method>.</para>
  2359.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2360.                      
  2361.                <method namespace="FileCtrl" class="TDirectoryListBox">Destroy</method> frees the bitmaps used for the Open, Close and Current folders, and then calls the inherited <method namespace="FileCtrl" class="TDirectoryListBox">Destroy</method> method.</para>
  2362.          </comments>
  2363.       </member>
  2364.       <member name="P:FileCtrl.FileCtrl.Drive">
  2365.          <summary>
  2366.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines the drive for which the list box displays the directory structure.</para>
  2367.          </summary>
  2368.          <comments>
  2369.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the value of <property namespace="FileCtrl" class="TDirectoryListBox">Drive</property> changes, the Directory value changes to the current directory on the specified drive.</para>
  2370.          </comments>
  2371.       </member>
  2372.       <member name="P:FileCtrl.FileCtrl.Directory">
  2373.          <summary>
  2374.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines the current directory for the directory list box control.</para>
  2375.          </summary>
  2376.          <comments>
  2377.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The directory list box displays the value of the <property namespace="FileCtrl" class="TDirectoryListBox">Directory</property> property as the current directory in the list box. The example shows how a directory list box and a file list box can work together through their <property namespace="FileCtrl" class="TDirectoryListBox">Directory</property> properties.</para>
  2378.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the form contains a file list box, you can set the FileList property to have the file list box automatically display the files from the directory specified by the <property namespace="FileCtrl" class="TDirectoryListBox">Directory</property> property.</para>
  2379.          </comments>
  2380.       </member>
  2381.       <member name="P:FileCtrl.FileCtrl.PreserveCase">
  2382.          <summary>
  2383.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the file system preserves the case of file names when writing to disk.</para>
  2384.          </summary>
  2385.          <comments>
  2386.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="FileCtrl" class="TDirectoryListBox">PreserveCase</property> to ascertain whether the current file system preserves the case of file names. <property namespace="FileCtrl" class="TDirectoryListBox">PreserveCase</property> returns true if it does and false if it does not.</para>
  2387.          </comments>
  2388.       </member>
  2389.       <member name="P:FileCtrl.FileCtrl.CaseSensitive">
  2390.          <summary>
  2391.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the system supports case-sensitive directory information.</para>
  2392.          </summary>
  2393.          <comments>
  2394.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="FileCtrl" class="TDirectoryListBox">CaseSensitive</property> to ascertain whether the current file system supports case-sensitive file names. <property namespace="FileCtrl" class="TDirectoryListBox">CaseSensitive</property> returns true if it does and false if it does not.</para>
  2395.          </comments>
  2396.       </member>
  2397.       <member name="P:FileCtrl.FileCtrl.DirLabel">
  2398.          <summary>
  2399.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides a simple way to display the current directory as the caption of a label control.</para>
  2400.          </summary>
  2401.          <comments>
  2402.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="FileCtrl" class="TDirectoryListBox">DirLabel</property> to specify a label. When the current directory changes in the directory list box, the change is reflected in the caption of the label.</para>
  2403.          </comments>
  2404.       </member>
  2405.       <member name="P:FileCtrl.FileCtrl.FileList">
  2406.          <summary>
  2407.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides a simple way to connect a directory list box with a file list box.</para>
  2408.          </summary>
  2409.          <comments>
  2410.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="FileCtrl" class="TDirectoryListBox">FileList</property> to specify a file list box in which to display the files of the current directory.</para>
  2411.          </comments>
  2412.       </member>
  2413.       <member name="E:FileCtrl.FileCtrl.OnChange">
  2414.          <summary>
  2415.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the user selects a new directory with the mouse or keyboard when the user moves the selection bar and presses enter.</para>
  2416.          </summary>
  2417.          <comments>
  2418.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="FileCtrl" class="TDirectoryListBox">OnChange</event> event handler to perform an action whenever a new directory is selected.</para>
  2419.          </comments>
  2420.       </member>
  2421.       <member name="T:FileCtrl.TTextCase">
  2422.          <summary>
  2423.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2424.                
  2425.                <type namespace="OleAuto">TTextCase</type> indicates the case of the volume name or drive letter that appears in a dialog box.</para>
  2426.          </summary>
  2427.          <comments>
  2428.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2429.                
  2430.                <type namespace="OleAuto">TTextCase</type> can have one of the following values:</para>
  2431.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2432.                
  2433.                <tr>
  2434.                   
  2435.                   <th>Value</th>
  2436.                   
  2437.                   <th>Meaning</th>
  2438.                
  2439.                </tr>
  2440.                
  2441.                <tr>
  2442.                   
  2443.                   <td>
  2444.                      
  2445.                      <para>tcLowerCase</para>
  2446.                   
  2447.                   </td>
  2448.                   
  2449.                   <td>
  2450.                      
  2451.                      <para>The volume name is displayed in lowercase letters.</para>
  2452.                   
  2453.                   </td>
  2454.                
  2455.                </tr>
  2456.                
  2457.                <tr>
  2458.                   
  2459.                   <td>
  2460.                      
  2461.                      <para>tcUpperCase</para>
  2462.                   
  2463.                   </td>
  2464.                   
  2465.                   <td>
  2466.                      
  2467.                      <para>The volume name is displayed in uppercase letters.</para>
  2468.                   
  2469.                   </td>
  2470.                
  2471.                </tr>
  2472.             
  2473.             </table>
  2474.          </comments>
  2475.       </member>
  2476.       <member name="T:FileCtrl.TDriveComboBox">
  2477.          <summary>
  2478.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2479.                
  2480.                <class namespace="filectrl">TDriveComboBox</class> implements a specialized combo box that displays all the drives available when the application runs. </para>
  2481.          </summary>
  2482.          <comments>
  2483.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Add <class namespace="filectrl">TDriveComboBox</class> to a form to allow users to select a drive. Use <class namespace="filectrl">TDriveComboBox</class> along with TFileListBox, TFilterComboBox, and TDirectoryListBox to add full file selection capabilities to a form. </para>
  2484.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To add a standard Windows 95 file open or save dialog to an application, use TOpenDialog or TSaveDialog instead.</para>
  2485.          </comments>
  2486.       </member>
  2487.       <member name="M:FileCtrl.FileCtrl.Create">
  2488.          <summary>
  2489.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2490.                      
  2491.                <method namespace="filectrl" class="TDriveComboBox">Create</method>s and initializes an instance of <method namespace="filectrl" class="TDriveComboBox">TDriveComboBox</method>.</para>
  2492.          </summary>
  2493.          <comments>
  2494.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="filectrl" class="TDriveComboBox">Create</method> to create a <method namespace="filectrl" class="TDriveComboBox">TDriveComboBox</method> object at runtime. Drive combo boxes placed on a form at design time are created automatically.</para>
  2495.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After allocating the memory for the combo box, <method namespace="filectrl" class="TDriveComboBox">Create</method> fills the combo box with all the drives on the system, and initializes the Drive property to the current drive.</para>
  2496.          </comments>
  2497.       </member>
  2498.       <member name="M:FileCtrl.FileCtrl.Destroy">
  2499.          <summary>
  2500.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2501.                      
  2502.                <method namespace="filectrl" class="TDriveComboBox">Destroy</method>s an instance of <method namespace="filectrl" class="TDriveComboBox">TDriveComboBox</method>.</para>
  2503.          </summary>
  2504.          <comments>
  2505.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="filectrl" class="TDriveComboBox">Destroy</method> directly in an application. Instead, call Free. Free checks that the drive combo box reference is not nil, and only then calls <method namespace="filectrl" class="TDriveComboBox">Destroy</method>.</para>
  2506.          </comments>
  2507.       </member>
  2508.       <member name="P:FileCtrl.FileCtrl.Drive">
  2509.          <summary>
  2510.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the currently selected drive displayed in the edit portion of the combo box. </para>
  2511.          </summary>
  2512.          <comments>
  2513.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="filectrl" class="TDriveComboBox">Drive</property> to initialize the combo box to a particular drive. Read <property namespace="filectrl" class="TDriveComboBox">Drive</property> to obtain the drive that was selected by the user.</para>
  2514.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the user uses the drive combo box to select a new drive, the selected drive becomes the value of the <property namespace="filectrl" class="TDriveComboBox">Drive</property> property. The value of the Text property also changes to the new volume name when the <property namespace="filectrl" class="TDriveComboBox">Drive</property> property value changes.</para>
  2515.          </comments>
  2516.       </member>
  2517.       <member name="P:FileCtrl.FileCtrl.DirList">
  2518.          <summary>
  2519.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Connects the drive combo box to a directory list box.</para>
  2520.          </summary>
  2521.          <comments>
  2522.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="filectrl" class="TDriveComboBox">DirList</property> to a directory list box control that should update when the user changes the drive. When a new drive is selected in the drive combo box, the specified directory list box updates to display the directory structure and the current directory on the new drive.</para>
  2523.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2524.                      
  2525.                <para>If the form contains a file list box as well, it can be updated automatically using the FileList property of the directory list box object.</para>
  2526.                   
  2527.             </note>
  2528.          </comments>
  2529.       </member>
  2530.       <member name="P:FileCtrl.FileCtrl.TextCase">
  2531.          <summary>
  2532.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines if the volume name in the Text property appears in uppercase or lowercase. </para>
  2533.          </summary>
  2534.          <comments>
  2535.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="filectrl" class="TDriveComboBox">TextCase</property> to the case that should be used to represent the drive letter that is the value of the Text property.</para>
  2536.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2537.                      
  2538.                <para>Changes made to the <property namespace="filectrl" class="TDriveComboBox">TextCase</property> property at design time don't appear until the application runs.</para>
  2539.                   
  2540.             </note>
  2541.          </comments>
  2542.       </member>
  2543.       <member name="T:FileCtrl.TFilterComboBox">
  2544.          <summary>
  2545.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2546.                
  2547.                <class namespace="FileCtrl">TFilterComboBox</class> is a specialized combo box that presents the user with a choice of file filters.</para>
  2548.          </summary>
  2549.          <comments>
  2550.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Add a filter combo box to a form that includes a file selection control to provide a set of predefined file filters. Use <class namespace="FileCtrl">TFilterComboBox</class> along with TDriveComboBox, TDirectoryListBox, and TFileListBox to add full file selection capabilities to a form. </para>
  2551.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To add a standard Win32 file open or save dialog to an application, use TOpenDialog or TSaveDialog instead.</para>
  2552.          </comments>
  2553.       </member>
  2554.       <member name="M:FileCtrl.FileCtrl.Create">
  2555.          <summary>
  2556.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2557.                      
  2558.                <method namespace="FileCtrl" class="TFilterComboBox">Create</method>s and initializes an instance of <method namespace="FileCtrl" class="TFilterComboBox">TFilterComboBox</method>.</para>
  2559.          </summary>
  2560.          <comments>
  2561.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="FileCtrl" class="TFilterComboBox">Create</method> to create a <method namespace="FileCtrl" class="TFilterComboBox">TFilterComboBox</method> objectat runtime. Filter combo boxes placed on a form at design time are created automatically.</para>
  2562.          </comments>
  2563.       </member>
  2564.       <member name="M:FileCtrl.FileCtrl.Destroy">
  2565.          <summary>
  2566.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2567.                      
  2568.                <method namespace="FileCtrl" class="TFilterComboBox">Destroy</method>s an instance of <method namespace="FileCtrl" class="TFilterComboBox">TFilterComboBox</method>.</para>
  2569.          </summary>
  2570.          <comments>
  2571.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="FileCtrl" class="TFilterComboBox">Destroy</method> directly in an application. Instead, call Free. Free checks that the filter combo box is not nil, and only then calls <method namespace="FileCtrl" class="TFilterComboBox">Destroy</method>.</para>
  2572.          </comments>
  2573.       </member>
  2574.       <member name="P:FileCtrl.FileCtrl.Mask">
  2575.          <summary>
  2576.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the mask associated with the string selected in the filter combo box.</para>
  2577.          </summary>
  2578.          <comments>
  2579.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="FileCtrl" class="TFilterComboBox">Mask</property> to obtain the mask that was selected by the user.</para>
  2580.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the user uses the filter combo box to select a new filter, the mask associated with the selected file type becomes the value of the <property namespace="FileCtrl" class="TFilterComboBox">Mask</property> property. If a file list box is linked to the filter combo box with the FileList property, the file list will update when the value of <property namespace="FileCtrl" class="TFilterComboBox">Mask</property> changes.</para>
  2581.          </comments>
  2582.       </member>
  2583.       <member name="P:FileCtrl.FileCtrl.FileList">
  2584.          <summary>
  2585.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Links the filter combo box to a file list box control.</para>
  2586.          </summary>
  2587.          <comments>
  2588.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the form includes a T<property namespace="FileCtrl" class="TFilterComboBox">FileList</property>Box object to display a list of files to choose from, set <property namespace="FileCtrl" class="TFilterComboBox">FileList</property> to allow the filter combo box to limit which files are displayed in the list box. Once the two controls are connected, whenever a new filter is selected using a filter combo box, the file list box displays the files that match the selected filter. </para>
  2589.          </comments>
  2590.       </member>
  2591.       <member name="P:FileCtrl.FileCtrl.Filter">
  2592.          <summary>
  2593.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Contains all the file masks displayed in the filter combo box.</para>
  2594.          </summary>
  2595.          <comments>
  2596.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set the <property namespace="FileCtrl" class="TFilterComboBox">Filter</property> property to specify the names that appear in the filter combo box, along with the masks associated with each name. Each mask is a file name that may include wildcards. The asterisk (*) is a wildcard which matches any number of arbitrary characters. The question mark (?) is a wildcard which matches a single arbitrary character. When the application runs, the file filter the user selects in the filter combo box becomes the value of the Mask property. </para>
  2597.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To create the value of <property namespace="FileCtrl" class="TFilterComboBox">Filter</property> for a single file type, follow these steps:</para>
  2598.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1Type some meaningful text to indicate the type of file.</para>
  2599.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2Type a | character (vertical bar).</para>
  2600.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3Type the file filter.</para>
  2601.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Don't put in any spaces around the | character in the string.</para>
  2602.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Here's an example:</para>
  2603.             <codeBlock xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" language="Delphi">FilterComboBox1.Filter := 'Text files|*.TXT';</codeBlock>
  2604.             <codeBlock xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" language="CBuilder">FilterComboBox1->Filter = "Text files|*.TXT";</codeBlock>
  2605.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <property namespace="FileCtrl" class="TFilterComboBox">Filter</property> is set to this string, the string "Text files" appears in the filter combo box. When the user selects "Text files", the mask is set to "*.TXT".</para>
  2606.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To specify multiple file filters, extend the value of <property namespace="FileCtrl" class="TFilterComboBox">Filter</property>, separating each file name/mask combination with a | character. <condition language="CBuilder">
  2607.                         
  2608.                   <property namespace="FileCtrl" class="TFilterComboBox">Filter</property> can specify an any number of file filters, as long as the string is less than 255 characters.</condition>
  2609.                   
  2610.             </para>
  2611.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Here's an example of two file filters that could be specified as the value of the <property namespace="FileCtrl" class="TFilterComboBox">Filter</property> property:</para>
  2612.             <codeBlock xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" language="Delphi">'Text files (*.TXT)|*.TXT|Pascal files (*.PAS)|*.PAS'</codeBlock>
  2613.             <codeBlock xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" language="CBuilder">"Text files (*.TXT)|*.TXT|C++ files (*.CPP)|*.CPP"</codeBlock>
  2614.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The previous example includes the file filters in parentheses in the text parts. This isn't required, but it's a common convention that helps users understand what to expect when they select a file filter.</para>
  2615.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The mask portion can include multiple file specifiers if they are separated with semicolons:</para>
  2616.             <codeBlock xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" language="Delphi">'All files|*.TXT;*.PAS;*.WB1'</codeBlock>
  2617.             <codeBlock xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" language="CBuilder">"All files|*.TXT;*.CPP;*.RC"</codeBlock>
  2618.          </comments>
  2619.       </member>
  2620.       <member name="T:FileCtrl.TSelectDirOpt">
  2621.          <summary>
  2622.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2623.                
  2624.                <condition os="Windows">
  2625.                   
  2626.                   <type namespace="OleAuto">TSelectDirOpt</type> and <type namespace="OleAuto">TSelectDirOpt</type>s determine how a directory selection dialog responds when the user enters a nonexistent directory.</condition>
  2627.             
  2628.             </para>
  2629.          </summary>
  2630.          <comments>
  2631.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2632.                
  2633.                <condition os="Windows">These are the possible values that can be added to the set of options:</condition>
  2634.             
  2635.             </para>
  2636.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2637.                
  2638.                <tr>
  2639.                   
  2640.                   <th>Value</th>
  2641.                   
  2642.                   <th>Meaning</th>
  2643.                
  2644.                </tr>
  2645.                
  2646.                <tr>
  2647.                   
  2648.                   <td>
  2649.                      
  2650.                      <para>sdAllowCreate</para>
  2651.                   
  2652.                   </td>
  2653.                   
  2654.                   <td>
  2655.                      
  2656.                      <para>An edit box allows the user to type in the name of a directory that does not exist. This option does not create a directory: the application must read the name of the selected directory and create it if desired.</para>
  2657.                   
  2658.                   </td>
  2659.                
  2660.                </tr>
  2661.                
  2662.                <tr>
  2663.                   
  2664.                   <td>
  2665.                      
  2666.                      <para>sdPerformCreate</para>
  2667.                   
  2668.                   </td>
  2669.                   
  2670.                   <td>
  2671.                      
  2672.                      <para>Used only in combination with sdAllowCreate. If the user enters a directory name that does not exist, the directory selection dialog creates it.</para>
  2673.                   
  2674.                   </td>
  2675.                
  2676.                </tr>
  2677.                
  2678.                <tr>
  2679.                   
  2680.                   <td>
  2681.                      
  2682.                      <para>sdPrompt</para>
  2683.                   
  2684.                   </td>
  2685.                   
  2686.                   <td>
  2687.                      
  2688.                      <para>Used only in combination with sdAllowCreate. Displays a message box that informs the user when the entered directory does not exist and asks if the directory should be created. If the user chooses OK, the directory is created if the option set includes sdPerformCreate. If the option set does not include sdPerformCreate, the directory is not created: the application must read the directory name and create it.</para>
  2689.                   
  2690.                   </td>
  2691.                
  2692.                </tr>
  2693.             
  2694.             </table>
  2695.          </comments>
  2696.       </member>
  2697.       <member name="M:FileCtrl.MinimizeName">
  2698.          <summary>
  2699.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Shortens a fully qualified path name so that it can be drawn with a specified length limit.</para>
  2700.          </summary>
  2701.          <comments>
  2702.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <routine namespace="FileCtrl">MinimizeName</routine> to obtain a version of a file name and path that can be drawn on a limited size drawing surface. <routine namespace="FileCtrl">MinimizeName</routine> replaces directories in the path portion of the file name with dots until the resulting name fits the specified number of pixels in length.</para>
  2703.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2704.                
  2705.                <routine namespace="FileCtrl">MinimizeName</routine> returns the shortened name.</para>
  2706.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Filename is the fully qualified path name that (possibly) needs to be shortened.</para>
  2707.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Canvas is the drawing surface on which the resulting name is to be rendered. It is used to determine font metrics.</para>
  2708.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">MaxLen is the length, in pixels, available for drawing the file name on the canvas.</para>
  2709.          </comments>
  2710.       </member>
  2711.       <member name="M:FileCtrl.ProcessPath">
  2712.          <summary>
  2713.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Parses a file name into its constituent parts.</para>
  2714.          </summary>
  2715.          <comments>
  2716.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="FileCtrl">ProcessPath</routine> to parse a file name into its drive, path, and file name.  </para>
  2717.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Pass the full file name that should be parsed as the EditText parameter. EditText must refer to an existing file or directory name.</para>
  2718.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2719.                
  2720.                <routine namespace="FileCtrl">ProcessPath</routine> returns the indicated drive, directory, and file name as the Drive, DirPart, and FilePart parameters.</para>
  2721.          </comments>
  2722.       </member>
  2723.       <member name="M:FileCtrl.SelectDirectory">
  2724.          <summary>
  2725.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Brings up a dialog to allow the user to enter a directory name.</para>
  2726.          </summary>
  2727.          <comments>
  2728.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="FileCtrl">SelectDirectory</routine> to let the user enter a directory name. </para>
  2729.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the first syntax to display the Windows directory browser. The Caption parameter specifies a caption for the dialog. The Root parameter specifies the root directory from which to browse. The selected directory is returned as the Directory parameter. When using this syntax, <routine namespace="FileCtrl">SelectDirectory</routine> does not change the value of the current directory.</para>
  2730.             <warning xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2731.                
  2732.                <para>You can't use the same variable for the Root parameter and the Directory parameter.</para>
  2733.             
  2734.             </warning>
  2735.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use the second syntax to call the Select Directory dialog box. The directory passed to the function with the Directory parameter appears as the currently selected directory when the dialog box appears. The name of the directory the user selects becomes the value of Directory when the function returns.</para>
  2736.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The HelpCtx parameter is the help context ID number.</para>
  2737.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Options parameter is a set of values. If Options is the empty set, the user can only select a directory that already exists. No edit box is provided for the user to enter a new directory name. If Options is not empty, the included values determine how the dialog responds when the user types a nonexistent directory name.</para>
  2738.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">With either syntax, <routine namespace="FileCtrl">SelectDirectory</routine> returns true if the user selected a directory and chose OK, and false if the user chose Cancel or closed the dialog box without selecting a directory.</para>
  2739.          </comments>
  2740.       </member>
  2741.       <member name="M:FileCtrl.DirectoryExists">
  2742.          <summary>
  2743.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether a specified directory exists.</para>
  2744.          </summary>
  2745.          <comments>
  2746.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <routine namespace="SysUtils">DirectoryExists</routine> to determine whether the directory specified by the Name parameter exists. If the directory exists, the function returns true. If the directory does not exist, the function returns false.</para>
  2747.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If a full path name is entered, <routine namespace="SysUtils">DirectoryExists</routine> searches for the directory along the designated path. Otherwise, the Name parameter is interpreted as a relative path name from the current directory.</para>
  2748.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2749.                
  2750.                <para>The FileCtrl unit (Windows only) also contains a <routine namespace="SysUtils">DirectoryExists</routine> function. However, the FileCtrl version is deprecated, and the SysUtils version preferred, even if the code does not need to be cross-platform.</para>
  2751.             
  2752.             </note>
  2753.          </comments>
  2754.       </member>
  2755.       <member name="M:FileCtrl.ForceDirectories">
  2756.          <summary>
  2757.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Creates a new directory, including the creation of parent directories as needed.</para>
  2758.          </summary>
  2759.          <comments>
  2760.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2761.                
  2762.                <routine namespace="SysUtils">ForceDirectories</routine> creates a new directory as specified in Dir, which must be a fully-qualified path name. If the directories given in the path do not yet exist, <routine namespace="SysUtils">ForceDirectories</routine> attempts to create them.</para>
  2763.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2764.                
  2765.                <routine namespace="SysUtils">ForceDirectories</routine> returns true if it successfully creates all necessary directories, false if it could not create a needed directory.</para>
  2766.             <warning xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2767.                
  2768.                <para>Important:Do not call <routine namespace="SysUtils">ForceDirectories</routine> with an empty string. Doing so causes <routine namespace="SysUtils">ForceDirectories</routine> to raise an exception.</para>
  2769.             
  2770.             </warning>
  2771.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2772.                
  2773.                <para>The FileCtrl unit (Windows only) also contains a <routine namespace="SysUtils">ForceDirectories</routine> function. However, the FileCtrl version is deprecated, and the SysUtils version preferred, even if the code does not need to be cross-platform.</para>
  2774.             
  2775.             </note>
  2776.          </comments>
  2777.       </member>
  2778.       <member name="T:MPlayer.TMPBtnType">
  2779.          <summary>
  2780.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2781.                
  2782.                <condition os="Windows">
  2783.                   
  2784.                   <type namespace="OleAuto">TMPBtnType</type> defines the possible buttons in a TMediaPlayer component and TButtonSet represents a set of those buttons.</condition>
  2785.             
  2786.             </para>
  2787.          </summary>
  2788.          <comments>
  2789.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2790.                
  2791.                <condition os="Windows">
  2792.                   
  2793.                   <type namespace="OleAuto">TMPBtnType</type> represents the type of a media player button. TButtonSet is a set of button types for the media player.</condition>
  2794.             
  2795.             </para>
  2796.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2797.                
  2798.                <condition os="Windows">Each button type has an associated action on the media player. The following table lists the button types and their associated actions:</condition>
  2799.             
  2800.             </para>
  2801.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2802.                
  2803.                <tr>
  2804.                   
  2805.                   <th>Value</th>
  2806.                   
  2807.                   <th>Action</th>
  2808.                
  2809.                </tr>
  2810.                
  2811.                <tr>
  2812.                   
  2813.                   <td>
  2814.                      
  2815.                      <para>btPlay</para>
  2816.                   
  2817.                   </td>
  2818.                   
  2819.                   <td>
  2820.                      
  2821.                      <para>Plays the media player.</para>
  2822.                   
  2823.                   </td>
  2824.                
  2825.                </tr>
  2826.                
  2827.                <tr>
  2828.                   
  2829.                   <td>
  2830.                      
  2831.                      <para>btRecord</para>
  2832.                   
  2833.                   </td>
  2834.                   
  2835.                   <td>
  2836.                      
  2837.                      <para>Starts recording.</para>
  2838.                   
  2839.                   </td>
  2840.                
  2841.                </tr>
  2842.                
  2843.                <tr>
  2844.                   
  2845.                   <td>
  2846.                      
  2847.                      <para>btStop</para>
  2848.                   
  2849.                   </td>
  2850.                   
  2851.                   <td>
  2852.                      
  2853.                      <para>Stops playing or recording.</para>
  2854.                   
  2855.                   </td>
  2856.                
  2857.                </tr>
  2858.                
  2859.                <tr>
  2860.                   
  2861.                   <td>
  2862.                      
  2863.                      <para>btNext</para>
  2864.                   
  2865.                   </td>
  2866.                   
  2867.                   <td>
  2868.                      
  2869.                      <para>Skips to the next track, or to the end if the medium doesn't use tracks.</para>
  2870.                   
  2871.                   </td>
  2872.                
  2873.                </tr>
  2874.                
  2875.                <tr>
  2876.                   
  2877.                   <td>
  2878.                      
  2879.                      <para>btPrev</para>
  2880.                   
  2881.                   </td>
  2882.                   
  2883.                   <td>
  2884.                      
  2885.                      <para>Skips to the previous track, or to the beginning if the medium doesn't use tracks.</para>
  2886.                   
  2887.                   </td>
  2888.                
  2889.                </tr>
  2890.                
  2891.                <tr>
  2892.                   
  2893.                   <td>
  2894.                      
  2895.                      <para>btStep</para>
  2896.                   
  2897.                   </td>
  2898.                   
  2899.                   <td>
  2900.                      
  2901.                      <para>Moves forward a number of frames.</para>
  2902.                   
  2903.                   </td>
  2904.                
  2905.                </tr>
  2906.                
  2907.                <tr>
  2908.                   
  2909.                   <td>
  2910.                      
  2911.                      <para>btBack</para>
  2912.                   
  2913.                   </td>
  2914.                   
  2915.                   <td>
  2916.                      
  2917.                      <para>Moves backward a number of frames.</para>
  2918.                   
  2919.                   </td>
  2920.                
  2921.                </tr>
  2922.                
  2923.                <tr>
  2924.                   
  2925.                   <td>
  2926.                      
  2927.                      <para>btPause</para>
  2928.                   
  2929.                   </td>
  2930.                   
  2931.                   <td>
  2932.                      
  2933.                      <para>Pauses playing or recording. If already paused when clicked, resumes playing or recording.</para>
  2934.                   
  2935.                   </td>
  2936.                
  2937.                </tr>
  2938.                
  2939.                <tr>
  2940.                   
  2941.                   <td>
  2942.                      
  2943.                      <para>btEject</para>
  2944.                   
  2945.                   </td>
  2946.                   
  2947.                   <td>
  2948.                      
  2949.                      <para>Ejects the medium.</para>
  2950.                   
  2951.                   </td>
  2952.                
  2953.                </tr>
  2954.             
  2955.             </table>
  2956.          </comments>
  2957.       </member>
  2958.       <member name="T:MPlayer.TButtonSet">
  2959.          <summary>
  2960.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2961.                
  2962.                <type namespace="DRIntf">TButtonSet</type> is a set of TNaviageBtn values.</para>
  2963.          </summary>
  2964.          <comments>
  2965.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2966.                
  2967.                <type namespace="DRIntf">TButtonSet</type> represents a set of zero or more of the buttons that can appear on a TDBNavigator control.</para>
  2968.          </comments>
  2969.       </member>
  2970.       <member name="T:MPlayer.TMPDeviceTypes">
  2971.          <summary>
  2972.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2973.                
  2974.                <condition os="Windows">
  2975.                   
  2976.                   <type namespace="OleAuto">TMPDeviceTypes</type> identifies a multimedia device.</condition>
  2977.             
  2978.             </para>
  2979.          </summary>
  2980.          <comments>
  2981.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2982.                
  2983.                <condition os="Windows">
  2984.                   
  2985.                   <type namespace="OleAuto">TMPDeviceTypes</type> type identifies the multimedia device types that can be opened by a TMediaPlayer component.  </condition>
  2986.             
  2987.             </para>
  2988.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2989.                
  2990.                <condition os="Windows">The following table lists the possible values:</condition>
  2991.             
  2992.             </para>
  2993.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  2994.                
  2995.                <tr>
  2996.                   
  2997.                   <th>Value</th>
  2998.                   
  2999.                   <th>Meaning</th>
  3000.                
  3001.                </tr>
  3002.                
  3003.                <tr>
  3004.                   
  3005.                   <td>
  3006.                      
  3007.                      <para>dtAutoSelect</para>
  3008.                   
  3009.                   </td>
  3010.                   
  3011.                   <td>
  3012.                      
  3013.                      <para>the device type is determined by the file extension.</para>
  3014.                   
  3015.                   </td>
  3016.                
  3017.                </tr>
  3018.                
  3019.                <tr>
  3020.                   
  3021.                   <td>
  3022.                      
  3023.                      <para>dtAVIVideo</para>
  3024.                   
  3025.                   </td>
  3026.                   
  3027.                   <td>
  3028.                      
  3029.                      <para>AVI clip</para>
  3030.                   
  3031.                   </td>
  3032.                
  3033.                </tr>
  3034.                
  3035.                <tr>
  3036.                   
  3037.                   <td>
  3038.                      
  3039.                      <para>dtCDAudio</para>
  3040.                   
  3041.                   </td>
  3042.                   
  3043.                   <td>
  3044.                      
  3045.                      <para>Audio CD recording</para>
  3046.                   
  3047.                   </td>
  3048.                
  3049.                </tr>
  3050.                
  3051.                <tr>
  3052.                   
  3053.                   <td>
  3054.                      
  3055.                      <para>dtDAT</para>
  3056.                   
  3057.                   </td>
  3058.                   
  3059.                   <td>
  3060.                      
  3061.                      <para>DAT file</para>
  3062.                   
  3063.                   </td>
  3064.                
  3065.                </tr>
  3066.                
  3067.                <tr>
  3068.                   
  3069.                   <td>
  3070.                      
  3071.                      <para>dtDigitalVideo</para>
  3072.                   
  3073.                   </td>
  3074.                   
  3075.                   <td>
  3076.                      
  3077.                      <para>Digital video recording</para>
  3078.                   
  3079.                   </td>
  3080.                
  3081.                </tr>
  3082.                
  3083.                <tr>
  3084.                   
  3085.                   <td>
  3086.                      
  3087.                      <para>dtMMMovie</para>
  3088.                   
  3089.                   </td>
  3090.                   
  3091.                   <td>
  3092.                      
  3093.                      <para>MM recording</para>
  3094.                   
  3095.                   </td>
  3096.                
  3097.                </tr>
  3098.                
  3099.                <tr>
  3100.                   
  3101.                   <td>
  3102.                      
  3103.                      <para>dtOther</para>
  3104.                   
  3105.                   </td>
  3106.                   
  3107.                   <td>
  3108.                      
  3109.                      <para>media type not identified by other categories</para>
  3110.                   
  3111.                   </td>
  3112.                
  3113.                </tr>
  3114.                
  3115.                <tr>
  3116.                   
  3117.                   <td>
  3118.                      
  3119.                      <para>dtOverlay</para>
  3120.                   
  3121.                   </td>
  3122.                   
  3123.                   <td>
  3124.                      
  3125.                      <para>Overlay</para>
  3126.                   
  3127.                   </td>
  3128.                
  3129.                </tr>
  3130.                
  3131.                <tr>
  3132.                   
  3133.                   <td>
  3134.                      
  3135.                      <para>dtScanner</para>
  3136.                   
  3137.                   </td>
  3138.                   
  3139.                   <td>
  3140.                      
  3141.                      <para>scanner</para>
  3142.                   
  3143.                   </td>
  3144.                
  3145.                </tr>
  3146.                
  3147.                <tr>
  3148.                   
  3149.                   <td>
  3150.                      
  3151.                      <para>dtSequencer</para>
  3152.                   
  3153.                   </td>
  3154.                   
  3155.                   <td>
  3156.                      
  3157.                      <para>sequencer</para>
  3158.                   
  3159.                   </td>
  3160.                
  3161.                </tr>
  3162.                
  3163.                <tr>
  3164.                   
  3165.                   <td>
  3166.                      
  3167.                      <para>dtVCR</para>
  3168.                   
  3169.                   </td>
  3170.                   
  3171.                   <td>
  3172.                      
  3173.                      <para>VCR</para>
  3174.                   
  3175.                   </td>
  3176.                
  3177.                </tr>
  3178.                
  3179.                <tr>
  3180.                   
  3181.                   <td>
  3182.                      
  3183.                      <para>dtVideodisc</para>
  3184.                   
  3185.                   </td>
  3186.                   
  3187.                   <td>
  3188.                      
  3189.                      <para>Videodisc</para>
  3190.                   
  3191.                   </td>
  3192.                
  3193.                </tr>
  3194.                
  3195.                <tr>
  3196.                   
  3197.                   <td>
  3198.                      
  3199.                      <para>dtWaveAudio</para>
  3200.                   
  3201.                   </td>
  3202.                   
  3203.                   <td>
  3204.                      
  3205.                      <para>.wav file</para>
  3206.                   
  3207.                   </td>
  3208.                
  3209.                </tr>
  3210.             
  3211.             </table>
  3212.          </comments>
  3213.       </member>
  3214.       <member name="T:MPlayer.TMPTimeFormats">
  3215.          <summary>
  3216.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3217.                
  3218.                <condition os="Windows">
  3219.                   
  3220.                   <type namespace="OleAuto">TMPTimeFormats</type> indicates the format a media player uses to indicate position.</condition>
  3221.             
  3222.             </para>
  3223.          </summary>
  3224.          <comments>
  3225.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3226.                
  3227.                <condition os="Windows">The <type namespace="OleAuto">TMPTimeFormats</type> type defines the time formats for a multimedia device used with a TMediaPlayer. The following table lists the possible values for the <type namespace="OleAuto">TMPTimeFormats</type> type:</condition>
  3228.             
  3229.             </para>
  3230.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3231.                
  3232.                <tr>
  3233.                   
  3234.                   <th>Value</th>
  3235.                   
  3236.                   <th>Time format</th>
  3237.                
  3238.                </tr>
  3239.                
  3240.                <tr>
  3241.                   
  3242.                   <td>
  3243.                      
  3244.                      <para>tfMilliseconds</para>
  3245.                   
  3246.                   </td>
  3247.                   
  3248.                   <td>
  3249.                      
  3250.                      <para>Milliseconds are stored as a 4-byte integer variable.</para>
  3251.                   
  3252.                   </td>
  3253.                
  3254.                </tr>
  3255.                
  3256.                <tr>
  3257.                   
  3258.                   <td>
  3259.                      
  3260.                      <para>tfHMS</para>
  3261.                   
  3262.                   </td>
  3263.                   
  3264.                   <td>
  3265.                      
  3266.                      <para>Hours, minutes, and seconds packed into a 4-byte integer. From least significant to most significant byte, the data values are</para>
  3267.                   
  3268.                   </td>
  3269.                
  3270.                </tr>
  3271.                
  3272.                <tr>
  3273.                   
  3274.                   <td>
  3275.                      
  3276.                      <para>  Hours (least significant byte)</para>
  3277.                   
  3278.                   </td>
  3279.                   
  3280.                   <td>
  3281.                      
  3282.                      <para/>
  3283.                   
  3284.                   </td>
  3285.                
  3286.                </tr>
  3287.                
  3288.                <tr>
  3289.                   
  3290.                   <td>
  3291.                      
  3292.                      <para>  Minutes</para>
  3293.                   
  3294.                   </td>
  3295.                   
  3296.                   <td>
  3297.                      
  3298.                      <para/>
  3299.                   
  3300.                   </td>
  3301.                
  3302.                </tr>
  3303.                
  3304.                <tr>
  3305.                   
  3306.                   <td>
  3307.                      
  3308.                      <para>  Seconds</para>
  3309.                   
  3310.                   </td>
  3311.                   
  3312.                   <td>
  3313.                      
  3314.                      <para/>
  3315.                   
  3316.                   </td>
  3317.                
  3318.                </tr>
  3319.                
  3320.                <tr>
  3321.                   
  3322.                   <td>
  3323.                      
  3324.                      <para>  Unused (most significant byte)</para>
  3325.                   
  3326.                   </td>
  3327.                   
  3328.                   <td>
  3329.                      
  3330.                      <para/>
  3331.                   
  3332.                   </td>
  3333.                
  3334.                </tr>
  3335.                
  3336.                <tr>
  3337.                   
  3338.                   <td>
  3339.                      
  3340.                      <para>tfMSF</para>
  3341.                   
  3342.                   </td>
  3343.                   
  3344.                   <td>
  3345.                      
  3346.                      <para>Minutes, seconds, and frames packed into a 4-byte integer. From least significant to most significant byte, the data values are</para>
  3347.                   
  3348.                   </td>
  3349.                
  3350.                </tr>
  3351.                
  3352.                <tr>
  3353.                   
  3354.                   <td>
  3355.                      
  3356.                      <para>  Minutes (least significant byte)</para>
  3357.                   
  3358.                   </td>
  3359.                   
  3360.                   <td>
  3361.                      
  3362.                      <para/>
  3363.                   
  3364.                   </td>
  3365.                
  3366.                </tr>
  3367.                
  3368.                <tr>
  3369.                   
  3370.                   <td>
  3371.                      
  3372.                      <para>  Seconds</para>
  3373.                   
  3374.                   </td>
  3375.                   
  3376.                   <td>
  3377.                      
  3378.                      <para/>
  3379.                   
  3380.                   </td>
  3381.                
  3382.                </tr>
  3383.                
  3384.                <tr>
  3385.                   
  3386.                   <td>
  3387.                      
  3388.                      <para>  Frames</para>
  3389.                   
  3390.                   </td>
  3391.                   
  3392.                   <td>
  3393.                      
  3394.                      <para/>
  3395.                   
  3396.                   </td>
  3397.                
  3398.                </tr>
  3399.                
  3400.                <tr>
  3401.                   
  3402.                   <td>
  3403.                      
  3404.                      <para>  Unused (most significant byte)</para>
  3405.                   
  3406.                   </td>
  3407.                   
  3408.                   <td>
  3409.                      
  3410.                      <para/>
  3411.                   
  3412.                   </td>
  3413.                
  3414.                </tr>
  3415.                
  3416.                <tr>
  3417.                   
  3418.                   <td>
  3419.                      
  3420.                      <para>tfFrames</para>
  3421.                   
  3422.                   </td>
  3423.                   
  3424.                   <td>
  3425.                      
  3426.                      <para>Frames are stored as a 4-byte integer variable.</para>
  3427.                   
  3428.                   </td>
  3429.                
  3430.                </tr>
  3431.                
  3432.                <tr>
  3433.                   
  3434.                   <td>
  3435.                      
  3436.                      <para>tfSMPTE24</para>
  3437.                   
  3438.                   </td>
  3439.                   
  3440.                   <td>
  3441.                      
  3442.                      <para>24-frame SMPTE packs values in a 4-byte variable. From least significant to most significant byte, the data values are</para>
  3443.                   
  3444.                   </td>
  3445.                
  3446.                </tr>
  3447.                
  3448.                <tr>
  3449.                   
  3450.                   <td>
  3451.                      
  3452.                      <para>  Hours (least significant byte)</para>
  3453.                   
  3454.                   </td>
  3455.                   
  3456.                   <td>
  3457.                      
  3458.                      <para/>
  3459.                   
  3460.                   </td>
  3461.                
  3462.                </tr>
  3463.                
  3464.                <tr>
  3465.                   
  3466.                   <td>
  3467.                      
  3468.                      <para>  Minutes</para>
  3469.                   
  3470.                   </td>
  3471.                   
  3472.                   <td>
  3473.                      
  3474.                      <para/>
  3475.                   
  3476.                   </td>
  3477.                
  3478.                </tr>
  3479.                
  3480.                <tr>
  3481.                   
  3482.                   <td>
  3483.                      
  3484.                      <para>  Seconds</para>
  3485.                   
  3486.                   </td>
  3487.                   
  3488.                   <td>
  3489.                      
  3490.                      <para/>
  3491.                   
  3492.                   </td>
  3493.                
  3494.                </tr>
  3495.                
  3496.                <tr>
  3497.                   
  3498.                   <td>
  3499.                      
  3500.                      <para>  Frames (most significant byte)</para>
  3501.                   
  3502.                   </td>
  3503.                   
  3504.                   <td>
  3505.                      
  3506.                      <para/>
  3507.                   
  3508.                   </td>
  3509.                
  3510.                </tr>
  3511.                
  3512.                <tr>
  3513.                   
  3514.                   <td>
  3515.                      
  3516.                      <para>SMPTE (Society of Motion Picture and Television Engineers) time is an absolute time format expressed in hours, minutes, seconds, and frames. The standard SMPTE division types are 24, 25, and 30 frames per second.</para>
  3517.                   
  3518.                   </td>
  3519.                   
  3520.                   <td>
  3521.                      
  3522.                      <para/>
  3523.                   
  3524.                   </td>
  3525.                
  3526.                </tr>
  3527.                
  3528.                <tr>
  3529.                   
  3530.                   <td>
  3531.                      
  3532.                      <para>tfSMPTE25</para>
  3533.                   
  3534.                   </td>
  3535.                   
  3536.                   <td>
  3537.                      
  3538.                      <para>25-frame SMPTE packs data into a 4-byte variable in the same order as 24-frame SMPTE.</para>
  3539.                   
  3540.                   </td>
  3541.                
  3542.                </tr>
  3543.                
  3544.                <tr>
  3545.                   
  3546.                   <td>
  3547.                      
  3548.                      <para>tfSMPTE30</para>
  3549.                   
  3550.                   </td>
  3551.                   
  3552.                   <td>
  3553.                      
  3554.                      <para>30-frame SMPTE packs data into the 4-byte variable in the same order as 24-frame SMPTE.</para>
  3555.                   
  3556.                   </td>
  3557.                
  3558.                </tr>
  3559.                
  3560.                <tr>
  3561.                   
  3562.                   <td>
  3563.                      
  3564.                      <para>tfSMPTE30Drop</para>
  3565.                   
  3566.                   </td>
  3567.                   
  3568.                   <td>
  3569.                      
  3570.                      <para>30-drop-frame SMPTE packs data into the 4-byte variable in the same order as 24-frame SMPTE.</para>
  3571.                   
  3572.                   </td>
  3573.                
  3574.                </tr>
  3575.                
  3576.                <tr>
  3577.                   
  3578.                   <td>
  3579.                      
  3580.                      <para>tfBytes</para>
  3581.                   
  3582.                   </td>
  3583.                   
  3584.                   <td>
  3585.                      
  3586.                      <para>Bytes are stored as a 4-byte integer variable.</para>
  3587.                   
  3588.                   </td>
  3589.                
  3590.                </tr>
  3591.                
  3592.                <tr>
  3593.                   
  3594.                   <td>
  3595.                      
  3596.                      <para>tfSamples</para>
  3597.                   
  3598.                   </td>
  3599.                   
  3600.                   <td>
  3601.                      
  3602.                      <para>Samples are stored as a 4-byte integer variable.</para>
  3603.                   
  3604.                   </td>
  3605.                
  3606.                </tr>
  3607.                
  3608.                <tr>
  3609.                   
  3610.                   <td>
  3611.                      
  3612.                      <para>tfTMSF</para>
  3613.                   
  3614.                   </td>
  3615.                   
  3616.                   <td>
  3617.                      
  3618.                      <para>Tracks, minutes, seconds, and frames are packed in the 4-byte variable. From least significant to most significant byte, the data values are</para>
  3619.                   
  3620.                   </td>
  3621.                
  3622.                </tr>
  3623.                
  3624.                <tr>
  3625.                   
  3626.                   <td>
  3627.                      
  3628.                      <para>  Tracks (least significant byte)</para>
  3629.                   
  3630.                   </td>
  3631.                   
  3632.                   <td>
  3633.                      
  3634.                      <para/>
  3635.                   
  3636.                   </td>
  3637.                
  3638.                </tr>
  3639.                
  3640.                <tr>
  3641.                   
  3642.                   <td>
  3643.                      
  3644.                      <para>  Minutes</para>
  3645.                   
  3646.                   </td>
  3647.                   
  3648.                   <td>
  3649.                      
  3650.                      <para/>
  3651.                   
  3652.                   </td>
  3653.                
  3654.                </tr>
  3655.                
  3656.                <tr>
  3657.                   
  3658.                   <td>
  3659.                      
  3660.                      <para>  Seconds</para>
  3661.                   
  3662.                   </td>
  3663.                   
  3664.                   <td>
  3665.                      
  3666.                      <para/>
  3667.                   
  3668.                   </td>
  3669.                
  3670.                </tr>
  3671.                
  3672.                <tr>
  3673.                   
  3674.                   <td>
  3675.                      
  3676.                      <para>  Frames (most significant byte)</para>
  3677.                   
  3678.                   </td>
  3679.                   
  3680.                   <td>
  3681.                      
  3682.                      <para/>
  3683.                   
  3684.                   </td>
  3685.                
  3686.                </tr>
  3687.             
  3688.             </table>
  3689.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3690.                
  3691.                <condition os="Windows">Note that MCI uses continuous track numbering.</condition>
  3692.             
  3693.             </para>
  3694.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3695.                
  3696.                <para>
  3697.                   
  3698.                   <condition os="Windows">Functions provided with MCI to help decoding the 4-byte integer specified in a given time format are documented under MCI Macros for Encoding and Decoding Time Data in the MMSYSTEM.HLP Help file.</condition>
  3699.                
  3700.                </para>
  3701.             
  3702.             </note>
  3703.          </comments>
  3704.       </member>
  3705.       <member name="T:MPlayer.TMPModes">
  3706.          <summary>
  3707.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3708.                
  3709.                <condition os="Windows">
  3710.                   
  3711.                   <type namespace="OleAuto">TMPModes</type> identifies the state of a TMediaPlayer component.</condition>
  3712.             
  3713.             </para>
  3714.          </summary>
  3715.          <comments>
  3716.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3717.                
  3718.                <condition os="Windows">
  3719.                   
  3720.                   <type namespace="OleAuto">TMPModes</type> type identifies the state of a media player. The following table lists the possible values:</condition>
  3721.             
  3722.             </para>
  3723.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3724.                
  3725.                <tr>
  3726.                   
  3727.                   <th>Value</th>
  3728.                   
  3729.                   <th>Mode</th>
  3730.                
  3731.                </tr>
  3732.                
  3733.                <tr>
  3734.                   
  3735.                   <td>
  3736.                      
  3737.                      <para>mpNotReady</para>
  3738.                   
  3739.                   </td>
  3740.                   
  3741.                   <td>
  3742.                      
  3743.                      <para>Not ready</para>
  3744.                   
  3745.                   </td>
  3746.                
  3747.                </tr>
  3748.                
  3749.                <tr>
  3750.                   
  3751.                   <td>
  3752.                      
  3753.                      <para>mpStopped</para>
  3754.                   
  3755.                   </td>
  3756.                   
  3757.                   <td>
  3758.                      
  3759.                      <para>Stopped</para>
  3760.                   
  3761.                   </td>
  3762.                
  3763.                </tr>
  3764.                
  3765.                <tr>
  3766.                   
  3767.                   <td>
  3768.                      
  3769.                      <para>mpPlaying</para>
  3770.                   
  3771.                   </td>
  3772.                   
  3773.                   <td>
  3774.                      
  3775.                      <para>Playing</para>
  3776.                   
  3777.                   </td>
  3778.                
  3779.                </tr>
  3780.                
  3781.                <tr>
  3782.                   
  3783.                   <td>
  3784.                      
  3785.                      <para>mpRecording</para>
  3786.                   
  3787.                   </td>
  3788.                   
  3789.                   <td>
  3790.                      
  3791.                      <para>Recording</para>
  3792.                   
  3793.                   </td>
  3794.                
  3795.                </tr>
  3796.                
  3797.                <tr>
  3798.                   
  3799.                   <td>
  3800.                      
  3801.                      <para>mpSeeking</para>
  3802.                   
  3803.                   </td>
  3804.                   
  3805.                   <td>
  3806.                      
  3807.                      <para>Seeking</para>
  3808.                   
  3809.                   </td>
  3810.                
  3811.                </tr>
  3812.                
  3813.                <tr>
  3814.                   
  3815.                   <td>
  3816.                      
  3817.                      <para>mpPaused</para>
  3818.                   
  3819.                   </td>
  3820.                   
  3821.                   <td>
  3822.                      
  3823.                      <para>Paused</para>
  3824.                   
  3825.                   </td>
  3826.                
  3827.                </tr>
  3828.                
  3829.                <tr>
  3830.                   
  3831.                   <td>
  3832.                      
  3833.                      <para>mpOpen</para>
  3834.                   
  3835.                   </td>
  3836.                   
  3837.                   <td>
  3838.                      
  3839.                      <para>Open</para>
  3840.                   
  3841.                   </td>
  3842.                
  3843.                </tr>
  3844.             
  3845.             </table>
  3846.          </comments>
  3847.       </member>
  3848.       <member name="T:MPlayer.TMPNotifyValues">
  3849.          <summary>
  3850.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3851.                
  3852.                <condition os="Windows">
  3853.                   
  3854.                   <type namespace="OleAuto">TMPNotifyValues</type> identifies the types of notifications a media device can give a TMediaPlayer component.</condition>
  3855.             
  3856.             </para>
  3857.          </summary>
  3858.          <comments>
  3859.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3860.                
  3861.                <condition os="Windows">The <type namespace="OleAuto">TMPNotifyValues</type> type defines the notification values for a multimedia device used with a TMediaPlayer. The possible values for the <type namespace="OleAuto">TMPNotifyValues</type> type are as follows.</condition>
  3862.             
  3863.             </para>
  3864.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3865.                
  3866.                <tr>
  3867.                   
  3868.                   <th>Value</th>
  3869.                   
  3870.                   <th>Meaning</th>
  3871.                
  3872.                </tr>
  3873.                
  3874.                <tr>
  3875.                   
  3876.                   <td>
  3877.                      
  3878.                      <para>nvSuccessful</para>
  3879.                   
  3880.                   </td>
  3881.                   
  3882.                   <td>
  3883.                      
  3884.                      <para>Command completed successfully</para>
  3885.                   
  3886.                   </td>
  3887.                
  3888.                </tr>
  3889.                
  3890.                <tr>
  3891.                   
  3892.                   <td>
  3893.                      
  3894.                      <para>nvSuperseded</para>
  3895.                   
  3896.                   </td>
  3897.                   
  3898.                   <td>
  3899.                      
  3900.                      <para>Command was superseded by another command</para>
  3901.                   
  3902.                   </td>
  3903.                
  3904.                </tr>
  3905.                
  3906.                <tr>
  3907.                   
  3908.                   <td>
  3909.                      
  3910.                      <para>nvAborted</para>
  3911.                   
  3912.                   </td>
  3913.                   
  3914.                   <td>
  3915.                      
  3916.                      <para>Command was aborted by the user</para>
  3917.                   
  3918.                   </td>
  3919.                
  3920.                </tr>
  3921.                
  3922.                <tr>
  3923.                   
  3924.                   <td>
  3925.                      
  3926.                      <para>nvFailure</para>
  3927.                   
  3928.                   </td>
  3929.                   
  3930.                   <td>
  3931.                      
  3932.                      <para>Command failed</para>
  3933.                   
  3934.                   </td>
  3935.                
  3936.                </tr>
  3937.             
  3938.             </table>
  3939.          </comments>
  3940.       </member>
  3941.       <member name="T:MPlayer.TMPDevCaps">
  3942.          <summary>
  3943.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3944.                
  3945.                <condition os="Windows">
  3946.                   
  3947.                   <type namespace="OleAuto">TMPDevCaps</type> defines the capabilities of a TMediaPlayer component and <type namespace="OleAuto">TMPDevCaps</type>Set represents a set of those capabilities.</condition>
  3948.             
  3949.             </para>
  3950.          </summary>
  3951.          <comments>
  3952.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3953.                
  3954.                <condition os="Windows">
  3955.                   
  3956.                   <type namespace="OleAuto">TMPDevCaps</type> represents the capabilities of a media player control. <type namespace="OleAuto">TMPDevCaps</type>Set is a set of <type namespace="OleAuto">TMPDevCaps</type> values.</condition>
  3957.             
  3958.             </para>
  3959.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3960.                
  3961.                <condition os="Windows">The following table lists the possible <type namespace="OleAuto">TMPDevCaps</type> values:</condition>
  3962.             
  3963.             </para>
  3964.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  3965.                
  3966.                <tr>
  3967.                   
  3968.                   <th>Value</th>
  3969.                   
  3970.                   <th>Capability</th>
  3971.                
  3972.                </tr>
  3973.                
  3974.                <tr>
  3975.                   
  3976.                   <td>
  3977.                      
  3978.                      <para>mpCanEject</para>
  3979.                   
  3980.                   </td>
  3981.                   
  3982.                   <td>
  3983.                      
  3984.                      <para>Can eject media</para>
  3985.                   
  3986.                   </td>
  3987.                
  3988.                </tr>
  3989.                
  3990.                <tr>
  3991.                   
  3992.                   <td>
  3993.                      
  3994.                      <para>mpCanPlay</para>
  3995.                   
  3996.                   </td>
  3997.                   
  3998.                   <td>
  3999.                      
  4000.                      <para>Can play media</para>
  4001.                   
  4002.                   </td>
  4003.                
  4004.                </tr>
  4005.                
  4006.                <tr>
  4007.                   
  4008.                   <td>
  4009.                      
  4010.                      <para>mpCanRecord</para>
  4011.                   
  4012.                   </td>
  4013.                   
  4014.                   <td>
  4015.                      
  4016.                      <para>Can record media</para>
  4017.                   
  4018.                   </td>
  4019.                
  4020.                </tr>
  4021.                
  4022.                <tr>
  4023.                   
  4024.                   <td>
  4025.                      
  4026.                      <para>mpCanStep</para>
  4027.                   
  4028.                   </td>
  4029.                   
  4030.                   <td>
  4031.                      
  4032.                      <para>Can step forward or backward within media</para>
  4033.                   
  4034.                   </td>
  4035.                
  4036.                </tr>
  4037.                
  4038.                <tr>
  4039.                   
  4040.                   <td>
  4041.                      
  4042.                      <para>mpUsesWindow</para>
  4043.                   
  4044.                   </td>
  4045.                   
  4046.                   <td>
  4047.                      
  4048.                      <para>Uses a window for displaying output</para>
  4049.                   
  4050.                   </td>
  4051.                
  4052.                </tr>
  4053.             
  4054.             </table>
  4055.          </comments>
  4056.       </member>
  4057.       <member name="T:MPlayer.EMCIDeviceError">
  4058.          <summary>
  4059.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4060.                
  4061.                <class namespace="mplayer">EMCIDeviceError</class> is the exception class for devices that provide a Media Control Interface (MCI) driver.</para>
  4062.          </summary>
  4063.          <comments>
  4064.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4065.                
  4066.                <class namespace="mplayer">EMCIDeviceError</class> is raised if an error occurs when accessing a multimedia device. The most common cause for the exception is trying to access a multimedia device before it has been opened with the Open method of TMediaPlayer.</para>
  4067.          </comments>
  4068.       </member>
  4069.       <member name="T:MPlayer.TMediaPlayer">
  4070.          <summary>
  4071.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4072.                
  4073.                <class namespace="MPlayer">TMediaPlayer</class> controls devices that provide a Media Control Interface (MCI) driver. </para>
  4074.          </summary>
  4075.          <comments>
  4076.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <class namespace="MPlayer">TMediaPlayer</class> component includes a set of buttons (Play, Stop, Eject, and so on) that control a multimedia device such as a CD-ROM drive, MIDI sequencer, or VCR. A multimedia device may be hardware or software.</para>
  4077.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The media player component contains of multiple buttons. These buttons can be clicked with the mouse, but are not separate objects or button components.</para>
  4078.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  4079.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ButtonValueAction</para>
  4080.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4081.                
  4082.                <tr>
  4083.                   
  4084.                   <th>Button</th>
  4085.                   
  4086.                   <th>Value</th>
  4087.                   
  4088.                   <th>Action</th>
  4089.                
  4090.                </tr>
  4091.                
  4092.                <tr>
  4093.                   
  4094.                   <td>
  4095.                      
  4096.                      <para>Play</para>
  4097.                   
  4098.                   </td>
  4099.                   
  4100.                   <td>
  4101.                      
  4102.                      <para>btPlay</para>
  4103.                   
  4104.                   </td>
  4105.                   
  4106.                   <td>
  4107.                      
  4108.                      <para>Plays the media player</para>
  4109.                   
  4110.                   </td>
  4111.                
  4112.                </tr>
  4113.                
  4114.                <tr>
  4115.                   
  4116.                   <td>
  4117.                      
  4118.                      <para>Pause</para>
  4119.                   
  4120.                   </td>
  4121.                   
  4122.                   <td>
  4123.                      
  4124.                      <para>btPause</para>
  4125.                   
  4126.                   </td>
  4127.                   
  4128.                   <td>
  4129.                      
  4130.                      <para>Pauses playing or recording. If already paused when clicked, resumes playing or recording.</para>
  4131.                   
  4132.                   </td>
  4133.                
  4134.                </tr>
  4135.                
  4136.                <tr>
  4137.                   
  4138.                   <td>
  4139.                      
  4140.                      <para>Stop</para>
  4141.                   
  4142.                   </td>
  4143.                   
  4144.                   <td>
  4145.                      
  4146.                      <para>btStop</para>
  4147.                   
  4148.                   </td>
  4149.                   
  4150.                   <td>
  4151.                      
  4152.                      <para>Stops playing or recording</para>
  4153.                   
  4154.                   </td>
  4155.                
  4156.                </tr>
  4157.                
  4158.                <tr>
  4159.                   
  4160.                   <td>
  4161.                      
  4162.                      <para>Next</para>
  4163.                   
  4164.                   </td>
  4165.                   
  4166.                   <td>
  4167.                      
  4168.                      <para>btNext</para>
  4169.                   
  4170.                   </td>
  4171.                   
  4172.                   <td>
  4173.                      
  4174.                      <para>Skips to the next track, or to the end if the medium doesn't use tracks</para>
  4175.                   
  4176.                   </td>
  4177.                
  4178.                </tr>
  4179.                
  4180.                <tr>
  4181.                   
  4182.                   <td>
  4183.                      
  4184.                      <para>Prev</para>
  4185.                   
  4186.                   </td>
  4187.                   
  4188.                   <td>
  4189.                      
  4190.                      <para>btPrev</para>
  4191.                   
  4192.                   </td>
  4193.                   
  4194.                   <td>
  4195.                      
  4196.                      <para>Skips to the previous track, or to the beginning if the medium doesn't use tracks</para>
  4197.                   
  4198.                   </td>
  4199.                
  4200.                </tr>
  4201.                
  4202.                <tr>
  4203.                   
  4204.                   <td>
  4205.                      
  4206.                      <para>Step</para>
  4207.                   
  4208.                   </td>
  4209.                   
  4210.                   <td>
  4211.                      
  4212.                      <para>btStep</para>
  4213.                   
  4214.                   </td>
  4215.                   
  4216.                   <td>
  4217.                      
  4218.                      <para>Moves forward a number of frames</para>
  4219.                   
  4220.                   </td>
  4221.                
  4222.                </tr>
  4223.                
  4224.                <tr>
  4225.                   
  4226.                   <td>
  4227.                      
  4228.                      <para>Back</para>
  4229.                   
  4230.                   </td>
  4231.                   
  4232.                   <td>
  4233.                      
  4234.                      <para>btBack</para>
  4235.                   
  4236.                   </td>
  4237.                   
  4238.                   <td>
  4239.                      
  4240.                      <para>Moves backward a number of frames</para>
  4241.                   
  4242.                   </td>
  4243.                
  4244.                </tr>
  4245.                
  4246.                <tr>
  4247.                   
  4248.                   <td>
  4249.                      
  4250.                      <para>Record</para>
  4251.                   
  4252.                   </td>
  4253.                   
  4254.                   <td>
  4255.                      
  4256.                      <para>btRecord</para>
  4257.                   
  4258.                   </td>
  4259.                   
  4260.                   <td>
  4261.                      
  4262.                      <para>Starts recording</para>
  4263.                   
  4264.                   </td>
  4265.                
  4266.                </tr>
  4267.                
  4268.                <tr>
  4269.                   
  4270.                   <td>
  4271.                      
  4272.                      <para>Eject</para>
  4273.                   
  4274.                   </td>
  4275.                   
  4276.                   <td>
  4277.                      
  4278.                      <para>btEject</para>
  4279.                   
  4280.                   </td>
  4281.                   
  4282.                   <td>
  4283.                      
  4284.                      <para>Ejects the medium</para>
  4285.                   
  4286.                   </td>
  4287.                
  4288.                </tr>
  4289.             
  4290.             </table>
  4291.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The multimedia device is played, paused, stopped, and so on when the user clicks the corresponding button on the <class namespace="MPlayer">TMediaPlayer</class> component. The device can also be controlled by the control methods that correspond to the buttons (Play, Pause, Stop, Next, Previous, Step, Back, StartRecording, and Eject).</para>
  4292.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The type of multimedia device (such as dtWaveAudio or dtVideodisc) is specified by the DeviceType property. If the device stores its media in a file, the name of the media file is specified by the FileName property. If DeviceType is dtAutoSelect, the media player attempts to determine the type of device from the extension of the file specified by FileName.</para>
  4293.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To have the media player attempt to open the device specified by DeviceType automatically when the media player component is created at runtime, set the AutoOpen property to true.</para>
  4294.          </comments>
  4295.       </member>
  4296.       <member name="M:MPlayer.MPlayer.Create">
  4297.          <summary>
  4298.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4299.                      
  4300.                <method namespace="MPlayer" class="TMediaPlayer">Create</method>s a media player object.</para>
  4301.          </summary>
  4302.          <comments>
  4303.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="MPlayer" class="TMediaPlayer">Create</method> to instantiate a media player at runtime. For media players created at design time, <method namespace="MPlayer" class="TMediaPlayer">Create</method> is called automatically.</para>
  4304.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4305.                      
  4306.                <method namespace="MPlayer" class="TMediaPlayer">Create</method> allocates memory for a media player and calls the inherited <method namespace="MPlayer" class="TMediaPlayer">Create</method>. Then it loads the bitmaps for the media player's buttons and initializes its properties, setting AutoEnable, AutoRewind, Colored, Enabled, and Visible to true, AutoOpen to false, and DeviceType to dtAutoSelect.</para>
  4307.          </comments>
  4308.       </member>
  4309.       <member name="M:MPlayer.MPlayer.KeyDown">
  4310.          <summary>
  4311.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Provides responses when the user types arrow keys or the space bar.</para>
  4312.          </summary>
  4313.          <comments>
  4314.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4315.                      
  4316.                <method namespace="MPlayer" class="TMediaPlayer">KeyDown</method> overrides the inherited method to implement the media player's response to certain keystrokes. It changes the current button when the user types the left or right arrow keys. When the user presses the space bar, <method namespace="MPlayer" class="TMediaPlayer">KeyDown</method> simulates a click on the current button.</para>
  4317.          </comments>
  4318.       </member>
  4319.       <member name="M:MPlayer.MPlayer.Loaded">
  4320.          <summary>
  4321.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initializes the media player after it is loaded from a stream.</para>
  4322.          </summary>
  4323.          <comments>
  4324.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4325.                      
  4326.                <method namespace="MPlayer" class="TMediaPlayer">Loaded</method> provides an opportunity for a component to initialize itself after all its parts have loaded from a stream. <method namespace="MPlayer" class="TMediaPlayer">TMediaPlayer</method> overrides the inherited method to implement the AutoOpen property.</para>
  4327.          </comments>
  4328.       </member>
  4329.       <member name="M:MPlayer.MPlayer.AutoButtonSet">
  4330.          <summary>
  4331.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Enables or Disables the media player's buttons.</para>
  4332.          </summary>
  4333.          <comments>
  4334.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4335.                      
  4336.                <method namespace="MPlayer" class="TMediaPlayer">AutoButtonSet</method> implements the automatic enabling and disabling of the media player's buttons when the AutoEnable property is true. The Btn parameter indicates which of the media player's buttons the user pressed.</para>
  4337.          </comments>
  4338.       </member>
  4339.       <member name="M:MPlayer.MPlayer.Notification">
  4340.          <summary>
  4341.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Responds when components are about to be inserted or removed.</para>
  4342.          </summary>
  4343.          <comments>
  4344.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By default, components pass along the notification to their owned components, if any. <method namespace="MPlayer" class="TMediaPlayer">Notification</method> calls the inherited <method namespace="MPlayer" class="TMediaPlayer">Notification</method> and then, if the Display window is deleted at runtime, it sets the video display back to original window.</para>
  4345.          </comments>
  4346.       </member>
  4347.       <member name="M:MPlayer.MPlayer.Paint">
  4348.          <summary>
  4349.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Renders the image of the media player.</para>
  4350.          </summary>
  4351.          <comments>
  4352.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the media player component receives a WM_PAINT message, like other custom controls, it responds by initializing the control's canvas and calling <method namespace="MPlayer" class="TMediaPlayer">Paint</method>. <method namespace="MPlayer" class="TMediaPlayer">Paint</method> draws the frame and all visible buttons.</para>
  4353.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When creating a descendant media player class, <method namespace="MPlayer" class="TMediaPlayer">Paint</method> can be overridden to draw the image of the corresponding media player object.</para>
  4354.          </comments>
  4355.       </member>
  4356.       <member name="M:MPlayer.MPlayer.MMNotify">
  4357.          <summary>
  4358.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Responds to a notification that the MCI device has completed an operation.</para>
  4359.          </summary>
  4360.          <comments>
  4361.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4362.                      
  4363.                <method namespace="MPlayer" class="TMediaPlayer">MMNotify</method> responds to a notification message from Windows that a multimedia command completed by updating button states if the AutoEnable property is true, setting internal flags to reflect the outcome of the command, then calling the DoNotify method to trigger the OnNotify event and any other special responses.</para>
  4364.          </comments>
  4365.       </member>
  4366.       <member name="M:MPlayer.MPlayer.Click">
  4367.          <summary>
  4368.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates an On<method namespace="MPlayer" class="TMediaPlayer">Click</method> event.</para>
  4369.          </summary>
  4370.          <comments>
  4371.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4372.                      
  4373.                <method namespace="MPlayer" class="TMediaPlayer">Click</method> for media-player components is the implementation method for the On<method namespace="MPlayer" class="TMediaPlayer">Click</method> event. By default, <method namespace="MPlayer" class="TMediaPlayer">Click</method> does nothing other than call any event handler attached to the media player's On<method namespace="MPlayer" class="TMediaPlayer">Click</method> event.<condition language="CBuilder"/>
  4374.                      
  4375.                <method namespace="MPlayer" class="TMediaPlayer">Click</method> can be overridden in descendant classes to customize responses to clicks.</para>
  4376.          </comments>
  4377.       </member>
  4378.       <member name="M:MPlayer.MPlayer.PostClick">
  4379.          <summary>
  4380.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines the action that takes place when an On<method namespace="MPlayer" class="TMediaPlayer">PostClick</method> event occurs.</para>
  4381.          </summary>
  4382.          <comments>
  4383.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4384.                      
  4385.                <method namespace="MPlayer" class="TMediaPlayer">PostClick</method> is the implementation method for the On<method namespace="MPlayer" class="TMediaPlayer">PostClick</method> event. By default, <method namespace="MPlayer" class="TMediaPlayer">PostClick</method> does nothing other than call any event handler attached to the media player's On<method namespace="MPlayer" class="TMediaPlayer">PostClick</method> event. <method namespace="MPlayer" class="TMediaPlayer">PostClick</method> can be overridden in descendant types to customize responses to clicks.</para>
  4386.          </comments>
  4387.       </member>
  4388.       <member name="M:MPlayer.MPlayer.DoNotify">
  4389.          <summary>
  4390.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates an OnNotify event.</para>
  4391.          </summary>
  4392.          <comments>
  4393.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4394.                      
  4395.                <method namespace="MPlayer" class="TMediaPlayer">DoNotify</method> is the implementation method for a media-player component's OnNotify event. The media player's MMNotify method calls <method namespace="MPlayer" class="TMediaPlayer">DoNotify</method> after correcting the enabling and disabling of buttons and setting internal flags from the values passed in the notification message parameters.</para>
  4396.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By default, <method namespace="MPlayer" class="TMediaPlayer">DoNotify</method> does nothing except call any event handler attached to the media player's OnNotify event. <method namespace="MPlayer" class="TMediaPlayer">DoNotify</method> can be overridden to provide other responses in addition to the inherited event-handler call.</para>
  4397.          </comments>
  4398.       </member>
  4399.       <member name="M:MPlayer.MPlayer.Updated">
  4400.          <summary>
  4401.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Signals that the media player has finished updating.</para>
  4402.          </summary>
  4403.          <comments>
  4404.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4405.                      
  4406.                <method namespace="MPlayer" class="TMediaPlayer">Updated</method> calls the inherited <method namespace="MPlayer" class="TMediaPlayer">Updated</method> before it modifies the layout of the media player buttons and forces a repaint.</para>
  4407.          </comments>
  4408.       </member>
  4409.       <member name="M:MPlayer.MPlayer.Open">
  4410.          <summary>
  4411.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4412.                      
  4413.                <method namespace="MPlayer" class="TMediaPlayer">Open</method>s a multimedia device.</para>
  4414.          </summary>
  4415.          <comments>
  4416.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="MPlayer" class="TMediaPlayer">Open</method> to open a multimedia device. The multimedia device type must be specified in the DeviceType property before a device can be opened.</para>
  4417.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">Open</method> stores a numerical error code in the Error property, and the corresponding error message in the ErrorMessage property.</para>
  4418.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">Open</method> method is completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">Open</method> generates an OnNotify event.</para>
  4419.          </comments>
  4420.       </member>
  4421.       <member name="M:MPlayer.MPlayer.Close">
  4422.          <summary>
  4423.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4424.                      
  4425.                <method namespace="MPlayer" class="TMediaPlayer">Close</method>s the open multimedia device.</para>
  4426.          </summary>
  4427.          <comments>
  4428.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">Close</method> stores a numerical error code in the Error property, and the corresponding error message in the ErrorMessage property.</para>
  4429.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">Close</method> method is completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">Close</method> generates an OnNotify event.</para>
  4430.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4431.                      
  4432.                <method namespace="MPlayer" class="TMediaPlayer">Close</method> is called automatically when the application is terminated.</para>
  4433.          </comments>
  4434.       </member>
  4435.       <member name="M:MPlayer.MPlayer.Play">
  4436.          <summary>
  4437.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4438.                      
  4439.                <method namespace="MPlayer" class="TMediaPlayer">Play</method>s the media loaded in the open multimedia device.</para>
  4440.          </summary>
  4441.          <comments>
  4442.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4443.                      
  4444.                <method namespace="MPlayer" class="TMediaPlayer">Play</method> is called when the <method namespace="MPlayer" class="TMediaPlayer">Play</method> button on the media player control is clicked at runtime.</para>
  4445.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">Play</method> stores a numerical error code in the Error property and the corresponding error message in the ErrorMessage property.</para>
  4446.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">Play</method> method has completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">Play</method> generates an OnNotify event.</para>
  4447.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the StartPos property is set, playing starts at the position specified in StartPos. Otherwise, playing starts at the current position, specified in the Position property. Similarly, if the EndPos property is set, playing stops at the position specified in EndPos. Otherwise, playing stops at the end of the medium.</para>
  4448.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Whether the medium (specified in the Position property) is rewound before playing starts depends on the AutoRewind property.</para>
  4449.          </comments>
  4450.       </member>
  4451.       <member name="M:MPlayer.MPlayer.Stop">
  4452.          <summary>
  4453.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Halts playing or recording.</para>
  4454.          </summary>
  4455.          <comments>
  4456.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4457.                      
  4458.                <method namespace="MPlayer" class="TMediaPlayer">Stop</method> is called when the <method namespace="MPlayer" class="TMediaPlayer">Stop</method> button on the media player control is clicked at runtime.</para>
  4459.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">Stop</method> stores a numerical error code in the Error property, and the corresponding error message in the ErrorMessage property.</para>
  4460.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">Stop</method> method has completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">Stop</method> generates an OnNotify event.</para>
  4461.          </comments>
  4462.       </member>
  4463.       <member name="M:MPlayer.MPlayer.Pause">
  4464.          <summary>
  4465.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Toggles the open multimedia device on or off. </para>
  4466.          </summary>
  4467.          <comments>
  4468.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the device is already paused when <method namespace="MPlayer" class="TMediaPlayer">Pause</method> is called, the device resumes playing or recording by calling the Resume method. <method namespace="MPlayer" class="TMediaPlayer">Pause</method> is called when the <method namespace="MPlayer" class="TMediaPlayer">Pause</method> button on the media player control is clicked at runtime.</para>
  4469.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">Pause</method> stores a numerical error code in the Error property and the corresponding error message in the ErrorMessage property.</para>
  4470.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">Pause</method> method has completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">Pause</method> generates an OnNotify event.</para>
  4471.          </comments>
  4472.       </member>
  4473.       <member name="M:MPlayer.MPlayer.Step">
  4474.          <summary>
  4475.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Moves forward a number of frames (determined by the Frames property) in the currently loaded medium.</para>
  4476.          </summary>
  4477.          <comments>
  4478.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4479.                      
  4480.                <method namespace="MPlayer" class="TMediaPlayer">Step</method> is called when the <method namespace="MPlayer" class="TMediaPlayer">Step</method> button on the media player control is clicked at runtime.</para>
  4481.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">Step</method> stores a numerical error code in the Error property and the corresponding error message in the ErrorMessage property.</para>
  4482.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">Step</method> method has completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">Step</method> generates an OnNotify event.</para>
  4483.          </comments>
  4484.       </member>
  4485.       <member name="M:MPlayer.MPlayer.Back">
  4486.          <summary>
  4487.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Steps backward a number of frames (determined by the value of the Frames property) in the currently loaded medium. </para>
  4488.          </summary>
  4489.          <comments>
  4490.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4491.                      
  4492.                <method namespace="MPlayer" class="TMediaPlayer">Back</method> is called when the <method namespace="MPlayer" class="TMediaPlayer">Back</method> button on the media player control is clicked at runtime.</para>
  4493.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">Back</method> stores a numerical error code in the Error property and the corresponding error message in the ErrorMessage property.</para>
  4494.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">Back</method> method has been completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">Back</method> generates an OnNotify event.</para>
  4495.          </comments>
  4496.       </member>
  4497.       <member name="M:MPlayer.MPlayer.Previous">
  4498.          <summary>
  4499.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the current position to the beginning of the previous track if the position was at the beginning of a track when <method namespace="MPlayer" class="TMediaPlayer">Previous</method> was called.</para>
  4500.          </summary>
  4501.          <comments>
  4502.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the position is at the first track or somewhere other than the beginning of a track when <method namespace="MPlayer" class="TMediaPlayer">Previous</method> was called, <method namespace="MPlayer" class="TMediaPlayer">Previous</method> sets the current position to the beginning of the current track. If the device doesn't use tracks, <method namespace="MPlayer" class="TMediaPlayer">Previous</method> sets the current position to the beginning of the medium, which is specified in the Start property. <method namespace="MPlayer" class="TMediaPlayer">Previous</method> is called when the <method namespace="MPlayer" class="TMediaPlayer">Previous</method> button on the media player control is clicked at runtime.</para>
  4503.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">Previous</method> stores a numerical error code in the Error property and the corresponding error message in the ErrorMessage property.</para>
  4504.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">Previous</method> method has completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">Previous</method> generates an OnNotify event.</para>
  4505.          </comments>
  4506.       </member>
  4507.       <member name="M:MPlayer.MPlayer.Next">
  4508.          <summary>
  4509.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Moves to the beginning of the next track of the currently loaded medium.</para>
  4510.          </summary>
  4511.          <comments>
  4512.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the current position is at the last track when <method namespace="MPlayer" class="TMediaPlayer">Next</method> is called, <method namespace="MPlayer" class="TMediaPlayer">Next</method> makes the current position the beginning of the last track. If the multimedia device doesn't use tracks, <method namespace="MPlayer" class="TMediaPlayer">Next</method> goes to the end of the medium. <method namespace="MPlayer" class="TMediaPlayer">Next</method> is called when the <method namespace="MPlayer" class="TMediaPlayer">Next</method> button on the media player control is clicked at runtime.</para>
  4513.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">Next</method> stores a numerical error code in the Error property, and the corresponding error message in the ErrorMessage property.</para>
  4514.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">Next</method> method has completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">Next</method> generates an OnNotify event.</para>
  4515.          </comments>
  4516.       </member>
  4517.       <member name="M:MPlayer.MPlayer.StartRecording">
  4518.          <summary>
  4519.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Begins recording from the current Position or from the position specified in StartPos. </para>
  4520.          </summary>
  4521.          <comments>
  4522.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4523.                      
  4524.                <method namespace="MPlayer" class="TMediaPlayer">StartRecording</method> is called when the Record button on the media player control is clicked at runtime.</para>
  4525.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">StartRecording</method> stores a numerical error code in the Error property and the corresponding error message in the ErrorMessage property.</para>
  4526.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">StartRecording</method> method has completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">StartRecording</method> generates an OnNotify event.</para>
  4527.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By default, the Notify property becomes true, and the Wait property becomes false upon completion of the <method namespace="MPlayer" class="TMediaPlayer">StartRecording</method> method. However, if these properties have been set to specific values prior to calling <method namespace="MPlayer" class="TMediaPlayer">StartRecording</method>, they remain unchanged.</para>
  4528.          </comments>
  4529.       </member>
  4530.       <member name="M:MPlayer.MPlayer.Eject">
  4531.          <summary>
  4532.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Releases the loaded medium from the open multimedia device.</para>
  4533.          </summary>
  4534.          <comments>
  4535.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4536.                      
  4537.                <method namespace="MPlayer" class="TMediaPlayer">Eject</method> is called when the <method namespace="MPlayer" class="TMediaPlayer">Eject</method> button on the media player control is clicked at runtime. It ejects the loaded medium from the open multimedia device.</para>
  4538.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">Eject</method> stores a numerical error code in the Error property, and the corresponding error message in the ErrorMessage property.</para>
  4539.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">Eject</method> method has been completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">Eject</method> generates an OnNotify event.</para>
  4540.          </comments>
  4541.       </member>
  4542.       <member name="M:MPlayer.MPlayer.Save">
  4543.          <summary>
  4544.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4545.                      
  4546.                <method namespace="MPlayer" class="TMediaPlayer">Save</method>s the currently loaded medium to the file specified in the FileName property. </para>
  4547.          </summary>
  4548.          <comments>
  4549.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4550.                      
  4551.                <method namespace="MPlayer" class="TMediaPlayer">Save</method> is ignored for devices that don't use media stored in files (video<condition language="CBuilder"/>discs, for example).</para>
  4552.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">Save</method> stores a numerical error code in the Error property, and the corresponding error message in the ErrorMessage property.</para>
  4553.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">Save</method> method has completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">Save</method> generates an OnNotify event.</para>
  4554.          </comments>
  4555.       </member>
  4556.       <member name="M:MPlayer.MPlayer.PauseOnly">
  4557.          <summary>
  4558.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Pauses the open multimedia device.</para>
  4559.          </summary>
  4560.          <comments>
  4561.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the device is already paused when <method namespace="MPlayer" class="TMediaPlayer">PauseOnly</method> is called, the device will remain paused.</para>
  4562.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">PauseOnly</method> stores a numerical error code in the Error property and the corresponding error message in the ErrorMessage property.</para>
  4563.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">PauseOnly</method> method has completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">PauseOnly</method> generates an OnNotify event.</para>
  4564.          </comments>
  4565.       </member>
  4566.       <member name="M:MPlayer.MPlayer.Resume">
  4567.          <summary>
  4568.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4569.                      
  4570.                <method namespace="MPlayer" class="TMediaPlayer">Resume</method>s playing or recording the currently paused multimedia device.</para>
  4571.          </summary>
  4572.          <comments>
  4573.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4574.                      
  4575.                <method namespace="MPlayer" class="TMediaPlayer">Resume</method> is called when the Pause button on the media player control is clicked at runtime, when the device is paused.</para>
  4576.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">Resume</method> stores a numerical error code in the Error property, and the corresponding error message in the ErrorMessage property.</para>
  4577.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">Resume</method> method has completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">Resume</method> generates an OnNotify event.</para>
  4578.          </comments>
  4579.       </member>
  4580.       <member name="M:MPlayer.MPlayer.Rewind">
  4581.          <summary>
  4582.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sets the current position to the beginning of the the medium, which is stored in the Start property.</para>
  4583.          </summary>
  4584.          <comments>
  4585.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Upon completion, <method namespace="MPlayer" class="TMediaPlayer">Rewind</method> stores a numerical error code in the Error property, and the corresponding error message in the ErrorMessage property.</para>
  4586.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before the <method namespace="MPlayer" class="TMediaPlayer">Rewind</method> method has completed. The Notify property determines whether <method namespace="MPlayer" class="TMediaPlayer">Rewind</method> generates an OnNotify event.</para>
  4587.          </comments>
  4588.       </member>
  4589.       <member name="M:MPlayer.MPlayer.Destroy">
  4590.          <summary>
  4591.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4592.                      
  4593.                <method namespace="MPlayer" class="TMediaPlayer">Destroy</method>s an instance of the media player.</para>
  4594.          </summary>
  4595.          <comments>
  4596.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="MPlayer" class="TMediaPlayer">Destroy</method> directly in an application. Call Free instead. Free checks that the <method namespace="MPlayer" class="TMediaPlayer">TMediaPlayer</method> reference is not nil before it calls <method namespace="MPlayer" class="TMediaPlayer">Destroy</method>.</para>
  4597.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4598.                      
  4599.                <method namespace="MPlayer" class="TMediaPlayer">Destroy</method> first verifies that no device is open, then destroys the bitmaps used for the media player's buttons and calls the inherited <method namespace="MPlayer" class="TMediaPlayer">Destroy</method>.</para>
  4600.          </comments>
  4601.       </member>
  4602.       <member name="P:MPlayer.MPlayer.TrackLength">
  4603.          <summary>
  4604.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the length of the track.</para>
  4605.          </summary>
  4606.          <comments>
  4607.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4608.                      
  4609.                <property namespace="MPlayer" class="TMediaPlayer">TrackLength</property> reports the length of the track specified by the TrackNum index.</para>
  4610.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="MPlayer" class="TMediaPlayer">TrackLength</property> is specified according to the current time format, which is specified in the TimeFormat property.</para>
  4611.          </comments>
  4612.       </member>
  4613.       <member name="P:MPlayer.MPlayer.TrackPosition">
  4614.          <summary>
  4615.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Reports the starting position of the track.</para>
  4616.          </summary>
  4617.          <comments>
  4618.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4619.                      
  4620.                <property namespace="MPlayer" class="TMediaPlayer">TrackPosition</property> reports the starting position of the track specified by the TrackNum index.</para>
  4621.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="MPlayer" class="TMediaPlayer">TrackPosition</property> is specified according to the current time format, which is specified in the TimeFormat property.</para>
  4622.          </comments>
  4623.       </member>
  4624.       <member name="P:MPlayer.MPlayer.Capabilities">
  4625.          <summary>
  4626.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines the capabilities of the open multimedia device.</para>
  4627.          </summary>
  4628.          <comments>
  4629.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The various capabilities specified in <property namespace="MPlayer" class="TMediaPlayer">Capabilities</property> are determined when the device is opened with the Open method.</para>
  4630.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4631.                      
  4632.                <para>Currently, there is no way to check whether a device can step forward or backward. <property namespace="MPlayer" class="TMediaPlayer">Capabilities</property> includes mpCanStep only if the device type (specified in the DeviceType property) is Animation, AVI Video, Digital Video, Overlay, or VCR.</para>
  4633.                   
  4634.             </note>
  4635.          </comments>
  4636.       </member>
  4637.       <member name="P:MPlayer.MPlayer.Error">
  4638.          <summary>
  4639.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the MCI error code returned by the media control method.</para>
  4640.          </summary>
  4641.          <comments>
  4642.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4643.                      
  4644.                <property namespace="MPlayer" class="TMediaPlayer">Error</property> specifies the MCI error code returned by the most recent media control method (Back, Close, Eject, Next, Open, Pause, PauseOnly, Play, Previous, StartRecording, Resume, Rewind, Step, or Stop). The <property namespace="MPlayer" class="TMediaPlayer">Error</property>Message property describes the <property namespace="MPlayer" class="TMediaPlayer">Error</property>.</para>
  4645.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The error code returned by media control methods are the same error code returned by the mciSendCommand function. The message describing the error code is stored in the <property namespace="MPlayer" class="TMediaPlayer">Error</property>Message property.</para>
  4646.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="MPlayer" class="TMediaPlayer">Error</property> is zero if the most recent media control method didn't cause an error. If a method results in an error, a value other than zero is stored in <property namespace="MPlayer" class="TMediaPlayer">Error</property>. If the error occurs during the opening of the device, an EMCIDevice<property namespace="MPlayer" class="TMediaPlayer">Error</property> exception occurs.</para>
  4647.          </comments>
  4648.       </member>
  4649.       <member name="P:MPlayer.MPlayer.ErrorMessage">
  4650.          <summary>
  4651.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Describes the error code stored in the Error property.</para>
  4652.          </summary>
  4653.          <comments>
  4654.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4655.                      
  4656.                <property namespace="MPlayer" class="TMediaPlayer">ErrorMessage</property> specifies the error message that describes the error code returned from the most recent media control method (Back, Close, Eject, Next, Open, Pause, PauseOnly, Play, Previous, StartRecording, Resume, Rewind, Step, or Stop). </para>
  4657.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The error code described by the message is stored in the Error property.</para>
  4658.          </comments>
  4659.       </member>
  4660.       <member name="P:MPlayer.MPlayer.Start">
  4661.          <summary>
  4662.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the starting position within the currently loaded medium.</para>
  4663.          </summary>
  4664.          <comments>
  4665.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4666.                      
  4667.                <property namespace="MPlayer" class="TMediaPlayer">Start</property> is the beginning of the medium for devices that don't use tracks, or the beginning of the first track for devices that use tracks. <property namespace="MPlayer" class="TMediaPlayer">Start</property> is defined when a multimedia device is opened with the Open method. <property namespace="MPlayer" class="TMediaPlayer">Start</property> is specified according to the current time format, which is stored in the TimeFormat property. <property namespace="MPlayer" class="TMediaPlayer">Start</property> is read-only at runtime and is unavailable at design time.</para>
  4668.          </comments>
  4669.       </member>
  4670.       <member name="P:MPlayer.MPlayer.Length">
  4671.          <summary>
  4672.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the length of the medium in the open multimedia device.</para>
  4673.          </summary>
  4674.          <comments>
  4675.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4676.                      
  4677.                <property namespace="MPlayer" class="TMediaPlayer">Length</property> is specified using the current time format, which is specified by the TimeFormat property.</para>
  4678.          </comments>
  4679.       </member>
  4680.       <member name="P:MPlayer.MPlayer.Tracks">
  4681.          <summary>
  4682.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the number of playable tracks on the open multimedia device.</para>
  4683.          </summary>
  4684.          <comments>
  4685.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4686.                      
  4687.                <property namespace="MPlayer" class="TMediaPlayer">Tracks</property> indicates how many of playable tracks are available on the open multimedia device.</para>
  4688.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4689.                      
  4690.                <property namespace="MPlayer" class="TMediaPlayer">Tracks</property> is undefined for devices that don't use tracks.</para>
  4691.          </comments>
  4692.       </member>
  4693.       <member name="P:MPlayer.MPlayer.Frames">
  4694.          <summary>
  4695.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the number of frames moved forward or backward.</para>
  4696.          </summary>
  4697.          <comments>
  4698.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4699.                      
  4700.                <property namespace="MPlayer" class="TMediaPlayer">Frames</property> specifies the number of frames the Step method steps forward or the Back method steps backward. <property namespace="MPlayer" class="TMediaPlayer">Frames</property> defaults to ten percent of the length of the currently loaded medium, which is specified by the Length property.</para>
  4701.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The definition of a frame varies by multimedia device. For display media, a frame is one still image.</para>
  4702.          </comments>
  4703.       </member>
  4704.       <member name="P:MPlayer.MPlayer.Mode">
  4705.          <summary>
  4706.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the state of the currently open multimedia device.</para>
  4707.          </summary>
  4708.          <comments>
  4709.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4710.                      
  4711.                <property namespace="MPlayer" class="TMediaPlayer">Mode</property> specifies the current state or mode of the currently open multimedia device.</para>
  4712.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The TMP<property namespace="MPlayer" class="TMediaPlayer">Mode</property>s type defines the modes for a multimedia device used with a <property namespace="MPlayer" class="TMediaPlayer">TMediaPlayer</property>.</para>
  4713.          </comments>
  4714.       </member>
  4715.       <member name="P:MPlayer.MPlayer.Position">
  4716.          <summary>
  4717.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the current position within the currently loaded medium.</para>
  4718.          </summary>
  4719.          <comments>
  4720.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="MPlayer" class="TMediaPlayer">Position</property> is specified according to the current time format, which is specified in the TimeFormat property.</para>
  4721.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4722.                      
  4723.                <property namespace="MPlayer" class="TMediaPlayer">Position</property> defaults to the beginning of the medium. If the medium supports multiple tracks, <property namespace="MPlayer" class="TMediaPlayer">Position</property> defaults to the beginning of the first track.</para>
  4724.          </comments>
  4725.       </member>
  4726.       <member name="P:MPlayer.MPlayer.Wait">
  4727.          <summary>
  4728.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether a media control method returns control to the application only after it has been completed.</para>
  4729.          </summary>
  4730.          <comments>
  4731.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4732.                      
  4733.                <property namespace="MPlayer" class="TMediaPlayer">Wait</property> determines whether a media control method (Back, Close, Eject, Next, Open, Pause, PauseOnly, Play, Previous, StartRecording, Resume, Rewind, Step, or Stop) returns control to the application only after it has been completed.</para>
  4734.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4735.                      
  4736.                <property namespace="MPlayer" class="TMediaPlayer">Wait</property> is unavailable at design time.</para>
  4737.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <property namespace="MPlayer" class="TMediaPlayer">Wait</property> is true, the media player component waits until the next media control method has completed before returning control to the application. If <property namespace="MPlayer" class="TMediaPlayer">Wait</property> is false, the application won't wait for the next media control method to finish before continuing.</para>
  4738.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4739.                      
  4740.                <property namespace="MPlayer" class="TMediaPlayer">Wait</property> affects only the next media control method called after setting <property namespace="MPlayer" class="TMediaPlayer">Wait</property>. <property namespace="MPlayer" class="TMediaPlayer">Wait</property> must be reset to affect any subsequent call to a media control method.</para>
  4741.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By default, Play and StartRecording function as if <property namespace="MPlayer" class="TMediaPlayer">Wait</property> is false. <property namespace="MPlayer" class="TMediaPlayer">Wait</property> must be set to true before calling Play or StartRecording to prevent control from returning to the application before playing or recording has finished. By default, all other media control methods function as if <property namespace="MPlayer" class="TMediaPlayer">Wait</property> is true.</para>
  4742.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4743.                      
  4744.                <para>
  4745.                         
  4746.                   <property namespace="MPlayer" class="TMediaPlayer">Wait</property> is usually set to false only if the next media control is expected to take a long time, so that the application can execute other code before the media control method has completed. If <property namespace="MPlayer" class="TMediaPlayer">Wait</property> is set to false, you should set Notify to true so the application is notified when the media control method completes.</para>
  4747.                   
  4748.             </note>
  4749.          </comments>
  4750.       </member>
  4751.       <member name="P:MPlayer.MPlayer.Notify">
  4752.          <summary>
  4753.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether an On<property namespace="MPlayer" class="TMediaPlayer">Notify</property> event is generated.</para>
  4754.          </summary>
  4755.          <comments>
  4756.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4757.                      
  4758.                <property namespace="MPlayer" class="TMediaPlayer">Notify</property> determines whether the next call to a media control method (Back, Close, Eject, Next, Open, Pause, PauseOnly, Play, Previous, StartRecording, Resume, Rewind, Step, or Stop) generates an On<property namespace="MPlayer" class="TMediaPlayer">Notify</property> event when the method has completed.</para>
  4759.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <property namespace="MPlayer" class="TMediaPlayer">Notify</property> is true, the next media control method generates On<property namespace="MPlayer" class="TMediaPlayer">Notify</property> event upon completion and stores the notification message in the <property namespace="MPlayer" class="TMediaPlayer">Notify</property>Value property. If <property namespace="MPlayer" class="TMediaPlayer">Notify</property> is false, the method does not generate an On<property namespace="MPlayer" class="TMediaPlayer">Notify</property> event and <property namespace="MPlayer" class="TMediaPlayer">Notify</property>Value remains unchanged.</para>
  4760.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4761.                      
  4762.                <property namespace="MPlayer" class="TMediaPlayer">Notify</property> affects only the next call to a media control method. After an On<property namespace="MPlayer" class="TMediaPlayer">Notify</property> event, <property namespace="MPlayer" class="TMediaPlayer">Notify</property> must be reset to affect any subsequent media control methods.</para>
  4763.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">By default, Play and StartRecording function as if <property namespace="MPlayer" class="TMediaPlayer">Notify</property> is true. Set <property namespace="MPlayer" class="TMediaPlayer">Notify</property> to false before calling Play or StartRecording to prevent an On<property namespace="MPlayer" class="TMediaPlayer">Notify</property> event from being generated when playing or recording has finished. By default, all other media control methods function as if <property namespace="MPlayer" class="TMediaPlayer">Notify</property> is false.</para>
  4764.             <tip xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4765.                      
  4766.                <para>Set <property namespace="MPlayer" class="TMediaPlayer">Notify</property> to true if the next media control is expected to take a long time, so the application is notified when the media control method has completed. If <property namespace="MPlayer" class="TMediaPlayer">Notify</property> is set to true, it is recommended to set Wait to false so that control returns to the application before the media control method is finished.</para>
  4767.                   
  4768.             </tip>
  4769.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4770.                      
  4771.                <para>When trying to resume a device that doesn't support Resume, the device is resumed as if the Play method was called. If <property namespace="MPlayer" class="TMediaPlayer">Notify</property> was assigned true before calling Resume (or any other media control method), <property namespace="MPlayer" class="TMediaPlayer">Notify</property> doesn't affect the call to Resume. Resume does not generate an On<property namespace="MPlayer" class="TMediaPlayer">Notify</property> event upon completion, and <property namespace="MPlayer" class="TMediaPlayer">Notify</property>Value remains unchanged.</para>
  4772.                   
  4773.             </note>
  4774.          </comments>
  4775.       </member>
  4776.       <member name="P:MPlayer.MPlayer.NotifyValue">
  4777.          <summary>
  4778.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the result of the last media control method that requested a notification.</para>
  4779.          </summary>
  4780.          <comments>
  4781.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4782.                      
  4783.                <property namespace="MPlayer" class="TMediaPlayer">NotifyValue</property> reports the result of the last media control method (Back, Close, Eject, Next, Open, Pause, PauseOnly, Play, Previous, StartRecording, Resume, Rewind, Step, or Stop) that requested a notification.</para>
  4784.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To request notification, set Notify to true before calling a media control method.</para>
  4785.          </comments>
  4786.       </member>
  4787.       <member name="P:MPlayer.MPlayer.StartPos">
  4788.          <summary>
  4789.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the position within the currently loaded medium from which to begin playing or recording.</para>
  4790.          </summary>
  4791.          <comments>
  4792.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4793.                      
  4794.                <property namespace="MPlayer" class="TMediaPlayer">StartPos</property> is specified using the current time format, which is specified in the TimeFormat property.</para>
  4795.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <property namespace="MPlayer" class="TMediaPlayer">StartPos</property> property affects only the next Play or StartRecording method called after setting <property namespace="MPlayer" class="TMediaPlayer">StartPos</property>. Reset must be set to <property namespace="MPlayer" class="TMediaPlayer">StartPos</property> to affect any subsequent calls to Play or StartRecording.</para>
  4796.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4797.                      
  4798.                <property namespace="MPlayer" class="TMediaPlayer">StartPos</property> does not affect the current position of the medium (specified in the Position property) until the next Play or StartRecording method is called.</para>
  4799.          </comments>
  4800.       </member>
  4801.       <member name="P:MPlayer.MPlayer.EndPos">
  4802.          <summary>
  4803.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the position within the currently loaded medium at which to stop playing or recording. </para>
  4804.          </summary>
  4805.          <comments>
  4806.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4807.                      
  4808.                <property namespace="MPlayer" class="TMediaPlayer">EndPos</property> is specified using the current time format, which is specified in the TimeFormat property.</para>
  4809.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The <property namespace="MPlayer" class="TMediaPlayer">EndPos</property> property affects only the next Play or StartRecording method called after setting <property namespace="MPlayer" class="TMediaPlayer">EndPos</property>. Reset <property namespace="MPlayer" class="TMediaPlayer">EndPos</property> to affect any subsequent calls to Play or StartRecording.</para>
  4810.          </comments>
  4811.       </member>
  4812.       <member name="P:MPlayer.MPlayer.DeviceID">
  4813.          <summary>
  4814.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the device ID for the currently open multimedia device.</para>
  4815.          </summary>
  4816.          <comments>
  4817.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of <property namespace="MPlayer" class="TMediaPlayer">DeviceID</property> is determined when a device is opened with the Open method. If no device is open, <property namespace="MPlayer" class="TMediaPlayer">DeviceID</property> is 0.</para>
  4818.          </comments>
  4819.       </member>
  4820.       <member name="P:MPlayer.MPlayer.TimeFormat">
  4821.          <summary>
  4822.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines the format used to specify position information.</para>
  4823.          </summary>
  4824.          <comments>
  4825.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4826.                      
  4827.                <property namespace="MPlayer" class="TMediaPlayer">TimeFormat</property> determines how the StartPos, Length, Position, Start, and EndPos properties are interpreted. For example, if Position is 180 and <property namespace="MPlayer" class="TMediaPlayer">TimeFormat</property> is tfMilliseconds, the current position is 180 milliseconds into the medium. If Position is 180 and <property namespace="MPlayer" class="TMediaPlayer">TimeFormat</property> is tfMSF, the current position is 180 minutes into the medium.</para>
  4828.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Not all formats are supported by every device. When trying to set an unsupported format, the assignment is ignored.</para>
  4829.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The current timing information is always passed in a 4-byte integer. In some formats, the timing information returned is not really one integer, but single bytes of information packed in the long integer.</para>
  4830.          </comments>
  4831.       </member>
  4832.       <member name="P:MPlayer.MPlayer.DisplayRect">
  4833.          <summary>
  4834.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies a rectangular area in the control specified by the Display property that is used to display output from a multimedia device.</para>
  4835.          </summary>
  4836.          <comments>
  4837.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To display output in a specific rectangle area on a form assign a TRect record to <property namespace="MPlayer" class="TMediaPlayer">DisplayRect</property>. The Rect function can be used to create a TRect record.</para>
  4838.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Media that use a rectangle to display output usually perform best if the default <property namespace="MPlayer" class="TMediaPlayer">DisplayRect</property> size is used. To set <property namespace="MPlayer" class="TMediaPlayer">DisplayRect</property> to the default size, position the rectangle in the upper left corner and use 0, 0 for the lower right corner.</para>
  4839.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4840.                      
  4841.                <property namespace="MPlayer" class="TMediaPlayer">DisplayRect</property> is ignored if Display is nil (Delphi) or NULL (C++).</para>
  4842.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Examples of multimedia devices that use a window to display output are Animation, AVI Video, Digital Video, Overlay, and VCR.</para>
  4843.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4844.                      
  4845.                <para>
  4846.                         
  4847.                   <property namespace="MPlayer" class="TMediaPlayer">DisplayRect</property> can be set only after the media device is opened.</para>
  4848.                   
  4849.             </note>
  4850.          </comments>
  4851.       </member>
  4852.       <member name="P:MPlayer.MPlayer.ColoredButtons">
  4853.          <summary>
  4854.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines which buttons on the media player control have color.</para>
  4855.          </summary>
  4856.          <comments>
  4857.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4858.                      
  4859.                <property namespace="MPlayer" class="TMediaPlayer">ColoredButtons</property> controls which buttons on the media player are colored.</para>
  4860.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If a button is not colored with <property namespace="MPlayer" class="TMediaPlayer">ColoredButtons</property>, it appears in black-and-white when visible. All media player control buttons are colored by default.</para>
  4861.          </comments>
  4862.       </member>
  4863.       <member name="P:MPlayer.MPlayer.EnabledButtons">
  4864.          <summary>
  4865.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines which buttons on the media player are usable.</para>
  4866.          </summary>
  4867.          <comments>
  4868.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4869.                      
  4870.                <property namespace="MPlayer" class="TMediaPlayer">EnabledButtons</property> controls which buttons on the media player are enabled and usable.</para>
  4871.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">An enabled button is colored and usable. A disabled button is dimmed and not usable. If a button is not enabled with <property namespace="MPlayer" class="TMediaPlayer">EnabledButtons</property>, it is disabled. By default, all buttons are enabled.</para>
  4872.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the AutoEnable property is true, AutoEnable supersedes <property namespace="MPlayer" class="TMediaPlayer">EnabledButtons</property>. The buttons automatically enabled or disabled by the media player override any buttons enabled or disabled with the <property namespace="MPlayer" class="TMediaPlayer">EnabledButtons</property> property.</para>
  4873.          </comments>
  4874.       </member>
  4875.       <member name="P:MPlayer.MPlayer.VisibleButtons">
  4876.          <summary>
  4877.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates which of the buttons on the media player are visible.</para>
  4878.          </summary>
  4879.          <comments>
  4880.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4881.                      
  4882.                <property namespace="MPlayer" class="TMediaPlayer">VisibleButtons</property> determines which buttons on the media player that are visible. If a button is not made visible with <property namespace="MPlayer" class="TMediaPlayer">VisibleButtons</property>, it does not appear on the media player control. By default, all buttons are visible when a media player component is added to a form.</para>
  4883.          </comments>
  4884.       </member>
  4885.       <member name="P:MPlayer.MPlayer.AutoEnable">
  4886.          <summary>
  4887.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether the media player automatically enables and disables individual buttons in the component.</para>
  4888.          </summary>
  4889.          <comments>
  4890.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="MPlayer" class="TMediaPlayer">AutoEnable</property> to automatically enable or disable the control buttons on the media player. If <property namespace="MPlayer" class="TMediaPlayer">AutoEnable</property> is true, the media player automatically enables or disables its control buttons. The media player determines which buttons to enable or disable by the current mode specified in the Mode property, and the current multimedia device type specified in the DeviceType property.</para>
  4891.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4892.                      
  4893.                <property namespace="MPlayer" class="TMediaPlayer">AutoEnable</property> overrides the EnabledButtons property. The buttons enabled or disabled automatically by the media player supersede any buttons enabled or disabled with EnabledButtons.</para>
  4894.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <property namespace="MPlayer" class="TMediaPlayer">AutoEnable</property> is false, the media player does not enable or disable buttons. The buttons must enabled or disabled with the EnabledButtons property.</para>
  4895.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The following table shows whether buttons are automatically enabled or disabled for each device mode:</para>
  4896.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">ButtonPlayRecordPauseStopNot Open</para>
  4897.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  4898.                      
  4899.                <tr>
  4900.                         
  4901.                   <th>Button</th>
  4902.                         
  4903.                   <th>Play</th>
  4904.                         
  4905.                   <th>Record</th>
  4906.                         
  4907.                   <th>Pause</th>
  4908.                         
  4909.                   <th>Stop</th>
  4910.                         
  4911.                   <th>Not Open</th>
  4912.                      
  4913.                </tr>
  4914.                      
  4915.                <tr>
  4916.                         
  4917.                   <td>
  4918.                            
  4919.                      <para>Back</para>
  4920.                         
  4921.                   </td>
  4922.                         
  4923.                   <td>
  4924.                            
  4925.                      <para>Enabled</para>
  4926.                         
  4927.                   </td>
  4928.                         
  4929.                   <td>
  4930.                            
  4931.                      <para>Enabled</para>
  4932.                         
  4933.                   </td>
  4934.                         
  4935.                   <td>
  4936.                            
  4937.                      <para>Enabled</para>
  4938.                         
  4939.                   </td>
  4940.                         
  4941.                   <td>
  4942.                            
  4943.                      <para>Enabled</para>
  4944.                         
  4945.                   </td>
  4946.                         
  4947.                   <td>
  4948.                            
  4949.                      <para>Disabled</para>
  4950.                         
  4951.                   </td>
  4952.                      
  4953.                </tr>
  4954.                      
  4955.                <tr>
  4956.                         
  4957.                   <td>
  4958.                            
  4959.                      <para>Eject</para>
  4960.                         
  4961.                   </td>
  4962.                         
  4963.                   <td>
  4964.                            
  4965.                      <para>Enabled</para>
  4966.                         
  4967.                   </td>
  4968.                         
  4969.                   <td>
  4970.                            
  4971.                      <para>Enabled</para>
  4972.                         
  4973.                   </td>
  4974.                         
  4975.                   <td>
  4976.                            
  4977.                      <para>Enabled</para>
  4978.                         
  4979.                   </td>
  4980.                         
  4981.                   <td>
  4982.                            
  4983.                      <para>Enabled</para>
  4984.                         
  4985.                   </td>
  4986.                         
  4987.                   <td>
  4988.                            
  4989.                      <para>Disabled</para>
  4990.                         
  4991.                   </td>
  4992.                      
  4993.                </tr>
  4994.                      
  4995.                <tr>
  4996.                         
  4997.                   <td>
  4998.                            
  4999.                      <para>Next</para>
  5000.                         
  5001.                   </td>
  5002.                         
  5003.                   <td>
  5004.                            
  5005.                      <para>Enabled</para>
  5006.                         
  5007.                   </td>
  5008.                         
  5009.                   <td>
  5010.                            
  5011.                      <para>Enabled</para>
  5012.                         
  5013.                   </td>
  5014.                         
  5015.                   <td>
  5016.                            
  5017.                      <para>Enabled</para>
  5018.                         
  5019.                   </td>
  5020.                         
  5021.                   <td>
  5022.                            
  5023.                      <para>Enabled</para>
  5024.                         
  5025.                   </td>
  5026.                         
  5027.                   <td>
  5028.                            
  5029.                      <para>Disabled</para>
  5030.                         
  5031.                   </td>
  5032.                      
  5033.                </tr>
  5034.                      
  5035.                <tr>
  5036.                         
  5037.                   <td>
  5038.                            
  5039.                      <para>Pause</para>
  5040.                         
  5041.                   </td>
  5042.                         
  5043.                   <td>
  5044.                            
  5045.                      <para>Enabled</para>
  5046.                         
  5047.                   </td>
  5048.                         
  5049.                   <td>
  5050.                            
  5051.                      <para>Enabled</para>
  5052.                         
  5053.                   </td>
  5054.                         
  5055.                   <td>
  5056.                            
  5057.                      <para>Enabled</para>
  5058.                         
  5059.                   </td>
  5060.                         
  5061.                   <td>
  5062.                            
  5063.                      <para>Disabled</para>
  5064.                         
  5065.                   </td>
  5066.                         
  5067.                   <td>
  5068.                            
  5069.                      <para>Disabled</para>
  5070.                         
  5071.                   </td>
  5072.                      
  5073.                </tr>
  5074.                      
  5075.                <tr>
  5076.                         
  5077.                   <td>
  5078.                            
  5079.                      <para>Play</para>
  5080.                         
  5081.                   </td>
  5082.                         
  5083.                   <td>
  5084.                            
  5085.                      <para>Disabled</para>
  5086.                         
  5087.                   </td>
  5088.                         
  5089.                   <td>
  5090.                            
  5091.                      <para>Disabled</para>
  5092.                         
  5093.                   </td>
  5094.                         
  5095.                   <td>
  5096.                            
  5097.                      <para>Enabled</para>
  5098.                         
  5099.                   </td>
  5100.                         
  5101.                   <td>
  5102.                            
  5103.                      <para>Enabled</para>
  5104.                         
  5105.                   </td>
  5106.                         
  5107.                   <td>
  5108.                            
  5109.                      <para>Disabled</para>
  5110.                         
  5111.                   </td>
  5112.                      
  5113.                </tr>
  5114.                      
  5115.                <tr>
  5116.                         
  5117.                   <td>
  5118.                            
  5119.                      <para>Prev</para>
  5120.                         
  5121.                   </td>
  5122.                         
  5123.                   <td>
  5124.                            
  5125.                      <para>Enabled</para>
  5126.                         
  5127.                   </td>
  5128.                         
  5129.                   <td>
  5130.                            
  5131.                      <para>Enabled</para>
  5132.                         
  5133.                   </td>
  5134.                         
  5135.                   <td>
  5136.                            
  5137.                      <para>Enabled</para>
  5138.                         
  5139.                   </td>
  5140.                         
  5141.                   <td>
  5142.                            
  5143.                      <para>Enabled</para>
  5144.                         
  5145.                   </td>
  5146.                         
  5147.                   <td>
  5148.                            
  5149.                      <para>Disabled</para>
  5150.                         
  5151.                   </td>
  5152.                      
  5153.                </tr>
  5154.                      
  5155.                <tr>
  5156.                         
  5157.                   <td>
  5158.                            
  5159.                      <para>Record</para>
  5160.                         
  5161.                   </td>
  5162.                         
  5163.                   <td>
  5164.                            
  5165.                      <para>Disabled</para>
  5166.                         
  5167.                   </td>
  5168.                         
  5169.                   <td>
  5170.                            
  5171.                      <para>Disabled</para>
  5172.                         
  5173.                   </td>
  5174.                         
  5175.                   <td>
  5176.                            
  5177.                      <para>Enabled</para>
  5178.                         
  5179.                   </td>
  5180.                         
  5181.                   <td>
  5182.                            
  5183.                      <para>Enabled</para>
  5184.                         
  5185.                   </td>
  5186.                         
  5187.                   <td>
  5188.                            
  5189.                      <para>Disabled</para>
  5190.                         
  5191.                   </td>
  5192.                      
  5193.                </tr>
  5194.                      
  5195.                <tr>
  5196.                         
  5197.                   <td>
  5198.                            
  5199.                      <para>Step</para>
  5200.                         
  5201.                   </td>
  5202.                         
  5203.                   <td>
  5204.                            
  5205.                      <para>Enabled</para>
  5206.                         
  5207.                   </td>
  5208.                         
  5209.                   <td>
  5210.                            
  5211.                      <para>Enabled</para>
  5212.                         
  5213.                   </td>
  5214.                         
  5215.                   <td>
  5216.                            
  5217.                      <para>Enabled</para>
  5218.                         
  5219.                   </td>
  5220.                         
  5221.                   <td>
  5222.                            
  5223.                      <para>Enabled</para>
  5224.                         
  5225.                   </td>
  5226.                         
  5227.                   <td>
  5228.                            
  5229.                      <para>Disabled</para>
  5230.                         
  5231.                   </td>
  5232.                      
  5233.                </tr>
  5234.                      
  5235.                <tr>
  5236.                         
  5237.                   <td>
  5238.                            
  5239.                      <para>Stop</para>
  5240.                         
  5241.                   </td>
  5242.                         
  5243.                   <td>
  5244.                            
  5245.                      <para>Enabled</para>
  5246.                         
  5247.                   </td>
  5248.                         
  5249.                   <td>
  5250.                            
  5251.                      <para>Enabled</para>
  5252.                         
  5253.                   </td>
  5254.                         
  5255.                   <td>
  5256.                            
  5257.                      <para>Disabled</para>
  5258.                         
  5259.                   </td>
  5260.                         
  5261.                   <td>
  5262.                            
  5263.                      <para>Disabled</para>
  5264.                         
  5265.                   </td>
  5266.                         
  5267.                   <td>
  5268.                            
  5269.                      <para>Disabled</para>
  5270.                         
  5271.                   </td>
  5272.                      
  5273.                </tr>
  5274.                   
  5275.             </table>
  5276.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">BackEnabledEnabledEnabledEnabledDisabled</para>
  5277.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">EjectEnabledEnabledEnabledEnabledDisabled</para>
  5278.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">NextEnabledEnabledEnabledEnabledDisabled</para>
  5279.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">PauseEnabledEnabledEnabledDisabledDisabled</para>
  5280.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">PlayDisabledDisabledEnabledEnabledDisabled</para>
  5281.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">PrevEnabledEnabledEnabledEnabledDisabled</para>
  5282.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">RecordDisabledDisabledEnabledEnabledDisabled</para>
  5283.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">StepEnabledEnabledEnabledEnabledDisabled</para>
  5284.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">StopEnabledEnabledDisabledDisabledDisabled</para>
  5285.          </comments>
  5286.       </member>
  5287.       <member name="P:MPlayer.MPlayer.AutoOpen">
  5288.          <summary>
  5289.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines if the media player is opened automatically when the application is run.</para>
  5290.          </summary>
  5291.          <comments>
  5292.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="MPlayer" class="TMediaPlayer">AutoOpen</property> to have the media player automatically open at runtime.</para>
  5293.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <property namespace="MPlayer" class="TMediaPlayer">AutoOpen</property> is true, the media player attempts to open the multimedia device specified by the DeviceType property (or FileName if DeviceType is dtAutoSelect) when the form containing the media player component is created at runtime. </para>
  5294.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <property namespace="MPlayer" class="TMediaPlayer">AutoOpen</property> is false, the device must be opened with a call to the Open method.</para>
  5295.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If an error occurs when opening the device, an exception of type EMCIDeviceError exception is raised that contains the error message. Upon completion, a numerical error code is stored in the Error property, and the corresponding error message is stored in the ErrorMessage property.</para>
  5296.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Wait property determines whether control is returned to the application before opening the multimedia device. The Notify property determines whether opening the device generates an OnNotify event.</para>
  5297.          </comments>
  5298.       </member>
  5299.       <member name="P:MPlayer.MPlayer.AutoRewind">
  5300.          <summary>
  5301.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines if the media player control rewinds before playing or recording.</para>
  5302.          </summary>
  5303.          <comments>
  5304.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <property namespace="MPlayer" class="TMediaPlayer">AutoRewind</property> is true and the current position is at the end of the medium, Play or StartRecording moves the current position to the beginning of the medium before playing or recording. If <property namespace="MPlayer" class="TMediaPlayer">AutoRewind</property> is false, the user must click the Prev button or write code to call Previous to move to the beginning.</para>
  5305.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If values have been assigned to StartPos or EndPos or if the multimedia device uses tracks, <property namespace="MPlayer" class="TMediaPlayer">AutoRewind</property> has no effect on playing or recording. When calling Play or StartRecording, the current position remains at the end of the medium.</para>
  5306.          </comments>
  5307.       </member>
  5308.       <member name="P:MPlayer.MPlayer.DeviceType">
  5309.          <summary>
  5310.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies a multimedia device type to open the media player.</para>
  5311.          </summary>
  5312.          <comments>
  5313.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5314.                      
  5315.                <property namespace="MPlayer" class="TMediaPlayer">DeviceType</property> specifies a multimedia device type to open with the Open method. The default is dtAutoSelect.</para>
  5316.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <property namespace="MPlayer" class="TMediaPlayer">DeviceType</property> is dtAutoSelect, the device type is determined by the file extension specified in the FileName property. If no device type is associated with the extension, the correct device type must be explicitly specified by setting <property namespace="MPlayer" class="TMediaPlayer">DeviceType</property> to a value other than dtAutoSelect.</para>
  5317.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">A multimedia device is typically associated with an appropriate file name extension when the device is installed. Associations are specified in the registry or SYSTEM.INI file. See the documentation for the specific device for instructions about how to associate file name extensions with the device.</para>
  5318.          </comments>
  5319.       </member>
  5320.       <member name="P:MPlayer.MPlayer.Display">
  5321.          <summary>
  5322.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the display window for an multimedia device that uses a window for output.</para>
  5323.          </summary>
  5324.          <comments>
  5325.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To use <property namespace="MPlayer" class="TMediaPlayer">Display</property>, assign the name of a windowed control such as a form or panel to <property namespace="MPlayer" class="TMediaPlayer">Display</property> to display output in that control.</para>
  5326.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The default value of <property namespace="MPlayer" class="TMediaPlayer">Display</property> is nil (Delphi) or NULL (C++), meaning that the device creates its own window to display output. Also, by freeing the control assigned to <property namespace="MPlayer" class="TMediaPlayer">Display</property> after the device has been opened, video output will be in its own default window.</para>
  5327.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Examples of multimedia devices that use a window to display output are Animation, AVI Video, Digital Video, Overlay, and VCR.</para>
  5328.          </comments>
  5329.       </member>
  5330.       <member name="P:MPlayer.MPlayer.FileName">
  5331.          <summary>
  5332.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the opened or saved media file.</para>
  5333.          </summary>
  5334.          <comments>
  5335.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5336.                      
  5337.                <property namespace="MPlayer" class="TMediaPlayer">FileName</property> specifies the media file to be opened by the Open method, or the file to save by the Save method.</para>
  5338.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">At design time, use a file open dialog box to specify the <property namespace="MPlayer" class="TMediaPlayer">FileName</property> property by clicking the ellipsis button (...) in the Object Inspector.</para>
  5339.          </comments>
  5340.       </member>
  5341.       <member name="P:MPlayer.MPlayer.Shareable">
  5342.          <summary>
  5343.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether more than one application can share a multimedia device.</para>
  5344.          </summary>
  5345.          <comments>
  5346.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If <property namespace="MPlayer" class="TMediaPlayer">Shareable</property> is false, no other components or applications can access the device. If <property namespace="MPlayer" class="TMediaPlayer">Shareable</property> is true, more than one component or application can access the device. <property namespace="MPlayer" class="TMediaPlayer">Shareable</property> defaults to false.</para>
  5347.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Be sure to set <property namespace="MPlayer" class="TMediaPlayer">Shareable</property> before opening a device.</para>
  5348.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Some devices are not shareable. If <property namespace="MPlayer" class="TMediaPlayer">Shareable</property> is set to true for a device that isn't shareable, the Open method fails and the error code is returned to the Error property.</para>
  5349.          </comments>
  5350.       </member>
  5351.       <member name="E:MPlayer.MPlayer.OnClick">
  5352.          <summary>
  5353.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the user presses and releases the mouse button while the mouse pointer is over one of the control buttons, or when the user presses Spacebar while the media player control has focus. </para>
  5354.          </summary>
  5355.          <comments>
  5356.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When the media player control has focus and the Spacebar is pressed, the user can use the Left Arrow or Right Arrow keys to select which control button to click.</para>
  5357.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The EMPNotify type is a method pointer that is called when an <event namespace="MPlayer" class="TMediaPlayer">OnClick</event> event for a <event namespace="MPlayer" class="TMediaPlayer">TMediaPlayer</event> components occurs. The Button argument can be one of the following values: btBack, btEject, btNext, btPause, btPlay, btPrev, btRecord, btStep, or btStop.</para>
  5358.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The default value of the event handler's DoDefault argument is true. If DoDefault is true, the media player control calls the method that corresponds to the clicked button. For example, if the user clicks the Play button (btPlay), the Play method is called.</para>
  5359.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If DoDefault is false, the user must write code that executes when a media player control button is clicked in the <event namespace="MPlayer" class="TMediaPlayer">OnClick</event> event handler. The following table lists the default methods corresponding to the media player control buttons:</para>
  5360.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Control buttonButton valueMethod called</para>
  5361.             <table xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5362.                      
  5363.                <tr>
  5364.                         
  5365.                   <th>Control button</th>
  5366.                         
  5367.                   <th>Button value</th>
  5368.                         
  5369.                   <th>Method called</th>
  5370.                      
  5371.                </tr>
  5372.                      
  5373.                <tr>
  5374.                         
  5375.                   <td>
  5376.                            
  5377.                      <para>Play</para>
  5378.                         
  5379.                   </td>
  5380.                         
  5381.                   <td>
  5382.                            
  5383.                      <para>btPlay</para>
  5384.                         
  5385.                   </td>
  5386.                         
  5387.                   <td>
  5388.                            
  5389.                      <para>Play</para>
  5390.                         
  5391.                   </td>
  5392.                      
  5393.                </tr>
  5394.                      
  5395.                <tr>
  5396.                         
  5397.                   <td>
  5398.                            
  5399.                      <para>Record</para>
  5400.                         
  5401.                   </td>
  5402.                         
  5403.                   <td>
  5404.                            
  5405.                      <para>btRecord</para>
  5406.                         
  5407.                   </td>
  5408.                         
  5409.                   <td>
  5410.                            
  5411.                      <para>StartRecording</para>
  5412.                         
  5413.                   </td>
  5414.                      
  5415.                </tr>
  5416.                      
  5417.                <tr>
  5418.                         
  5419.                   <td>
  5420.                            
  5421.                      <para>Stop</para>
  5422.                         
  5423.                   </td>
  5424.                         
  5425.                   <td>
  5426.                            
  5427.                      <para>btStop</para>
  5428.                         
  5429.                   </td>
  5430.                         
  5431.                   <td>
  5432.                            
  5433.                      <para>Stop</para>
  5434.                         
  5435.                   </td>
  5436.                      
  5437.                </tr>
  5438.                      
  5439.                <tr>
  5440.                         
  5441.                   <td>
  5442.                            
  5443.                      <para>Next</para>
  5444.                         
  5445.                   </td>
  5446.                         
  5447.                   <td>
  5448.                            
  5449.                      <para>btNext</para>
  5450.                         
  5451.                   </td>
  5452.                         
  5453.                   <td>
  5454.                            
  5455.                      <para>Next</para>
  5456.                         
  5457.                   </td>
  5458.                      
  5459.                </tr>
  5460.                      
  5461.                <tr>
  5462.                         
  5463.                   <td>
  5464.                            
  5465.                      <para>Prev</para>
  5466.                         
  5467.                   </td>
  5468.                         
  5469.                   <td>
  5470.                            
  5471.                      <para>btPrev</para>
  5472.                         
  5473.                   </td>
  5474.                         
  5475.                   <td>
  5476.                            
  5477.                      <para>Previous</para>
  5478.                         
  5479.                   </td>
  5480.                      
  5481.                </tr>
  5482.                      
  5483.                <tr>
  5484.                         
  5485.                   <td>
  5486.                            
  5487.                      <para>Step</para>
  5488.                         
  5489.                   </td>
  5490.                         
  5491.                   <td>
  5492.                            
  5493.                      <para>btStep</para>
  5494.                         
  5495.                   </td>
  5496.                         
  5497.                   <td>
  5498.                            
  5499.                      <para>Step</para>
  5500.                         
  5501.                   </td>
  5502.                      
  5503.                </tr>
  5504.                      
  5505.                <tr>
  5506.                         
  5507.                   <td>
  5508.                            
  5509.                      <para>Back</para>
  5510.                         
  5511.                   </td>
  5512.                         
  5513.                   <td>
  5514.                            
  5515.                      <para>btBack</para>
  5516.                         
  5517.                   </td>
  5518.                         
  5519.                   <td>
  5520.                            
  5521.                      <para>Back</para>
  5522.                         
  5523.                   </td>
  5524.                      
  5525.                </tr>
  5526.                      
  5527.                <tr>
  5528.                         
  5529.                   <td>
  5530.                            
  5531.                      <para>Pause</para>
  5532.                         
  5533.                   </td>
  5534.                         
  5535.                   <td>
  5536.                            
  5537.                      <para>btPause</para>
  5538.                         
  5539.                   </td>
  5540.                         
  5541.                   <td>
  5542.                            
  5543.                      <para>Pause</para>
  5544.                         
  5545.                   </td>
  5546.                      
  5547.                </tr>
  5548.                      
  5549.                <tr>
  5550.                         
  5551.                   <td>
  5552.                            
  5553.                      <para>Eject</para>
  5554.                         
  5555.                   </td>
  5556.                         
  5557.                   <td>
  5558.                            
  5559.                      <para>btEject</para>
  5560.                         
  5561.                   </td>
  5562.                         
  5563.                   <td>
  5564.                            
  5565.                      <para>Eject</para>
  5566.                         
  5567.                   </td>
  5568.                      
  5569.                </tr>
  5570.                   
  5571.             </table>
  5572.          </comments>
  5573.       </member>
  5574.       <member name="E:MPlayer.MPlayer.OnPostClick">
  5575.          <summary>
  5576.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs after the OnClick event handler is called.</para>
  5577.          </summary>
  5578.          <comments>
  5579.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5580.                      
  5581.                <event namespace="MPlayer" class="TMediaPlayer">OnPostClick</event> is generated after the code of the OnClick event handler has been called. If Wait is true when the media player was clicked, <event namespace="MPlayer" class="TMediaPlayer">OnPostClick</event> won't be called until the completion of the OnClick code. If Wait is false, control can return to the application before completion of the OnClick code; therefore, the <event namespace="MPlayer" class="TMediaPlayer">OnPostClick</event> event may occur before the actions initiated by the OnClick event have completed.</para>
  5582.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For example, if the user clicks the Play button and the DoDefault parameter of the OnClick event handler for the media player is true, the media is played. If the media is long enough, it will still be playing when the <event namespace="MPlayer" class="TMediaPlayer">OnPostClick</event> event is generated if Wait is true. If Wait is false, however, <event namespace="MPlayer" class="TMediaPlayer">OnPostClick</event> won't occur until the media has finished playing.</para>
  5583.          </comments>
  5584.       </member>
  5585.       <member name="E:MPlayer.MPlayer.OnNotify">
  5586.          <summary>
  5587.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs upon the completion of a media control method.</para>
  5588.          </summary>
  5589.          <comments>
  5590.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5591.                      
  5592.                <event namespace="MPlayer" class="TMediaPlayer">OnNotify</event> occurs upon the completion of a media control method (Back, Close, Eject, Next, Open, Pause, PauseOnly, Play, Previous, Resume, Rewind, StartRecording, Step, or Stop) when the Notify property is set to true before the call to the media control method. After an <event namespace="MPlayer" class="TMediaPlayer">OnNotify</event> event, the Notify property must be reset to true for the next <event namespace="MPlayer" class="TMediaPlayer">OnNotify</event> event to occur.</para>
  5593.          </comments>
  5594.       </member>
  5595.       <member name="T:DdeMan.TDdeClientConv">
  5596.          <summary>
  5597.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5598.                
  5599.                <class namespace="DdeMan">TDdeClientConv</class> represents a DDE conversation with a DDE server application. </para>
  5600.          </summary>
  5601.          <comments>
  5602.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="DdeMan">TDdeClientConv</class> with a TDdeClientItem object to enable an application to act as a DDE client. <class namespace="DdeMan">TDdeClientConv</class> provides many properties, events, and methods that provide services to</para>
  5603.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Link to a specified DDE server with a specified DDE topic.</para>
  5604.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Send data or macro commands to the DDE server after a link has been established.</para>
  5605.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specify a format for the data that is sent to the DDE server.</para>
  5606.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Allow event handlers to respond when the DDE link is opened or closed.</para>
  5607.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TDdeClientItem objects are associated with a <class namespace="DdeMan">TDdeClientConv</class> by setting their DdeConv property.</para>
  5608.          </comments>
  5609.       </member>
  5610.       <member name="M:DdeMan.DdeMan.PasteLink">
  5611.          <summary>
  5612.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Opens a DDE conversation with the current Clipboard object.</para>
  5613.          </summary>
  5614.          <comments>
  5615.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="DdeMan" class="TDdeClientConv">PasteLink</method> to establish a DDE link to an object on the Clipboard. <method namespace="DdeMan" class="TDdeClientConv">PasteLink</method> sets the DdeTopic or DdeService properties from the Clipboard. <method namespace="DdeMan" class="TDdeClientConv">PasteLink</method> returns true if the link is successfully established.</para>
  5616.          </comments>
  5617.       </member>
  5618.       <member name="M:DdeMan.DdeMan.OpenLink">
  5619.          <summary>
  5620.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Initiates a new DDE conversation.</para>
  5621.          </summary>
  5622.          <comments>
  5623.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="DdeMan" class="TDdeClientConv">OpenLink</method> to establish a new DDE conversation with the DdeService. If the server application is not running, <method namespace="DdeMan" class="TDdeClientConv">OpenLink</method> will launch the ServiceApplication. If the conversation is successfully opened, an OnOpen event occurs and <method namespace="DdeMan" class="TDdeClientConv">OpenLink</method> returns true. If the conversation isn't successfully opened, <method namespace="DdeMan" class="TDdeClientConv">OpenLink</method> returns false.</para>
  5624.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5625.                      
  5626.                <para>If ConnectMode is ddeAutomatic, <method namespace="DdeMan" class="TDdeClientConv">OpenLink</method> is called automatically when the DdeTopic and DdeService are specified by SetLink.</para>
  5627.                   
  5628.             </note>
  5629.          </comments>
  5630.       </member>
  5631.       <member name="M:DdeMan.DdeMan.SetLink">
  5632.          <summary>
  5633.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the service and topic of a DDE conversation and attempts to open the link if ConnectMode is ddeAutomatic.</para>
  5634.          </summary>
  5635.          <comments>
  5636.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="DdeMan" class="TDdeClientConv">SetLink</method> to fully specify a DDE conversation. If ConnectMode is ddeManual, calling <method namespace="DdeMan" class="TDdeClientConv">SetLink</method> is equivalent to setting the DdeTopic and DdeService properties, and clearing all data from any associated TDdeClientItem objects. If ConnectMode is ddeAutomatic, <method namespace="DdeMan" class="TDdeClientConv">SetLink</method> opens the link to the DDE server as well.</para>
  5637.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Service and Topic parameters specify the values for the DdeTopic and DdeService properties, respectively.</para>
  5638.          </comments>
  5639.       </member>
  5640.       <member name="M:DdeMan.DdeMan.StartAdvise">
  5641.          <summary>
  5642.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Starts an advise loop for all of the TDdeClientItems associated with the current DDE conversation. </para>
  5643.          </summary>
  5644.          <comments>
  5645.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="DdeMan" class="TDdeClientConv">StartAdvise</method> to start an advise loop for all of the TDdeClientItems associated with the current DDE conversation. <method namespace="DdeMan" class="TDdeClientConv">StartAdvise</method> returns true if loop startup is successful.</para>
  5646.          </comments>
  5647.       </member>
  5648.       <member name="M:DdeMan.DdeMan.PokeDataLines">
  5649.          <summary>
  5650.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sends multiple lines of data to a DDE server application. </para>
  5651.          </summary>
  5652.          <comments>
  5653.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="DdeMan" class="TDdeClientConv">PokeDataLines</method> to transfer multiple lines of text data to a DDE server that supports poked data. Item specifies the linked item in the DDE server. Data is a set of strings that specifies the text data to transfer.</para>
  5654.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of the DDE item depends on the linked DDE server application. Item is typically a selectable portion of text, such as a spreadsheet cell or a database field in an edit box. If the DDE server is a CLX application, Item is the name of the linked DDE server component.</para>
  5655.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The usual direction of data flow is from the DDE server to the DDE client application. Some DDE server applications won't accept poked data. PokeData returns true if the data was successfully transferred, false if the data was not successfully transferred.</para>
  5656.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To poke a single string rather than a string list, use the PokeData method.</para>
  5657.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5658.                      
  5659.                <para>If either the ExecuteMacro or ExecuteMacroLines method was called with its WaitFlg parameter set to true, PokeData will automatically fail until the server application has completed executing the macro. The WaitStat property indicates when PokeData will attempt to poke data to the server.</para>
  5660.                   
  5661.             </note>
  5662.          </comments>
  5663.       </member>
  5664.       <member name="M:DdeMan.DdeMan.PokeData">
  5665.          <summary>
  5666.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sends data to a DDE server application. </para>
  5667.          </summary>
  5668.          <comments>
  5669.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="DdeMan" class="TDdeClientConv">PokeData</method> to transfer text data to a DDE server that supports poked data. Item specifies the linked item in the DDE server. Data is a null-terminated string that specifies the text data to transfer.</para>
  5670.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of the DDE item depends on the linked DDE server application. Item is typically a selectable portion of text, such as a spreadsheet cell or a database field in an edit box. If the DDE server is a <condition language="Delphi">Delphi</condition>
  5671.                      
  5672.                <condition language="CBuilder">C++Builder</condition> application, Item is the name of the linked DDE server component.</para>
  5673.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The usual direction of data flow is from the DDE server to the DDE client application. Some DDE server applications won't accept poked data. <method namespace="DdeMan" class="TDdeClientConv">PokeData</method> returns true if the data was successfully transferred, false if the data was not successfully transferred.</para>
  5674.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">To poke a string list rather than a single string, use the <method namespace="DdeMan" class="TDdeClientConv">PokeData</method>Lines method.</para>
  5675.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5676.                      
  5677.                <para>If either the ExecuteMacro or ExecuteMacroLines method was called with its WaitFlg parameter set to true, <method namespace="DdeMan" class="TDdeClientConv">PokeData</method> will automatically fail until the server application has completed executing the macro. The WaitStat property indicates when <method namespace="DdeMan" class="TDdeClientConv">PokeData</method> will attempt to poke data to the server.</para>
  5678.                   
  5679.             </note>
  5680.          </comments>
  5681.       </member>
  5682.       <member name="M:DdeMan.DdeMan.ExecuteMacroLines">
  5683.          <summary>
  5684.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sends a list of several macro commands to a DDE server application.</para>
  5685.          </summary>
  5686.          <comments>
  5687.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="DdeMan" class="TDdeClientConv">ExecuteMacroLines</method> to send several macro commands to the server application. To send a single macro command, use ExecuteMacro instead. <method namespace="DdeMan" class="TDdeClientConv">ExecuteMacroLines</method> returns true if the macro list was successfully passed to the DDE server application. If <method namespace="DdeMan" class="TDdeClientConv">ExecuteMacroLines</method> is unable to send a list of command strings, it returns false.</para>
  5688.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Cmd contains the list of macros to be executed by the DDE server application. WaitFlg determines if this DDE client should wait until the DDE server application finishes executing all the macros before allowing another DDE transaction to be sent. If WaitFlg is set to true, subsequent calls to ExecuteMacro, <method namespace="DdeMan" class="TDdeClientConv">ExecuteMacroLines</method>, PokeData, PokeDataLines, and RequestData will fail until the DDE server application completes all of the macros.</para>
  5689.          </comments>
  5690.       </member>
  5691.       <member name="M:DdeMan.DdeMan.ExecuteMacro">
  5692.          <summary>
  5693.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Sends a macro command string to the DDE server application.</para>
  5694.          </summary>
  5695.          <comments>
  5696.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="DdeMan" class="TDdeClientConv">ExecuteMacro</method> to send a single macro command to the server application. To send multiple macro commands, use <method namespace="DdeMan" class="TDdeClientConv">ExecuteMacro</method>Lines instead. <method namespace="DdeMan" class="TDdeClientConv">ExecuteMacro</method> returns true if the macro was successfully passed to the DDE server application. If <method namespace="DdeMan" class="TDdeClientConv">ExecuteMacro</method> was unable to send a command string, <method namespace="DdeMan" class="TDdeClientConv">ExecuteMacro</method> returns false.</para>
  5697.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Cmd is a null-terminated string that contains the macro to be executed by the DDE server application. The actual value of Cmd depends on the DDE server application. See the documentation of the DDE server application for the command strings it will accept.</para>
  5698.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">WaitFlg determines if this DDE client should wait until the DDE server application finishes executing the macro before allowing another DDE transaction to succeed. If WaitFlg is set to true, subsequent calls to <method namespace="DdeMan" class="TDdeClientConv">ExecuteMacro</method>, <method namespace="DdeMan" class="TDdeClientConv">ExecuteMacro</method>Lines, PokeData, PokeDataLines, and RequestData will fail until the DDE server application completes the macro.</para>
  5699.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Attempting to execute a macro or poke data before a DDE server application completes a currently executing macro may cause the executing macro to fail or to produce unpredictable results. See the documentation of the DDE server application for the results of sending command strings or poking data before macro execution has completed.</para>
  5700.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5701.                      
  5702.                <para>
  5703.                         
  5704.                   <method namespace="DdeMan" class="TDdeClientConv">ExecuteMacro</method> returns true if the macro command was successfully passed to the DDE server. A true value does not ensure that the macro command will execute successfully once it has been accepted by the server.</para>
  5705.                   
  5706.             </note>
  5707.          </comments>
  5708.       </member>
  5709.       <member name="M:DdeMan.DdeMan.RequestData">
  5710.          <summary>
  5711.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Requests data from a DDE server.</para>
  5712.          </summary>
  5713.          <comments>
  5714.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="DdeMan" class="TDdeClientConv">RequestData</method> to send a request to the DDE server for the data named by Item. <method namespace="DdeMan" class="TDdeClientConv">RequestData</method> returns the value of the named DDE server item. </para>
  5715.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5716.                      
  5717.                <para>
  5718.                         
  5719.                   <method namespace="DdeMan" class="TDdeClientConv">RequestData</method> automatically allocates memory to store the returned data, but applications must dispose of this string after processing it. This is done with the StrDispose procedure.</para>
  5720.                   
  5721.             </note>
  5722.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the DDE server contains DDE items that can be continually updated, data can be received and updated automatically by creating TDdeClientItem objects for those items.</para>
  5723.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The value of the DDE item depends on the linked DDE server application. Item is typically a selectable portion of text, such as a spreadsheet cell or a database field in an edit box. If the DDE server is a CLX application, Item is the name of the linked DDE server component.</para>
  5724.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5725.                      
  5726.                <para>See the documentation for the DDE server application for specific information about specifying a DDE item.</para>
  5727.                   
  5728.             </note>
  5729.          </comments>
  5730.       </member>
  5731.       <member name="M:DdeMan.DdeMan.Create">
  5732.          <summary>
  5733.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5734.                      
  5735.                <method namespace="DdeMan" class="TDdeClientConv">Create</method>s an instance of <method namespace="DdeMan" class="TDdeClientConv">TDdeClientConv</method>.</para>
  5736.          </summary>
  5737.          <comments>
  5738.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="DdeMan" class="TDdeClientConv">Create</method> to create an instance of <method namespace="DdeMan" class="TDdeClientConv">TDdeClientConv</method>. After calling the inherited constructor, <method namespace="DdeMan" class="TDdeClientConv">Create</method> creates the helper objects used to manage individual DDE client items.</para>
  5739.          </comments>
  5740.       </member>
  5741.       <member name="M:DdeMan.DdeMan.CloseLink">
  5742.          <summary>
  5743.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Terminates an ongoing DDE conversation.</para>
  5744.          </summary>
  5745.          <comments>
  5746.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="DdeMan" class="TDdeClientConv">CloseLink</method> when all communication with the DDE server is finished. After a link is closed, no DDE communication can take place between the DDE client and server until another link is opened.</para>
  5747.          </comments>
  5748.       </member>
  5749.       <member name="M:DdeMan.DdeMan.Destroy">
  5750.          <summary>
  5751.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5752.                      
  5753.                <method namespace="DdeMan" class="TDdeClientConv">Destroy</method>s an instance of <method namespace="DdeMan" class="TDdeClientConv">TDdeClientConv</method>.</para>
  5754.          </summary>
  5755.          <comments>
  5756.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="DdeMan" class="TDdeClientConv">Destroy</method> directly in an application. Instead, call Free. Free verifies that the <method namespace="DdeMan" class="TDdeClientConv">TDdeClientConv</method> reference is not nil, and only then calls <method namespace="DdeMan" class="TDdeClientConv">Destroy</method>. </para>
  5757.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5758.                      
  5759.                <method namespace="DdeMan" class="TDdeClientConv">Destroy</method> closes the link to the server and frees up all helper objects before calling the inherited destructor.</para>
  5760.          </comments>
  5761.       </member>
  5762.       <member name="P:DdeMan.DdeMan.DdeFmt">
  5763.          <summary>
  5764.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Represents the clipboard format used for submitting or requesting a data item.</para>
  5765.          </summary>
  5766.          <comments>
  5767.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="DdeMan" class="TDdeClientConv">DdeFmt</property> to specify the format of DDE data items when it has not been specified by the server.</para>
  5768.          </comments>
  5769.       </member>
  5770.       <member name="P:DdeMan.DdeMan.WaitStat">
  5771.          <summary>
  5772.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates whether the server is in the process of servicing a DDE macro that prohibits asynchronous DDE transactions.</para>
  5773.          </summary>
  5774.          <comments>
  5775.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="DdeMan" class="TDdeClientConv">WaitStat</property> to learn whether a DDE transaction can be started. When <property namespace="DdeMan" class="TDdeClientConv">WaitStat</property> is true, the server is processing the last macro, and attempts to execute a macro, request data, or poke data will fail. When <property namespace="DdeMan" class="TDdeClientConv">WaitStat</property> is false, the server is free to execute the next transaction in the DDE conversation.</para>
  5776.          </comments>
  5777.       </member>
  5778.       <member name="P:DdeMan.DdeMan.Conv">
  5779.          <summary>
  5780.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the handle for the current DDE conversation.</para>
  5781.          </summary>
  5782.          <comments>
  5783.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="DdeMan" class="TDdeClientConv">Conv</property> to get a handle to the DDE conversation when it is required for a Windows API function call. <property namespace="DdeMan" class="TDdeClientConv">Conv</property> is available once a DDE conversation has been established by OpenLink or PasteLink.</para>
  5784.          </comments>
  5785.       </member>
  5786.       <member name="P:DdeMan.DdeMan.DataMode">
  5787.          <summary>
  5788.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Governs whether portions of the DDE conversation execute automatically.</para>
  5789.          </summary>
  5790.          <comments>
  5791.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5792.                      
  5793.                <property namespace="DdeMan" class="TDdeClientConv">DataMode</property> is not implemented for <property namespace="DdeMan" class="TDdeClientConv">TDdeClientConv</property>. Derived objects can use this property to automatically execute portions of a DDE conversation, such as a RequestData or PokeData call.</para>
  5794.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5795.                      
  5796.                <para>To determine the way the DDE conversation is established, use ConnectMode instead.</para>
  5797.                   
  5798.             </note>
  5799.          </comments>
  5800.       </member>
  5801.       <member name="P:DdeMan.DdeMan.ServiceApplication">
  5802.          <summary>
  5803.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the main executable file name (with path, if necessary) of a DDE server application, without the .EXE extension. </para>
  5804.          </summary>
  5805.          <comments>
  5806.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="DdeMan" class="TDdeClientConv">ServiceApplication</property> to the name of the server application. Typically, this is the same value as the DdeService property. Sometimes, however, DdeService is a value other than the DDE server application's executable file name.</para>
  5807.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the server application is not running when the <property namespace="DdeMan" class="TDdeClientConv">TDdeClientConv</property> tries to establish a DDE conversation, OpenLink uses the <property namespace="DdeMan" class="TDdeClientConv">ServiceApplication</property> property to launch the server.</para>
  5808.          </comments>
  5809.       </member>
  5810.       <member name="P:DdeMan.DdeMan.DdeService">
  5811.          <summary>
  5812.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the DDE server application to be linked to a DDE client. </para>
  5813.          </summary>
  5814.          <comments>
  5815.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="DdeMan" class="TDdeClientConv">DdeService</property> to specify the server application to link to. Typically, <property namespace="DdeMan" class="TDdeClientConv">DdeService</property> is the file name (with path, if necessary) of the DDE server application's main executable file without the .EXE extension. If the DDE server is a CLX application, <property namespace="DdeMan" class="TDdeClientConv">DdeService</property> is the project name without the .DPR or .EXE extension. For example, to link to a TDdeServerConv component in PROJ1.DPR, set <property namespace="DdeMan" class="TDdeClientConv">DdeService</property> to PROJ1.</para>
  5816.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">At design time, specify <property namespace="DdeMan" class="TDdeClientConv">DdeService</property> by typing the DDE server application name in the object inspector or by choosing Paste Link in the DDE Info dialog box. To establish a link at runtime, specify the service and topic with the SetLink method.</para>
  5817.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5818.                      
  5819.                <para>The necessary value for <property namespace="DdeMan" class="TDdeClientConv">DdeService</property> depends on the individual server application. See the documentation of the DDE server application for specific information about how to specify the server application.</para>
  5820.                   
  5821.             </note>
  5822.          </comments>
  5823.       </member>
  5824.       <member name="P:DdeMan.DdeMan.DdeTopic">
  5825.          <summary>
  5826.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the topic of a DDE conversation</para>
  5827.          </summary>
  5828.          <comments>
  5829.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="DdeMan" class="TDdeClientConv">DdeTopic</property> to indicate the server-defined topic name of the DDE conversation. Typically, <property namespace="DdeMan" class="TDdeClientConv">DdeTopic</property> is a file name (with path, if necessary) used by the server application. If the DDE server is a CLX application, by default <property namespace="DdeMan" class="TDdeClientConv">DdeTopic</property> is the caption of the form containing the linked component. If the DDE client is linked to a TDdeServerConv component, <property namespace="DdeMan" class="TDdeClientConv">DdeTopic</property> is the name of the server conversation component rather than the form caption.</para>
  5830.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">At design time, specify <property namespace="DdeMan" class="TDdeClientConv">DdeTopic</property> either by typing the <property namespace="DdeMan" class="TDdeClientConv">DdeTopic</property> name in the object inspector or by choosing Paste Link in the DDE Info dialog box. To establish a link at runtime, specify the service and topic with the SetLink method.</para>
  5831.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5832.                      
  5833.                <para>The server application defines the topic names available for a DDE conversation. See the documentation for the DDE server application for specific information about the names of available topics.</para>
  5834.                   
  5835.             </note>
  5836.          </comments>
  5837.       </member>
  5838.       <member name="P:DdeMan.DdeMan.ConnectMode">
  5839.          <summary>
  5840.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines whether the link to the DDE server is established automatically when the form is opened.</para>
  5841.          </summary>
  5842.          <comments>
  5843.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="DdeMan" class="TDdeClientConv">ConnectMode</property> to change the way a DDE conversation is established. If <property namespace="DdeMan" class="TDdeClientConv">ConnectMode</property> is ddeAutomatic, the link is established when it is defined by SetLink. If <property namespace="DdeMan" class="TDdeClientConv">ConnectMode</property> is ddeManual, the application must call the OpenLink method or the PasteLink method to establish the DDE conversation.</para>
  5844.          </comments>
  5845.       </member>
  5846.       <member name="P:DdeMan.DdeMan.FormatChars">
  5847.          <summary>
  5848.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Determines if certain characters are filtered out of text data transferred from a DDE server application.</para>
  5849.          </summary>
  5850.          <comments>
  5851.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <property namespace="DdeMan" class="TDdeClientConv">FormatChars</property> with DDE server applications that transfer backspaces, linefeeds, carriage returns, and tabs with the text data. These formatting characters can cause incorrect spacing, line breaks, or characters in the DDE client data. To prevent the formatting characters from interfering with the formatting of the client data, set <property namespace="DdeMan" class="TDdeClientConv">FormatChars</property> to false. To include the formatting characters sent by the DDE server, set <property namespace="DdeMan" class="TDdeClientConv">FormatChars</property> to true.</para>
  5852.          </comments>
  5853.       </member>
  5854.       <member name="E:DdeMan.DdeMan.OnClose">
  5855.          <summary>
  5856.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the DDE conversation terminates.</para>
  5857.          </summary>
  5858.          <comments>
  5859.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="DdeMan" class="TDdeClientConv">OnClose</event> event handler to take specific action when the DDE conversation ends. The DDE conversation will end if the server terminates the conversation, if the link is closed or changed, or if the <event namespace="DdeMan" class="TDdeClientConv">TDdeClientConv</event> object is destroyed.</para>
  5860.          </comments>
  5861.       </member>
  5862.       <member name="E:DdeMan.DdeMan.OnOpen">
  5863.          <summary>
  5864.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs immediately after the DDE link to the server has been established.</para>
  5865.          </summary>
  5866.          <comments>
  5867.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="DdeMan" class="TDdeClientConv">OnOpen</event> event handler to take specific action whenever a link is established to the DDE server. The DDE link is established by the <event namespace="DdeMan" class="TDdeClientConv">OnOpen</event> method or the PasteLink method. SetLink will also establish a DDE link if the ConnectMode is ddeAutomatic. <event namespace="DdeMan" class="TDdeClientConv">OnOpen</event> will not be called if the link fails, such as when the server application can't be launched.</para>
  5868.          </comments>
  5869.       </member>
  5870.       <member name="T:DdeMan.TDdeClientItem">
  5871.          <summary>
  5872.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">TDDEClientItem defines an item in a DDE conversation. </para>
  5873.          </summary>
  5874.          <comments>
  5875.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use TDDEClientItem with TDDEClientConv to enable an application to act as a DDE client. A DDE client item specifies a single item supported by a DDE server. A single TDDEClientConv object may be associated with multiple client items. If the DDE client conversation has established a link with a DDE server, the server will automatically and continually update all client items until the conversation is terminated.</para>
  5876.          </comments>
  5877.       </member>
  5878.       <member name="M:DdeMan.DdeMan.Create">
  5879.          <summary>
  5880.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5881.                      
  5882.                <method namespace="DdeMan" class="TDdeClientItem">Create</method>s an instance of TDDEClientItem.</para>
  5883.          </summary>
  5884.          <comments>
  5885.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="DdeMan" class="TDdeClientItem">Create</method> to instantiate a TDDEClientItem at runtime. After calling the inherited constructor, <method namespace="DdeMan" class="TDdeClientItem">Create</method> creates a helper object to manage the Lines property.</para>
  5886.          </comments>
  5887.       </member>
  5888.       <member name="M:DdeMan.DdeMan.Destroy">
  5889.          <summary>
  5890.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5891.                      
  5892.                <method namespace="DdeMan" class="TDdeClientItem">Destroy</method>s an instance of TDDEClientItem.</para>
  5893.          </summary>
  5894.          <comments>
  5895.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="DdeMan" class="TDdeClientItem">Destroy</method> directly in an application. Instead, call Free. Free checks that the TDDEClientItem is not nil, and only then calls <method namespace="DdeMan" class="TDdeClientItem">Destroy</method>.</para>
  5896.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5897.                      
  5898.                <method namespace="DdeMan" class="TDdeClientItem">Destroy</method> frees the memory associated with the Lines property before calling the inherited destructor.</para>
  5899.          </comments>
  5900.       </member>
  5901.       <member name="P:DdeMan.DdeMan.Text">
  5902.          <summary>
  5903.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Contains the text data to exchange in a DDE conversation. </para>
  5904.          </summary>
  5905.          <comments>
  5906.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="DdeMan" class="TDdeClientItem">Text</property> to get the text that is updated by the DDE server application. <property namespace="DdeMan" class="TDdeClientItem">Text</property> is updated automatically by the DDE server. When <property namespace="DdeMan" class="TDdeClientItem">Text</property> is changed by the server, an OnChange event occurs.</para>
  5907.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set the <property namespace="DdeMan" class="TDdeClientItem">Text</property> property to poke data to the DDE server.</para>
  5908.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5909.                      
  5910.                <property namespace="DdeMan" class="TDdeClientItem">Text</property> corresponds to the Lines property. Whenever the value of Lines or <property namespace="DdeMan" class="TDdeClientItem">Text</property> is updated, the other is also changed so that the first line of Lines is always equal to <property namespace="DdeMan" class="TDdeClientItem">Text</property>.</para>
  5911.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">For text data longer than the 255 character limit of <property namespace="DdeMan" class="TDdeClientItem">Text</property>, use the Lines property.</para>
  5912.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5913.                      
  5914.                <para>Data can also be sent to the DDE server by calling the PokeData method of the DDE client conversation.</para>
  5915.                   
  5916.             </note>
  5917.          </comments>
  5918.       </member>
  5919.       <member name="P:DdeMan.DdeMan.Lines">
  5920.          <summary>
  5921.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Contains the text data to exchange in a DDE conversation.</para>
  5922.          </summary>
  5923.          <comments>
  5924.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Read <property namespace="DdeMan" class="TDdeClientItem">Lines</property> to get the text that is updated by the DDE server application. <property namespace="DdeMan" class="TDdeClientItem">Lines</property> is updated automatically by the DDE server. When <property namespace="DdeMan" class="TDdeClientItem">Lines</property> is changed by the server, an OnChange event occurs.</para>
  5925.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set the <property namespace="DdeMan" class="TDdeClientItem">Lines</property> property to poke data to the DDE server.</para>
  5926.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5927.                      
  5928.                <property namespace="DdeMan" class="TDdeClientItem">Lines</property> corresponds to the Text property. Whenever the value of <property namespace="DdeMan" class="TDdeClientItem">Lines</property> or Text is updated, the other is also changed so that the first line of <property namespace="DdeMan" class="TDdeClientItem">Lines</property> is always equal to Text.</para>
  5929.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5930.                      
  5931.                <para>
  5932.                         
  5933.                   <property namespace="DdeMan" class="TDdeClientItem">Lines</property> of data can also be sent to the DDE server by calling the PokeData<property namespace="DdeMan" class="TDdeClientItem">Lines</property> method of the DDE client conversation.</para>
  5934.                   
  5935.             </note>
  5936.          </comments>
  5937.       </member>
  5938.       <member name="P:DdeMan.DdeMan.DdeConv">
  5939.          <summary>
  5940.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the DDE client conversation to associate with the DDE client item.</para>
  5941.          </summary>
  5942.          <comments>
  5943.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set DdeConv to associate the DDE client item with a DDE client conversation. The value of DdeConv is the DDE client conversation object that defines the DDE conversation. The DdeConv establishes the link to the server that provides the Text for the DDE client item.</para>
  5944.          </comments>
  5945.       </member>
  5946.       <member name="P:DdeMan.DdeMan.DdeItem">
  5947.          <summary>
  5948.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the item of a DDE conversation. </para>
  5949.          </summary>
  5950.          <comments>
  5951.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set the DdeItem property to the name of a DDE item supported by the DDE server. The value of DdeItem depends on the linked DDE server application. DdeItem is typically a selectable portion of text, such as a spreadsheet cell or a database field in an edit box. If the DDE server is a <condition language="Delphi">Delphi</condition>
  5952.                      
  5953.                <condition language="CBuilder">C++Builder</condition> application, DdeItem is the name of the linked DDE server item.</para>
  5954.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">At design time, specify DdeItem by typing the item string in the object inspector. Alternately, DdeItem can be specified from the DDE conversation by pasting a link using the DDE Info dialog box, which is called by clicking the ellipsis (...) button for DdeService or DdeTopic in the object inspector. After choosing Paste Link in the DDE Info dialog box, choose the item from a list of possible items for DdeItem in the object inspector when link information is on the Clipboard.</para>
  5955.             <note xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5956.                      
  5957.                <para>See the documentation for the DDE server application for the specific information about specifying DDE items.</para>
  5958.                   
  5959.             </note>
  5960.          </comments>
  5961.       </member>
  5962.       <member name="E:DdeMan.DdeMan.OnChange">
  5963.          <summary>
  5964.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs immediately after the DDE server updates the Lines property.</para>
  5965.          </summary>
  5966.          <comments>
  5967.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="DdeMan" class="TDdeClientItem">OnChange</event> event handler to take specific action when the DDE server updates the text for this DDE client item. The new value for the DDE client item can be found by reading the Lines or Text property.</para>
  5968.          </comments>
  5969.       </member>
  5970.       <member name="T:DdeMan.TDdeServerConv">
  5971.          <summary>
  5972.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5973.                
  5974.                <class namespace="DdeMan">TDdeServerConv</class> represents a DDE topic of conversation with a DDE client.</para>
  5975.          </summary>
  5976.          <comments>
  5977.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="DdeMan">TDdeServerConv</class> to establish a DDE topic with a DDE client application. Individual items under the DDE topic are represented by TDdeServerItem objects. These items are linked to the DDE server conversation by setting their ServerConv property.</para>
  5978.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Using a <class namespace="DdeMan">TDdeServerConv</class> component is optional. Without a <class namespace="DdeMan">TDdeServerConv</class> object, the client can still enter into a DDE conversation and receive an update directly from a TDdeServerItem object. However, a DDE server conversation is required to handle any macros that the DDE client may send.</para>
  5979.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Name property of the DDE server conversation provides the topic used by DDE clients to establish a link to the DDE server conversation. DDE server items that are not associated with a DDE server conversation use the Caption property of the form for the topic name. Use a <class namespace="DdeMan">TDdeServerConv</class> object when establishing multiple DDE topics in a single form, or when the Caption of the form may not be unique or constant at runtime.</para>
  5980.          </comments>
  5981.       </member>
  5982.       <member name="M:DdeMan.DdeMan.ExecuteMacro">
  5983.          <summary>
  5984.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Responds to macros sent by the DDE client.</para>
  5985.          </summary>
  5986.          <comments>
  5987.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5988.                      
  5989.                <method namespace="DdeMan" class="TDdeServerConv">ExecuteMacro</method> provides the only way for a DDE server application to respond to macros sent by DDE clients. <method namespace="DdeMan" class="TDdeServerConv">ExecuteMacro</method> is called when the DDE client sends a Macro over the DDE link. Data is the handle to the DDE data that contains the macro.</para>
  5990.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5991.                      
  5992.                <method namespace="DdeMan" class="TDdeServerConv">ExecuteMacro</method> retrieves the strings of the macro from Data, and calls the On<method namespace="DdeMan" class="TDdeServerConv">ExecuteMacro</method> event handler. If there is no On<method namespace="DdeMan" class="TDdeServerConv">ExecuteMacro</method> event handler, the macro is ignored. Whether or not there is an On<method namespace="DdeMan" class="TDdeServerConv">ExecuteMacro</method> event handler, the DDE client always receives notification that the macro was successfully transmitted, unless Data contains no macro.</para>
  5993.          </comments>
  5994.       </member>
  5995.       <member name="M:DdeMan.DdeMan.Create">
  5996.          <summary>
  5997.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  5998.                      
  5999.                <method namespace="DdeMan" class="TDdeServerConv">Create</method>s an instance of <method namespace="DdeMan" class="TDdeServerConv">TDdeServerConv</method>.</para>
  6000.          </summary>
  6001.          <comments>
  6002.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="DdeMan" class="TDdeServerConv">Create</method> to create an instance of <method namespace="DdeMan" class="TDdeServerConv">TDdeServerConv</method> at runtime. For <method namespace="DdeMan" class="TDdeServerConv">TDdeServerConv</method> objects placed on forms at design time, <method namespace="DdeMan" class="TDdeServerConv">Create</method> is called automatically.</para>
  6003.          </comments>
  6004.       </member>
  6005.       <member name="M:DdeMan.DdeMan.Destroy">
  6006.          <summary>
  6007.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6008.                      
  6009.                <method namespace="DdeMan" class="TDdeServerConv">Destroy</method>s an instance of <method namespace="DdeMan" class="TDdeServerConv">TDdeServerConv</method>.</para>
  6010.          </summary>
  6011.          <comments>
  6012.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="DdeMan" class="TDdeServerConv">Destroy</method> directly in an application. Instead, call Free. Free verifies that the <method namespace="DdeMan" class="TDdeServerConv">TDdeServerConv</method> reference is not nil and only then calls <method namespace="DdeMan" class="TDdeServerConv">Destroy</method>.</para>
  6013.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6014.                      
  6015.                <method namespace="DdeMan" class="TDdeServerConv">Destroy</method> removes the DDE server conversation topic from the application, but does not terminate any currently open DDE conversations. Instead, the DDE server items that were associated with the DDE server conversation become associated with the form instead, and continue their link to the DDE client.</para>
  6016.          </comments>
  6017.       </member>
  6018.       <member name="E:DdeMan.DdeMan.OnOpen">
  6019.          <summary>
  6020.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs immediately after the DDE link to the client has been established.</para>
  6021.          </summary>
  6022.          <comments>
  6023.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="DdeMan" class="TDdeServerConv">OnOpen</event> event handler to take specific action whenever a link is established to a DDE client. The Sender parameter is the DDE server conversation, not the DDE client.</para>
  6024.          </comments>
  6025.       </member>
  6026.       <member name="E:DdeMan.DdeMan.OnClose">
  6027.          <summary>
  6028.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the DDE client terminates the DDE conversation.</para>
  6029.          </summary>
  6030.          <comments>
  6031.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="DdeMan" class="TDdeServerConv">OnClose</event> event handler to take specific action when the DDE conversation ends. The DDE conversation will end if the client terminates the conversation. It does not end if the <event namespace="DdeMan" class="TDdeServerConv">TDdeServerConv</event> object is destroyed. In that case, the DDE server items simply remove themselves from the DDE server conversation, and continue the link to the DDE client.</para>
  6032.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">The Sender parameter is the DDE server conversation, not the DDE client.</para>
  6033.          </comments>
  6034.       </member>
  6035.       <member name="E:DdeMan.DdeMan.OnExecuteMacro">
  6036.          <summary>
  6037.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the DDE client sends a macro to the DDE server conversation.</para>
  6038.          </summary>
  6039.          <comments>
  6040.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="DdeMan" class="TDdeServerConv">OnExecuteMacro</event> event handler to implement a response to macros sent by the DDE client. </para>
  6041.          </comments>
  6042.       </member>
  6043.       <member name="T:DdeMan.TDdeServerItem">
  6044.          <summary>
  6045.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6046.                
  6047.                <class namespace="DdeMan">TDdeServerItem</class> defines the item of a DDE conversation. </para>
  6048.          </summary>
  6049.          <comments>
  6050.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <class namespace="DdeMan">TDdeServerItem</class> by itself, or, optionally, with a TDdeServerConv object to enable an application to function as a DDE server. DDE clients link to an individual DDE server item by referring to the Name property. Once a link to a DDE client is established, the DDE server item can update the client to changes in the item data, or receive data that the DDE client pokes to the item.</para>
  6051.          </comments>
  6052.       </member>
  6053.       <member name="M:DdeMan.DdeMan.PokeData">
  6054.          <summary>
  6055.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Processes data that has been poked to the DDE server item by a DDE client.</para>
  6056.          </summary>
  6057.          <comments>
  6058.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="DdeMan" class="TDdeServerItem">PokeData</method> to inform the DDE server item that the DDE conversation holds data that has been poked from a DDE client. Data is the DDE handle to the poked data.</para>
  6059.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6060.                      
  6061.                <method namespace="DdeMan" class="TDdeServerItem">PokeData</method> does the following:</para>
  6062.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1Uses the Data handle to obtain the data that was poked.</para>
  6063.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2Sets the Lines property to the new data value.</para>
  6064.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3Triggers an OnChange event.</para>
  6065.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">4Sends the new value of the data back to the DDE client.</para>
  6066.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">5Triggers an On<method namespace="DdeMan" class="TDdeServerItem">PokeData</method> event.</para>
  6067.          </comments>
  6068.       </member>
  6069.       <member name="M:DdeMan.DdeMan.Create">
  6070.          <summary>
  6071.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6072.                      
  6073.                <method namespace="DdeMan" class="TDdeServerItem">Create</method>s an instance of <method namespace="DdeMan" class="TDdeServerItem">TDdeServerItem</method>.</para>
  6074.          </summary>
  6075.          <comments>
  6076.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="DdeMan" class="TDdeServerItem">Create</method> to instantiate a DDE server item at runtime. <method namespace="DdeMan" class="TDdeServerItem">TDdeServerItem</method> objects placed on forms at design time are created automatically.</para>
  6077.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">After calling the inherited constructor, <method namespace="DdeMan" class="TDdeServerItem">Create</method> initializes the Fmt property to CF_TEXT, and creates a helper object to manage the Lines property.</para>
  6078.          </comments>
  6079.       </member>
  6080.       <member name="M:DdeMan.DdeMan.CopyToClipboard">
  6081.          <summary>
  6082.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Copies the data specified in the Text or Lines property to the Windows Clipboard, along with DDE link information.</para>
  6083.          </summary>
  6084.          <comments>
  6085.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Use <method namespace="DdeMan" class="TDdeServerItem">CopyToClipboard</method> to enable DDE clients to link to the DDE server item by executing an Edit | Paste Link command, or its equivalent in the command structure of the DDE client application.</para>
  6086.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6087.                      
  6088.                <method namespace="DdeMan" class="TDdeServerItem">CopyToClipboard</method> can be used to create a DDE link at runtime only. To create a link at design time, select the <method namespace="DdeMan" class="TDdeServerItem">TDdeServerItem</method> object and choose Edit | Copy from the menu. Then, activate the DDE client application and paste the link according to the rules of the DDE client application. See the documentation for the DDE client application for specific information about pasting the link.</para>
  6089.          </comments>
  6090.       </member>
  6091.       <member name="M:DdeMan.DdeMan.Change">
  6092.          <summary>
  6093.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Generates an On<method namespace="DdeMan" class="TDdeServerItem">Change</method> event.</para>
  6094.          </summary>
  6095.          <comments>
  6096.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Call <method namespace="DdeMan" class="TDdeServerItem">Change</method> to trigger an On<method namespace="DdeMan" class="TDdeServerItem">Change</method> event when not setting the Lines or Text property. Use <method namespace="DdeMan" class="TDdeServerItem">Change</method> in conjunction with the On<method namespace="DdeMan" class="TDdeServerItem">Change</method> event to enable the DDE server item to exchange data that is not compatible with the strings used by the Lines and Text properties.</para>
  6097.          </comments>
  6098.       </member>
  6099.       <member name="M:DdeMan.DdeMan.Destroy">
  6100.          <summary>
  6101.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6102.                      
  6103.                <method namespace="DdeMan" class="TDdeServerItem">Destroy</method>s an instance of <method namespace="DdeMan" class="TDdeServerItem">TDdeServerItem</method>.</para>
  6104.          </summary>
  6105.          <comments>
  6106.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Do not call <method namespace="DdeMan" class="TDdeServerItem">Destroy</method> directly in an application. Instead, call Free. Free verifies that the <method namespace="DdeMan" class="TDdeServerItem">TDdeServerItem</method> is not nil, and only then calls <method namespace="DdeMan" class="TDdeServerItem">Destroy</method>.</para>
  6107.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6108.                      
  6109.                <method namespace="DdeMan" class="TDdeServerItem">Destroy</method> frees the memory associated with the Lines property before calling the inherited destructor.</para>
  6110.          </comments>
  6111.       </member>
  6112.       <member name="P:DdeMan.DdeMan.Fmt">
  6113.          <summary>
  6114.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Indicates the clipboard format the DDE client item uses to pass data to the DDE client.</para>
  6115.          </summary>
  6116.          <comments>
  6117.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="DdeMan" class="TDdeServerItem">Fmt</property> in an OnChange event handler to specify a clipboard format for the data that is passed to the DDE client if it is not text. The DDE data that is sent to the DDE client includes this format so that clients can correctly interpret the data. Read <property namespace="DdeMan" class="TDdeServerItem">Fmt</property> when the client pokes data to the DDE server item to determine the clipboard format the client used to format the data.</para>
  6118.          </comments>
  6119.       </member>
  6120.       <member name="P:DdeMan.DdeMan.ServerConv">
  6121.          <summary>
  6122.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Specifies the DDE server conversation to associate with the DDE server item. </para>
  6123.          </summary>
  6124.          <comments>
  6125.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="DdeMan" class="TDdeServerItem">ServerConv</property> to associate the DDE server item with a DDE topic represented by the DDE server conversation. If <property namespace="DdeMan" class="TDdeServerItem">ServerConv</property> is not set, the DDE topic of the conversation is the value of the Caption property of the form containing the <property namespace="DdeMan" class="TDdeServerItem">TDdeServerItem</property> component.</para>
  6126.          </comments>
  6127.       </member>
  6128.       <member name="P:DdeMan.DdeMan.Text">
  6129.          <summary>
  6130.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Contains the data to exchange in a DDE conversation. </para>
  6131.          </summary>
  6132.          <comments>
  6133.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="DdeMan" class="TDdeServerItem">Text</property> to the data the DDE server item sends to the DDE client. Whenever the <property namespace="DdeMan" class="TDdeServerItem">Text</property> property changes, an OnChange event occurs and then the new value is sent to the DDE client. If the DDE server item accepts poked data, <property namespace="DdeMan" class="TDdeServerItem">Text</property> receives the data whenever the DDE client pokes data to this item. When <property namespace="DdeMan" class="TDdeServerItem">Text</property> is changed by a DDE client poking data, an OnPokeData event occurs after the OnChange event.</para>
  6134.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Usually <property namespace="DdeMan" class="TDdeServerItem">Text</property> contains text, and setting <property namespace="DdeMan" class="TDdeServerItem">Text</property> sets the Fmt property to CF_TEXT. However, <property namespace="DdeMan" class="TDdeServerItem">Text</property> can contain non-text data. If <property namespace="DdeMan" class="TDdeServerItem">Text</property> does not specify text data, Fmt must be changed to indicate the format of the data in an OnChange event handler.</para>
  6135.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6136.                      
  6137.                <property namespace="DdeMan" class="TDdeServerItem">Text</property> corresponds to the Lines property. Whenever the value of Lines or <property namespace="DdeMan" class="TDdeServerItem">Text</property> is changed, the other is updated so that the first line of Lines is always equal to <property namespace="DdeMan" class="TDdeServerItem">Text</property>.</para>
  6138.          </comments>
  6139.       </member>
  6140.       <member name="P:DdeMan.DdeMan.Lines">
  6141.          <summary>
  6142.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Contains the data to exchange in a DDE conversation. </para>
  6143.          </summary>
  6144.          <comments>
  6145.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Set <property namespace="DdeMan" class="TDdeServerItem">Lines</property> to the data the DDE server item sends to the DDE client. Whenever the <property namespace="DdeMan" class="TDdeServerItem">Lines</property> property changes, an OnChange event occurs and then the new value is sent to the DDE client. If the DDE server item accepts poked data, <property namespace="DdeMan" class="TDdeServerItem">Lines</property> receives the data whenever the DDE client pokes data to this item. When <property namespace="DdeMan" class="TDdeServerItem">Lines</property> is changed by a DDE client poking data, an OnPokeData event occurs after the OnChange event.</para>
  6146.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Usually <property namespace="DdeMan" class="TDdeServerItem">Lines</property> contains text, and setting <property namespace="DdeMan" class="TDdeServerItem">Lines</property> sets the Fmt property to CF_TEXT. However, <condition language="Delphi">Delphi</condition>
  6147.                      
  6148.                <condition language="CBuilder">C++Builder</condition> strings can contain non-text data. If <property namespace="DdeMan" class="TDdeServerItem">Lines</property> does not specify text data, Fmt must be changed to indicate the format of the data in an OnChange event handler.</para>
  6149.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  6150.                      
  6151.                <property namespace="DdeMan" class="TDdeServerItem">Lines</property> corresponds to the Text property. Whenever the value of <property namespace="DdeMan" class="TDdeServerItem">Lines</property> or Text is changed, the other is updated so that the first line of <property namespace="DdeMan" class="TDdeServerItem">Lines</property> is always equal to Text.</para>
  6152.          </comments>
  6153.       </member>
  6154.       <member name="E:DdeMan.DdeMan.OnChange">
  6155.          <summary>
  6156.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs when the Lines property changes, before the changes have been sent to the DDE client.</para>
  6157.          </summary>
  6158.          <comments>
  6159.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="DdeMan" class="TDdeServerItem">OnChange</event> event handler to take specific action when the DDE server item is about to update the DDE client. The new value for the DDE client item can be found by reading the Lines or Text property.</para>
  6160.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">If the value of Lines does not contain text data, an <event namespace="DdeMan" class="TDdeServerItem">OnChange</event> event handler must be assigned to change the value of Fmt. <event namespace="DdeMan" class="TDdeServerItem">OnChange</event> is called after Fmt gets set to CF_TEXT by setting the Lines property, but before the data gets sent to the client.</para>
  6161.          </comments>
  6162.       </member>
  6163.       <member name="E:DdeMan.DdeMan.OnPokeData">
  6164.          <summary>
  6165.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Occurs after a DDE client changes the value of the Lines property.</para>
  6166.          </summary>
  6167.          <comments>
  6168.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">Write an <event namespace="DdeMan" class="TDdeServerItem">OnPokeData</event> event handler to take specific action when the DDE client pokes data to this DDE server item. The new value for the item can be found by reading the Lines or Text property.</para>
  6169.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">When a DDE client pokes data to a DDE server items, the PokeData method is called. PokeData causes the following events.</para>
  6170.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1First, the new value is assigned to the Lines (Text) property.</para>
  6171.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">2An OnChange event occurs.</para>
  6172.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">3The new value is sent back to the DDE client.</para>
  6173.             <para xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">4An <event namespace="DdeMan" class="TDdeServerItem">OnPokeData</event> event occurs.</para>
  6174.          </comments>
  6175.       </member>
  6176.    </members>
  6177. </doc>