180 lines
8.0 KiB
XML
180 lines
8.0 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<Type Name="FlowLayoutSettings" FullName="System.Windows.Forms.FlowLayoutSettings">
|
||
|
|
<TypeSignature Language="C#" Value="public class FlowLayoutSettings : System.Windows.Forms.LayoutSettings" />
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyName>System.Windows.Forms</AssemblyName>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<Base>
|
||
|
|
<BaseTypeName>System.Windows.Forms.LayoutSettings</BaseTypeName>
|
||
|
|
</Base>
|
||
|
|
<Interfaces />
|
||
|
|
<Attributes>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.ComponentModel.DefaultProperty("FlowDirection")</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
</Attributes>
|
||
|
|
<Docs>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="T:System.Windows.Forms.FlowLayoutSettings" /> class collects and manages the characteristics associated with the flow layout scheme. This class is used internally by the <see cref="T:System.Windows.Forms.FlowLayoutPanel" /> and <see cref="T:System.Windows.Forms.ToolStrip" /> classes, as well as the flow layout engine. The <see cref="T:System.Windows.Forms.FlowLayoutSettings" /> class is used by the layout engine to determine how to layout the container's child controls.</para>
|
||
|
|
<para>The <see cref="T:System.Windows.Forms.FlowLayoutSettings" /> class manages the following information:</para>
|
||
|
|
<list type="bullet">
|
||
|
|
<item>
|
||
|
|
<para>The flow direction of consecutive controls.</para>
|
||
|
|
</item>
|
||
|
|
<item>
|
||
|
|
<para>Whether the contents should be wrapped or clipped if the child controls cannot be contained within their parent.</para>
|
||
|
|
</item>
|
||
|
|
</list>
|
||
|
|
<para>
|
||
|
|
<see cref="T:System.Windows.Forms.FlowLayoutSettings" /> does not have a public constructor.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Collects the characteristics associated with flow layouts.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<Members>
|
||
|
|
<Member MemberName="FlowDirection">
|
||
|
|
<MemberSignature Language="C#" Value="public System.Windows.Forms.FlowDirection FlowDirection { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<Attributes>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.ComponentModel.DefaultValue(System.Windows.Forms.FlowDirection.LeftToRight)</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
</Attributes>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Windows.Forms.FlowDirection</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>
|
||
|
|
<see cref="P:System.Windows.Forms.FlowLayoutSettings.FlowDirection" /> is the default property for the <see cref="T:System.Windows.Forms.FlowLayoutSettings" /> class.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets a value indicating the flow direction of consecutive controls.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="GetFlowBreak">
|
||
|
|
<MemberSignature Language="C#" Value="public bool GetFlowBreak (object child);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="child" Type="System.Object" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Returns a value that represents the flow break setting of the control.</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>true if the flow break is set; otherwise, false.</para>
|
||
|
|
</returns>
|
||
|
|
<param name="child">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The child control.</param>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="LayoutEngine">
|
||
|
|
<MemberSignature Language="C#" Value="public override System.Windows.Forms.Layout.LayoutEngine LayoutEngine { get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Windows.Forms.Layout.LayoutEngine</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="P:System.Windows.Forms.TableLayoutSettings.LayoutEngine" /> property is typically used in two contexts:</para>
|
||
|
|
<list type="bullet">
|
||
|
|
<item>
|
||
|
|
<para>A container that uses a flow layout.</para>
|
||
|
|
</item>
|
||
|
|
<item>
|
||
|
|
<para>A control contained within a flow layout container (for example, a button contained in a cell of a <see cref="T:System.Windows.Forms.FlowLayoutPanel" />).</para>
|
||
|
|
</item>
|
||
|
|
</list>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets the current flow layout engine.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="SetFlowBreak">
|
||
|
|
<MemberSignature Language="C#" Value="public void SetFlowBreak (object child, bool value);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Void</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="child" Type="System.Object" />
|
||
|
|
<Parameter Name="value" Type="System.Boolean" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Sets the value that represents the flow break setting of the control.</para>
|
||
|
|
</summary>
|
||
|
|
<param name="child">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The child control.</param>
|
||
|
|
<param name="value">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The flow break value to set.</param>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="WrapContents">
|
||
|
|
<MemberSignature Language="C#" Value="public bool WrapContents { set; get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<Attributes>
|
||
|
|
<Attribute>
|
||
|
|
<AttributeName>System.ComponentModel.DefaultValue(true)</AttributeName>
|
||
|
|
</Attribute>
|
||
|
|
</Attributes>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<since version=".NET 2.0" />
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>If the area of the container is too small to display all the child controls, then at least one control will be clipped regardless of the <see cref="P:System.Windows.Forms.FlowLayoutSettings.WrapContents" /> value. </para>
|
||
|
|
<para>Subsequent resizing of the container will reapply the layout to the contained controls.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets a value indicating whether the contents should be wrapped or clipped when they exceed the original boundaries of their container.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
</Member>
|
||
|
|
</Members>
|
||
|
|
</Type>
|