mcs/class/Managed.Windows.Forms/Documentation/en/System.Windows.Forms/DrawTreeNodeEventArgs.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="DrawTreeNodeEventArgs" FullName="System.Windows.Forms.DrawTreeNodeEventArgs">
   3   <TypeSignature Language="C#" Value="public class DrawTreeNodeEventArgs : EventArgs" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   7   </AssemblyInfo>
   8   <Base>
   9     <BaseTypeName>System.EventArgs</BaseTypeName>
  10   </Base>
  11   <Interfaces />
  12   <Docs>
  13     <since version=".NET 2.0" />
  14     <remarks>
  15       <attribution license="cc4" from="Microsoft" modified="false" />
  16       <para>Use the <see cref="E:System.Windows.Forms.TreeView.DrawNode" /> event to customize the appearance of nodes in a <see cref="T:System.Windows.Forms.TreeView" /> control using owner drawing.</para>
  17       <para>The <see cref="E:System.Windows.Forms.TreeView.DrawNode" /> event is raised by a <see cref="T:System.Windows.Forms.TreeView" /> control when its <see cref="P:System.Windows.Forms.TreeView.DrawMode" /> property is set to <see cref="F:System.Windows.Forms.TreeViewDrawMode.OwnerDrawAll" /> or <see cref="F:System.Windows.Forms.TreeViewDrawMode.OwnerDrawText" /> and a node is displayed or updated. The <see cref="T:System.Windows.Forms.DrawTreeNodeEventArgs" /> passed to the event handler contains information about the node to draw as well as providing methods to help you draw the node.</para>
  18       <para>Use the <see cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.State" /> or <see cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.Node" /> properties to retrieve information about the node to draw. Use the <see cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.Graphics" /> property to do the actual drawing within the area specified by the <see cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.Bounds" /> property. To make the operating system draw a node that does not need to be owner drawn, set the <see cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.DrawDefault" /> property to true.</para>
  19       <para>When the <see cref="P:System.Windows.Forms.TreeView.DrawMode" /> property is set to <see cref="F:System.Windows.Forms.TreeViewDrawMode.OwnerDrawText" />, the area indicated by the <see cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.Bounds" /> property includes the label portion of the node only. When the <see cref="P:System.Windows.Forms.TreeView.DrawMode" /> property is set to <see cref="F:System.Windows.Forms.TreeViewDrawMode.OwnerDrawAll" />, the <see cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.Bounds" /> area includes the entire node, including the area typically used for icons, checkboxes, plus and minus signs, and lines connecting the nodes.</para>
  20     </remarks>
  21     <summary>
  22       <attribution license="cc4" from="Microsoft" modified="false" />
  23       <para>Provides data for the <see cref="E:System.Windows.Forms.TreeView.DrawNode" /> event.</para>
  24     </summary>
  25   </Docs>
  26   <Members>
  27     <Member MemberName=".ctor">
  28       <MemberSignature Language="C#" Value="public DrawTreeNodeEventArgs (System.Drawing.Graphics graphics, System.Windows.Forms.TreeNode node, System.Drawing.Rectangle bounds, System.Windows.Forms.TreeNodeStates state);" />
  29       <MemberType>Constructor</MemberType>
  30       <Parameters>
  31         <Parameter Name="graphics" Type="System.Drawing.Graphics" />
  32         <Parameter Name="node" Type="System.Windows.Forms.TreeNode" />
  33         <Parameter Name="bounds" Type="System.Drawing.Rectangle" />
  34         <Parameter Name="state" Type="System.Windows.Forms.TreeNodeStates" />
  35       </Parameters>
  36       <Docs>
  37         <remarks>To be added.</remarks>
  38         <since version=".NET 2.0" />
  39         <summary>
  40           <attribution license="cc4" from="Microsoft" modified="false" />
  41           <para>Initializes a new instance of the <see cref="T:System.Windows.Forms.DrawTreeNodeEventArgs" /> class.</para>
  42         </summary>
  43         <param name="graphics">
  44           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Graphics" /> surface on which to draw. </param>
  45         <param name="node">
  46           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Windows.Forms.TreeNode" /> to draw. </param>
  47         <param name="bounds">
  48           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Drawing.Rectangle" /> within which to draw. </param>
  49         <param name="state">
  50           <attribution license="cc4" from="Microsoft" modified="false" />A bitwise combination of the <see cref="T:System.Windows.Forms.TreeNodeStates" /> values indicating the current state of the <see cref="T:System.Windows.Forms.TreeNode" /> to draw. </param>
  51       </Docs>
  52       <AssemblyInfo>
  53         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  54       </AssemblyInfo>
  55     </Member>
  56     <Member MemberName="Bounds">
  57       <MemberSignature Language="C#" Value="public System.Drawing.Rectangle Bounds { get; }" />
  58       <MemberType>Property</MemberType>
  59       <ReturnValue>
  60         <ReturnType>System.Drawing.Rectangle</ReturnType>
  61       </ReturnValue>
  62       <Docs>
  63         <value>To be added.</value>
  64         <since version=".NET 2.0" />
  65         <remarks>
  66           <attribution license="cc4" from="Microsoft" modified="false" />
  67           <para>The location specified by this property is relative to the upper-left corner of the <see cref="T:System.Windows.Forms.TreeView" /> control.</para>
  68           <para>When the <see cref="P:System.Windows.Forms.TreeView.DrawMode" /> property is set to <see cref="F:System.Windows.Forms.TreeViewDrawMode.OwnerDrawText" />, the area specified by the <see cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.Bounds" /> property is the region in which a node can be clicked to select it. If you draw outside this hit test region, you should provide your own code for selecting a node when its visible area is clicked. You may also want to provide your own hit test code when the <see cref="P:System.Windows.Forms.TreeView.DrawMode" /> property is set to <see cref="F:System.Windows.Forms.TreeViewDrawMode.OwnerDrawAll" />. In this mode, the <see cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.Bounds" /> property encompasses the whole node across the entire width of the <see cref="T:System.Windows.Forms.TreeView" /> control, rather than the just hit test region.</para>
  69         </remarks>
  70         <summary>
  71           <attribution license="cc4" from="Microsoft" modified="false" />
  72           <para>Gets the size and location of the <see cref="T:System.Windows.Forms.TreeNode" /> to draw.</para>
  73         </summary>
  74       </Docs>
  75       <AssemblyInfo>
  76         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  77       </AssemblyInfo>
  78     </Member>
  79     <Member MemberName="DrawDefault">
  80       <MemberSignature Language="C#" Value="public bool DrawDefault { set; get; }" />
  81       <MemberType>Property</MemberType>
  82       <ReturnValue>
  83         <ReturnType>System.Boolean</ReturnType>
  84       </ReturnValue>
  85       <Docs>
  86         <value>To be added.</value>
  87         <since version=".NET 2.0" />
  88         <remarks>
  89           <attribution license="cc4" from="Microsoft" modified="false" />
  90           <para>Set this property to true for nodes that you do not want to customize when you handle the <see cref="E:System.Windows.Forms.TreeView.DrawNode" /> event. For example, this is useful when you want to customize only nodes that are in a specific state.</para>
  91         </remarks>
  92         <summary>
  93           <attribution license="cc4" from="Microsoft" modified="false" />
  94           <para>Gets or sets a value indicating whether the <see cref="T:System.Windows.Forms.TreeNode" /> should be drawn by the operating system rather than being owner drawn.</para>
  95         </summary>
  96       </Docs>
  97       <AssemblyInfo>
  98         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  99       </AssemblyInfo>
 100     </Member>
 101     <Member MemberName="Graphics">
 102       <MemberSignature Language="C#" Value="public System.Drawing.Graphics Graphics { get; }" />
 103       <MemberType>Property</MemberType>
 104       <ReturnValue>
 105         <ReturnType>System.Drawing.Graphics</ReturnType>
 106       </ReturnValue>
 107       <Docs>
 108         <value>To be added.</value>
 109         <since version=".NET 2.0" />
 110         <remarks>
 111           <attribution license="cc4" from="Microsoft" modified="false" />
 112           <para>The <see cref="T:System.Drawing.Graphics" /> class provides properties and methods useful for drawing on the display device.</para>
 113         </remarks>
 114         <summary>
 115           <attribution license="cc4" from="Microsoft" modified="false" />
 116           <para>Gets the <see cref="T:System.Drawing.Graphics" /> object used to draw the <see cref="T:System.Windows.Forms.TreeNode" />.</para>
 117         </summary>
 118       </Docs>
 119       <AssemblyInfo>
 120         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 121       </AssemblyInfo>
 122     </Member>
 123     <Member MemberName="Node">
 124       <MemberSignature Language="C#" Value="public System.Windows.Forms.TreeNode Node { get; }" />
 125       <MemberType>Property</MemberType>
 126       <ReturnValue>
 127         <ReturnType>System.Windows.Forms.TreeNode</ReturnType>
 128       </ReturnValue>
 129       <Docs>
 130         <value>To be added.</value>
 131         <since version=".NET 2.0" />
 132         <remarks>
 133           <attribution license="cc4" from="Microsoft" modified="false" />
 134           <para>Use this property to access the <see cref="T:System.Windows.Forms.TreeNode" /> object to draw. This is useful when the <see cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.State" /> property does not provide adequate information to meet your needs. The <see cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.State" /> property provides only basic state information that you can use, for example, to determine whether a node is selected, checked, or focused. The <see cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.Node" /> property, on the other hand, allows you to access all members of the <see cref="T:System.Windows.Forms.TreeNode" /> object. You must access the node directly, for example, when you want to determine its expansion state.</para>
 135         </remarks>
 136         <summary>
 137           <attribution license="cc4" from="Microsoft" modified="false" />
 138           <para>Gets the <see cref="T:System.Windows.Forms.TreeNode" /> to draw.</para>
 139         </summary>
 140       </Docs>
 141       <AssemblyInfo>
 142         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 143       </AssemblyInfo>
 144     </Member>
 145     <Member MemberName="State">
 146       <MemberSignature Language="C#" Value="public System.Windows.Forms.TreeNodeStates State { get; }" />
 147       <MemberType>Property</MemberType>
 148       <ReturnValue>
 149         <ReturnType>System.Windows.Forms.TreeNodeStates</ReturnType>
 150       </ReturnValue>
 151       <Docs>
 152         <value>To be added.</value>
 153         <since version=".NET 2.0" />
 154         <remarks>
 155           <attribution license="cc4" from="Microsoft" modified="false" />
 156           <para>Use this property to check whether the <see cref="T:System.Windows.Forms.TreeNode" /> object to draw is in a particular state. This property provides only basic state information about the node. You can use this property, for example, to determine whether a node is selected, checked, or focused. If you need to know more, retrieve the node through the <see cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.Node" /> property. For example, to determine whether the node is expanded, you must retrieve the node and check the <see cref="P:System.Windows.Forms.TreeNode.IsExpanded" /> property.</para>
 157         </remarks>
 158         <summary>
 159           <attribution license="cc4" from="Microsoft" modified="false" />
 160           <para>Gets the current state of the <see cref="T:System.Windows.Forms.TreeNode" /> to draw.</para>
 161         </summary>
 162       </Docs>
 163       <AssemblyInfo>
 164         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 165       </AssemblyInfo>
 166     </Member>
 167   </Members>
 168 </Type>