Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
428 lines (402 sloc) 23.6 KB
<Type Name="Size" FullName="Windows.Foundation.Size">
<TypeSignature Language="C#" Value="public struct Size" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit Size extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:Windows.Foundation.Size" />
<TypeSignature Language="VB.NET" Value="Public Structure Size" />
<TypeSignature Language="C++ CLI" Value="public value class Size" />
<TypeSignature Language="F#" Value="type Size = struct" />
<AssemblyInfo>
<AssemblyName>System.Runtime.WindowsRuntime</AssemblyName>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.14.0</AssemblyVersion>
<AssemblyVersion>4.0.15.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="dotnet-uwp-10.0">
<AttributeName>System.Security.SecurityCritical</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Describes the width and height of an object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This struct represents the .NET projection of the Windows Runtime (WinRT) `Size` struct. For more information, see [Size](https://docs.microsoft.com/uwp/api/windows.foundation.size) in the UWP API reference.
]]></format>
</remarks>
<related type="Article" href="https://docs.microsoft.com/uwp/api/windows.foundation.size">Size (UWP)</related>
<related type="Article" href="https://docs.microsoft.com/dotnet/api/system.windows.size">System.Windows.Size (.NET)</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Size (double width, double height);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(float64 width, float64 height) cil managed" />
<MemberSignature Language="DocId" Value="M:Windows.Foundation.Size.#ctor(System.Double,System.Double)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (width As Double, height As Double)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; Size(double width, double height);" />
<MemberSignature Language="F#" Value="new Windows.Foundation.Size : double * double -&gt; Windows.Foundation.Size" Usage="new Windows.Foundation.Size (width, height)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.WindowsRuntime</AssemblyName>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.14.0</AssemblyVersion>
<AssemblyVersion>4.0.15.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="width" Type="System.Double" />
<Parameter Name="height" Type="System.Double" />
</Parameters>
<Docs>
<param name="width">The initial width of the instance of <see cref="T:Windows.Foundation.Size" />.</param>
<param name="height">The initial height of the instance of <see cref="T:Windows.Foundation.Size" />.</param>
<summary>Initializes a new instance of the <see cref="T:Windows.Foundation.Size" /> struct and assigns it an initial width and height.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This struct represents the .NET projection of the Windows Runtime (WinRT) `Size` struct. For more information, see [Size](https://docs.microsoft.com/uwp/api/windows.foundation.size) in the UWP API reference.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="width" /> or <paramref name="height" /> are less than 0.</exception>
</Docs>
</Member>
<Member MemberName="Empty">
<MemberSignature Language="C#" Value="public static Windows.Foundation.Size Empty { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype Windows.Foundation.Size Empty" />
<MemberSignature Language="DocId" Value="P:Windows.Foundation.Size.Empty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Property Empty As Size" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static property Windows::Foundation::Size Empty { Windows::Foundation::Size get(); };" />
<MemberSignature Language="F#" Value="member this.Empty : Windows.Foundation.Size" Usage="Windows.Foundation.Size.Empty" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.WindowsRuntime</AssemblyName>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.14.0</AssemblyVersion>
<AssemblyVersion>4.0.15.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Windows.Foundation.Size</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that represents an empty <see cref="T:Windows.Foundation.Size" />.</summary>
<value>An empty instance of <see cref="T:Windows.Foundation.Size" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This struct represents the .NET projection of the Windows Runtime (WinRT) `Size` struct. For more information, see [Size](https://docs.microsoft.com/uwp/api/windows.foundation.size) in the UWP API reference.
For more information about this member, see <xref:System.Windows.Size.Empty?displayProperty=nameWithType> in the .NET Framework API reference.
]]></format>
</remarks>
</Docs>
</Member>
<MemberGroup MemberName="Equals">
<AssemblyInfo>
<AssemblyName>System.Runtime.WindowsRuntime</AssemblyName>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.14.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>To be added.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This struct represents the .NET projection of the Windows Runtime (WinRT) `Size` struct. For more information, see [Size](https://docs.microsoft.com/uwp/api/windows.foundation.size) in the UWP API reference.
For more information about this member, see <xref:System.Windows.Size.Equals%2A?displayProperty=nameWithType> in the .NET Framework API reference.
]]></format>
</remarks>
</Docs>
</MemberGroup>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object o);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object o) cil managed" />
<MemberSignature Language="DocId" Value="M:Windows.Foundation.Size.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (o As Object) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override bool Equals(System::Object ^ o);" />
<MemberSignature Language="F#" Value="override this.Equals : obj -&gt; bool" Usage="size.Equals o" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.WindowsRuntime</AssemblyName>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.14.0</AssemblyVersion>
<AssemblyVersion>4.0.15.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="dotnet-uwp-10.0">
<AttributeName>System.Security.SecuritySafeCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="o" Type="System.Object" />
</Parameters>
<Docs>
<param name="o">The object to compare.</param>
<summary>Compares an object to an instance of <see cref="T:Windows.Foundation.Size" /> for equality.</summary>
<returns>
<see langword="true" /> if <paramref name="o" /> is a <see cref="T:Windows.Foundation.Size" /> value and the sizes of the two objects are equal; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (Windows.Foundation.Size value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Equals(valuetype Windows.Foundation.Size value) cil managed" />
<MemberSignature Language="DocId" Value="M:Windows.Foundation.Size.Equals(Windows.Foundation.Size)" />
<MemberSignature Language="VB.NET" Value="Public Function Equals (value As Size) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; bool Equals(Windows::Foundation::Size value);" />
<MemberSignature Language="F#" Value="override this.Equals : Windows.Foundation.Size -&gt; bool" Usage="size.Equals value" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.WindowsRuntime</AssemblyName>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.14.0</AssemblyVersion>
<AssemblyVersion>4.0.15.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Windows.Foundation.Size" />
</Parameters>
<Docs>
<param name="value">The size to compare to this current instance of <see cref="T:Windows.Foundation.Size" />.</param>
<summary>Compares a value to an instance of <see cref="T:Windows.Foundation.Size" /> for equality.</summary>
<returns>
<see langword="true" /> if the instances of <see cref="T:Windows.Foundation.Size" /> are equal; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:Windows.Foundation.Size.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override int GetHashCode();" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -&gt; int" Usage="size.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.WindowsRuntime</AssemblyName>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.14.0</AssemblyVersion>
<AssemblyVersion>4.0.15.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="dotnet-uwp-10.0">
<AttributeName>System.Security.SecuritySafeCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets the hash code for this instance of <see cref="T:Windows.Foundation.Size" />.</summary>
<returns>The hash code for this instance of <see cref="T:Windows.Foundation.Size" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This struct represents the .NET projection of the Windows Runtime (WinRT) `Size` struct. For more information, see [Size](https://docs.microsoft.com/uwp/api/windows.foundation.size) in the UWP API reference.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Height">
<MemberSignature Language="C#" Value="public double Height { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 Height" />
<MemberSignature Language="DocId" Value="P:Windows.Foundation.Size.Height" />
<MemberSignature Language="VB.NET" Value="Public Property Height As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property double Height { double get(); void set(double value); };" />
<MemberSignature Language="F#" Value="member this.Height : double with get, set" Usage="Windows.Foundation.Size.Height" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.WindowsRuntime</AssemblyName>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.14.0</AssemblyVersion>
<AssemblyVersion>4.0.15.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the height of this instance of <see cref="T:Windows.Foundation.Size" />.</summary>
<value>The <see cref="P:Windows.Foundation.Size.Height" /> of this instance of <see cref="T:Windows.Foundation.Size" />, in pixels. The default is 0. The value cannot be negative.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This struct represents the .NET projection of the Windows Runtime (WinRT) `Size` struct. For more information, see [Size](https://docs.microsoft.com/uwp/api/windows.foundation.size) in the UWP API reference.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">Specified a value less than 0.</exception>
</Docs>
</Member>
<Member MemberName="IsEmpty">
<MemberSignature Language="C#" Value="public bool IsEmpty { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsEmpty" />
<MemberSignature Language="DocId" Value="P:Windows.Foundation.Size.IsEmpty" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsEmpty As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool IsEmpty { bool get(); };" />
<MemberSignature Language="F#" Value="member this.IsEmpty : bool" Usage="Windows.Foundation.Size.IsEmpty" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.WindowsRuntime</AssemblyName>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.14.0</AssemblyVersion>
<AssemblyVersion>4.0.15.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether this instance of <see cref="T:Windows.Foundation.Size" /> is <see cref="P:Windows.Foundation.Size.Empty" />.</summary>
<value>
<see langword="true" /> if this instance of size is <see cref="P:Windows.Foundation.Size.Empty" />; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This struct represents the .NET projection of the Windows Runtime (WinRT) `Size` struct. For more information, see [Size](https://docs.microsoft.com/uwp/api/windows.foundation.size) in the UWP API reference.
For more information about this member, see <xref:System.Windows.Size.IsEmpty?displayProperty=nameWithType> in the .NET Framework API reference.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="op_Equality">
<MemberSignature Language="C#" Value="public static bool operator == (Windows.Foundation.Size size1, Windows.Foundation.Size size2);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype Windows.Foundation.Size size1, valuetype Windows.Foundation.Size size2) cil managed" />
<MemberSignature Language="DocId" Value="M:Windows.Foundation.Size.op_Equality(Windows.Foundation.Size,Windows.Foundation.Size)" />
<MemberSignature Language="VB.NET" Value="Public Shared Operator == (size1 As Size, size2 As Size) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static bool operator ==(Windows::Foundation::Size size1, Windows::Foundation::Size size2);" />
<MemberSignature Language="F#" Value="static member ( = ) : Windows.Foundation.Size * Windows.Foundation.Size -&gt; bool" Usage="size1 = size2" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.WindowsRuntime</AssemblyName>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.14.0</AssemblyVersion>
<AssemblyVersion>4.0.15.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="size1" Type="Windows.Foundation.Size" />
<Parameter Name="size2" Type="Windows.Foundation.Size" />
</Parameters>
<Docs>
<param name="size1">The first instance of <see cref="T:Windows.Foundation.Size" /> to compare.</param>
<param name="size2">The second instance of <see cref="T:Windows.Foundation.Size" /> to compare.</param>
<summary>Compares two instances of <see cref="T:Windows.Foundation.Size" /> for equality.</summary>
<returns>
<see langword="true" /> if the two instances of <see cref="T:Windows.Foundation.Size" /> are equal; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This struct represents the .NET projection of the Windows Runtime (WinRT) `Size` struct. For more information, see [Size](https://docs.microsoft.com/uwp/api/windows.foundation.size) in the UWP API reference.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="op_Inequality">
<MemberSignature Language="C#" Value="public static bool operator != (Windows.Foundation.Size size1, Windows.Foundation.Size size2);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype Windows.Foundation.Size size1, valuetype Windows.Foundation.Size size2) cil managed" />
<MemberSignature Language="DocId" Value="M:Windows.Foundation.Size.op_Inequality(Windows.Foundation.Size,Windows.Foundation.Size)" />
<MemberSignature Language="VB.NET" Value="Public Shared Operator != (size1 As Size, size2 As Size) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static bool operator !=(Windows::Foundation::Size size1, Windows::Foundation::Size size2);" />
<MemberSignature Language="F#" Value="static member op_Inequality : Windows.Foundation.Size * Windows.Foundation.Size -&gt; bool" Usage="Windows.Foundation.Size.op_Inequality (size1, size2)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.WindowsRuntime</AssemblyName>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.14.0</AssemblyVersion>
<AssemblyVersion>4.0.15.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="size1" Type="Windows.Foundation.Size" />
<Parameter Name="size2" Type="Windows.Foundation.Size" />
</Parameters>
<Docs>
<param name="size1">The first instance of <see cref="T:Windows.Foundation.Size" /> to compare.</param>
<param name="size2">The second instance of <see cref="T:Windows.Foundation.Size" /> to compare.</param>
<summary>Compares two instances of <see cref="T:Windows.Foundation.Size" /> for inequality.</summary>
<returns>
<see langword="true" /> if the instances of <see cref="T:Windows.Foundation.Size" /> are not equal; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This struct represents the .NET projection of the Windows Runtime (WinRT) `Size` struct. For more information, see [Size](https://docs.microsoft.com/uwp/api/windows.foundation.size) in the UWP API reference.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Windows.Foundation.Size.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override System::String ^ ToString();" />
<MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="size.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.WindowsRuntime</AssemblyName>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.14.0</AssemblyVersion>
<AssemblyVersion>4.0.15.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="dotnet-uwp-10.0">
<AttributeName>System.Security.SecuritySafeCritical</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a string representation of this <see cref="T:Windows.Foundation.Size" />.</summary>
<returns>A string representation of this <see cref="T:Windows.Foundation.Size" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This struct represents the .NET projection of the Windows Runtime (WinRT) `Size` struct. For more information, see [Size](https://docs.microsoft.com/uwp/api/windows.foundation.size) in the UWP API reference.
For more information about this member, see <xref:System.Windows.Size.ToString%2A?displayProperty=nameWithType> in the .NET Framework API reference.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public double Width { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance float64 Width" />
<MemberSignature Language="DocId" Value="P:Windows.Foundation.Size.Width" />
<MemberSignature Language="VB.NET" Value="Public Property Width As Double" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property double Width { double get(); void set(double value); };" />
<MemberSignature Language="F#" Value="member this.Width : double with get, set" Usage="Windows.Foundation.Size.Width" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Runtime.WindowsRuntime</AssemblyName>
<AssemblyVersion>4.0.10.0</AssemblyVersion>
<AssemblyVersion>4.0.14.0</AssemblyVersion>
<AssemblyVersion>4.0.15.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the width of this instance of <see cref="T:Windows.Foundation.Size" />.</summary>
<value>The <see cref="P:Windows.Foundation.Size.Width" /> of this instance of <see cref="T:Windows.Foundation.Size" />, in pixels. The default value is 0. The value cannot be negative.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This struct represents the .NET projection of the Windows Runtime (WinRT) `Size` struct. For more information, see [Size](https://docs.microsoft.com/uwp/api/windows.foundation.size) in the UWP API reference.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">Specified a value less than 0.</exception>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.