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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="DesignerActionUIService" FullName="System.ComponentModel.Design.DesignerActionUIService">
<TypeSignature Language="C#" Value="public sealed class DesignerActionUIService : IDisposable" />
<AssemblyInfo>
<AssemblyName>System.Design</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>You can control the display of your designer's <see cref="P:System.ComponentModel.Design.ComponentDesigner.ActionLists" /> with the <see cref="T:System.ComponentModel.Design.DesignerActionUIService" /> class. <see cref="T:System.ComponentModel.Design.DesignerActionUIService" /> provides a straightforward interface for displaying the items for each component, including the following methods and events:</para>
<list type="bullet">
<item>
<para>The <see cref="M:System.ComponentModel.Design.DesignerActionUIService.ShowUI(System.ComponentModel.IComponent)" /> and <see cref="M:System.ComponentModel.Design.DesignerActionUIService.HideUI(System.ComponentModel.IComponent)" /> methods display and hide the items for a component.</para>
</item>
<item>
<para>The <see cref="E:System.ComponentModel.Design.DesignerActionUIService.DesignerActionUIStateChange" /> event indicates when the UI changes for a component.</para>
</item>
</list>
<para>Use the <see cref="T:System.ComponentModel.Design.DesignerActionService" /> to manage the <see cref="T:System.ComponentModel.Design.DesignerActionList" /> collections associated with your component. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Manages the user interface (UI) for a smart tag panel. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName="DesignerActionUIStateChange">
<MemberSignature Language="C#" Value="public event System.ComponentModel.Design.DesignerActionUIStateChangeEventHandler DesignerActionUIStateChange;" />
<MemberType>Event</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ComponentModel.Design.DesignerActionUIStateChangeEventHandler</ReturnType>
</ReturnValue>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The following table lists the set of specialized classes associated with the <see cref="E:System.ComponentModel.Design.DesignerActionUIService.DesignerActionUIStateChange" /> event.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Specialized type</para>
</term>
<description>
<para>Description</para>
</description>
</item>
</listheader>
<item>
<term>
<para>
<see cref="T:System.ComponentModel.Design.DesignerActionUIStateChangeEventArgs" /> </para>
</term>
<description>
<para>Adds information specific to smart tag panel management. This class is specialized from <see cref="T:System.EventArgs" />.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="T:System.ComponentModel.Design.DesignerActionUIStateChangeEventHandler" /> </para>
</term>
<description>
<para>Connects the <see cref="T:System.ComponentModel.Design.DesignerActionUIStateChangeEventArgs" /> with its handler.</para>
</description>
</item>
<item>
<term>
<para>
<see cref="T:System.ComponentModel.Design.DesignerActionUIStateChangeType" /> </para>
</term>
<description>
<para>Denotes whether the smart tag panel is being displayed or hidden.</para>
</description>
</item>
</list>
<para>For more information about handling events, see <format type="text/html"><a href="01e4f1bc-e55e-413f-98c7-6588493e5f67">Consuming Events</a></format>. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Occurs when a request is made to show or hide a smart tag panel.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Call <see cref="M:System.ComponentModel.Design.DesignerActionUIService.Dispose" /> when you are finished using the <see cref="T:System.ComponentModel.Design.DesignerActionUIService" />. The <see cref="M:System.ComponentModel.Design.DesignerActionUIService.Dispose" /> method leaves the <see cref="T:System.ComponentModel.Design.DesignerActionUIService" /> in an unusable state. After calling <see cref="M:System.ComponentModel.Design.DesignerActionUIService.Dispose" />, you must release all references to the <see cref="T:System.ComponentModel.Design.DesignerActionUIService" /> so the garbage collector can reclaim the memory that the <see cref="T:System.ComponentModel.Design.DesignerActionUIService" /> was occupying. For more information, see <format type="text/html"><a href="a17b0066-71c2-4ba4-9822-8e19332fc213">Cleaning Up Unmanaged Resources</a></format> and <format type="text/html"><a href="eb4e1af0-3b48-4fbc-ad4e-fc2f64138bf9">Implementing a Dispose Method</a></format>. </para>
<block subset="none" type="note">
<para>Always call <see cref="M:System.ComponentModel.Design.DesignerActionUIService.Dispose" /> before you release your last reference to the <see cref="T:System.ComponentModel.Design.DesignerActionUIService" />. Otherwise, the resources it is using will not be freed until the garbage collector calls the <see cref="T:System.ComponentModel.Design.DesignerActionUIService" /> object's Finalize method.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Releases all resources used by the <see cref="T:System.ComponentModel.Design.DesignerActionUIService" /> class.</para>
</summary>
</Docs>
</Member>
<Member MemberName="HideUI">
<MemberSignature Language="C#" Value="public void HideUI (System.ComponentModel.IComponent component);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="component" Type="System.ComponentModel.IComponent" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the smart tag panel is currently being displayed, the <see cref="M:System.ComponentModel.Design.DesignerActionUIService.HideUI(System.ComponentModel.IComponent)" /> method will hide it. This method raises the <see cref="E:System.ComponentModel.Design.DesignerActionUIService.DesignerActionUIStateChange" /> event, stipulating <see cref="F:System.ComponentModel.Design.DesignerActionUIStateChangeType.Hide" /> as the event type. </para>
<block subset="none" type="note">
<para>The <see cref="M:System.ComponentModel.Design.DesignerActionUIService.HideUI(System.ComponentModel.IComponent)" /> and <see cref="M:System.ComponentModel.Design.DesignerActionUIService.ShowUI(System.ComponentModel.IComponent)" /> methods are implemented only to raise their corresponding events. The actual functionality is found in the handlers for these events, which are part of the design-time environment.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Hides the smart tag panel for a component.</para>
</summary>
<param name="component">
<attribution license="cc4" from="Microsoft" modified="false" />The component whose smart tag panel should be hidden.</param>
</Docs>
</Member>
<Member MemberName="Refresh">
<MemberSignature Language="C#" Value="public void Refresh (System.ComponentModel.IComponent component);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="component" Type="System.ComponentModel.IComponent" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.ComponentModel.Design.DesignerActionUIService.Refresh(System.ComponentModel.IComponent)" /> method updates the internal DesignerAction <see cref="T:System.Windows.Forms.Design.Behavior.Glyph" />, as well as the smart tag panel.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Updates the smart tag panel.</para>
</summary>
<param name="component">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to refresh.</param>
</Docs>
</Member>
<Member MemberName="ShouldAutoShow">
<MemberSignature Language="C#" Value="public bool ShouldAutoShow (System.ComponentModel.IComponent component);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="component" Type="System.ComponentModel.IComponent" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether to automatically show the smart tag panel.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true to automatically show the smart tag panel; otherwise, false.</para>
</returns>
<param name="component">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.ComponentModel.IComponent" /> to automatically show.</param>
</Docs>
</Member>
<Member MemberName="ShowUI">
<MemberSignature Language="C#" Value="public void ShowUI (System.ComponentModel.IComponent component);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="component" Type="System.ComponentModel.IComponent" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the smart tag panel is currently hidden, the <see cref="M:System.ComponentModel.Design.DesignerActionUIService.ShowUI(System.ComponentModel.IComponent)" /> method will display the panel. This method raises the <see cref="E:System.ComponentModel.Design.DesignerActionUIService.DesignerActionUIStateChange" /> event, stipulating <see cref="F:System.ComponentModel.Design.DesignerActionUIStateChangeType.Show" /> as the event type. </para>
<block subset="none" type="note">
<para>The <see cref="M:System.ComponentModel.Design.DesignerActionUIService.HideUI(System.ComponentModel.IComponent)" /> and <see cref="M:System.ComponentModel.Design.DesignerActionUIService.ShowUI(System.ComponentModel.IComponent)" /> methods are implemented only to raise their corresponding events. The actual functionality is found in the handlers for these events, which are part of the design-time environment.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Displays the smart tag panel for a component.</para>
</summary>
<param name="component">
<attribution license="cc4" from="Microsoft" modified="false" />The component whose smart tag panel should be displayed.</param>
</Docs>
</Member>
</Members>
</Type>
|