-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
GifBitmapDecoder.xml
143 lines (134 loc) · 11 KB
/
GifBitmapDecoder.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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
<Type Name="GifBitmapDecoder" FullName="System.Windows.Media.Imaging.GifBitmapDecoder">
<TypeSignature Language="C#" Value="public sealed class GifBitmapDecoder : System.Windows.Media.Imaging.BitmapDecoder" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit GifBitmapDecoder extends System.Windows.Media.Imaging.BitmapDecoder" />
<TypeSignature Language="DocId" Value="T:System.Windows.Media.Imaging.GifBitmapDecoder" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class GifBitmapDecoder
Inherits BitmapDecoder" />
<TypeSignature Language="F#" Value="type GifBitmapDecoder = class
 inherit BitmapDecoder" />
<TypeSignature Language="C++ CLI" Value="public ref class GifBitmapDecoder sealed : System::Windows::Media::Imaging::BitmapDecoder" />
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Windows.Media.Imaging.BitmapDecoder</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Defines a decoder for Graphics Interchange Format (GIF) encoded images.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of <see cref="T:System.Windows.Media.Imaging.GifBitmapDecoder" />.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GifBitmapDecoder (System.IO.Stream bitmapStream, System.Windows.Media.Imaging.BitmapCreateOptions createOptions, System.Windows.Media.Imaging.BitmapCacheOption cacheOption);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream bitmapStream, valuetype System.Windows.Media.Imaging.BitmapCreateOptions createOptions, valuetype System.Windows.Media.Imaging.BitmapCacheOption cacheOption) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.GifBitmapDecoder.#ctor(System.IO.Stream,System.Windows.Media.Imaging.BitmapCreateOptions,System.Windows.Media.Imaging.BitmapCacheOption)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (bitmapStream As Stream, createOptions As BitmapCreateOptions, cacheOption As BitmapCacheOption)" />
<MemberSignature Language="F#" Value="new System.Windows.Media.Imaging.GifBitmapDecoder : System.IO.Stream * System.Windows.Media.Imaging.BitmapCreateOptions * System.Windows.Media.Imaging.BitmapCacheOption -> System.Windows.Media.Imaging.GifBitmapDecoder" Usage="new System.Windows.Media.Imaging.GifBitmapDecoder (bitmapStream, createOptions, cacheOption)" />
<MemberSignature Language="C++ CLI" Value="public:
 GifBitmapDecoder(System::IO::Stream ^ bitmapStream, System::Windows::Media::Imaging::BitmapCreateOptions createOptions, System::Windows::Media::Imaging::BitmapCacheOption cacheOption);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="bitmapStream" Type="System.IO.Stream" />
<Parameter Name="createOptions" Type="System.Windows.Media.Imaging.BitmapCreateOptions" />
<Parameter Name="cacheOption" Type="System.Windows.Media.Imaging.BitmapCacheOption" />
</Parameters>
<Docs>
<param name="bitmapStream">Bitmap stream to decode.</param>
<param name="createOptions">Initialization options for the bitmap image.</param>
<param name="cacheOption">The cache method to use for the bitmap image.</param>
<summary>Initializes a new instance of <see cref="T:System.Windows.Media.Imaging.GifBitmapDecoder" /> from the specified file stream with the specified <paramref name="createOptions" /> and <paramref name="cacheOption" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Windows.Media.Imaging.BitmapCacheOption.OnLoad> cache option if you wish to close the `bitmapStream` after the decoder is created. The default <xref:System.Windows.Media.Imaging.BitmapCacheOption.OnDemand> cache option retains access to the stream until the bitmap is needed and cleanup is handled by the garbage collector.
## Examples
The following code example demonstrates how to create an instance of and use a <xref:System.Windows.Media.Imaging.GifBitmapDecoder> from a file stream. The decoded image is used as the source of an <xref:System.Windows.Controls.Image> control.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/GifBitmapDecoderEncoder/CPP/GifEncoderDecoder.cpp" id="Snippet1":::
:::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/GifBitmapDecoder/.ctor/GifEncoderDecoder.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/GifBitmapDecoderEncoder/VB/GifEncoderDecoder.vb" id="Snippet1":::
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="bitmapStream" /> value is <see langword="null" />.</exception>
<exception cref="T:System.IO.FileFormatException">The <paramref name="bitmapStream" /> is not a Graphics Interchange Format (GIF) encoded image.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GifBitmapDecoder (Uri bitmapUri, System.Windows.Media.Imaging.BitmapCreateOptions createOptions, System.Windows.Media.Imaging.BitmapCacheOption cacheOption);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri bitmapUri, valuetype System.Windows.Media.Imaging.BitmapCreateOptions createOptions, valuetype System.Windows.Media.Imaging.BitmapCacheOption cacheOption) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Imaging.GifBitmapDecoder.#ctor(System.Uri,System.Windows.Media.Imaging.BitmapCreateOptions,System.Windows.Media.Imaging.BitmapCacheOption)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (bitmapUri As Uri, createOptions As BitmapCreateOptions, cacheOption As BitmapCacheOption)" />
<MemberSignature Language="F#" Value="new System.Windows.Media.Imaging.GifBitmapDecoder : Uri * System.Windows.Media.Imaging.BitmapCreateOptions * System.Windows.Media.Imaging.BitmapCacheOption -> System.Windows.Media.Imaging.GifBitmapDecoder" Usage="new System.Windows.Media.Imaging.GifBitmapDecoder (bitmapUri, createOptions, cacheOption)" />
<MemberSignature Language="C++ CLI" Value="public:
 GifBitmapDecoder(Uri ^ bitmapUri, System::Windows::Media::Imaging::BitmapCreateOptions createOptions, System::Windows::Media::Imaging::BitmapCacheOption cacheOption);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecurityCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecurityCritical>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="bitmapUri" Type="System.Uri" />
<Parameter Name="createOptions" Type="System.Windows.Media.Imaging.BitmapCreateOptions" />
<Parameter Name="cacheOption" Type="System.Windows.Media.Imaging.BitmapCacheOption" />
</Parameters>
<Docs>
<param name="bitmapUri">
<see cref="T:System.Uri" /> that identifies the bitmap to decode.</param>
<param name="createOptions">Initialization options for the bitmap image.</param>
<param name="cacheOption">The cache method to use for the bitmap image.</param>
<summary>Initializes a new instance of <see cref="T:System.Windows.Media.Imaging.GifBitmapDecoder" /> from the specified <see cref="T:System.Uri" /> with the specified <paramref name="createOptions" /> and <paramref name="cacheOption" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates how to create an instance of and use a <xref:System.Windows.Media.Imaging.GifBitmapDecoder> from a <xref:System.Uri>. The decoded image is used as the source of an <xref:System.Windows.Controls.Image> control.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Wpf/GifBitmapDecoderEncoder/CPP/GifEncoderDecoder.cpp" id="Snippet5":::
:::code language="csharp" source="~/snippets/csharp/System.Windows.Media.Imaging/GifBitmapDecoder/.ctor/GifEncoderDecoder.cs" id="Snippet5":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/GifBitmapDecoderEncoder/VB/GifEncoderDecoder.vb" id="Snippet5":::
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="bitmapUri" /> value is <see langword="null" />.</exception>
<exception cref="T:System.IO.FileFormatException">The <paramref name="bitmapUri" /> is not a Graphics Interchange Format (GIF) encoded image.</exception>
</Docs>
</Member>
</Members>
</Type>