1<?xml version="1.0" encoding="utf-8"?> 2<Type Name="HierarchicalDataSourceDesigner" FullName="System.Web.UI.Design.HierarchicalDataSourceDesigner"> 3 <TypeSignature Language="C#" Value="public class HierarchicalDataSourceDesigner : System.Web.UI.Design.ControlDesigner, System.Web.UI.Design.IHierarchicalDataSourceDesigner" /> 4 <AssemblyInfo> 5 <AssemblyName>System.Design</AssemblyName> 6 <AssemblyVersion>2.0.0.0</AssemblyVersion> 7 </AssemblyInfo> 8 <Base> 9 <BaseTypeName>System.Web.UI.Design.ControlDesigner</BaseTypeName> 10 </Base> 11 <Interfaces> 12 <Interface> 13 <InterfaceName>System.Web.UI.Design.IHierarchicalDataSourceDesigner</InterfaceName> 14 </Interface> 15 </Interfaces> 16 <Docs> 17 <remarks> 18 <attribution license="cc4" from="Microsoft" modified="false" /> 19 <para>The <see cref="T:System.Web.UI.Design.HierarchicalDataSourceDesigner" /> class is a base class for deriving your own data source designer for a custom data source control derived from the <see cref="T:System.Web.UI.HierarchicalDataSourceControl" /> class. Other classes that derive from <see cref="T:System.Web.UI.Design.HierarchicalDataSourceDesigner" /> are <see cref="T:System.Web.UI.Design.WebControls.XmlDataSourceDesigner" /> and <see cref="T:System.Web.UI.Design.WebControls.SiteMapDataSourceDesigner" />.</para> 20 </remarks> 21 <summary> 22 <attribution license="cc4" from="Microsoft" modified="false" /> 23 <para>Provides design-time support in a visual designer for the <see cref="T:System.Web.UI.HierarchicalDataSourceControl" /> control.</para> 24 </summary> 25 </Docs> 26 <Members> 27 <Member MemberName=".ctor"> 28 <MemberSignature Language="C#" Value="public HierarchicalDataSourceDesigner ();" /> 29 <MemberType>Constructor</MemberType> 30 <AssemblyInfo> 31 <AssemblyVersion>2.0.0.0</AssemblyVersion> 32 </AssemblyInfo> 33 <Parameters /> 34 <Docs> 35 <remarks>To be added.</remarks> 36 <summary> 37 <attribution license="cc4" from="Microsoft" modified="false" /> 38 <para>Initializes a new instance of the <see cref="T:System.Web.UI.Design.HierarchicalDataSourceDesigner" /> class.</para> 39 </summary> 40 </Docs> 41 </Member> 42 <Member MemberName="ActionLists"> 43 <MemberSignature Language="C#" Value="public override System.ComponentModel.Design.DesignerActionListCollection ActionLists { get; }" /> 44 <MemberType>Property</MemberType> 45 <AssemblyInfo> 46 <AssemblyVersion>2.0.0.0</AssemblyVersion> 47 </AssemblyInfo> 48 <ReturnValue> 49 <ReturnType>System.ComponentModel.Design.DesignerActionListCollection</ReturnType> 50 </ReturnValue> 51 <Docs> 52 <value>To be added.</value> 53 <remarks>To be added.</remarks> 54 <summary> 55 <attribution license="cc4" from="Microsoft" modified="false" /> 56 <para>Gets the action list collection for the control designer.</para> 57 </summary> 58 </Docs> 59 </Member> 60 <Member MemberName="CanConfigure"> 61 <MemberSignature Language="C#" Value="public virtual bool CanConfigure { get; }" /> 62 <MemberType>Property</MemberType> 63 <AssemblyInfo> 64 <AssemblyVersion>2.0.0.0</AssemblyVersion> 65 </AssemblyInfo> 66 <ReturnValue> 67 <ReturnType>System.Boolean</ReturnType> 68 </ReturnValue> 69 <Docs> 70 <value>To be added.</value> 71 <remarks> 72 <attribution license="cc4" from="Microsoft" modified="false" /> 73 <para>A design host, such as vsprvslong, uses this property to determine whether to show a <ui>Configure</ui> command in the Smart-Tag menu in design view.</para> 74 </remarks> 75 <summary> 76 <attribution license="cc4" from="Microsoft" modified="false" /> 77 <para>Gets a value that indicates whether the <see cref="M:System.Web.UI.Design.IHierarchicalDataSourceDesigner.Configure" /> method can be called.</para> 78 </summary> 79 </Docs> 80 </Member> 81 <Member MemberName="CanRefreshSchema"> 82 <MemberSignature Language="C#" Value="public virtual bool CanRefreshSchema { get; }" /> 83 <MemberType>Property</MemberType> 84 <AssemblyInfo> 85 <AssemblyVersion>2.0.0.0</AssemblyVersion> 86 </AssemblyInfo> 87 <ReturnValue> 88 <ReturnType>System.Boolean</ReturnType> 89 </ReturnValue> 90 <Docs> 91 <value>To be added.</value> 92 <remarks> 93 <attribution license="cc4" from="Microsoft" modified="false" /> 94 <para>A design host, such as vsprvslong, uses this property to determine whether to show a <ui>Refresh Schema</ui> command in the Smart-Tag menu in design view.</para> 95 </remarks> 96 <summary> 97 <attribution license="cc4" from="Microsoft" modified="false" /> 98 <para>Gets a value that indicates whether the <see cref="M:System.Web.UI.Design.IHierarchicalDataSourceDesigner.RefreshSchema(System.Boolean)" /> method can be called.</para> 99 </summary> 100 </Docs> 101 </Member> 102 <Member MemberName="Configure"> 103 <MemberSignature Language="C#" Value="public virtual void Configure ();" /> 104 <MemberType>Method</MemberType> 105 <AssemblyInfo> 106 <AssemblyVersion>2.0.0.0</AssemblyVersion> 107 </AssemblyInfo> 108 <ReturnValue> 109 <ReturnType>System.Void</ReturnType> 110 </ReturnValue> 111 <Parameters /> 112 <Docs> 113 <remarks> 114 <attribution license="cc4" from="Microsoft" modified="false" /> 115 <para>The <see cref="M:System.Web.UI.Design.HierarchicalDataSourceDesigner.Configure" /> method is not supported in the <see cref="T:System.Web.UI.Design.HierarchicalDataSourceDesigner" /> class.</para> 116 </remarks> 117 <summary> 118 <attribution license="cc4" from="Microsoft" modified="false" /> 119 <para>Launches the configuration wizard for the underlying data source.</para> 120 </summary> 121 </Docs> 122 </Member> 123 <Member MemberName="DataSourceChanged"> 124 <MemberSignature Language="C#" Value="public event EventHandler DataSourceChanged;" /> 125 <MemberType>Event</MemberType> 126 <AssemblyInfo> 127 <AssemblyVersion>2.0.0.0</AssemblyVersion> 128 </AssemblyInfo> 129 <ReturnValue> 130 <ReturnType>System.EventHandler</ReturnType> 131 </ReturnValue> 132 <Docs> 133 <remarks>To be added.</remarks> 134 <summary> 135 <attribution license="cc4" from="Microsoft" modified="false" /> 136 <para>Occurs when any property of the associated data source changes.</para> 137 </summary> 138 </Docs> 139 </Member> 140 <Member MemberName="GetDesignTimeHtml"> 141 <MemberSignature Language="C#" Value="public override string GetDesignTimeHtml ();" /> 142 <MemberType>Method</MemberType> 143 <AssemblyInfo> 144 <AssemblyVersion>2.0.0.0</AssemblyVersion> 145 </AssemblyInfo> 146 <ReturnValue> 147 <ReturnType>System.String</ReturnType> 148 </ReturnValue> 149 <Parameters /> 150 <Docs> 151 <returns>To be added.</returns> 152 <remarks>To be added.</remarks> 153 <summary> 154 <attribution license="cc4" from="Microsoft" modified="false" /> 155 <para>Gets the HTML markup that is used to represent the control at design time.</para> 156 </summary> 157 </Docs> 158 </Member> 159 <Member MemberName="GetView"> 160 <MemberSignature Language="C#" Value="public virtual System.Web.UI.Design.DesignerHierarchicalDataSourceView GetView (string viewPath);" /> 161 <MemberType>Method</MemberType> 162 <AssemblyInfo> 163 <AssemblyVersion>2.0.0.0</AssemblyVersion> 164 </AssemblyInfo> 165 <ReturnValue> 166 <ReturnType>System.Web.UI.Design.DesignerHierarchicalDataSourceView</ReturnType> 167 </ReturnValue> 168 <Parameters> 169 <Parameter Name="viewPath" Type="System.String" /> 170 </Parameters> 171 <Docs> 172 <remarks>To be added.</remarks> 173 <summary> 174 <attribution license="cc4" from="Microsoft" modified="false" /> 175 <para>Gets the named data source view associated with the data source control.</para> 176 </summary> 177 <returns> 178 <attribution license="cc4" from="Microsoft" modified="false" /> 179 <para>A <see cref="T:System.Web.UI.Design.DesignerHierarchicalDataSourceView" /> object.</para> 180 </returns> 181 <param name="viewPath"> 182 <attribution license="cc4" from="Microsoft" modified="false" />The unique path to the block of data to use in creating the view.</param> 183 </Docs> 184 </Member> 185 <Member MemberName="OnDataSourceChanged"> 186 <MemberSignature Language="C#" Value="protected virtual void OnDataSourceChanged (EventArgs e);" /> 187 <MemberType>Method</MemberType> 188 <AssemblyInfo> 189 <AssemblyVersion>2.0.0.0</AssemblyVersion> 190 </AssemblyInfo> 191 <ReturnValue> 192 <ReturnType>System.Void</ReturnType> 193 </ReturnValue> 194 <Parameters> 195 <Parameter Name="e" Type="System.EventArgs" /> 196 </Parameters> 197 <Docs> 198 <remarks> 199 <attribution license="cc4" from="Microsoft" modified="false" /> 200 <para>The <see cref="M:System.Web.UI.Design.HierarchicalDataSourceDesigner.OnDataSourceChanged(System.EventArgs)" /> method notifies the designer of each control bound to the associated data source to refresh its control in the design host. This method can be suppressed with the <see cref="M:System.Web.UI.Design.HierarchicalDataSourceDesigner.SuppressDataSourceEvents" /> method, or by calling the <see cref="M:System.Web.UI.Design.HierarchicalDataSourceDesigner.RefreshSchema(System.Boolean)" /> method with an argument of false.</para> 201 </remarks> 202 <summary> 203 <attribution license="cc4" from="Microsoft" modified="false" /> 204 <para>Raises the <see cref="E:System.Web.UI.Design.HierarchicalDataSourceDesigner.DataSourceChanged" /> event when the properties of the data source have changed and the <see cref="P:System.Web.UI.Design.HierarchicalDataSourceDesigner.SuppressingDataSourceEvents" /> property value is false.</para> 205 </summary> 206 <param name="e"> 207 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> object provided by the calling object.</param> 208 </Docs> 209 </Member> 210 <Member MemberName="OnSchemaRefreshed"> 211 <MemberSignature Language="C#" Value="protected virtual void OnSchemaRefreshed (EventArgs e);" /> 212 <MemberType>Method</MemberType> 213 <AssemblyInfo> 214 <AssemblyVersion>2.0.0.0</AssemblyVersion> 215 </AssemblyInfo> 216 <ReturnValue> 217 <ReturnType>System.Void</ReturnType> 218 </ReturnValue> 219 <Parameters> 220 <Parameter Name="e" Type="System.EventArgs" /> 221 </Parameters> 222 <Docs> 223 <remarks> 224 <attribution license="cc4" from="Microsoft" modified="false" /> 225 <para>This method notifies the designers of each control bound to the associated data source that the fields in the schema have changed. This method can be suppressed with the <see cref="M:System.Web.UI.Design.HierarchicalDataSourceDesigner.SuppressDataSourceEvents" /> method, or by calling the <see cref="M:System.Web.UI.Design.HierarchicalDataSourceDesigner.RefreshSchema(System.Boolean)" /> method with an argument of true.</para> 226 </remarks> 227 <summary> 228 <attribution license="cc4" from="Microsoft" modified="false" /> 229 <para>Raises the <see cref="E:System.Web.UI.Design.HierarchicalDataSourceDesigner.SchemaRefreshed" /> event when the schema of the data source has changed and the <see cref="P:System.Web.UI.Design.HierarchicalDataSourceDesigner.SuppressingDataSourceEvents" /> property value is false.</para> 230 </summary> 231 <param name="e"> 232 <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.EventArgs" /> object.</param> 233 </Docs> 234 </Member> 235 <Member MemberName="RefreshSchema"> 236 <MemberSignature Language="C#" Value="public virtual void RefreshSchema (bool preferSilent);" /> 237 <MemberType>Method</MemberType> 238 <AssemblyInfo> 239 <AssemblyVersion>2.0.0.0</AssemblyVersion> 240 </AssemblyInfo> 241 <ReturnValue> 242 <ReturnType>System.Void</ReturnType> 243 </ReturnValue> 244 <Parameters> 245 <Parameter Name="preferSilent" Type="System.Boolean" /> 246 </Parameters> 247 <Docs> 248 <remarks> 249 <attribution license="cc4" from="Microsoft" modified="false" /> 250 <para>This method is not supported in this class, but is implemented in derived classes, such as the <see cref="T:System.Web.UI.Design.WebControls.XmlDataSourceDesigner" /> class.</para> 251 </remarks> 252 <summary> 253 <attribution license="cc4" from="Microsoft" modified="false" /> 254 <para>Refreshes the schema of the data.</para> 255 </summary> 256 <param name="preferSilent"> 257 <attribution license="cc4" from="Microsoft" modified="false" />This parameter is not used in this implementation. However, it should be supported in derived classes.</param> 258 </Docs> 259 </Member> 260 <Member MemberName="ResumeDataSourceEvents"> 261 <MemberSignature Language="C#" Value="public virtual void ResumeDataSourceEvents ();" /> 262 <MemberType>Method</MemberType> 263 <AssemblyInfo> 264 <AssemblyVersion>2.0.0.0</AssemblyVersion> 265 </AssemblyInfo> 266 <ReturnValue> 267 <ReturnType>System.Void</ReturnType> 268 </ReturnValue> 269 <Parameters /> 270 <Docs> 271 <remarks> 272 <attribution license="cc4" from="Microsoft" modified="false" /> 273 <para>Data source events can be suppressed by setting the <see cref="P:System.Web.UI.Design.HierarchicalDataSourceDesigner.SuppressingDataSourceEvents" /> property to false, or by calling the <see cref="M:System.Web.UI.Design.HierarchicalDataSourceDesigner.RefreshSchema(System.Boolean)" /> method with an argument of true.</para> 274 </remarks> 275 <summary> 276 <attribution license="cc4" from="Microsoft" modified="false" /> 277 <para>Restores data source events after they have been suppressed.</para> 278 </summary> 279 </Docs> 280 </Member> 281 <Member MemberName="SchemaRefreshed"> 282 <MemberSignature Language="C#" Value="public event EventHandler SchemaRefreshed;" /> 283 <MemberType>Event</MemberType> 284 <AssemblyInfo> 285 <AssemblyVersion>2.0.0.0</AssemblyVersion> 286 </AssemblyInfo> 287 <ReturnValue> 288 <ReturnType>System.EventHandler</ReturnType> 289 </ReturnValue> 290 <Docs> 291 <remarks>To be added.</remarks> 292 <summary> 293 <attribution license="cc4" from="Microsoft" modified="false" /> 294 <para>Occurs after the schema has been refreshed.</para> 295 </summary> 296 </Docs> 297 </Member> 298 <Member MemberName="SuppressDataSourceEvents"> 299 <MemberSignature Language="C#" Value="public virtual void SuppressDataSourceEvents ();" /> 300 <MemberType>Method</MemberType> 301 <AssemblyInfo> 302 <AssemblyVersion>2.0.0.0</AssemblyVersion> 303 </AssemblyInfo> 304 <ReturnValue> 305 <ReturnType>System.Void</ReturnType> 306 </ReturnValue> 307 <Parameters /> 308 <Docs> 309 <remarks>To be added.</remarks> 310 <summary> 311 <attribution license="cc4" from="Microsoft" modified="false" /> 312 <para>Postpones all data source events until after the <see cref="M:System.Web.UI.Design.HierarchicalDataSourceDesigner.ResumeDataSourceEvents" /> method is called.</para> 313 </summary> 314 </Docs> 315 </Member> 316 <Member MemberName="SuppressingDataSourceEvents"> 317 <MemberSignature Language="C#" Value="protected bool SuppressingDataSourceEvents { get; }" /> 318 <MemberType>Property</MemberType> 319 <AssemblyInfo> 320 <AssemblyVersion>2.0.0.0</AssemblyVersion> 321 </AssemblyInfo> 322 <ReturnValue> 323 <ReturnType>System.Boolean</ReturnType> 324 </ReturnValue> 325 <Docs> 326 <value>To be added.</value> 327 <remarks>To be added.</remarks> 328 <summary> 329 <attribution license="cc4" from="Microsoft" modified="false" /> 330 <para>Indicates whether data source events have been disabled.</para> 331 </summary> 332 </Docs> 333 </Member> 334 </Members> 335</Type>