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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="DesignerActionPropertyItem" FullName="System.ComponentModel.Design.DesignerActionPropertyItem">
<TypeSignature Language="C#" Value="public sealed class DesignerActionPropertyItem : System.ComponentModel.Design.DesignerActionItem" />
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ComponentModel.Design.DesignerActionItem</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> class represents individual items in a smart tag panel. Each item is typically associated with a property in a class that is derived from the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class and supplied by the component author. The association is maintained through the name of the property, as stored in the <see cref="P:System.ComponentModel.Design.DesignerActionPropertyItem.MemberName" /> property. </para>
<para>Individual panel items are associated together to form a panel by a call to the <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method of the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class.</para>
<para>To display the value of the associated property, that property must have a get accessor method; to allow editing, the property must have a set accessor method. The way in which the panel allows direct editing of a property item by the user depends on the supporting type information present for the data type of the associated property. The following table shows the likely scheme.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Property type information</para>
</term>
<description>
<para>Property item editing user interface (UI)</para>
</description>
</item>
</listheader>
<item>
<term>
<para>Has an associated type editor (<see cref="T:System.Drawing.Design.UITypeEditor" />)</para>
</term>
<description>
<para>The type editor associated with the underlying property is displayed for editing the property's value.</para>
</description>
</item>
<item>
<term>
<para>Has an associated type converter to a known type (<see cref="T:System.ComponentModel.TypeConverter" />)</para>
</term>
<description>
<para>The type editor for the known type is displayed for editing the property's value. For example, a type converter to <see cref="T:System.String" /> will likely display a <see cref="T:System.Windows.Forms.TextBox" />.</para>
</description>
</item>
<item>
<term>
<para>Boolean value</para>
</term>
<description>
<para>The item is displayed using a binary UI, such as a check mark. </para>
</description>
</item>
<item>
<term>
<para>None of the above.</para>
</term>
<description>
<para>The item is displayed as a non-editable text string using the data type's <see cref="M:System.Object.ToString" /> method.</para>
</description>
</item>
</list>
<para>All fundamental types, such as <see cref="T:System.Boolean" />, and common dnprdnshort data types, such as <see cref="T:System.String" />, supply standard type converters and editors. For more information about type converters, see <format type="text/html"><a href="90373a3f-d8c8-492d-841c-945d62393c56">How to: Implement a Type Converter</a></format> or <format type="text/html"><a href="49253ae6-7657-4810-82ab-1176a6feeada">Generalized Type Conversion</a></format>. For more information about type editors, see <format type="text/html"><a href="ed961fb9-ee02-4666-b511-05f3204bb75c">How to: Implement a UI Type Editor</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents a panel item that is associated with a property in a class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" />. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DesignerActionPropertyItem (string memberName, string displayName);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="memberName" Type="System.String" />
<Parameter Name="displayName" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.ComponentModel.Design.DesignerActionPropertyItem.#ctor(System.String,System.String)" /> constructor sets the <see cref="P:System.ComponentModel.Design.DesignerActionItem.Category" /> and <see cref="P:System.ComponentModel.Design.DesignerActionItem.Description" /> properties to null.</para>
<para>The <paramref name="memberName" /> parameter refers to the name of the associated property that is a member of the programmer-supplied class derived from the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> class, with the specified property and display names.</para>
</summary>
<param name="memberName">
<attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive name of the property associated with this panel item.</param>
<param name="displayName">
<attribution license="cc4" from="Microsoft" modified="false" />The panel text for this item.</param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DesignerActionPropertyItem (string memberName, string displayName, string category);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="memberName" Type="System.String" />
<Parameter Name="displayName" Type="System.String" />
<Parameter Name="category" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.ComponentModel.Design.DesignerActionPropertyItem.#ctor(System.String,System.String,System.String)" /> constructor sets the <see cref="P:System.ComponentModel.Design.DesignerActionItem.Description" /> property to null.</para>
<para>For more information about how the <paramref name="category" /> parameter is used to group items on a panel, see the <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method.</para>
<para>The <paramref name="memberName" /> parameter refers to the name of the associated property that is a member of the programmer-supplied class derived from <see cref="T:System.ComponentModel.Design.DesignerActionList" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> class, with the specified property and category names, and display text.</para>
</summary>
<param name="memberName">
<attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive name of the property associated with this panel item.</param>
<param name="displayName">
<attribution license="cc4" from="Microsoft" modified="false" />The panel text for this item.</param>
<param name="category">
<attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive <see cref="T:System.String" /> used to group similar items on the panel.</param>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DesignerActionPropertyItem (string memberName, string displayName, string category, string description);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="memberName" Type="System.String" />
<Parameter Name="displayName" Type="System.String" />
<Parameter Name="category" Type="System.String" />
<Parameter Name="description" Type="System.String" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For more information about how the <paramref name="category" /> parameter is used to group items on a panel, see the <see cref="M:System.ComponentModel.Design.DesignerActionList.GetSortedActionItems" /> method.</para>
<para>The <paramref name="memberName" /> parameter refers to the name of the associated property that is a member of the programmer-supplied class derived from the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ComponentModel.Design.DesignerActionPropertyItem" /> class, with the specified property and category names, and display and description text.</para>
</summary>
<param name="memberName">
<attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive name of the property associated with this panel item.</param>
<param name="displayName">
<attribution license="cc4" from="Microsoft" modified="false" />The panel text for this item.</param>
<param name="category">
<attribution license="cc4" from="Microsoft" modified="false" />The case-sensitive <see cref="T:System.String" /> used to group similar items on the panel.</param>
<param name="description">
<attribution license="cc4" from="Microsoft" modified="false" />Supplemental text for this item, used in ToolTips or the status bar.</param>
</Docs>
</Member>
<Member MemberName="MemberName">
<MemberSignature Language="C#" Value="public string MemberName { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.ComponentModel.Design.DesignerActionPropertyItem.MemberName" /> property specifies which property—in the class derived from the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> class—the item should be bound to. When the programmer interacts with the panel item through the user interface (UI), this associated property will be set.</para>
<para>
<see cref="P:System.ComponentModel.Design.DesignerActionPropertyItem.MemberName" /> is set in the constructor. Its value is case-sensitive.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the name of the property that this item is associated with.</para>
</summary>
</Docs>
</Member>
<Member MemberName="RelatedComponent">
<MemberSignature Language="C#" Value="public System.ComponentModel.IComponent RelatedComponent { set; get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ComponentModel.IComponent</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>With the <see cref="P:System.ComponentModel.Design.DesignerActionPropertyItem.RelatedComponent" /> property, another component can lend its pull-model panel items to the current list. For example, a user control might aggregate the <see cref="T:System.ComponentModel.Design.DesignerActionItem" /> objects from one or more of its constituent controls.</para>
<para>This property works in conjunction with the <see cref="P:System.ComponentModel.Design.DesignerActionItem.AllowAssociate" /> property.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a component that contributes its items to the current panel.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>
|