-
Notifications
You must be signed in to change notification settings - Fork 6
/
PackageVersionHelper.xml
111 lines (111 loc) · 7.18 KB
/
PackageVersionHelper.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<Type Name="PackageVersionHelper" FullName="Microsoft.Toolkit.Uwp.Helpers.PackageVersionHelper">
<TypeSignature Language="C#" Value="public static class PackageVersionHelper" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit PackageVersionHelper extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Toolkit.Uwp.Helpers.PackageVersionHelper" />
<TypeSignature Language="VB.NET" Value="Public Module PackageVersionHelper" />
<TypeSignature Language="F#" Value="type PackageVersionHelper = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>6.1.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
This class provides static helper methods for <see cref="T:Windows.ApplicationModel.PackageVersion" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ToFormattedString">
<MemberSignature Language="C#" Value="public static string ToFormattedString (this Windows.ApplicationModel.PackageVersion packageVersion);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig string ToFormattedString(valuetype Windows.ApplicationModel.PackageVersion packageVersion) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Toolkit.Uwp.Helpers.PackageVersionHelper.ToFormattedString(Windows.ApplicationModel.PackageVersion)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ToFormattedString (packageVersion As PackageVersion) As String" />
<MemberSignature Language="F#" Value="static member ToFormattedString : Windows.ApplicationModel.PackageVersion -> string" Usage="Microsoft.Toolkit.Uwp.Helpers.PackageVersionHelper.ToFormattedString packageVersion" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>6.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="packageVersion" Type="Windows.ApplicationModel.PackageVersion" Index="0" FrameworkAlternate="win-comm-toolkit-dotnet-6.1" RefType="this" />
</Parameters>
<Docs>
<param name="packageVersion">The <see cref="T:Windows.ApplicationModel.PackageVersion" /> to convert to a string</param>
<summary>
Returns a string representation of a version with the format 'Major.Minor.Build.Revision'.
</summary>
<returns>Version string of the format 'Major.Minor.Build.Revision'</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToFormattedString">
<MemberSignature Language="C#" Value="public static string ToFormattedString (this Windows.ApplicationModel.PackageVersion packageVersion, int significance = 4);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig string ToFormattedString(valuetype Windows.ApplicationModel.PackageVersion packageVersion, int32 significance) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Toolkit.Uwp.Helpers.PackageVersionHelper.ToFormattedString(Windows.ApplicationModel.PackageVersion,System.Int32)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ToFormattedString (packageVersion As PackageVersion, Optional significance As Integer = 4) As String" />
<MemberSignature Language="F#" Value="static member ToFormattedString : Windows.ApplicationModel.PackageVersion * int -> string" Usage="Microsoft.Toolkit.Uwp.Helpers.PackageVersionHelper.ToFormattedString (packageVersion, significance)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="packageVersion" Type="Windows.ApplicationModel.PackageVersion" RefType="this" Index="0" FrameworkAlternate="win-comm-toolkit-dotnet-7.0;win-comm-toolkit-dotnet-7.1" />
<Parameter Name="significance" Type="System.Int32" Index="1" FrameworkAlternate="win-comm-toolkit-dotnet-7.0;win-comm-toolkit-dotnet-7.1" />
</Parameters>
<Docs>
<param name="packageVersion">The <see cref="T:Windows.ApplicationModel.PackageVersion" /> to convert to a string</param>
<param name="significance">The number of version numbers to return, default is 4 for the full version number.</param>
<summary>
Returns a string representation of a version with the format 'Major.Minor.Build.Revision'.
</summary>
<returns>Version string of the format 'Major.Minor.Build.Revision'</returns>
<remarks>To be added.</remarks>
<example>
Package.Current.Id.Version.ToFormattedString(2); // Returns "7.0" for instance.
</example>
</Docs>
</Member>
<Member MemberName="ToPackageVersion">
<MemberSignature Language="C#" Value="public static Windows.ApplicationModel.PackageVersion ToPackageVersion (this string formattedVersionNumber);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Windows.ApplicationModel.PackageVersion ToPackageVersion(string formattedVersionNumber) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Toolkit.Uwp.Helpers.PackageVersionHelper.ToPackageVersion(System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function ToPackageVersion (formattedVersionNumber As String) As PackageVersion" />
<MemberSignature Language="F#" Value="static member ToPackageVersion : string -> Windows.ApplicationModel.PackageVersion" Usage="Microsoft.Toolkit.Uwp.Helpers.PackageVersionHelper.ToPackageVersion formattedVersionNumber" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Toolkit.Uwp</AssemblyName>
<AssemblyVersion>6.1.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Windows.ApplicationModel.PackageVersion</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="formattedVersionNumber" Type="System.String" RefType="this" />
</Parameters>
<Docs>
<param name="formattedVersionNumber">Version string of the format 'Major.Minor.Build.Revision'</param>
<summary>
Converts a string representation of a version number to an equivalent <see cref="T:Windows.ApplicationModel.PackageVersion" />.
</summary>
<returns>The parsed <see cref="T:Windows.ApplicationModel.PackageVersion" /></returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>