gui-cs.Terminal.Gui/ecmadocs/en/Terminal.Gui/Dim.xml

<Type Name="Dim" FullName="Terminal.Gui.Dim">
  <TypeSignature Language="C#" Value="public class Dim" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Dim extends System.Object" />
  <AssemblyInfo>
    <AssemblyName>Terminal.Gui</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary />
    <remarks>
      <para>
                Use the Dim objects on the Width or Height properties of a view to control the position.
              </para>
      <para>
                These can be used to set the absolute position, when merely assigning an
                integer value (via the implicit integer to Pos conversion), and they can be combined
                to produce more useful layouts, like: Pos.Center - 3, which would shift the postion
                of the view 3 characters to the left after centering for example.
              </para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Dim ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Fill">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Dim Fill (int margin = 0);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Dim Fill(int32 margin) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Dim</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="margin" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="margin">Margin to use.</param>
        <summary>
            Creates a Dim object that fills the dimension, but leaves the specified number of colums for a margin.
            </summary>
        <returns>The Fill dimension.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Height">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Dim Height (Terminal.Gui.View view);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Dim Height(class Terminal.Gui.View view) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Dim</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="view" Type="Terminal.Gui.View" />
      </Parameters>
      <Docs>
        <param name="view">The view that will be tracked.</param>
        <summary>
            Returns a Dim object tracks the Height of the specified view.
            </summary>
        <returns>The dimension of the other view.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Addition">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Dim op_Addition (Terminal.Gui.Dim left, Terminal.Gui.Dim right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Terminal.Gui.Dim op_Addition(class Terminal.Gui.Dim left, class Terminal.Gui.Dim right) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Dim</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Terminal.Gui.Dim" />
        <Parameter Name="right" Type="Terminal.Gui.Dim" />
      </Parameters>
      <Docs>
        <param name="left">The first <see cref="T:Terminal.Gui.Pos" /> to add.</param>
        <param name="right">The second <see cref="T:Terminal.Gui.Pos" /> to add.</param>
        <summary>
            Adds a <see cref="T:Terminal.Gui.Pos" /> to a <see cref="T:Terminal.Gui.Pos" />, yielding a new <see cref="T:Terminal.Gui.Pos" />.
            </summary>
        <returns>The <see cref="T:Terminal.Gui.Pos" /> that is the sum of the values of <c>left</c> and <c>right</c>.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Implicit">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Dim op_Implicit (int n);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Terminal.Gui.Dim op_Implicit(int32 n) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Dim</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="n" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="n">The value to convert to the pos.</param>
        <summary>
            Creates an Absolute Pos from the specified integer value.
            </summary>
        <returns>The Absolute Pos.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Subtraction">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Dim op_Subtraction (Terminal.Gui.Dim left, Terminal.Gui.Dim right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Terminal.Gui.Dim op_Subtraction(class Terminal.Gui.Dim left, class Terminal.Gui.Dim right) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Dim</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Terminal.Gui.Dim" />
        <Parameter Name="right" Type="Terminal.Gui.Dim" />
      </Parameters>
      <Docs>
        <param name="left">The <see cref="T:Terminal.Gui.Pos" /> to subtract from (the minuend).</param>
        <param name="right">The <see cref="T:Terminal.Gui.Pos" /> to subtract (the subtrahend).</param>
        <summary>
            Subtracts a <see cref="T:Terminal.Gui.Pos" /> from a <see cref="T:Terminal.Gui.Pos" />, yielding a new <see cref="T:Terminal.Gui.Pos" />.
            </summary>
        <returns>The <see cref="T:Terminal.Gui.Pos" /> that is the <c>left</c> minus <c>right</c>.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Percent">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Dim Percent (float n);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Dim Percent(float32 n) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Dim</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="n" Type="System.Single" />
      </Parameters>
      <Docs>
        <param name="n">A value between 0 and 100 representing the percentage.</param>
        <summary>
            Creates a percentage Dim object
            </summary>
        <returns>The percent Dim object.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Sized">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Dim Sized (int n);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Dim Sized(int32 n) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Dim</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="n" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="n">The value to convert to the pos.</param>
        <summary>
            Creates an Absolute Pos from the specified integer value.
            </summary>
        <returns>The Absolute Pos.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Width">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Dim Width (Terminal.Gui.View view);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Dim Width(class Terminal.Gui.View view) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Dim</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="view" Type="Terminal.Gui.View" />
      </Parameters>
      <Docs>
        <param name="view">The view that will be tracked.</param>
        <summary>
            Returns a Dim object tracks the Width of the specified view.
            </summary>
        <returns>The dimension of the other view.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>