245 lines
15 KiB
XML
245 lines
15 KiB
XML
|
<?xml version="1.0" encoding="utf-8"?>
|
||
|
|
<Type Name="ImageKeyConverter" FullName="System.Windows.Forms.ImageKeyConverter">
|
||
|
|
<TypeSignature Language="C#" Value="public class ImageKeyConverter : System.ComponentModel.StringConverter" />
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyName>System.Windows.Forms</AssemblyName>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<Base>
|
||
|
|
<BaseTypeName>System.ComponentModel.StringConverter</BaseTypeName>
|
||
|
|
</Base>
|
||
|
|
<Interfaces />
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>The <see cref="T:System.Windows.Forms.ImageKeyConverter" /> class is used to convert key values of an <see cref="T:System.Windows.Forms.ImageList" /> to and from other data types. For more information about type converters, see the <see cref="T:System.ComponentModel.TypeConverter" /> base class and <format type="text/html"><a href="90373a3f-d8c8-492d-841c-945d62393c56">How to: Implement a Type Converter</a></format>.</para>
|
||
|
|
<block subset="none" type="note">
|
||
|
|
<para>Typically, you do not directly create an instance of an <see cref="T:System.Windows.Forms.ImageKeyConverter" />. Instead, call the <see cref="M:System.ComponentModel.TypeDescriptor.GetConverter(System.Object)" /> method of the <see cref="T:System.ComponentModel.TypeDescriptor" /> class. For more information, see the examples in the <see cref="T:System.ComponentModel.TypeConverter" /> base class.</para>
|
||
|
|
</block>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Provides a type converter to convert data for an image key to and from another data type.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
<Members>
|
||
|
|
<Member MemberName=".ctor">
|
||
|
|
<MemberSignature Language="C#" Value="public ImageKeyConverter ();" />
|
||
|
|
<MemberType>Constructor</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<Parameters />
|
||
|
|
<Docs>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Initializes a new instance of the <see cref="T:System.Windows.Forms.ImageKeyConverter" /> class. </para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="CanConvertFrom">
|
||
|
|
<MemberSignature Language="C#" Value="public override bool CanConvertFrom (System.ComponentModel.ITypeDescriptorContext context, Type sourceType);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
|
||
|
|
<Parameter Name="sourceType" Type="System.Type" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Returns whether this converter can convert an object of the given type to a string using the specified context.</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>true to indicate the specified conversion can be performed; otherwise, false. </para>
|
||
|
|
</returns>
|
||
|
|
<param name="context">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context.</param>
|
||
|
|
<param name="sourceType">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Type" /> that specifies the type you want to convert from.</param>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="ConvertFrom">
|
||
|
|
<MemberSignature Language="C#" Value="public override object ConvertFrom (System.ComponentModel.ITypeDescriptorContext context, System.Globalization.CultureInfo culture, object value);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Object</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
|
||
|
|
<Parameter Name="culture" Type="System.Globalization.CultureInfo" />
|
||
|
|
<Parameter Name="value" Type="System.Object" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Converts from the specified object to a string.</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>An <see cref="T:System.Object" /> that represents the converted value.</para>
|
||
|
|
</returns>
|
||
|
|
<param name="context">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context. </param>
|
||
|
|
<param name="culture">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Globalization.CultureInfo" /> to provide locale information. </param>
|
||
|
|
<param name="value">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Object" /> to convert. </param>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="ConvertTo">
|
||
|
|
<MemberSignature Language="C#" Value="public override object ConvertTo (System.ComponentModel.ITypeDescriptorContext context, System.Globalization.CultureInfo culture, object value, Type destinationType);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Object</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
|
||
|
|
<Parameter Name="culture" Type="System.Globalization.CultureInfo" />
|
||
|
|
<Parameter Name="value" Type="System.Object" />
|
||
|
|
<Parameter Name="destinationType" Type="System.Type" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Converts the given object to the specified type.</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>An <see cref="T:System.Object" /> that represents the converted <paramref name="value" />.</para>
|
||
|
|
</returns>
|
||
|
|
<param name="context">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context, which can be used to extract additional information about the environment this type converter is being invoked from. This parameter or properties of this parameter can be null. </param>
|
||
|
|
<param name="culture">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Globalization.CultureInfo" /> that provides locale information. </param>
|
||
|
|
<param name="value">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The object to convert, typically an image key.</param>
|
||
|
|
<param name="destinationType">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The type to convert the object to.</param>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="GetStandardValues">
|
||
|
|
<MemberSignature Language="C#" Value="public override System.ComponentModel.TypeConverter.StandardValuesCollection GetStandardValues (System.ComponentModel.ITypeDescriptorContext context);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.ComponentModel.TypeConverter+StandardValuesCollection</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>If no image list is found, and the <see cref="T:System.Windows.Forms.ImageKeyConverter" /> supports null as a standard value, the <see cref="M:System.Windows.Forms.ImageKeyConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> method returns a collection containing a single empty string. If no image list is found, and null is not supported as a standard value, <see cref="M:System.Windows.Forms.ImageKeyConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)" /> returns an empty collection.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Returns a collection of standard image keys for the image list associated with the specified context. </para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>A <see cref="T:System.ComponentModel.TypeConverter.StandardValuesCollection" /> that contains the standard set of image key values. </para>
|
||
|
|
</returns>
|
||
|
|
<param name="context">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context, which can be used to extract additional information about the environment this type converter is being invoked from. This parameter or properties of this parameter can be null.</param>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="GetStandardValuesExclusive">
|
||
|
|
<MemberSignature Language="C#" Value="public override bool GetStandardValuesExclusive (System.ComponentModel.ITypeDescriptorContext context);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>If the list returned by the <see cref="Overload:System.Windows.Forms.ImageKeyConverter.GetStandardValues" /> method is exclusive, no other values are valid. This is typical of an enumerated data type. If the list is not exclusive, there are other valid values besides the list of standard values that <see cref="Overload:System.Windows.Forms.ImageIndexConverter.GetStandardValues" /> provides.</para>
|
||
|
|
<para>As implemented in this type converter, this method always returns true. </para>
|
||
|
|
<para>Typically, you should call the <see cref="Overload:System.Windows.Forms.ImageKeyConverter.GetStandardValuesSupported" /> method before you attempt to use the <see cref="Overload:System.Windows.Forms.ImageKeyConverter.GetStandardValues" /> and <see cref="Overload:System.Windows.Forms.ImageKeyConverter.GetStandardValuesExclusive" /> methods. </para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Determines whether the list of standard values for the <see cref="T:System.Windows.Forms.ImageKeyConverter" /> is exclusive (that is, whether it allows values other than those returned by <see cref="Overload:System.Windows.Forms.ImageKeyConverter.GetStandardValues" />).</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>true to indicate the list does not allow additional values; otherwise, false. Always returns true. </para>
|
||
|
|
</returns>
|
||
|
|
<param name="context">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context, which can be used to extract additional information about the environment this type converter is being invoked from. This parameter or properties of this parameter can be null.</param>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="GetStandardValuesSupported">
|
||
|
|
<MemberSignature Language="C#" Value="public override bool GetStandardValuesSupported (System.ComponentModel.ITypeDescriptorContext context);" />
|
||
|
|
<MemberType>Method</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Parameters>
|
||
|
|
<Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
|
||
|
|
</Parameters>
|
||
|
|
<Docs>
|
||
|
|
<remarks>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>As implemented in the <see cref="T:System.Windows.Forms.ImageKeyConverter" /> class, the <see cref="M:System.Windows.Forms.ImageKeyConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)" /> method always returns true since <see cref="T:System.Windows.Forms.ImageKeyConverter" /> supports a standard set of index values for images that can be picked from a list.</para>
|
||
|
|
</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Determines whether this type converter supports a standard set of values that can be picked from a list.</para>
|
||
|
|
</summary>
|
||
|
|
<returns>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>true to indicate a list of standard values is supported; otherwise, false. Always returns true.</para>
|
||
|
|
</returns>
|
||
|
|
<param name="context">
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context, which can be used to extract additional information about the environment this type converter is being invoked from. This parameter or properties of this parameter can be null.</param>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
<Member MemberName="IncludeNoneAsStandardValue">
|
||
|
|
<MemberSignature Language="C#" Value="protected virtual bool IncludeNoneAsStandardValue { get; }" />
|
||
|
|
<MemberType>Property</MemberType>
|
||
|
|
<AssemblyInfo>
|
||
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
|
|
</AssemblyInfo>
|
||
|
|
<ReturnValue>
|
||
|
|
<ReturnType>System.Boolean</ReturnType>
|
||
|
|
</ReturnValue>
|
||
|
|
<Docs>
|
||
|
|
<value>To be added.</value>
|
||
|
|
<remarks>To be added.</remarks>
|
||
|
|
<summary>
|
||
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
|
|
<para>Gets or sets a value indicating whether null is valid in the <see cref="T:System.ComponentModel.TypeConverter.StandardValuesCollection" /> collection.</para>
|
||
|
|
</summary>
|
||
|
|
</Docs>
|
||
|
|
</Member>
|
||
|
|
</Members>
|
||
|
|
</Type>
|