diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/ImageSource.xml')
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/ImageSource.xml | 382 |
1 files changed, 382 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/ImageSource.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/ImageSource.xml new file mode 100644 index 00000000..162b3a10 --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/ImageSource.xml @@ -0,0 +1,382 @@ +<Type Name="ImageSource" FullName="Xamarin.Forms.ImageSource"> + <TypeSignature Language="C#" Value="public abstract class ImageSource : Xamarin.Forms.Element" /> + <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ImageSource extends Xamarin.Forms.Element" /> + <AssemblyInfo> + <AssemblyName>Xamarin.Forms.Core</AssemblyName> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>Xamarin.Forms.Element</BaseTypeName> + </Base> + <Interfaces> + </Interfaces> + <Attributes> + <Attribute> + <AttributeName>Xamarin.Forms.TypeConverter(typeof(Xamarin.Forms.ImageSourceConverter))</AttributeName> + </Attribute> + </Attributes> + <Docs> + <summary>Abstract class whose implementors load images from files or the Web.</summary> + <remarks>To be added.</remarks> + </Docs> + <Members> + <Member MemberName="Cancel"> + <MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<bool> Cancel ();" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> Cancel() cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Threading.Tasks.Task<System.Boolean></ReturnType> + </ReturnValue> + <Parameters /> + <Docs> + <summary>Request a cancel of the ImageSource loading.</summary> + <returns>An awaitable Task. The result of the Task indicates if the Task was successfully cancelled.</returns> + <remarks>Calling Cancel() multiple times will throw an exception.</remarks> + </Docs> + </Member> + <Member MemberName="CancellationTokenSource"> + <MemberSignature Language="C#" Value="protected System.Threading.CancellationTokenSource CancellationTokenSource { get; }" /> + <MemberSignature Language="ILAsm" Value=".property instance class System.Threading.CancellationTokenSource CancellationTokenSource" /> + <MemberType>Property</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Threading.CancellationTokenSource</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets the CancellationTokenSource.</summary> + <value> + </value> + <remarks>Used by inheritors to implement cancellable loads.</remarks> + </Docs> + </Member> + <Member MemberName="FromFile"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.ImageSource FromFile (string file);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Xamarin.Forms.ImageSource FromFile(string file) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.ImageSource</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="file" Type="System.String" /> + </Parameters> + <Docs> + <param name="file">The name of a file that contains a valid image.</param> + <summary>Returns a new <see cref="T:Xamarin.Forms.FileImageSource" /> that reads from <paramref name="file" />.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="FromResource"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.ImageSource FromResource (string resource);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Xamarin.Forms.ImageSource FromResource(string resource) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.ImageSource</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="resource" Type="System.String" /> + </Parameters> + <Docs> + <param name="resource">A string representing the id of the EmbeddedResource to load.</param> + <summary>Creates an ImageSource for an EmbeddedResource included in the Assembly from which the call to FromResource is made.</summary> + <returns>A newly created ImageSource.</returns> + <remarks> + </remarks> + </Docs> + </Member> + <Member MemberName="FromResource"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.ImageSource FromResource (string resource, System.Reflection.Assembly sourceAssembly = null);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Xamarin.Forms.ImageSource FromResource(string resource, class System.Reflection.Assembly sourceAssembly) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.ImageSource</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="resource" Type="System.String" /> + <Parameter Name="sourceAssembly" Type="System.Reflection.Assembly" /> + </Parameters> + <Docs> + <param name="resource">The name of a valid image resource in <paramref name="sourceAssembly" />.</param> + <param name="sourceAssembly">The source assembly in which to search for the image.</param> + <summary>Creates a <see cref="T:Xamarin.Forms.ImageSource" /> from the specified resource in the specified source assembly.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="FromResource"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.ImageSource FromResource (string resource, Type resolvingType);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Xamarin.Forms.ImageSource FromResource(string resource, class System.Type resolvingType) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.ImageSource</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="resource" Type="System.String" /> + <Parameter Name="resolvingType" Type="System.Type" /> + </Parameters> + <Docs> + <param name="resource">The name of a valid image resource in the assembly to which <paramref name="resolvingType" /> belongs.</param> + <param name="resolvingType">A type from the assembly in which to look up the image resource with <paramref name="resource" />.</param> + <summary>Creates a <see cref="T:Xamarin.Forms.ImageSource" /> from the specified resource in the specified source assembly.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="FromStream"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.ImageSource FromStream (Func<System.IO.Stream> stream);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Xamarin.Forms.ImageSource FromStream(class System.Func`1<class System.IO.Stream> stream) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.ImageSource</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="stream" Type="System.Func<System.IO.Stream>" /> + </Parameters> + <Docs> + <param name="stream">A stream that supplies image data.</param> + <summary>Returns a new <see cref="T:Xamarin.Forms.StreamImageSource" /> that reads from <paramref name="stream" />.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="FromUri"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.ImageSource FromUri (Uri uri);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Xamarin.Forms.ImageSource FromUri(class System.Uri uri) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.ImageSource</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="uri" Type="System.Uri" /> + </Parameters> + <Docs> + <param name="uri">A URI that identifies a valid image.</param> + <summary>Returns a new <see cref="T:Xamarin.Forms.UriImageSource" /> that reads from <paramref name="uri" />.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="OnLoadingCompleted"> + <MemberSignature Language="C#" Value="protected void OnLoadingCompleted (bool cancelled);" /> + <MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void OnLoadingCompleted(bool cancelled) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="cancelled" Type="System.Boolean" /> + </Parameters> + <Docs> + <param name="cancelled">A bool indicating if the source was cancelled.</param> + <summary>Called by inheritors to indicate the end of the loading of the source.</summary> + <remarks>OnLoadingCompleted should follow a OnLoadingStarted.</remarks> + </Docs> + </Member> + <Member MemberName="OnLoadingStarted"> + <MemberSignature Language="C#" Value="protected void OnLoadingStarted ();" /> + <MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void OnLoadingStarted() cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters /> + <Docs> + <summary>Called by inheritors to indicate the beginning of a loading operation.</summary> + <remarks>OnLoadingCompleted should follow a OnLoadingStarted.</remarks> + </Docs> + </Member> + <Member MemberName="OnSourceChanged"> + <MemberSignature Language="C#" Value="protected void OnSourceChanged ();" /> + <MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void OnSourceChanged() cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Parameters /> + <Docs> + <summary>Called by inheritors to indicate that the source changed..</summary> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="op_Implicit"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.ImageSource op_Implicit (string source);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Xamarin.Forms.ImageSource op_Implicit(string source) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.ImageSource</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="source" Type="System.String" /> + </Parameters> + <Docs> + <param name="source">A string that represents an image location.</param> + <summary>Allows implicit casting from a string that represents an absolute URI.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="op_Implicit"> + <MemberSignature Language="C#" Value="public static Xamarin.Forms.ImageSource op_Implicit (Uri uri);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Xamarin.Forms.ImageSource op_Implicit(class System.Uri uri) cil managed" /> + <MemberType>Method</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + <AssemblyVersion>1.3.0.0</AssemblyVersion> + <AssemblyVersion>1.4.0.0</AssemblyVersion> + <AssemblyVersion>1.5.0.0</AssemblyVersion> + <AssemblyVersion>2.0.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.ImageSource</ReturnType> + </ReturnValue> + <Parameters> + <Parameter Name="uri" Type="System.Uri" /> + </Parameters> + <Docs> + <param name="uri">A absolute URI that specifies an image location.</param> + <summary>Allows implicit casting from <see cref="T:System.Uri" /> objects that were created with an absolute URI.</summary> + <returns>To be added.</returns> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Xamarin.Forms.IElement.Parent"> + <MemberSignature Language="C#" Value="Xamarin.Forms.Element Xamarin.Forms.IElement.Parent { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance class Xamarin.Forms.Element Xamarin.Forms.IElement.Parent" /> + <MemberType>Property</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>Xamarin.Forms.Element</ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets the element to which this <see cref="T:Xamarin.Forms.ImageSource" /> object belongs.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + <Member MemberName="Xamarin.Forms.IElement.XamlParent"> + <MemberSignature Language="C#" Value="WeakReference<Xamarin.Forms.Element> Xamarin.Forms.IElement.XamlParent { get; set; }" /> + <MemberSignature Language="ILAsm" Value=".property instance class System.WeakReference`1<class Xamarin.Forms.Element> Xamarin.Forms.IElement.XamlParent" /> + <MemberType>Property</MemberType> + <AssemblyInfo> + <AssemblyVersion>1.0.0.0</AssemblyVersion> + <AssemblyVersion>1.1.0.0</AssemblyVersion> + <AssemblyVersion>1.2.0.0</AssemblyVersion> + </AssemblyInfo> + <ReturnValue> + <ReturnType>System.WeakReference<Xamarin.Forms.Element></ReturnType> + </ReturnValue> + <Docs> + <summary>Gets or sets a weak reference to the parent of this <see cref="T:Xamarin.Forms.ImageSource" /> object.</summary> + <value>To be added.</value> + <remarks>To be added.</remarks> + </Docs> + </Member> + </Members> +</Type> |